Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WAFRegional.Types.FieldToMatch

Description

Synopsis

data FieldToMatch = FieldToMatch' {
- data' :: Maybe Text
- type' :: MatchFieldType
}
newFieldToMatch :: MatchFieldType -> FieldToMatch
fieldToMatch_data :: Lens' FieldToMatch (Maybe Text)
fieldToMatch_type :: Lens' FieldToMatch MatchFieldType

Documentation

data FieldToMatch Source #

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Specifies where in a web request to look for TargetString.

See: newFieldToMatch smart constructor.

Constructors

FieldToMatch'

Fields

data' :: Maybe Text
When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.
When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.
If the value of Type is any other value, omit Data.
type' :: MatchFieldType
The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
- HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
- METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
- QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
- URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
- BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
- SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
- ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

Instances

Instances details

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

newFieldToMatch Source #

Arguments

:: MatchFieldType	`$sel:type':FieldToMatch'`
-> FieldToMatch

Create a value of FieldToMatch 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:data':FieldToMatch', fieldToMatch_data - When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

If the value of Type is any other value, omit Data.

$sel:type':FieldToMatch', fieldToMatch_type - The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

fieldToMatch_data :: Lens' FieldToMatch (Maybe Text) Source #

When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

If the value of Type is any other value, omit Data.

fieldToMatch_type :: Lens' FieldToMatch MatchFieldType Source #

The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.
ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.