software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.HeadersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnRuleGroup.HeadersProperty.Builder

Enclosing interface:

CfnRuleGroup.HeadersProperty

public static final class CfnRuleGroup.HeadersProperty.Builder
extends java.lang.Object

A builder for CfnRuleGroup.HeadersProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

matchPattern

public CfnRuleGroup.HeadersProperty.Builder matchPattern(IResolvable matchPattern)

Sets the value of CfnRuleGroup.HeadersProperty.getMatchPattern()

Parameters:

matchPattern - The filter to use to identify the subset of headers to inspect in a web request. This parameter is required. You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

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

Returns:

this

matchPattern

public CfnRuleGroup.HeadersProperty.Builder matchPattern(CfnRuleGroup.HeaderMatchPatternProperty matchPattern)

Sets the value of CfnRuleGroup.HeadersProperty.getMatchPattern()

Parameters:

matchPattern - The filter to use to identify the subset of headers to inspect in a web request. This parameter is required. You must specify exactly one setting: either All , IncludedHeaders , or ExcludedHeaders .

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

Returns:

this

matchScope

public CfnRuleGroup.HeadersProperty.Builder matchScope(java.lang.String matchScope)

Sets the value of CfnRuleGroup.HeadersProperty.getMatchScope()

Parameters:

matchScope - The parts of the headers to match with the rule inspection criteria. This parameter is required. If you specify All , AWS WAF inspects both keys and values.

Returns:

this

oversizeHandling

public CfnRuleGroup.HeadersProperty.Builder oversizeHandling(java.lang.String oversizeHandling)

Sets the value of CfnRuleGroup.HeadersProperty.getOversizeHandling()

Parameters:

oversizeHandling - What AWS WAF should do if the headers of the request are larger than AWS WAF can inspect. This parameter is required. 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 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

public CfnRuleGroup.HeadersProperty build()

Builds the configured instance.

Returns:

a new instance of CfnRuleGroup.HeadersProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided