Package software.amazon.awscdk.cfnpropertymixins.services.wafv2

Class CfnRuleGroupPropsMixin.HeadersProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.wafv2.CfnRuleGroupPropsMixin.HeadersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.HeadersProperty>

Enclosing interface:

CfnRuleGroupPropsMixin.HeadersProperty

@Stability(Stable)
public static final class CfnRuleGroupPropsMixin.HeadersProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.HeadersProperty>

A builder for CfnRuleGroupPropsMixin.HeadersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRuleGroupPropsMixin.HeadersProperty	build()	Builds the configured instance.
CfnRuleGroupPropsMixin.HeadersProperty.Builder	matchPattern(CfnRuleGroupPropsMixin.HeaderMatchPatternProperty matchPattern)	Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getMatchPattern()
CfnRuleGroupPropsMixin.HeadersProperty.Builder	matchPattern(IResolvable matchPattern)	Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getMatchPattern()
CfnRuleGroupPropsMixin.HeadersProperty.Builder	matchScope(String matchScope)	Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getMatchScope()
CfnRuleGroupPropsMixin.HeadersProperty.Builder	oversizeHandling(String oversizeHandling)	Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getOversizeHandling()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

matchPattern

@Stability(Stable)
public CfnRuleGroupPropsMixin.HeadersProperty.Builder matchPattern(IResolvable matchPattern)

Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getMatchPattern()

Parameters:

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

Returns:

this

matchPattern

@Stability(Stable)
public CfnRuleGroupPropsMixin.HeadersProperty.Builder matchPattern(CfnRuleGroupPropsMixin.HeaderMatchPatternProperty matchPattern)

Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getMatchPattern()

Parameters:

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

Returns:

this

matchScope

@Stability(Stable)
public CfnRuleGroupPropsMixin.HeadersProperty.Builder matchScope(String matchScope)

Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getMatchScope()

Parameters:

matchScope - 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.

Returns:

this

oversizeHandling

@Stability(Stable)
public CfnRuleGroupPropsMixin.HeadersProperty.Builder oversizeHandling(String oversizeHandling)

Sets the value of CfnRuleGroupPropsMixin.HeadersProperty.getOversizeHandling()

Parameters:

oversizeHandling - What AWS WAF should do if the headers determined by your match scope 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.

Returns:

this

build

@Stability(Stable)
public CfnRuleGroupPropsMixin.HeadersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRuleGroupPropsMixin.HeadersProperty>

Returns:

a new instance of CfnRuleGroupPropsMixin.HeadersProperty

Throws:

NullPointerException - if any required attribute was not provided