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 |
Synopsis
- data FieldToMatch = FieldToMatch' {}
- newFieldToMatch :: FieldToMatch
- fieldToMatch_allQueryArguments :: Lens' FieldToMatch (Maybe AllQueryArguments)
- fieldToMatch_body :: Lens' FieldToMatch (Maybe Body)
- fieldToMatch_cookies :: Lens' FieldToMatch (Maybe Cookies)
- fieldToMatch_headers :: Lens' FieldToMatch (Maybe Headers)
- fieldToMatch_jsonBody :: Lens' FieldToMatch (Maybe JsonBody)
- fieldToMatch_method :: Lens' FieldToMatch (Maybe Method)
- fieldToMatch_queryString :: Lens' FieldToMatch (Maybe QueryString)
- fieldToMatch_singleHeader :: Lens' FieldToMatch (Maybe SingleHeader)
- fieldToMatch_singleQueryArgument :: Lens' FieldToMatch (Maybe SingleQueryArgument)
- fieldToMatch_uriPath :: Lens' FieldToMatch (Maybe UriPath)
Documentation
data FieldToMatch Source #
The part of the web request that you want WAF to inspect. Include the
single FieldToMatch
type that you want to inspect, with additional
specifications as needed, according to the type. You specify a single
request component in FieldToMatch
for each rule statement that
requires it. To inspect more than one component of the web request,
create a separate rule statement for each component.
Example JSON for a QueryString
field to match:
"FieldToMatch": { "QueryString": {} }
Example JSON for a Method
field to match specification:
"FieldToMatch": { "Method": { "Name": "DELETE" } }
See: newFieldToMatch
smart constructor.
FieldToMatch' | |
|
Instances
newFieldToMatch :: FieldToMatch Source #
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:allQueryArguments:FieldToMatch'
, fieldToMatch_allQueryArguments
- Inspect all query arguments.
$sel:body:FieldToMatch'
, fieldToMatch_body
- Inspect the request body as plain text. The request body immediately
follows the request headers. This is 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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to
WAF for inspection by the underlying host service. For information about
how to handle oversized request bodies, see the Body
object
configuration.
$sel:cookies:FieldToMatch'
, fieldToMatch_cookies
- Inspect the request cookies. You must configure scope and pattern
matching filters in the Cookies
object, to define the set of cookies
and the parts of the cookies that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the
first 200 cookies are forwarded to WAF for inspection by the underlying
host service. You must configure how to handle any oversize cookie
content in the Cookies
object. WAF applies the pattern matching
filters to the cookies that it receives from the underlying host
service.
$sel:headers:FieldToMatch'
, fieldToMatch_headers
- Inspect the request headers. You must configure scope and pattern
matching filters in the Headers
object, to define the set of headers
to and the parts of the headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the
first 200 headers are forwarded to WAF for inspection by the underlying
host service. You must configure how to handle any oversize header
content in the Headers
object. WAF applies the pattern matching
filters to the headers that it receives from the underlying host
service.
$sel:jsonBody:FieldToMatch'
, fieldToMatch_jsonBody
- Inspect the request body as JSON. The request body immediately follows
the request headers. This is 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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to
WAF for inspection by the underlying host service. For information about
how to handle oversized request bodies, see the JsonBody
object
configuration.
$sel:method:FieldToMatch'
, fieldToMatch_method
- Inspect the HTTP method. The method indicates the type of operation that
the request is asking the origin to perform.
$sel:queryString:FieldToMatch'
, fieldToMatch_queryString
- Inspect the query string. This is the part of a URL that appears after a
?
character, if any.
$sel:singleHeader:FieldToMatch'
, fieldToMatch_singleHeader
- Inspect a single header. Provide the name of the header to inspect, for
example, User-Agent
or Referer
. This setting isn't case sensitive.
Example JSON: "SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the Headers
FieldToMatch
setting.
$sel:singleQueryArgument:FieldToMatch'
, fieldToMatch_singleQueryArgument
- Inspect a single query argument. Provide the name of the query argument
to inspect, such as UserName or SalesRegion. The name can be up to
30 characters long and isn't case sensitive.
Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
$sel:uriPath:FieldToMatch'
, fieldToMatch_uriPath
- Inspect the request URI path. This is the part of the web request that
identifies a resource, for example, /images/daily-ad.jpg
.
fieldToMatch_allQueryArguments :: Lens' FieldToMatch (Maybe AllQueryArguments) Source #
Inspect all query arguments.
fieldToMatch_body :: Lens' FieldToMatch (Maybe Body) Source #
Inspect the request body as plain text. The request body immediately follows the request headers. This is 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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to
WAF for inspection by the underlying host service. For information about
how to handle oversized request bodies, see the Body
object
configuration.
fieldToMatch_cookies :: Lens' FieldToMatch (Maybe Cookies) Source #
Inspect the request cookies. You must configure scope and pattern
matching filters in the Cookies
object, to define the set of cookies
and the parts of the cookies that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the
first 200 cookies are forwarded to WAF for inspection by the underlying
host service. You must configure how to handle any oversize cookie
content in the Cookies
object. WAF applies the pattern matching
filters to the cookies that it receives from the underlying host
service.
fieldToMatch_headers :: Lens' FieldToMatch (Maybe Headers) Source #
Inspect the request headers. You must configure scope and pattern
matching filters in the Headers
object, to define the set of headers
to and the parts of the headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the
first 200 headers are forwarded to WAF for inspection by the underlying
host service. You must configure how to handle any oversize header
content in the Headers
object. WAF applies the pattern matching
filters to the headers that it receives from the underlying host
service.
fieldToMatch_jsonBody :: Lens' FieldToMatch (Maybe JsonBody) Source #
Inspect the request body as JSON. The request body immediately follows the request headers. This is 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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to
WAF for inspection by the underlying host service. For information about
how to handle oversized request bodies, see the JsonBody
object
configuration.
fieldToMatch_method :: Lens' FieldToMatch (Maybe Method) Source #
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
fieldToMatch_queryString :: Lens' FieldToMatch (Maybe QueryString) Source #
Inspect the query string. This is the part of a URL that appears after a
?
character, if any.
fieldToMatch_singleHeader :: Lens' FieldToMatch (Maybe SingleHeader) Source #
Inspect a single header. Provide the name of the header to inspect, for
example, User-Agent
or Referer
. This setting isn't case sensitive.
Example JSON: "SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the Headers
FieldToMatch
setting.
fieldToMatch_singleQueryArgument :: Lens' FieldToMatch (Maybe SingleQueryArgument) Source #
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
fieldToMatch_uriPath :: Lens' FieldToMatch (Maybe UriPath) Source #
Inspect the request URI path. This is the part of the web request that
identifies a resource, for example, /images/daily-ad.jpg
.