AWS::WAFv2::WebACL RuleAction - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::WAFv2::WebACL RuleAction

The action that Amazon 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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

Allow

Instructs Amazon WAF to allow the web request.

Required: No

Type: AllowAction

Update requires: No interruption

Block

Instructs Amazon WAF to block the web request.

Required: No

Type: BlockAction

Update requires: No interruption

Captcha

Specifies that Amazon WAF should run a CAPTCHA check against the request:

  • If the request includes a valid, unexpired CAPTCHA token, Amazon WAF allows the web request inspection to proceed to the next rule, similar to a CountAction.

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

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

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

    • The HTTP status code 405 Method Not Allowed.

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

You can configure the expiration time in the CaptchaConfig 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.

Required: No

Type: CaptchaAction

Update requires: No interruption

Challenge

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

Required: No

Type: ChallengeAction

Update requires: No interruption

Count

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

Required: No

Type: CountAction

Update requires: No interruption