Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.HeadersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.HeadersProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

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

Inspect all headers in the web request.

You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead.

Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

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;
 HeadersProperty headersProperty = HeadersProperty.builder()
         .matchPattern(HeaderMatchPatternProperty.builder()
                 .all(all)
                 .excludedHeaders(List.of("excludedHeaders"))
                 .includedHeaders(List.of("includedHeaders"))
                 .build())
         .matchScope("matchScope")
         .oversizeHandling("oversizeHandling")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.HeadersProperty.Builder	builder()
Object	getMatchPattern()	The filter to use to identify the subset of headers to inspect in a web request.
String	getMatchScope()	The parts of the headers to match with the rule inspection criteria.
String	getOversizeHandling()	What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMatchPattern

@Stability(Stable)
@NotNull
Object getMatchPattern()

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" ] }

See Also:

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

getMatchScope

@Stability(Stable)
@NotNull
String getMatchScope()

The parts of the headers to match with the rule inspection criteria.

If you specify ALL , AWS WAF inspects both keys and values.

All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values.

See Also:

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

getOversizeHandling

@Stability(Stable)
@NotNull
String getOversizeHandling()

What AWS WAF should do if the headers of the request are more numerous or larger than AWS WAF can inspect.

AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF .

The options for oversize handling are the following:

• CONTINUE - Inspect the available headers normally, according to the rule inspection criteria.
• MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
• NO_MATCH - Treat the web request as not matching the rule statement.

See Also:

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

builder

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

Returns:

a CfnRuleGroup.HeadersProperty.Builder of CfnRuleGroup.HeadersProperty