Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.CustomHTTPHeaderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.CustomHTTPHeaderProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

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

A custom header for custom request and response handling.

This is used in CustomResponse and CustomRequestHandling

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.*;
 CustomHTTPHeaderProperty customHTTPHeaderProperty = CustomHTTPHeaderProperty.builder()
         .name("name")
         .value("value")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.CustomHTTPHeaderProperty.Builder	builder()
String	getName()	The name of the custom header.
String	getValue()	The value of the custom header.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the custom header.

For custom request header insertion, when AWS WAF inserts the header into the request, it prefixes this name x-amzn-waf- , to avoid confusion with the headers that are already in the request. For example, for the header name sample , AWS WAF inserts the header x-amzn-waf-sample .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html#cfn-wafv2-rulegroup-customhttpheader-name

getValue

@Stability(Stable)
@NotNull
String getValue()

The value of the custom header.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-customhttpheader.html#cfn-wafv2-rulegroup-customhttpheader-value

builder

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

Returns:

a CfnRuleGroup.CustomHTTPHeaderProperty.Builder of CfnRuleGroup.CustomHTTPHeaderProperty