Package software.amazon.awssdk.services.route53resolver.model

Class FirewallRule

    • Method Detail

      • firewallRuleGroupId

        public final String firewallRuleGroupId()

        The unique identifier of the Firewall rule group of the rule.

        Returns:
        The unique identifier of the Firewall rule group of the rule.

      • firewallDomainListId

        public final String firewallDomainListId()

        The ID of the domain list that's used in the rule.

        Returns:
        The ID of the domain list that's used in the rule.

      • firewallThreatProtectionId

        public final String firewallThreatProtectionId()

        ID of the DNS Firewall Advanced rule.

        Returns:
        ID of the DNS Firewall Advanced rule.

      • name

        public final String name()

        The name of the rule.

        Returns:
        The name of the rule.

      • priority

        public final Integer priority()

        The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

        Returns:
        The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

      • action

        public final Action action()

        The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

        • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

        • ALERT - Permit the request to go through but send an alert to the logs.

        • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

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

        Returns:
        The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

        • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

        • ALERT - Permit the request to go through but send an alert to the logs.

        • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

        See Also:
        Action

      • actionAsString

        public final String actionAsString()

        The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

        • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

        • ALERT - Permit the request to go through but send an alert to the logs.

        • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

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

        Returns:
        The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

        • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

        • ALERT - Permit the request to go through but send an alert to the logs.

        • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

        See Also:
        Action

      • blockResponse

        public final BlockResponse blockResponse()

        The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

        • NODATA - Respond indicating that the query was successful, but no response is available for it.

        • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

        • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

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

        Returns:
        The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

        • NODATA - Respond indicating that the query was successful, but no response is available for it.

        • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

        • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

        See Also:
        BlockResponse

      • blockResponseAsString

        public final String blockResponseAsString()

        The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

        • NODATA - Respond indicating that the query was successful, but no response is available for it.

        • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

        • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

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

        Returns:
        The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

        • NODATA - Respond indicating that the query was successful, but no response is available for it.

        • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

        • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

        See Also:
        BlockResponse

      • blockOverrideDomain

        public final String blockOverrideDomain()

        The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

        Returns:
        The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      • blockOverrideDnsType

        public final BlockOverrideDnsType blockOverrideDnsType()

        The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

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

        Returns:
        The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
        See Also:
        BlockOverrideDnsType

      • blockOverrideDnsTypeAsString

        public final String blockOverrideDnsTypeAsString()

        The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

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

        Returns:
        The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
        See Also:
        BlockOverrideDnsType

      • blockOverrideTtl

        public final Integer blockOverrideTtl()

        The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

        Returns:
        The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

      • creatorRequestId

        public final String creatorRequestId()

        A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

        Returns:
        A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

      • creationTime

        public final String creationTime()

        The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

        Returns:
        The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

      • modificationTime

        public final String modificationTime()

        The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

        Returns:
        The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

      • firewallDomainRedirectionAction

        public final FirewallDomainRedirectionAction firewallDomainRedirectionAction()

        How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

        INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

        TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

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

        Returns:
        How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

        INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

        TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

        See Also:
        FirewallDomainRedirectionAction

      • firewallDomainRedirectionActionAsString

        public final String firewallDomainRedirectionActionAsString()

        How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

        INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

        TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

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

        Returns:
        How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

        INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

        TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

        See Also:
        FirewallDomainRedirectionAction

      • qtype

        public final String qtype()

        The DNS query type you want the rule to evaluate. Allowed values are;

        • A: Returns an IPv4 address.

        • AAAA: Returns an Ipv6 address.

        • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

        • CNAME: Returns another domain name.

        • DS: Record that identifies the DNSSEC signing key of a delegated zone.

        • MX: Specifies mail servers.

        • NAPTR: Regular-expression-based rewriting of domain names.

        • NS: Authoritative name servers.

        • PTR: Maps an IP address to a domain name.

        • SOA: Start of authority record for the zone.

        • SPF: Lists the servers authorized to send emails from a domain.

        • SRV: Application specific values that identify servers.

        • TXT: Verifies email senders and application-specific values.

        • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

        Returns:
        The DNS query type you want the rule to evaluate. Allowed values are;

        • A: Returns an IPv4 address.

        • AAAA: Returns an Ipv6 address.

        • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

        • CNAME: Returns another domain name.

        • DS: Record that identifies the DNSSEC signing key of a delegated zone.

        • MX: Specifies mail servers.

        • NAPTR: Regular-expression-based rewriting of domain names.

        • NS: Authoritative name servers.

        • PTR: Maps an IP address to a domain name.

        • SOA: Start of authority record for the zone.

        • SPF: Lists the servers authorized to send emails from a domain.

        • SRV: Application specific values that identify servers.

        • TXT: Verifies email senders and application-specific values.

        • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

      • dnsThreatProtection

        public final DnsThreatProtection dnsThreatProtection()

        The type of the DNS Firewall Advanced rule. Valid values are:

        • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

        • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

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

        Returns:
        The type of the DNS Firewall Advanced rule. Valid values are:

        • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

        • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

        See Also:
        DnsThreatProtection

      • dnsThreatProtectionAsString

        public final String dnsThreatProtectionAsString()

        The type of the DNS Firewall Advanced rule. Valid values are:

        • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

        • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

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

        Returns:
        The type of the DNS Firewall Advanced rule. Valid values are:

        • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

        • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

        See Also:
        DnsThreatProtection

      • confidenceThreshold

        public final ConfidenceThreshold confidenceThreshold()

        The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

        • LOW: Provides the highest detection rate for threats, but also increases false positives.

        • MEDIUM: Provides a balance between detecting threats and false positives.

        • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

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

        Returns:
        The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

        • LOW: Provides the highest detection rate for threats, but also increases false positives.

        • MEDIUM: Provides a balance between detecting threats and false positives.

        • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

        See Also:
        ConfidenceThreshold

      • confidenceThresholdAsString

        public final String confidenceThresholdAsString()

        The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

        • LOW: Provides the highest detection rate for threats, but also increases false positives.

        • MEDIUM: Provides a balance between detecting threats and false positives.

        • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

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

        Returns:
        The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

        • LOW: Provides the highest detection rate for threats, but also increases false positives.

        • MEDIUM: Provides a balance between detecting threats and false positives.

        • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

        See Also:
        ConfidenceThreshold

      • hashCode

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

      • equals

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

      • 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)