Class FirewallRule

java.lang.Object

software.amazon.awssdk.services.route53resolver.model.FirewallRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FirewallRule.Builder,FirewallRule>

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

A single firewall rule in a rule group.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FirewallRule.Builder

Method Summary

Modifier and Type	Method	Description
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:
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:
final BlockOverrideDnsType	blockOverrideDnsType()	The DNS record's type.
final String	blockOverrideDnsTypeAsString()	The DNS record's type.
final String	blockOverrideDomain()	The custom DNS record to send back in response to the query.
final Integer	blockOverrideTtl()	The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.
final BlockResponse	blockResponse()	The way that you want DNS Firewall to block the request.
final String	blockResponseAsString()	The way that you want DNS Firewall to block the request.
static FirewallRule.Builder	builder()
final String	creationTime()	The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
final String	creatorRequestId()	A unique string defined by you to identify the request.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final String	firewallDomainListId()	The ID of the domain list that's used in the rule.
final FirewallDomainRedirectionAction	firewallDomainRedirectionAction()	How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
final String	firewallDomainRedirectionActionAsString()	How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.
final String	firewallRuleGroupId()	The unique identifier of the firewall rule group of the rule.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	modificationTime()	The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
final String	name()	The name of the rule.
final Integer	priority()	The priority of the rule in the rule group.
final String	qtype()	The DNS query type you want the rule to evaluate.
final List<SdkField<?>>	sdkFields()
static Class<? extends FirewallRule.Builder>	serializableBuilderClass()
FirewallRule.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

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.

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:

• ALLOW - Permit the request to go through.

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

• ALLOW - Permit the request to go through.

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

• ALLOW - Permit the request to go through.

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

• ALLOW - Permit the request to go through.

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

toBuilder

public FirewallRule.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<FirewallRule.Builder,FirewallRule>

Returns:

a builder for type T

builder

public static FirewallRule.Builder builder()

serializableBuilderClass

public static Class<? extends FirewallRule.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.