Struct aws_sdk_wafv2::types::Cookies
source · #[non_exhaustive]pub struct Cookies {
pub match_pattern: Option<CookieMatchPattern>,
pub match_scope: MapMatchScope,
pub oversize_handling: OversizeHandling,
}
Expand description
Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch
specification.
Example JSON: "Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.match_pattern: Option<CookieMatchPattern>
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" ] }
match_scope: MapMatchScope
The parts of the cookies to inspect 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 logical AND
statement to combine two match rules, one that inspects the keys and another that inspects the values.
oversize_handling: 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.
Implementations§
source§impl Cookies
impl Cookies
sourcepub fn match_pattern(&self) -> Option<&CookieMatchPattern>
pub fn match_pattern(&self) -> Option<&CookieMatchPattern>
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" ] }
sourcepub fn match_scope(&self) -> &MapMatchScope
pub fn match_scope(&self) -> &MapMatchScope
The parts of the cookies to inspect 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 logical AND
statement to combine two match rules, one that inspects the keys and another that inspects the values.
sourcepub fn oversize_handling(&self) -> &OversizeHandling
pub fn oversize_handling(&self) -> &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.