aws-cdk-lib.aws_wafv2.CfnRuleGroup.HeaderMatchPatternProperty

interface HeaderMatchPatternProperty

LanguageType name
.NETAmazon.CDK.AWS.WAFv2.CfnRuleGroup.HeaderMatchPatternProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnRuleGroup_HeaderMatchPatternProperty
Javasoftware.amazon.awscdk.services.wafv2.CfnRuleGroup.HeaderMatchPatternProperty
Pythonaws_cdk.aws_wafv2.CfnRuleGroup.HeaderMatchPatternProperty
TypeScript aws-cdk-lib » aws_wafv2 » CfnRuleGroup » HeaderMatchPatternProperty

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';

declare const all: any;
const headerMatchPatternProperty: wafv2.CfnRuleGroup.HeaderMatchPatternProperty = {
  all: all,
  excludedHeaders: ['excludedHeaders'],
  includedHeaders: ['includedHeaders'],
};

Properties

NameTypeDescription
all?anyInspect all headers.
excludedHeaders?string[]Inspect only the headers whose keys don't match any of the strings specified here.
includedHeaders?string[]Inspect only the headers that have a key that matches one of the strings specified here.

all?

Type: any (optional)

Inspect all headers.


excludedHeaders?

Type: string[] (optional)

Inspect only the headers whose keys don't match any of the strings specified here.


includedHeaders?

Type: string[] (optional)

Inspect only the headers that have a key that matches one of the strings specified here.