Class GetFirewallRuleResponse

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

  • 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, or a threat in a DNS Firewall Advanced rule.

      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, or a threat in a DNS Firewall Advanced rule.
      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, or a threat in a DNS Firewall Advanced rule.

      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, or a threat in a DNS Firewall Advanced rule.
      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.

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

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

      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.

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

    • blockResponse

      public final FirewallBlockResponse blockResponse()

      The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

      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 way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
      See Also:

    • blockResponseAsString

      public final String blockResponseAsString()

      The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

      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 way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
      See Also:

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

      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 DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.
      See Also:

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

      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 DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time and date the DNS Firewall rule was created.

      Returns:
      The time and date the DNS Firewall rule was created.

    • description

      public final String description()

      The description of the DNS Firewall rule.

      Returns:
      The description of the DNS Firewall rule.

    • dnsAdvancedProtection

      public final DnsAdvancedProtection dnsAdvancedProtection()

      The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.

      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:
      The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.
      See Also:

    • dnsAdvancedProtectionAsString

      public final String dnsAdvancedProtectionAsString()

      The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.

      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:
      The type of the DNS Firewall Advanced rule. Valid values are DGA and DNS_TUNNELING.
      See Also:

    • firewallDomainListId

      public final String firewallDomainListId()

      The ID of a DNS Firewall domain list.

      Returns:
      The ID of a DNS Firewall domain list.

    • id

      public final String id()

      ID of the DNS Firewall rule.

      Returns:
      ID of the DNS Firewall rule.

    • name

      public final String name()

      The name of the DNS Firewall rule.

      Returns:
      The name of the DNS Firewall rule.

    • priority

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

      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.

    • dnsViewId

      public final String dnsViewId()

      The DNS view ID the DNS Firewall is associated with.

      Returns:
      The DNS view ID the DNS Firewall is associated with.

    • queryType

      public final String queryType()

      The DNS query type you want the rule to evaluate.

      Returns:
      The DNS query type you want the rule to evaluate.

    • status

      public final CRResourceStatus status()

      The operational status of the DNS Firewall rule.

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

      Returns:
      The operational status of the DNS Firewall rule.
      See Also:

    • statusAsString

      public final String statusAsString()

      The operational status of the DNS Firewall rule.

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

      Returns:
      The operational status of the DNS Firewall rule.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The date and time the DNS Firewall rule was updated.

      Returns:
      The date and time the DNS Firewall rule was updated.

    • toBuilder

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

    • builder

      public static GetFirewallRuleResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.