software.amazon.awssdk.services.wafv2.model

Interface Cookies.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Cookies.Builder,Cookies>, SdkBuilder<Cookies.Builder,Cookies>, SdkPojo

Enclosing class:

Cookies

public static interface Cookies.Builder
extends SdkPojo, CopyableBuilder<Cookies.Builder,Cookies>

Method Summary

Modifier and Type	Method and Description
default Cookies.Builder	matchPattern(Consumer<CookieMatchPattern.Builder> matchPattern) The filter to use to identify the subset of cookies to inspect in a web request.
Cookies.Builder	matchPattern(CookieMatchPattern matchPattern) The filter to use to identify the subset of cookies to inspect in a web request.
Cookies.Builder	matchScope(MapMatchScope matchScope) The parts of the cookies to inspect with the rule inspection criteria.
Cookies.Builder	matchScope(String matchScope) The parts of the cookies to inspect with the rule inspection criteria.
Cookies.Builder	oversizeHandling(OversizeHandling oversizeHandling) What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect.
Cookies.Builder	oversizeHandling(String oversizeHandling) What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

matchPattern

Cookies.Builder matchPattern(CookieMatchPattern matchPattern)

The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

Parameters:

matchPattern - The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

Returns:

Returns a reference to this object so that method calls can be chained together.

matchPattern

default Cookies.Builder matchPattern(Consumer<CookieMatchPattern.Builder> matchPattern)

The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

This is a convenience method that creates an instance of the CookieMatchPattern.Builder avoiding the need to create one manually via CookieMatchPattern.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matchPattern(CookieMatchPattern).

Parameters:

matchPattern - a consumer that will call methods on CookieMatchPattern.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

matchPattern(CookieMatchPattern)

matchScope

Cookies.Builder matchScope(String matchScope)

The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

Parameters:

matchScope - The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MapMatchScope, MapMatchScope

matchScope

Cookies.Builder matchScope(MapMatchScope matchScope)

The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

Parameters:

matchScope - The parts of the cookies to inspect with the rule inspection criteria. If you specify All , WAF inspects both keys and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MapMatchScope, MapMatchScope

oversizeHandling

Cookies.Builder oversizeHandling(String oversizeHandling)

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. 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 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. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

Parameters:

oversizeHandling - What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. 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 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. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OversizeHandling, OversizeHandling

oversizeHandling

Cookies.Builder oversizeHandling(OversizeHandling oversizeHandling)

What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. 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 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. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

Parameters:

oversizeHandling - What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. 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 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. WAF applies the rule action to the request.

• NO_MATCH - Treat the web request as not matching the rule statement.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OversizeHandling, OversizeHandling