Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.HeaderMatchPatternProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.HeaderMatchPatternProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(Stable)
public static interface CfnWebACL.HeaderMatchPatternProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.wafv2.*;
 Object all;
 HeaderMatchPatternProperty headerMatchPatternProperty = HeaderMatchPatternProperty.builder()
         .all(all)
         .excludedHeaders(List.of("excludedHeaders"))
         .includedHeaders(List.of("includedHeaders"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.HeaderMatchPatternProperty.Builder	builder()
default Object	getAll()	Inspect all headers.
default List<String>	getExcludedHeaders()	Inspect only the headers whose keys don't match any of the strings specified here.
default List<String>	getIncludedHeaders()	Inspect only the headers that have a key that matches one of the strings specified here.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAll

@Stability(Stable)
@Nullable
default Object getAll()

Inspect all headers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html#cfn-wafv2-webacl-headermatchpattern-all

getExcludedHeaders

@Stability(Stable)
@Nullable
default List<String> getExcludedHeaders()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html#cfn-wafv2-webacl-headermatchpattern-excludedheaders

getIncludedHeaders

@Stability(Stable)
@Nullable
default List<String> getIncludedHeaders()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-headermatchpattern.html#cfn-wafv2-webacl-headermatchpattern-includedheaders

builder

@Stability(Stable)
static CfnWebACL.HeaderMatchPatternProperty.Builder builder()

Returns:

a CfnWebACL.HeaderMatchPatternProperty.Builder of CfnWebACL.HeaderMatchPatternProperty