Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.CustomRequestHandlingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.CustomRequestHandlingProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

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

Custom request handling behavior that inserts custom headers into a web request.

You can add custom request handling for AWS WAF to use when the rule action doesn't block the request. For example, CaptchaAction for requests with valid t okens, and AllowAction .

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.*;
 CustomRequestHandlingProperty customRequestHandlingProperty = CustomRequestHandlingProperty.builder()
         .insertHeaders(List.of(CustomHTTPHeaderProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.CustomRequestHandlingProperty.Builder	builder()
Object	getInsertHeaders()	The HTTP headers to insert into the request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInsertHeaders

@Stability(Stable)
@NotNull
Object getInsertHeaders()

The HTTP headers to insert into the request. 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.CustomRequestHandlingProperty.Builder builder()

Returns:

a CfnRuleGroup.CustomRequestHandlingProperty.Builder of CfnRuleGroup.CustomRequestHandlingProperty