AWS::WAFv2::WebACL BlockAction - Amazon CloudFormation
SyntaxPropertiesExamples
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 BlockAction

Specifies that Amazon WAF should block the request and optionally defines additional custom handling for the response to the web request.

This is used in the context of other settings, for example to specify values for a rule action or a web ACL default action.

Syntax

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

Properties

CustomResponse

Defines a custom response for the web request.

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

Required: No

Type: CustomResponse

Update requires: No interruption

Examples

Set an block action

The following shows an example block action specification.

YAML

Action:
  Block: {}

JSON

"Action": {
  "Block": {}
}

Set a block action with a custom response setting

The following shows an example block action specification with a custom response setting.

YAML

Block:
  CustomResponse:
    ResponseCode: 503
    CustomResponseBodyKey: CustomResponseBodyKey1
    ResponseHeaders:
      - Name: BlockActionHeader1Name
        Value: BlockActionHeader1Value
      - Name: BlockActionHeader2Name
        Value: BlockActionHeader2Value

JSON

"Block": {
  "CustomResponse": {
    "ResponseCode": 503,
    "CustomResponseBodyKey": "CustomResponseBodyKey1",
    "ResponseHeaders": [
      {
        "Name": "BlockActionHeader1Name",
        "Value": "BlockActionHeader1Value"
      },
      {
        "Name": "BlockActionHeader2Name",
        "Value": "BlockActionHeader2Value"
      }
    ]
  }
}