Class FirewallRuleDomain

java.lang.Object
software.amazon.awssdk.services.route53resolver.model.FirewallRuleDomain
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FirewallRuleDomain.Builder,FirewallRuleDomain>

@Generated("software.amazon.awssdk:codegen") public final class FirewallRuleDomain extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FirewallRuleDomain.Builder,FirewallRuleDomain>

A domain that DNS Firewall observed for an AutoAllowlist rule, with its review status and request volume. Counts are aggregated across all VPCs that use the rule group, through a rule group association or through a Route 53 Profile that includes the rule group, including VPCs in other accounts. The domain isn't attributed to the VPC or account in which it was observed.

See Also:
  • Method Details

    • domainName

      public final String domainName()

      The domain name.

      Returns:
      The domain name.
    • domainStatus

      public final FirewallDomainStatus domainStatus()

      The review status of the domain:

      • OBSERVED - DNS Firewall saw the domain in the VPCs' DNS traffic and you haven't allowed or denied it. The look-back window seeds the initial observed domains. After that, a domain becomes observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list with REMOVE. To keep observing new domains, place a rule that blocks the domains you haven't approved after the AutoAllowlist rule. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created. Observed domains aren't evaluated for safety, so review them before you allow them.

      • ALLOWED - DNS Firewall allowed queries for the domain, whether or not the domain is in the rule's managed domain list. To get the domains in the managed domain list (the allowlist that the rule enforces), call ListFirewallRuleDomains with FirewallDomainListId.

      • DENIED - The domain was denied with the DENY operation of UpdateFirewallDomains, which also removes it from the managed domain list if it was there. A denied domain that is still queried and not blocked can move to ALLOWED.

      If the service returns an enum value that is not available in the current SDK version, domainStatus will return FirewallDomainStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainStatusAsString().

      Returns:
      The review status of the domain:

      • OBSERVED - DNS Firewall saw the domain in the VPCs' DNS traffic and you haven't allowed or denied it. The look-back window seeds the initial observed domains. After that, a domain becomes observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list with REMOVE. To keep observing new domains, place a rule that blocks the domains you haven't approved after the AutoAllowlist rule. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created. Observed domains aren't evaluated for safety, so review them before you allow them.

      • ALLOWED - DNS Firewall allowed queries for the domain, whether or not the domain is in the rule's managed domain list. To get the domains in the managed domain list (the allowlist that the rule enforces), call ListFirewallRuleDomains with FirewallDomainListId.

      • DENIED - The domain was denied with the DENY operation of UpdateFirewallDomains, which also removes it from the managed domain list if it was there. A denied domain that is still queried and not blocked can move to ALLOWED.

      See Also:
    • domainStatusAsString

      public final String domainStatusAsString()

      The review status of the domain:

      • OBSERVED - DNS Firewall saw the domain in the VPCs' DNS traffic and you haven't allowed or denied it. The look-back window seeds the initial observed domains. After that, a domain becomes observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list with REMOVE. To keep observing new domains, place a rule that blocks the domains you haven't approved after the AutoAllowlist rule. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created. Observed domains aren't evaluated for safety, so review them before you allow them.

      • ALLOWED - DNS Firewall allowed queries for the domain, whether or not the domain is in the rule's managed domain list. To get the domains in the managed domain list (the allowlist that the rule enforces), call ListFirewallRuleDomains with FirewallDomainListId.

      • DENIED - The domain was denied with the DENY operation of UpdateFirewallDomains, which also removes it from the managed domain list if it was there. A denied domain that is still queried and not blocked can move to ALLOWED.

      If the service returns an enum value that is not available in the current SDK version, domainStatus will return FirewallDomainStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainStatusAsString().

      Returns:
      The review status of the domain:

      • OBSERVED - DNS Firewall saw the domain in the VPCs' DNS traffic and you haven't allowed or denied it. The look-back window seeds the initial observed domains. After that, a domain becomes observed when any DNS Firewall rule blocks a query for it from a VPC that uses the rule group, including rules in other rule groups, or when you remove it from the managed domain list with REMOVE. To keep observing new domains, place a rule that blocks the domains you haven't approved after the AutoAllowlist rule. Domains from the look-back period that keep being queried and aren't blocked move to ALLOWED within about a day after the rule is created. Observed domains aren't evaluated for safety, so review them before you allow them.

      • ALLOWED - DNS Firewall allowed queries for the domain, whether or not the domain is in the rule's managed domain list. To get the domains in the managed domain list (the allowlist that the rule enforces), call ListFirewallRuleDomains with FirewallDomainListId.

      • DENIED - The domain was denied with the DENY operation of UpdateFirewallDomains, which also removes it from the managed domain list if it was there. A denied domain that is still queried and not blocked can move to ALLOWED.

      See Also:
    • last24HourRequests

      public final Long last24HourRequests()

      The number of DNS requests observed for this domain in the last 24 hours.

      Returns:
      The number of DNS requests observed for this domain in the last 24 hours.
    • totalRequests

      public final Long totalRequests()

      The total number of DNS requests observed for this domain since it was first added, including the requests in the look-back window that seeded the rule.

      Returns:
      The total number of DNS requests observed for this domain since it was first added, including the requests in the look-back window that seeded the rule.
    • addedTime

      public final String addedTime()

      The date and time when the domain was first observed and added, in RFC 3339 format.

      Returns:
      The date and time when the domain was first observed and added, in RFC 3339 format.
    • toBuilder

      public FirewallRuleDomain.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FirewallRuleDomain.Builder,FirewallRuleDomain>
      Returns:
      a builder for type T
    • builder

      public static FirewallRuleDomain.Builder builder()
    • serializableBuilderClass

      public static Class<? extends FirewallRuleDomain.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.