Package software.amazon.awssdk.services.waf.model

Class WafAction

java.lang.Object
software.amazon.awssdk.services.waf.model.WafAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WafAction.Builder,WafAction>
@Generated("software.amazon.awssdk:codegen") public final class WafAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WafAction.Builder,WafAction>

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

See Also:

  • Method Details

    • type

      public final WafActionType type()

      Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

      • ALLOW: AWS WAF allows requests

      • BLOCK: AWS WAF blocks requests

      • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

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

      Returns:
      Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

      • ALLOW: AWS WAF allows requests

      • BLOCK: AWS WAF blocks requests

      • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

      • ALLOW: AWS WAF allows requests

      • BLOCK: AWS WAF blocks requests

      • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

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

      Returns:
      Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

      • ALLOW: AWS WAF allows requests

      • BLOCK: AWS WAF blocks requests

      • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

      See Also:

    • toBuilder

      public WafAction.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<WafAction.Builder,WafAction>
      Returns:
      a builder for type T

    • builder

      public static WafAction.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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