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

Class CreateFirewallRuleRequest

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.CreateFirewallRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateFirewallRuleRequest.Builder,CreateFirewallRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFirewallRuleRequest extends Route53ResolverRequest implements ToCopyableBuilder<CreateFirewallRuleRequest.Builder,CreateFirewallRuleRequest>

  • Method Details

    • creatorRequestId

      public final String creatorRequestId()

      A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

      Returns:
      A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    • firewallRuleGroupId

      public final String firewallRuleGroupId()

      The unique identifier of the firewall rule group where you want to create the rule.

      Returns:
      The unique identifier of the firewall rule group where you want to create the rule.

    • firewallDomainListId

      public final String firewallDomainListId()

      The ID of the domain list that you want to use in the rule.

      Returns:
      The ID of the domain list that you want 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 and send metrics and logs to Cloud Watch.

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

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

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

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

      See Also:

    • blockResponse

      public final BlockResponse blockResponse()

      The way that you want DNS Firewall to block the request, used with 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.

      This setting is required if the rule action setting is BLOCK.

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

      This setting is required if the rule action setting is BLOCK.

      See Also:

    • blockResponseAsString

      public final String blockResponseAsString()

      The way that you want DNS Firewall to block the request, used with 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.

      This setting is required if the rule action setting is BLOCK.

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

      This setting is required if the rule action setting is BLOCK.

      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.

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

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

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

      This setting is required if the BlockResponse setting is OVERRIDE.

      See Also:

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

    • name

      public final String name()

      A name that lets you identify the rule in the rule group.

      Returns:
      A name that lets you identify the rule in the rule group.

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