Class UpdateFirewallRuleRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.route53resolver.model.Route53ResolverRequest
-
- software.amazon.awssdk.services.route53resolver.model.UpdateFirewallRuleRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateFirewallRuleRequest.Builder,UpdateFirewallRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFirewallRuleRequest extends Route53ResolverRequest implements ToCopyableBuilder<UpdateFirewallRuleRequest.Builder,UpdateFirewallRuleRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateFirewallRuleRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Actionaction()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:StringactionAsString()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:BlockOverrideDnsTypeblockOverrideDnsType()The DNS record's type.StringblockOverrideDnsTypeAsString()The DNS record's type.StringblockOverrideDomain()The custom DNS record to send back in response to the query.IntegerblockOverrideTtl()The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.BlockResponseblockResponse()The way that you want DNS Firewall to block the request.StringblockResponseAsString()The way that you want DNS Firewall to block the request.static UpdateFirewallRuleRequest.Builderbuilder()ConfidenceThresholdconfidenceThreshold()The confidence threshold for DNS Firewall Advanced.StringconfidenceThresholdAsString()The confidence threshold for DNS Firewall Advanced.DnsThreatProtectiondnsThreatProtection()The type of the DNS Firewall Advanced rule.StringdnsThreatProtectionAsString()The type of the DNS Firewall Advanced rule.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfirewallDomainListId()The ID of the domain list to use in the rule.FirewallDomainRedirectionActionfirewallDomainRedirectionAction()How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.StringfirewallDomainRedirectionActionAsString()How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.StringfirewallRuleGroupId()The unique identifier of the firewall rule group for the rule.StringfirewallThreatProtectionId()The DNS Firewall Advanced rule ID.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()The name of the rule.Integerpriority()The setting that determines the processing order of the rule in the rule group.Stringqtype()The DNS query type you want the rule to evaluate.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateFirewallRuleRequest.Builder>serializableBuilderClass()UpdateFirewallRuleRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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 for the rule.
- Returns:
- The unique identifier of the firewall rule group for the rule.
-
firewallDomainListId
public final String firewallDomainListId()
The ID of the domain list to use in the rule.
- Returns:
- The ID of the domain list to use in the rule.
-
firewallThreatProtectionId
public final String firewallThreatProtectionId()
The DNS Firewall Advanced rule ID.
- Returns:
- The DNS Firewall Advanced rule ID.
-
priority
public final Integer priority()
The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
- Returns:
- The setting that determines the processing order of the rule in the rule group. DNS Firewall processes
the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
-
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. This option requires additional details in the rule'sBlockResponse.
If the service returns an enum value that is not available in the current SDK version,
actionwill 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, 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. This option requires additional details in the rule'sBlockResponse.
-
- 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. This option requires additional details in the rule'sBlockResponse.
If the service returns an enum value that is not available in the current SDK version,
actionwill 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, 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. This option requires additional details in the rule'sBlockResponse.
-
- 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'sBlockOverride*settings.
If the service returns an enum value that is not available in the current SDK version,
blockResponsewill 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:
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'sBlockOverride*settings.
If the service returns an enum value that is not available in the current SDK version,
blockResponsewill 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:
BlockResponse
-
-
blockOverrideDomain
public final String blockOverrideDomain()
The custom DNS record to send back in response to the query. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.- Returns:
- The custom DNS record to send back in response to the query. Used for the rule action
BLOCKwith aBlockResponsesetting ofOVERRIDE.
-
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 actionBLOCKwith aBlockResponsesetting ofOVERRIDE.If the service returns an enum value that is not available in the current SDK version,
blockOverrideDnsTypewill 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 actionBLOCKwith aBlockResponsesetting ofOVERRIDE. - 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 actionBLOCKwith aBlockResponsesetting ofOVERRIDE.If the service returns an enum value that is not available in the current SDK version,
blockOverrideDnsTypewill 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 actionBLOCKwith aBlockResponsesetting ofOVERRIDE. - 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
BLOCKwith aBlockResponsesetting 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
BLOCKwith aBlockResponsesetting ofOVERRIDE.
-
name
public final String name()
The name of the rule.
- Returns:
- The name of the rule.
-
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,
firewallDomainRedirectionActionwill returnFirewallDomainRedirectionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfirewallDomainRedirectionActionAsString().- 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,
firewallDomainRedirectionActionwill returnFirewallDomainRedirectionAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfirewallDomainRedirectionActionAsString().- 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.
If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.
- 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.
If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.
-
-
-
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,
dnsThreatProtectionwill returnDnsThreatProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdnsThreatProtectionAsString().- 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,
dnsThreatProtectionwill returnDnsThreatProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdnsThreatProtectionAsString().- 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,
confidenceThresholdwill returnConfidenceThreshold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfidenceThresholdAsString().- 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,
confidenceThresholdwill returnConfidenceThreshold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfidenceThresholdAsString().- 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
-
-
toBuilder
public UpdateFirewallRuleRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateFirewallRuleRequest.Builder,UpdateFirewallRuleRequest>- Specified by:
toBuilderin classRoute53ResolverRequest
-
builder
public static UpdateFirewallRuleRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateFirewallRuleRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-