Package software.amazon.awssdk.services.wafv2.model

Class ChallengeAction

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

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

  • If the request includes a valid, unexpired challenge token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a CountAction.

  • If the request doesn't include a valid, unexpired challenge token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

    WAF then generates a challenge response that it sends back to the client, which includes the following:

    • The header x-amzn-waf-action with a value of challenge.

    • The HTTP status code 202 Request Accepted.

    • If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.

    Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.

    A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.

    After the client session successfully responds to the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.

You can configure the expiration time in the ChallengeConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn't available for web ACL default actions.

See Also:

  • Method Details

    • customRequestHandling

      public final CustomRequestHandling customRequestHandling()

      Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

      For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

      Returns:
      Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

      For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

    • toBuilder

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

    • builder

      public static ChallengeAction.Builder builder()

    • serializableBuilderClass

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