Class Headers
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Headers.Builder,
Headers>
Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
If you want to inspect just the value of a single header, use the SingleHeader
FieldToMatch
setting instead.
Example JSON:
"Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Headers.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final HeaderMatchPattern
The filter to use to identify the subset of headers to inspect in a web request.final MapMatchScope
The parts of the headers to match with the rule inspection criteria.final String
The parts of the headers to match with the rule inspection criteria.final OversizeHandling
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect.final String
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect.static Class
<? extends Headers.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- Returns:
- 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
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
-
matchScope
The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.If the service returns an enum value that is not available in the current SDK version,
matchScope
will returnMapMatchScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommatchScopeAsString()
.- Returns:
- The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values. - See Also:
-
matchScopeAsString
The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values.If the service returns an enum value that is not available in the current SDK version,
matchScope
will returnMapMatchScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommatchScopeAsString()
.- Returns:
- The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values. - See Also:
-
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.
If the service returns an enum value that is not available in the current SDK version,
oversizeHandling
will returnOversizeHandling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoversizeHandlingAsString()
.- Returns:
- 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.
-
- See Also:
-
-
oversizeHandlingAsString
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.
If the service returns an enum value that is not available in the current SDK version,
oversizeHandling
will returnOversizeHandling.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoversizeHandlingAsString()
.- Returns:
- 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.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Headers.Builder,
Headers> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-