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.Headers

Description

Documentation

data Headers Source #

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: newHeaders smart constructor.

Constructors

Headers'

Fields

matchPattern :: HeaderMatchPattern
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"} }
matchScope :: MapMatchScope
The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.
oversizeHandling :: OversizeHandling
What WAF should do if the headers of the request are 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 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.

Instances

Instances details

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

newHeaders Source #

Arguments

:: HeaderMatchPattern	`$sel:matchPattern:Headers'`
-> MapMatchScope	`$sel:matchScope:Headers'`
-> OversizeHandling	`$sel:oversizeHandling:Headers'`
-> Headers

Create a value of Headers 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:Headers', headers_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"} }

$sel:matchScope:Headers', headers_matchScope - The parts of the headers to match with the rule inspection criteria. If you specify All, WAF inspects both keys and values.

$sel:oversizeHandling:Headers', headers_oversizeHandling - What WAF should do if the headers of the request are 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 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.

headers_matchPattern :: Lens' Headers HeaderMatchPattern Source #

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

headers_matchScope :: Lens' Headers MapMatchScope Source #

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

headers_oversizeHandling :: Lens' Headers OversizeHandling Source #

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