Class CfnWebACL.CookiesProperty.Builder
java.lang.Object
software.amazon.awscdk.services.wafv2.CfnWebACL.CookiesProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnWebACL.CookiesProperty>
- Enclosing interface:
- CfnWebACL.CookiesProperty
@Stability(Stable)
public static final class CfnWebACL.CookiesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWebACL.CookiesProperty>
A builder for
CfnWebACL.CookiesProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.matchPattern
(IResolvable matchPattern) Sets the value ofCfnWebACL.CookiesProperty.getMatchPattern()
matchPattern
(CfnWebACL.CookieMatchPatternProperty matchPattern) Sets the value ofCfnWebACL.CookiesProperty.getMatchPattern()
matchScope
(String matchScope) Sets the value ofCfnWebACL.CookiesProperty.getMatchScope()
oversizeHandling
(String oversizeHandling) Sets the value ofCfnWebACL.CookiesProperty.getOversizeHandling()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
matchPattern
Sets the value ofCfnWebACL.CookiesProperty.getMatchPattern()
- Parameters:
matchPattern
- The filter to use to identify the subset of cookies to inspect in a web request. This parameter is required. You must specify exactly one setting: eitherAll
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }
- Returns:
this
-
matchPattern
@Stability(Stable) public CfnWebACL.CookiesProperty.Builder matchPattern(CfnWebACL.CookieMatchPatternProperty matchPattern) Sets the value ofCfnWebACL.CookiesProperty.getMatchPattern()
- Parameters:
matchPattern
- The filter to use to identify the subset of cookies to inspect in a web request. This parameter is required. You must specify exactly one setting: eitherAll
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }
- Returns:
this
-
matchScope
Sets the value ofCfnWebACL.CookiesProperty.getMatchScope()
- Parameters:
matchScope
- The parts of the cookies to inspect with the rule inspection criteria. This parameter is required. If you specifyAll
, AWS WAF inspects both keys and values.- Returns:
this
-
oversizeHandling
@Stability(Stable) public CfnWebACL.CookiesProperty.Builder oversizeHandling(String oversizeHandling) Sets the value ofCfnWebACL.CookiesProperty.getOversizeHandling()
- Parameters:
oversizeHandling
- What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. This parameter is required. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF .The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies 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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnWebACL.CookiesProperty>
- Returns:
- a new instance of
CfnWebACL.CookiesProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-