interface CustomHTTPHeaderProperty

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	Amazon.CDK.AWS.WAFv2.CfnWebACL.CustomHTTPHeaderProperty
Java	software.amazon.awscdk.services.wafv2.CfnWebACL.CustomHTTPHeaderProperty
Python	aws_cdk.aws_wafv2.CfnWebACL.CustomHTTPHeaderProperty
TypeScript	@aws-cdk/aws-wafv2 » CfnWebACL » CustomHTTPHeaderProperty

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 * as wafv2 from '@aws-cdk/aws-wafv2';
const customHTTPHeaderProperty: wafv2.CfnWebACL.CustomHTTPHeaderProperty = {
  name: 'name',
  value: 'value',
};

Properties

Name	Type	Description
name	string	The name of the custom header.
value	string	The value of the custom header.

---

name

Type: string

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 .

---

value

Type: string

The value of the custom header.