Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.ChallengeActionProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWebACL.ChallengeActionProperty.Jsii$Proxy
Enclosing class:
CfnWebACL
@Stability(Stable) public static interface CfnWebACL.ChallengeActionProperty extends software.amazon.jsii.JsiiSerializable
Specifies that AWS 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, AWS 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, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 ChallengeActionProperty challengeActionProperty = ChallengeActionProperty.builder()
         .customRequestHandling(CustomRequestHandlingProperty.builder()
                 .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .build())
         .build();