Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WAFV2.Types.Cookies

Description

Documentation

data Cookies Source #

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" }

See: newCookies smart constructor.

Constructors

Cookies'

Fields

matchPattern :: 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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }
matchScope :: MapMatchScope
The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
oversizeHandling :: 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.

Instances

Instances details

FromJSON Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods parseJSON :: Value -> Parser Cookies # parseJSONList :: Value -> Parser [Cookies] #
ToJSON Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods toJSON :: Cookies -> Value # toEncoding :: Cookies -> Encoding # toJSONList :: [Cookies] -> Value # toEncodingList :: [Cookies] -> Encoding #
Generic Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Associated Types type Rep Cookies :: Type -> Type # Methods from :: Cookies -> Rep Cookies x # to :: Rep Cookies x -> Cookies #
Read Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods readsPrec :: Int -> ReadS Cookies # readList :: ReadS [Cookies] # readPrec :: ReadPrec Cookies # readListPrec :: ReadPrec [Cookies] #
Show Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods showsPrec :: Int -> Cookies -> ShowS # show :: Cookies -> String # showList :: [Cookies] -> ShowS #
NFData Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods rnf :: Cookies -> () #
Eq Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods (==) :: Cookies -> Cookies -> Bool # (/=) :: Cookies -> Cookies -> Bool #
Hashable Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies Methods hashWithSalt :: Int -> Cookies -> Int # hash :: Cookies -> Int #
type Rep Cookies Source #
Instance details Defined in Amazonka.WAFV2.Types.Cookies type Rep Cookies = D1 ('MetaData "Cookies" "Amazonka.WAFV2.Types.Cookies" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "Cookies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "matchPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CookieMatchPattern) :: (S1 ('MetaSel ('Just "matchScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MapMatchScope) :: S1 ('MetaSel ('Just "oversizeHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OversizeHandling))))

newCookies Source #

Arguments

:: CookieMatchPattern	`$sel:matchPattern:Cookies'`
-> MapMatchScope	`$sel:matchScope:Cookies'`
-> OversizeHandling	`$sel:oversizeHandling:Cookies'`
-> Cookies

Create a value of Cookies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:matchPattern:Cookies', cookies_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": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }

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

$sel:oversizeHandling:Cookies', cookies_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.

cookies_matchPattern :: Lens' Cookies CookieMatchPattern Source #

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

cookies_matchScope :: Lens' Cookies MapMatchScope Source #

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

cookies_oversizeHandling :: Lens' Cookies OversizeHandling Source #

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.