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 BlockAction.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.
Contents
- 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.
Type: Integer
Valid Range: Minimum value of 200. Maximum value of 599.
Required: Yes
- 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
CustomResponseBodiessetting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default actionBlockActionsetting, you reference the response body using this key.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\w\-]+$Required: No
- 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.
Type: Array of CustomHTTPHeader objects
Array Members: Minimum number of 1 item.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
