FieldToMatch (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.FieldToMatch

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FieldToMatch
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a web request component to be used in a rule match statement or in a logging configuration.
- In a rule statement, this is 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" } }
- In a logging configuration, this is used in the RedactedFields property to specify a field to redact from the logging records. For this use case, note the following:
  - Even though all FieldToMatch settings are available, the only valid settings for field redaction are UriPath, QueryString, SingleHeader, and Method.
  - In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs.
  - If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FieldToMatch()

Constructors
Constructor and Description
`FieldToMatch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FieldToMatch`	`clone()`
`boolean`	`equals(Object obj)`
`AllQueryArguments`	`getAllQueryArguments()` Inspect all query arguments.
`Body`	`getBody()` Inspect the request body as plain text.
`Cookies`	`getCookies()` Inspect the request cookies.
`HeaderOrder`	`getHeaderOrder()` 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.
`Headers`	`getHeaders()` Inspect the request headers.
`JA3Fingerprint`	`getJA3Fingerprint()` Available for use with Amazon CloudFront distributions and Application Load Balancers.
`JsonBody`	`getJsonBody()` Inspect the request body as JSON.
`Method`	`getMethod()` Inspect the HTTP method.
`QueryString`	`getQueryString()` Inspect the query string.
`SingleHeader`	`getSingleHeader()` Inspect a single header.
`SingleQueryArgument`	`getSingleQueryArgument()` Inspect a single query argument.
`UriPath`	`getUriPath()` Inspect the request URI path.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllQueryArguments(AllQueryArguments allQueryArguments)` Inspect all query arguments.
`void`	`setBody(Body body)` Inspect the request body as plain text.
`void`	`setCookies(Cookies cookies)` Inspect the request cookies.
`void`	`setHeaderOrder(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.
`void`	`setHeaders(Headers headers)` Inspect the request headers.
`void`	`setJA3Fingerprint(JA3Fingerprint jA3Fingerprint)` Available for use with Amazon CloudFront distributions and Application Load Balancers.
`void`	`setJsonBody(JsonBody jsonBody)` Inspect the request body as JSON.
`void`	`setMethod(Method method)` Inspect the HTTP method.
`void`	`setQueryString(QueryString queryString)` Inspect the query string.
`void`	`setSingleHeader(SingleHeader singleHeader)` Inspect a single header.
`void`	`setSingleQueryArgument(SingleQueryArgument singleQueryArgument)` Inspect a single query argument.
`void`	`setUriPath(UriPath uriPath)` Inspect the request URI path.
`String`	`toString()` Returns a string representation of this object.
`FieldToMatch`	`withAllQueryArguments(AllQueryArguments allQueryArguments)` Inspect all query arguments.
`FieldToMatch`	`withBody(Body body)` Inspect the request body as plain text.
`FieldToMatch`	`withCookies(Cookies cookies)` Inspect the request cookies.
`FieldToMatch`	`withHeaderOrder(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.
`FieldToMatch`	`withHeaders(Headers headers)` Inspect the request headers.
`FieldToMatch`	`withJA3Fingerprint(JA3Fingerprint jA3Fingerprint)` Available for use with Amazon CloudFront distributions and Application Load Balancers.
`FieldToMatch`	`withJsonBody(JsonBody jsonBody)` Inspect the request body as JSON.
`FieldToMatch`	`withMethod(Method method)` Inspect the HTTP method.
`FieldToMatch`	`withQueryString(QueryString queryString)` Inspect the query string.
`FieldToMatch`	`withSingleHeader(SingleHeader singleHeader)` Inspect a single header.
`FieldToMatch`	`withSingleQueryArgument(SingleQueryArgument singleQueryArgument)` Inspect a single query argument.
`FieldToMatch`	`withUriPath(UriPath uriPath)` Inspect the request URI path.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FieldToMatch
```
public FieldToMatch()
```
- Method Detail
  - setSingleHeader
```
public void setSingleHeader(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.
    
    Parameters:
    
    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.
  - getSingleHeader
```
public SingleHeader getSingleHeader()
```
    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.
    
    Returns:
    
    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.
  - withSingleHeader
```
public FieldToMatch withSingleHeader(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSingleQueryArgument
```
public void setSingleQueryArgument(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" }
    
    Parameters:
    
    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" }
  - getSingleQueryArgument
```
public SingleQueryArgument getSingleQueryArgument()
```
    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" }
    
    Returns:
    
    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" }
  - withSingleQueryArgument
```
public FieldToMatch withSingleQueryArgument(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" }
    
    Parameters:
    
    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" }
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllQueryArguments
```
public void setAllQueryArguments(AllQueryArguments allQueryArguments)
```
    Inspect all query arguments.
    
    Parameters:
    
    allQueryArguments - Inspect all query arguments.
  - getAllQueryArguments
```
public AllQueryArguments getAllQueryArguments()
```
    Inspect all query arguments.
    
    Returns:
    
    Inspect all query arguments.
  - withAllQueryArguments
```
public FieldToMatch withAllQueryArguments(AllQueryArguments allQueryArguments)
```
    Inspect all query arguments.
    
    Parameters:
    
    allQueryArguments - Inspect all query arguments.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUriPath
```
public void setUriPath(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.
    
    Parameters:
    
    uriPath - Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.
  - getUriPath
```
public UriPath getUriPath()
```
    Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.
    
    Returns:
    
    Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.
  - withUriPath
```
public FieldToMatch withUriPath(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.
    
    Parameters:
    
    uriPath - Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueryString
```
public void setQueryString(QueryString queryString)
```
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Parameters:
    
    queryString - Inspect the query string. This is the part of a URL that appears after a ? character, if any.
  - getQueryString
```
public QueryString getQueryString()
```
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Returns:
    
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
  - withQueryString
```
public FieldToMatch withQueryString(QueryString queryString)
```
    Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Parameters:
    
    queryString - Inspect the query string. This is the part of a URL that appears after a ? character, if any.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBody
```
public void setBody(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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    - For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    For information about how to handle oversized request bodies, see the Body object configuration.
    Parameters:
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    
    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    
    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    
    For information about how to handle oversized request bodies, see the Body object configuration.
  - getBody
```
public Body getBody()
```
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    - For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    For information about how to handle oversized request bodies, see the Body object configuration.
    Returns:
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    
    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    
    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    
    For information about how to handle oversized request bodies, see the Body object configuration.
  - withBody
```
public FieldToMatch withBody(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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    - For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    For information about how to handle oversized request bodies, see the Body object configuration.
    Parameters:
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    
    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    
    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    
    For information about how to handle oversized request bodies, see the Body object configuration.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMethod
```
public void setMethod(Method method)
```
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Parameters:
    
    method - Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
  - getMethod
```
public Method getMethod()
```
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Returns:
    
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
  - withMethod
```
public FieldToMatch withMethod(Method method)
```
    Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Parameters:
    
    method - Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJsonBody
```
public void setJsonBody(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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    - For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    For information about how to handle oversized request bodies, see the JsonBody object configuration.
    Parameters:
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    
    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    
    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    
    For information about how to handle oversized request bodies, see the JsonBody object configuration.
  - getJsonBody
```
public JsonBody getJsonBody()
```
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    - For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    For information about how to handle oversized request bodies, see the JsonBody object configuration.
    Returns:
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    
    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    
    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    
    For information about how to handle oversized request bodies, see the JsonBody object configuration.
  - withJsonBody
```
public FieldToMatch withJsonBody(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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    - For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    - For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    For information about how to handle oversized request bodies, see the JsonBody object configuration.
    Parameters:
    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.
    
    WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
    
    For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
    
    For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
    
    For information about how to handle oversized request bodies, see the JsonBody object configuration.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeaders
```
public void setHeaders(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.
    
    Parameters:
    
    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.
  - getHeaders
```
public Headers getHeaders()
```
    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.
    
    Returns:
    
    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.
  - withHeaders
```
public FieldToMatch withHeaders(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCookies
```
public void setCookies(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.
    
    Parameters:
    
    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.
  - getCookies
```
public Cookies getCookies()
```
    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.
    
    Returns:
    
    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.
  - withCookies
```
public FieldToMatch withCookies(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeaderOrder
```
public void setHeaderOrder(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.
    
    Parameters:
    
    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.
  - getHeaderOrder
```
public HeaderOrder getHeaderOrder()
```
    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.
    
    Returns:
    
    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.
  - withHeaderOrder
```
public FieldToMatch withHeaderOrder(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJA3Fingerprint
```
public void setJA3Fingerprint(JA3Fingerprint jA3Fingerprint)
```
    Available for use with Amazon CloudFront distributions and Application Load Balancers. 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.
    
    Parameters:
    
    jA3Fingerprint - Available for use with Amazon CloudFront distributions and Application Load Balancers. 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.
  - getJA3Fingerprint
```
public JA3Fingerprint getJA3Fingerprint()
```
    Available for use with Amazon CloudFront distributions and Application Load Balancers. 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.
    
    Returns:
    
    Available for use with Amazon CloudFront distributions and Application Load Balancers. 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.
  - withJA3Fingerprint
```
public FieldToMatch withJA3Fingerprint(JA3Fingerprint jA3Fingerprint)
```
    Available for use with Amazon CloudFront distributions and Application Load Balancers. 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.
    
    Parameters:
    
    jA3Fingerprint - Available for use with Amazon CloudFront distributions and Application Load Balancers. 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public FieldToMatch clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class FieldToMatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldToMatch

Method Detail

setSingleHeader

getSingleHeader

withSingleHeader

setSingleQueryArgument

getSingleQueryArgument

withSingleQueryArgument

setAllQueryArguments

getAllQueryArguments

withAllQueryArguments

setUriPath

getUriPath

withUriPath

setQueryString

getQueryString

withQueryString

setBody

getBody

withBody

setMethod

getMethod

withMethod

setJsonBody

getJsonBody

withJsonBody

setHeaders

getHeaders

withHeaders

setCookies

getCookies

withCookies

setHeaderOrder

getHeaderOrder

withHeaderOrder

setJA3Fingerprint

getJA3Fingerprint

withJA3Fingerprint

toString

equals

hashCode

clone

marshall