software.amazon.awscdk.services.wafv2

Class CfnWebACL.HeadersProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnWebACL.HeadersProperty

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

A builder for CfnWebACL.HeadersProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnWebACL.HeadersProperty	build() Builds the configured instance.
CfnWebACL.HeadersProperty.Builder	matchPattern(CfnWebACL.HeaderMatchPatternProperty matchPattern) Sets the value of CfnWebACL.HeadersProperty.getMatchPattern()
CfnWebACL.HeadersProperty.Builder	matchPattern(IResolvable matchPattern) Sets the value of CfnWebACL.HeadersProperty.getMatchPattern()
CfnWebACL.HeadersProperty.Builder	matchScope(String matchScope) Sets the value of CfnWebACL.HeadersProperty.getMatchScope()
CfnWebACL.HeadersProperty.Builder	oversizeHandling(String oversizeHandling) Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.HeadersProperty.Builder matchPattern(CfnWebACL.HeaderMatchPatternProperty matchPattern)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.HeadersProperty.Builder matchPattern(IResolvable matchPattern)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.HeadersProperty.Builder matchScope(String matchScope)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.HeadersProperty.Builder oversizeHandling(String oversizeHandling)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.HeadersProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnWebACL.HeadersProperty

Throws:

NullPointerException - if any required attribute was not provided