Class CreateFirewallRuleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.route53globalresolver.model.Route53GlobalResolverRequest
software.amazon.awssdk.services.route53globalresolver.model.CreateFirewallRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateFirewallRuleRequest.Builder,CreateFirewallRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFirewallRuleRequest extends Route53GlobalResolverRequest implements ToCopyableBuilder<CreateFirewallRuleRequest.Builder,CreateFirewallRuleRequest>

  • Method Details

    • action

      public final FirewallRuleAction 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 and send metrics and logs to CloudWatch.

      • 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 FirewallRuleAction.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 and send metrics and logs to CloudWatch.

      • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

      See Also:

    • 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 and send metrics and logs to CloudWatch.

      • 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 FirewallRuleAction.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 and send metrics and logs to CloudWatch.

      • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

      See Also:

    • blockOverrideDnsType

      public final BlockOverrideDnsQueryType 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.

      This setting is required if the BlockResponse setting is OVERRIDE.

      If the service returns an enum value that is not available in the current SDK version, blockOverrideDnsType will return BlockOverrideDnsQueryType.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.

      This setting is required if the BlockResponse setting is OVERRIDE.

      See Also:

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

      This setting is required if the BlockResponse setting is OVERRIDE.

      If the service returns an enum value that is not available in the current SDK version, blockOverrideDnsType will return BlockOverrideDnsQueryType.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.

      This setting is required if the BlockResponse setting is OVERRIDE.

      See Also:

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

      This setting is required if the BlockResponse setting is 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.

      This setting is required if the BlockResponse setting is OVERRIDE.

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

      This setting is required if the BlockResponse setting is 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.

      This setting is required if the BlockResponse setting is OVERRIDE.

    • blockResponse

      public final FirewallBlockResponse blockResponse()

      The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).

      If the service returns an enum value that is not available in the current SDK version, blockResponse will return FirewallBlockResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blockResponseAsString().

      Returns:
      The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).
      See Also:

    • blockResponseAsString

      public final String blockResponseAsString()

      The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).

      If the service returns an enum value that is not available in the current SDK version, blockResponse will return FirewallBlockResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blockResponseAsString().

      Returns:
      The response to return when the action is BLOCK. Valid values are NXDOMAIN (domain does not exist), NODATA (domain exists but no records), or OVERRIDE (return custom response).
      See Also:

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.

      Returns:
      A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.

    • confidenceThreshold

      public final ConfidenceThreshold confidenceThreshold()

      The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.

      If the service returns an enum value that is not available in the current SDK version, confidenceThreshold will return ConfidenceThreshold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confidenceThresholdAsString().

      Returns:
      The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.
      See Also:

    • confidenceThresholdAsString

      public final String confidenceThresholdAsString()

      The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.

      If the service returns an enum value that is not available in the current SDK version, confidenceThreshold will return ConfidenceThreshold.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confidenceThresholdAsString().

      Returns:
      The confidence threshold for advanced threat detection. Valid values are HIGH, MEDIUM, or LOW, indicating the accuracy level required for threat detection.
      See Also:

    • description

      public final String description()

      An optional description for the firewall rule.

      Returns:
      An optional description for the firewall rule.

    • dnsAdvancedProtection

      public final DnsAdvancedProtection dnsAdvancedProtection()

      Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.

      If the service returns an enum value that is not available in the current SDK version, dnsAdvancedProtection will return DnsAdvancedProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dnsAdvancedProtectionAsString().

      Returns:
      Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.
      See Also:

    • dnsAdvancedProtectionAsString

      public final String dnsAdvancedProtectionAsString()

      Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.

      If the service returns an enum value that is not available in the current SDK version, dnsAdvancedProtection will return DnsAdvancedProtection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dnsAdvancedProtectionAsString().

      Returns:
      Whether to enable advanced DNS threat protection for this rule. Advanced protection can detect and block DNS tunneling and Domain Generation Algorithm (DGA) threats.
      See Also:

    • firewallDomainListId

      public final String firewallDomainListId()

      The ID of the firewall domain list to use in this rule.

      Returns:
      The ID of the firewall domain list to use in this rule.

    • name

      public final String name()

      A descriptive name for the firewall rule.

      Returns:
      A descriptive name for the firewall rule.

    • priority

      public final Long priority()

      The priority of this rule. Rules are evaluated in priority order, with lower numbers having higher priority. When a DNS query matches multiple rules, the rule with the highest priority (lowest number) is applied.

      Returns:
      The priority of this rule. Rules are evaluated in priority order, with lower numbers having higher priority. When a DNS query matches multiple rules, the rule with the highest priority (lowest number) is applied.

    • dnsViewId

      public final String dnsViewId()

      The ID of the DNS view to associate with this firewall rule.

      Returns:
      The ID of the DNS view to associate with this firewall rule.

    • qType

      public final String qType()

      The DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).

      Returns:
      The DNS query type to match for this rule. Examples include A (IPv4 address), AAAA (IPv6 address), MX (mail exchange), or TXT (text record).

    • toBuilder

      public CreateFirewallRuleRequest.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<CreateFirewallRuleRequest.Builder,CreateFirewallRuleRequest>
      Specified by:
      toBuilder in class Route53GlobalResolverRequest
      Returns:
      a builder for type T

    • builder

      public static CreateFirewallRuleRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.