Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.CustomResponseProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.CustomResponseProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(Stable)
public static interface CfnRuleGroup.CustomResponseProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleGroup.CustomResponseProperty.Builder	A builder for CfnRuleGroup.CustomResponseProperty
static final class	CfnRuleGroup.CustomResponseProperty.Jsii$Proxy	An implementation for CfnRuleGroup.CustomResponseProperty

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.CustomResponseProperty.Builder	builder()
default String	getCustomResponseBodyKey()	References the response body that you want AWS WAF to return to the web request client.
Number	getResponseCode()	The HTTP status code to return to the client.
default Object	getResponseHeaders()	The HTTP headers to use in the response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResponseCode

@Stability(Stable)
@NotNull
Number 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 .

getCustomResponseBodyKey

@Stability(Stable)
@Nullable
default String 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 the WebACL or 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.

getResponseHeaders

@Stability(Stable)
@Nullable
default Object getResponseHeaders()

The HTTP headers to use in the response. 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 .

builder

@Stability(Stable)
static CfnRuleGroup.CustomResponseProperty.Builder builder()

Returns:

a CfnRuleGroup.CustomResponseProperty.Builder of CfnRuleGroup.CustomResponseProperty