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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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:
`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:
`BlockOverrideDnsType`	`blockOverrideDnsType()`	The DNS record's type.
`String`	`blockOverrideDnsTypeAsString()`	The DNS record's type.
`String`	`blockOverrideDomain()`	The custom DNS record to send back in response to the query.
`Integer`	`blockOverrideTtl()`	The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.
`BlockResponse`	`blockResponse()`	The way that you want DNS Firewall to block the request.
`String`	`blockResponseAsString()`	The way that you want DNS Firewall to block the request.
`static FirewallRule.Builder`	`builder()`
`String`	`creationTime()`	The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
`String`	`creatorRequestId()`	A unique string defined by you to identify the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`firewallDomainListId()`	The ID of the domain list that's used in the rule.
`String`	`firewallRuleGroupId()`	The unique identifier of the firewall rule group of the rule.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`modificationTime()`	The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
`String`	`name()`	The name of the rule.
`Integer`	`priority()`	The priority of the rule in the rule group.
`String`	`qtype()`	The DNS query type you want the rule to evaluate.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FirewallRule.Builder>`	`serializableBuilderClass()`
`FirewallRule.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- 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.
  - 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).
  - 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.
    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.
  - toBuilder
```
public FirewallRule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FirewallRule.Builder,FirewallRule>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class FirewallRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

firewallRuleGroupId

firewallDomainListId

name

priority

action

actionAsString

blockResponse

blockResponseAsString

blockOverrideDomain

blockOverrideDnsType

blockOverrideDnsTypeAsString

blockOverrideTtl

creatorRequestId

creationTime

modificationTime

qtype

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields