Struct aws_sdk_wafv2::model::Cookies

#[non_exhaustive]
pub struct Cookies {
    pub match_pattern: Option<CookieMatchPattern>,
    pub match_scope: Option<MapMatchScope>,
    pub oversize_handling: Option<OversizeHandling>,
}

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 for WAF to inspect, in the FieldToMatch specification.

Example JSON: "Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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: "CookieMatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

match_scope: Option<MapMatchScope>

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

oversize_handling: Option<OversizeHandling>

What WAF should do if the cookies of the request are 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 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

impl Cookies

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: "CookieMatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

pub fn match_scope(&self) -> Option<&MapMatchScope>

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

pub fn oversize_handling(&self) -> Option<&OversizeHandling>

What WAF should do if the cookies of the request are 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 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.

impl Cookies

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Cookies

Trait Implementations

impl Clone for Cookies

fn clone(&self) -> Cookies

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Cookies

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<Cookies> for Cookies

fn eq(&self, other: &Cookies) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Cookies) -> bool

This method tests for !=.

impl StructuralPartialEq for Cookies