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

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 interface	UpdateFirewallRuleRequest.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 UpdateFirewallRuleRequest.Builder	builder()
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 to use in the rule.
final String	firewallRuleGroupId()	The unique identifier of the firewall rule group for the rule.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final int	hashCode()
final String	name()	The name of the rule.
final Integer	priority()	The setting that determines the processing order 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 UpdateFirewallRuleRequest.Builder>	serializableBuilderClass()
UpdateFirewallRuleRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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:

• 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. This option requires additional details in the rule's BlockResponse.

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. This option requires additional details in the rule's BlockResponse.

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. This option requires additional details in the rule's BlockResponse.

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. This option requires additional details in the rule's BlockResponse.

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.

name

public final String name()

The name of the rule.

Returns:

The name of the rule.

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 UpdateFirewallRuleRequest.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<UpdateFirewallRuleRequest.Builder,UpdateFirewallRuleRequest>

Specified by:

toBuilder in class Route53ResolverRequest

Returns:

a builder for type T

builder

public static UpdateFirewallRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFirewallRuleRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.