Class FirewallRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FirewallRule.Builder,
FirewallRule>
A single firewall rule in a rule group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal 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
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
The DNS record's type.final String
The DNS record's type.final String
The custom DNS record to send back in response to the query.final Integer
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.final BlockResponse
The way that you want DNS Firewall to block the request.final String
The way that you want DNS Firewall to block the request.static FirewallRule.Builder
builder()
final String
The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).final String
A unique string defined by you to identify the request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The ID of the domain list that's used in the rule.final String
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
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.static Class
<? extends FirewallRule.Builder> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The name of the rule.
- Returns:
- The name of the rule.
-
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
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'sBlockResponse
setting.
If the service returns an enum value that is not available in the current SDK version,
action
will returnAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- 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'sBlockResponse
setting.
-
- See Also:
-
-
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'sBlockResponse
setting.
If the service returns an enum value that is not available in the current SDK version,
action
will returnAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- 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'sBlockResponse
setting.
-
- See Also:
-
-
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'sBlockOverride*
settings.
If the service returns an enum value that is not available in the current SDK version,
blockResponse
will returnBlockResponse.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromblockResponseAsString()
.- 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'sBlockOverride*
settings.
-
- See Also:
-
-
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'sBlockOverride*
settings.
If the service returns an enum value that is not available in the current SDK version,
blockResponse
will returnBlockResponse.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromblockResponseAsString()
.- 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'sBlockOverride*
settings.
-
- See Also:
-
-
blockOverrideDomain
The custom DNS record to send back in response to the query. Used for the rule action
BLOCK
with aBlockResponse
setting ofOVERRIDE
.- Returns:
- The custom DNS record to send back in response to the query. Used for the rule action
BLOCK
with aBlockResponse
setting ofOVERRIDE
.
-
blockOverrideDnsType
The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain
. Used for the rule actionBLOCK
with aBlockResponse
setting ofOVERRIDE
.If the service returns an enum value that is not available in the current SDK version,
blockOverrideDnsType
will returnBlockOverrideDnsType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromblockOverrideDnsTypeAsString()
.- Returns:
- The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain
. Used for the rule actionBLOCK
with aBlockResponse
setting ofOVERRIDE
. - See Also:
-
blockOverrideDnsTypeAsString
The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain
. Used for the rule actionBLOCK
with aBlockResponse
setting ofOVERRIDE
.If the service returns an enum value that is not available in the current SDK version,
blockOverrideDnsType
will returnBlockOverrideDnsType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromblockOverrideDnsTypeAsString()
.- Returns:
- The DNS record's type. This determines the format of the record value that you provided in
BlockOverrideDomain
. Used for the rule actionBLOCK
with aBlockResponse
setting ofOVERRIDE
. - See Also:
-
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 aBlockResponse
setting ofOVERRIDE
.- 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 aBlockResponse
setting ofOVERRIDE
.
-
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
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
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
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
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 interfaceToCopyableBuilder<FirewallRule.Builder,
FirewallRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-