Interface CfnRuleGroup.CustomResponseProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRuleGroup.CustomResponseProperty.Jsii$Proxy
- Enclosing class:
CfnRuleGroup
You can define a custom response for rule actions and default web ACL actions that are set to Block
.
For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF developer guide .
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.*; CustomResponseProperty customResponseProperty = CustomResponseProperty.builder() .responseCode(123) // the properties below are optional .customResponseBodyKey("customResponseBodyKey") .responseHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRuleGroup.CustomResponseProperty
static final class
An implementation forCfnRuleGroup.CustomResponseProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getResponseCode
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 .
- See Also:
-
getCustomResponseBodyKey
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 theWebACL
orRuleGroup
where you want to use it. Then, in the rule action or web ACL default actionBlockAction
setting, you reference the response body using this key.- See Also:
-
getResponseHeaders
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 .
- See Also:
-
builder
-