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

Description

Synopsis

Documentation

data JsonMatchPattern Source #

The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody.

See: newJsonMatchPattern smart constructor.

Constructors

JsonMatchPattern'

Fields

all :: Maybe All
Match all of the elements. See also MatchScope in JsonBody.
You must specify either this setting or the IncludedPaths setting, but not both.
includedPaths :: Maybe (NonEmpty Text)
Match only the specified include paths. See also MatchScope in JsonBody.
Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
You must specify either this setting or the All setting, but not both.
Don't use this option to include all paths. Instead, use the All setting.

Instances

Instances details

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

newJsonMatchPattern :: JsonMatchPattern Source #

Create a value of JsonMatchPattern 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:all:JsonMatchPattern', jsonMatchPattern_all - Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

$sel:includedPaths:JsonMatchPattern', jsonMatchPattern_includedPaths - Match only the specified include paths. See also MatchScope in JsonBody.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Don't use this option to include all paths. Instead, use the All setting.

jsonMatchPattern_all :: Lens' JsonMatchPattern (Maybe All) Source #

Match all of the elements. See also MatchScope in JsonBody.

You must specify either this setting or the IncludedPaths setting, but not both.

jsonMatchPattern_includedPaths :: Lens' JsonMatchPattern (Maybe (NonEmpty Text)) Source #

Match only the specified include paths. See also MatchScope in JsonBody.

Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

You must specify either this setting or the All setting, but not both.

Don't use this option to include all paths. Instead, use the All setting.