public static interface FieldToMatch.Builder extends SdkPojo, CopyableBuilder<FieldToMatch.Builder,FieldToMatch>
| Modifier and Type | Method and Description |
|---|---|
FieldToMatch.Builder |
allQueryArguments(AllQueryArguments allQueryArguments)
Inspect all query arguments.
|
default FieldToMatch.Builder |
allQueryArguments(Consumer<AllQueryArguments.Builder> allQueryArguments)
Inspect all query arguments.
|
FieldToMatch.Builder |
body(Body body)
Inspect the request body as plain text.
|
default FieldToMatch.Builder |
body(Consumer<Body.Builder> body)
Inspect the request body as plain text.
|
default FieldToMatch.Builder |
cookies(Consumer<Cookies.Builder> cookies)
Inspect the request cookies.
|
FieldToMatch.Builder |
cookies(Cookies cookies)
Inspect the request cookies.
|
default FieldToMatch.Builder |
headerOrder(Consumer<HeaderOrder.Builder> headerOrder)
Inspect a string containing the list of the request's header names, ordered as they appear in the web request
that WAF receives for inspection.
|
FieldToMatch.Builder |
headerOrder(HeaderOrder headerOrder)
Inspect a string containing the list of the request's header names, ordered as they appear in the web request
that WAF receives for inspection.
|
default FieldToMatch.Builder |
headers(Consumer<Headers.Builder> headers)
Inspect the request headers.
|
FieldToMatch.Builder |
headers(Headers headers)
Inspect the request headers.
|
default FieldToMatch.Builder |
ja3Fingerprint(Consumer<JA3Fingerprint.Builder> ja3Fingerprint)
Match against the request's JA3 fingerprint.
|
FieldToMatch.Builder |
ja3Fingerprint(JA3Fingerprint ja3Fingerprint)
Match against the request's JA3 fingerprint.
|
default FieldToMatch.Builder |
jsonBody(Consumer<JsonBody.Builder> jsonBody)
Inspect the request body as JSON.
|
FieldToMatch.Builder |
jsonBody(JsonBody jsonBody)
Inspect the request body as JSON.
|
default FieldToMatch.Builder |
method(Consumer<Method.Builder> method)
Inspect the HTTP method.
|
FieldToMatch.Builder |
method(Method method)
Inspect the HTTP method.
|
default FieldToMatch.Builder |
queryString(Consumer<QueryString.Builder> queryString)
Inspect the query string.
|
FieldToMatch.Builder |
queryString(QueryString queryString)
Inspect the query string.
|
default FieldToMatch.Builder |
singleHeader(Consumer<SingleHeader.Builder> singleHeader)
Inspect a single header.
|
FieldToMatch.Builder |
singleHeader(SingleHeader singleHeader)
Inspect a single header.
|
default FieldToMatch.Builder |
singleQueryArgument(Consumer<SingleQueryArgument.Builder> singleQueryArgument)
Inspect a single query argument.
|
FieldToMatch.Builder |
singleQueryArgument(SingleQueryArgument singleQueryArgument)
Inspect a single query argument.
|
default FieldToMatch.Builder |
uriPath(Consumer<UriPath.Builder> uriPath)
Inspect the request URI path.
|
FieldToMatch.Builder |
uriPath(UriPath uriPath)
Inspect the request URI path.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildFieldToMatch.Builder singleHeader(SingleHeader 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.
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.
default FieldToMatch.Builder singleHeader(Consumer<SingleHeader.Builder> 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.
SingleHeader.Builder avoiding the need
to create one manually via SingleHeader.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to singleHeader(SingleHeader).
singleHeader - a consumer that will call methods on SingleHeader.BuildersingleHeader(SingleHeader)FieldToMatch.Builder singleQueryArgument(SingleQueryArgument 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" }
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" }
default FieldToMatch.Builder singleQueryArgument(Consumer<SingleQueryArgument.Builder> 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" }
SingleQueryArgument.Builder avoiding the
need to create one manually via SingleQueryArgument.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to singleQueryArgument(SingleQueryArgument).
singleQueryArgument - a consumer that will call methods on SingleQueryArgument.BuildersingleQueryArgument(SingleQueryArgument)FieldToMatch.Builder allQueryArguments(AllQueryArguments allQueryArguments)
Inspect all query arguments.
allQueryArguments - Inspect all query arguments.default FieldToMatch.Builder allQueryArguments(Consumer<AllQueryArguments.Builder> allQueryArguments)
Inspect all query arguments.
This is a convenience method that creates an instance of theAllQueryArguments.Builder avoiding the
need to create one manually via AllQueryArguments.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to allQueryArguments(AllQueryArguments).
allQueryArguments - a consumer that will call methods on AllQueryArguments.BuilderallQueryArguments(AllQueryArguments)FieldToMatch.Builder uriPath(UriPath uriPath)
Inspect the request URI path. This is the part of the web request that identifies a resource, for example,
/images/daily-ad.jpg.
uriPath - Inspect the request URI path. This is the part of the web request that identifies a resource, for
example, /images/daily-ad.jpg.default FieldToMatch.Builder uriPath(Consumer<UriPath.Builder> uriPath)
Inspect the request URI path. This is the part of the web request that identifies a resource, for example,
/images/daily-ad.jpg.
UriPath.Builder avoiding the need to
create one manually via UriPath.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to uriPath(UriPath).
uriPath - a consumer that will call methods on UriPath.BuilderuriPath(UriPath)FieldToMatch.Builder queryString(QueryString queryString)
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
queryString - Inspect the query string. This is the part of a URL that appears after a ? character, if
any.default FieldToMatch.Builder queryString(Consumer<QueryString.Builder> queryString)
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
QueryString.Builder avoiding the need to
create one manually via QueryString.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to queryString(QueryString).
queryString - a consumer that will call methods on QueryString.BuilderqueryString(QueryString)FieldToMatch.Builder body(Body 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.
A limited amount of the request body is forwarded to WAF for inspection by the underlying host service. For
regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB
(16,384 bytes). For CloudFront distributions, you can increase the limit in the web ACL's
AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the Body object configuration.
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.
A limited amount of the request body is forwarded to WAF for inspection by the underlying host
service. For regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the
limit is 16 KB (16,384 bytes). For CloudFront distributions, you can increase the limit in the web
ACL's AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the Body object
configuration.
default FieldToMatch.Builder body(Consumer<Body.Builder> 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.
A limited amount of the request body is forwarded to WAF for inspection by the underlying host service. For
regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB
(16,384 bytes). For CloudFront distributions, you can increase the limit in the web ACL's
AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the Body object configuration.
Body.Builder avoiding the need to create
one manually via Body.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to body(Body).
body - a consumer that will call methods on Body.Builderbody(Body)FieldToMatch.Builder method(Method method)
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
method - Inspect the HTTP method. The method indicates the type of operation that the request is asking the
origin to perform.default FieldToMatch.Builder method(Consumer<Method.Builder> method)
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
This is a convenience method that creates an instance of theMethod.Builder avoiding the need to
create one manually via Method.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to method(Method).
method - a consumer that will call methods on Method.Buildermethod(Method)FieldToMatch.Builder jsonBody(JsonBody 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.
A limited amount of the request body is forwarded to WAF for inspection by the underlying host service. For
regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB
(16,384 bytes). For CloudFront distributions, you can increase the limit in the web ACL's
AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the JsonBody object
configuration.
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.
A limited amount of the request body is forwarded to WAF for inspection by the underlying host
service. For regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the
limit is 16 KB (16,384 bytes). For CloudFront distributions, you can increase the limit in the web
ACL's AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the JsonBody object
configuration.
default FieldToMatch.Builder jsonBody(Consumer<JsonBody.Builder> 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.
A limited amount of the request body is forwarded to WAF for inspection by the underlying host service. For
regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB
(16,384 bytes). For CloudFront distributions, you can increase the limit in the web ACL's
AssociationConfig, for additional processing fees.
For information about how to handle oversized request bodies, see the JsonBody object
configuration.
JsonBody.Builder avoiding the need to
create one manually via JsonBody.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to jsonBody(JsonBody).
jsonBody - a consumer that will call methods on JsonBody.BuilderjsonBody(JsonBody)FieldToMatch.Builder headers(Headers 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.
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.
default FieldToMatch.Builder headers(Consumer<Headers.Builder> 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.
Headers.Builder avoiding the need to
create one manually via Headers.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to headers(Headers).
headers - a consumer that will call methods on Headers.Builderheaders(Headers)FieldToMatch.Builder cookies(Cookies 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.
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.
default FieldToMatch.Builder cookies(Consumer<Cookies.Builder> 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.
Cookies.Builder avoiding the need to
create one manually via Cookies.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to cookies(Cookies).
cookies - a consumer that will call methods on Cookies.Buildercookies(Cookies)FieldToMatch.Builder headerOrder(HeaderOrder headerOrder)
Inspect a string containing the list of the request's header names, ordered as they appear in the web request
that WAF receives for inspection. WAF generates the string and then uses that as the field to match component
in its inspection. WAF separates the header names in the string using colons and no added spaces, for example
host:user-agent:accept:authorization:referer.
headerOrder - Inspect a string containing the list of the request's header names, ordered as they appear in the web
request that WAF receives for inspection. WAF generates the string and then uses that as the field to
match component in its inspection. WAF separates the header names in the string using colons and no
added spaces, for example host:user-agent:accept:authorization:referer.default FieldToMatch.Builder headerOrder(Consumer<HeaderOrder.Builder> headerOrder)
Inspect a string containing the list of the request's header names, ordered as they appear in the web request
that WAF receives for inspection. WAF generates the string and then uses that as the field to match component
in its inspection. WAF separates the header names in the string using colons and no added spaces, for example
host:user-agent:accept:authorization:referer.
HeaderOrder.Builder avoiding the need to
create one manually via HeaderOrder.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to headerOrder(HeaderOrder).
headerOrder - a consumer that will call methods on HeaderOrder.BuilderheaderOrder(HeaderOrder)FieldToMatch.Builder ja3Fingerprint(JA3Fingerprint ja3Fingerprint)
Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match ByteMatchStatement with the
PositionalConstraint set to EXACTLY.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
ja3Fingerprint - Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from
the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the
client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough
TLS Client Hello information for the calculation. Almost all web requests include this
information.
You can use this choice only with a string match ByteMatchStatement with the
PositionalConstraint set to EXACTLY.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
default FieldToMatch.Builder ja3Fingerprint(Consumer<JA3Fingerprint.Builder> ja3Fingerprint)
Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match ByteMatchStatement with the
PositionalConstraint set to EXACTLY.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
This is a convenience method that creates an instance of theJA3Fingerprint.Builder avoiding the need
to create one manually via JA3Fingerprint.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to ja3Fingerprint(JA3Fingerprint).
ja3Fingerprint - a consumer that will call methods on JA3Fingerprint.Builderja3Fingerprint(JA3Fingerprint)Copyright © 2023. All rights reserved.