software.amazon.awscdk.services.wafv2

Interface CfnWebACL.CustomHTTPHeaderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.CustomHTTPHeaderProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(value=Stable)
public static interface CfnWebACL.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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnWebACL.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 Detail

getName

@Stability(value=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 .

getValue

@Stability(value=Stable)
 @NotNull
String getValue()

The value of the custom header.

builder

@Stability(value=Stable)
static CfnWebACL.CustomHTTPHeaderProperty.Builder builder()

Returns:

a CfnWebACL.CustomHTTPHeaderProperty.Builder of CfnWebACL.CustomHTTPHeaderProperty