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

Description

Synopsis

data LabelMatchStatement = LabelMatchStatement' {
- scope :: LabelMatchScope
- key :: Text
}
newLabelMatchStatement :: LabelMatchScope -> Text -> LabelMatchStatement
labelMatchStatement_scope :: Lens' LabelMatchStatement LabelMatchScope
labelMatchStatement_key :: Lens' LabelMatchStatement Text

Documentation

data LabelMatchStatement Source #

A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.

The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.

See: newLabelMatchStatement smart constructor.

Constructors

LabelMatchStatement'

Fields

scope :: LabelMatchScope
Specify whether you want to match using the label name or just the namespace.
key :: Text
The string to match against. The setting you provide for this depends on the match statement's Scope setting:
- If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
- If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

Instances

Instances details

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

newLabelMatchStatement Source #

Arguments

:: LabelMatchScope	`$sel:scope:LabelMatchStatement'`
-> Text	`$sel:key:LabelMatchStatement'`
-> LabelMatchStatement

Create a value of LabelMatchStatement 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:scope:LabelMatchStatement', labelMatchStatement_scope - Specify whether you want to match using the label name or just the namespace.

$sel:key:LabelMatchStatement', labelMatchStatement_key - The string to match against. The setting you provide for this depends on the match statement's Scope setting:

If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.

labelMatchStatement_scope :: Lens' LabelMatchStatement LabelMatchScope Source #

Specify whether you want to match using the label name or just the namespace.

labelMatchStatement_key :: Lens' LabelMatchStatement Text Source #

The string to match against. The setting you provide for this depends on the match statement's Scope setting:

If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name.
If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.

Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name.