You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WAFV2::Types::FieldToMatch

  • Object
show all
Defined in:



When passing FieldToMatch as input to an Aws::Client method, you can use a vanilla Hash:

  single_header: {
    name: "FieldToMatchData", # required
  single_query_argument: {
    name: "FieldToMatchData", # required
  all_query_arguments: {
  uri_path: {
  query_string: {
  body: {
  method: {

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

The part of a web request that you want AWS 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 a web request, create a separate rule statement for each component.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details


Inspect all query arguments.



Inspect the request body, which 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.

Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don\'t need to inspect more than 8 KB, you can guarantee that you don\'t allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn\'t support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.


  • (Types::Body)

    Inspect the request body, which immediately follows the request headers.


Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.



Inspect the query string. This is the part of a URL that appears after a ? character, if any.



Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn\'t case sensitive.



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.

This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.



Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.