Package software.amazon.awssdk.services.wafv2.model

Interface FieldToMatch.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FieldToMatch.Builder,FieldToMatch>, SdkBuilder<FieldToMatch.Builder,FieldToMatch>, SdkPojo
Enclosing class:
FieldToMatch
public static interface FieldToMatch.Builder extends SdkPojo, CopyableBuilder<FieldToMatch.Builder,FieldToMatch>

  • Method Details

    • singleHeader

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

      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.

    • singleHeader

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      singleHeader - a consumer that will call methods on SingleHeader.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • singleQueryArgument

      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" }

      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.

    • singleQueryArgument

      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" }

      This is a convenience method that creates an instance of the 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).

      Parameters:
      singleQueryArgument - a consumer that will call methods on SingleQueryArgument.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • allQueryArguments

      FieldToMatch.Builder allQueryArguments(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.

    • allQueryArguments

      default FieldToMatch.Builder allQueryArguments(Consumer<AllQueryArguments.Builder> allQueryArguments)

      Inspect all query arguments.

      This is a convenience method that creates an instance of the AllQueryArguments.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).

      Parameters:
      allQueryArguments - a consumer that will call methods on AllQueryArguments.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • uriPath

      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.

      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.

    • uriPath

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      uriPath - a consumer that will call methods on UriPath.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryString

      FieldToMatch.Builder queryString(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.

    • queryString

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      queryString - a consumer that will call methods on QueryString.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • body

      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.

      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.

    • body

      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.

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      body - a consumer that will call methods on Body.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • method

      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.

      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.

    • method

      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 the Method.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).

      Parameters:
      method - a consumer that will call methods on Method.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jsonBody

      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.

      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.

    • jsonBody

      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.

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      jsonBody - a consumer that will call methods on JsonBody.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • headers

      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.

      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.

    • headers

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      headers - a consumer that will call methods on Headers.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cookies

      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.

      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.

    • cookies

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      cookies - a consumer that will call methods on Cookies.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • headerOrder

      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.

      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.

    • headerOrder

      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.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      headerOrder - a consumer that will call methods on HeaderOrder.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ja3Fingerprint

      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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ja3Fingerprint

      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 the JA3Fingerprint.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).

      Parameters:
      ja3Fingerprint - a consumer that will call methods on JA3Fingerprint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: