software.amazon.awssdk.services.wafv2.model

Interface Headers.Builder

All Superinterfaces:

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

Enclosing class:

Headers

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

Method Summary

Modifier and Type	Method and Description
default Headers.Builder	matchPattern(Consumer<HeaderMatchPattern.Builder> matchPattern) The filter to use to identify the subset of headers to inspect in a web request.
Headers.Builder	matchPattern(HeaderMatchPattern matchPattern) The filter to use to identify the subset of headers to inspect in a web request.
Headers.Builder	matchScope(MapMatchScope matchScope) The parts of the headers to match with the rule inspection criteria.
Headers.Builder	matchScope(String matchScope) The parts of the headers to match with the rule inspection criteria.
Headers.Builder	oversizeHandling(OversizeHandling oversizeHandling) What WAF should do if the headers of the request are more numerous or larger than WAF can inspect.
Headers.Builder	oversizeHandling(String oversizeHandling) What WAF should do if the headers 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

Headers.Builder matchPattern(HeaderMatchPattern 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" ] }

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:

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

matchPattern

default Headers.Builder matchPattern(Consumer<HeaderMatchPattern.Builder> 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" ] }

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

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

Parameters:

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

Returns:

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

See Also:

matchPattern(HeaderMatchPattern)

matchScope

Headers.Builder matchScope(String matchScope)

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

Parameters:

matchScope - The parts of the headers to match 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

Headers.Builder matchScope(MapMatchScope matchScope)

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

Parameters:

matchScope - The parts of the headers to match 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

Headers.Builder oversizeHandling(String oversizeHandling)

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

Headers.Builder oversizeHandling(OversizeHandling oversizeHandling)

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