Class RuleAction

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

The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.

See Also:

  • Method Details

    • block

      public final BlockAction block()

      Instructs WAF to block the web request.

      Returns:
      Instructs WAF to block the web request.

    • allow

      public final AllowAction allow()

      Instructs WAF to allow the web request.

      Returns:
      Instructs WAF to allow the web request.

    • count

      public final CountAction count()

      Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

      Returns:
      Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.

    • captcha

      public final CaptchaAction captcha()

      Instructs WAF to run a CAPTCHA check against the web request.

      Returns:
      Instructs WAF to run a CAPTCHA check against the web request.

    • challenge

      public final ChallengeAction challenge()

      Instructs WAF to run a Challenge check against the web request.

      Returns:
      Instructs WAF to run a Challenge check against the web request.

    • monetize

      public final MonetizeAction monetize()

      Instructs WAF to return an HTTP 402 Payment Required response with a price manifest. The requesting client can complete payment and resubmit the request to gain access. This is a terminating action-requests that do not complete payment are blocked. This action is available only for web ACLs associated with Amazon CloudFront distributions and requires a MonetizationConfig on the web ACL.

      Returns:
      Instructs WAF to return an HTTP 402 Payment Required response with a price manifest. The requesting client can complete payment and resubmit the request to gain access. This is a terminating action-requests that do not complete payment are blocked. This action is available only for web ACLs associated with Amazon CloudFront distributions and requires a MonetizationConfig on the web ACL.

    • toBuilder

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

    • builder

      public static RuleAction.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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