AWS::WAFv2::WebACL CustomResponse

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to the block action.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide.

Syntax

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

JSON

{
  "CustomResponseBodyKey" : String,
  "ResponseCode" : Integer,
  "ResponseHeaders" : [ CustomHTTPHeader, ... ]
}

YAML

  CustomResponseBodyKey: String
  ResponseCode: Integer
  ResponseHeaders: 
    - CustomHTTPHeader

Properties

CustomResponseBodyKey

References the response body that you want AWS WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the AWS::WAFv2::WebACL or AWS::WAFv2::RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

Required: No

Type: String

Pattern: ^[\w\-]+$

Update requires: No interruption

ResponseCode

The HTTP status code to return to the client.

For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide.

Required: Yes

Type: Integer

Minimum: 200

Maximum: 599

Update requires: No interruption

ResponseHeaders

The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Required: No

Type: Array of CustomHTTPHeader

Minimum: 1

Update requires: No interruption