class Aws::WAFV2::Types::ByteMatchStatement

A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement.

@note When making an API call, you may pass ByteMatchStatement

data as a hash:

    {
      search_string: "data", # required
      field_to_match: { # required
        single_header: {
          name: "FieldToMatchData", # required
        },
        single_query_argument: {
          name: "FieldToMatchData", # required
        },
        all_query_arguments: {
        },
        uri_path: {
        },
        query_string: {
        },
        body: {
        },
        method: {
        },
        json_body: {
          match_pattern: { # required
            all: {
            },
            included_paths: ["JsonPointerPath"],
          },
          match_scope: "ALL", # required, accepts ALL, KEY, VALUE
          invalid_fallback_behavior: "MATCH", # accepts MATCH, NO_MATCH, EVALUATE_AS_STRING
        },
      },
      text_transformations: [ # required
        {
          priority: 1, # required
          type: "NONE", # required, accepts NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE, BASE64_DECODE, HEX_DECODE, MD5, REPLACE_COMMENTS, ESCAPE_SEQ_DECODE, SQL_HEX_DECODE, CSS_DECODE, JS_DECODE, NORMALIZE_PATH, NORMALIZE_PATH_WIN, REMOVE_NULLS, REPLACE_NULLS, BASE64_DECODE_EXT, URL_DECODE_UNI, UTF8_TO_UNICODE
        },
      ],
      positional_constraint: "EXACTLY", # required, accepts EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD
    }

@!attribute [rw] search_string

A string value that you want WAF to search for. WAF searches only in
the part of web requests that you designate for inspection in
FieldToMatch. The maximum length of the value is 50 bytes.

Valid values depend on the component that you specify for inspection
in `FieldToMatch`\:

* `Method`\: The HTTP method that you want WAF to search for. This
  indicates the type of operation specified in the request.

* `UriPath`\: The value that you want WAF to search for in the URI
  path, for example, `/images/daily-ad.jpg`.

If `SearchString` includes alphabetic characters A-Z and a-z, note
that the value is case sensitive.

**If you're using the WAF API**

Specify a base64-encoded version of the value. The maximum length of
the value before you base64-encode it is 50 bytes.

For example, suppose the value of `Type` is `HEADER` and the value
of `Data` is `User-Agent`. If you want to search the `User-Agent`
header for the value `BadBot`, you base64-encode `BadBot` using MIME
base64-encoding and include the resulting value, `QmFkQm90`, in the
value of `SearchString`.

**If you're using the CLI or one of the Amazon Web Services SDKs**

The value that you want WAF to search for. The SDK automatically
base64 encodes the value.
@return [String]

@!attribute [rw] field_to_match

The part of a web request that you want WAF to inspect. For more
information, see FieldToMatch.
@return [Types::FieldToMatch]

@!attribute [rw] text_transformations

Text transformations eliminate some of the unusual formatting that
attackers use in web requests in an effort to bypass detection. If
you specify one or more transformations in a rule statement, WAF
performs all transformations on the content of the request component
identified by `FieldToMatch`, starting from the lowest priority
setting, before inspecting the content for a match.
@return [Array<Types::TextTransformation>]

@!attribute [rw] positional_constraint

The area within the portion of a web request that you want WAF to
search for `SearchString`. Valid values include the following:

**CONTAINS**

The specified part of the web request must include the value of
`SearchString`, but the location doesn't matter.

**CONTAINS\_WORD**

The specified part of the web request must include the value of
`SearchString`, and `SearchString` must contain only alphanumeric
characters or underscore (A-Z, a-z, 0-9, or \_). In addition,
`SearchString` must be a word, which means that both of the
following are true:

* `SearchString` is at the beginning of the specified part of the
  web request or is preceded by a character other than an
  alphanumeric character or underscore (\_). Examples include the
  value of a header and `;BadBot`.

* `SearchString` is at the end of the specified part of the web
  request or is followed by a character other than an alphanumeric
  character or underscore (\_), for example, `BadBot;` and
  `-BadBot;`.

**EXACTLY**

The value of the specified part of the web request must exactly
match the value of `SearchString`.

**STARTS\_WITH**

The value of `SearchString` must appear at the beginning of the
specified part of the web request.

**ENDS\_WITH**

The value of `SearchString` must appear at the end of the specified
part of the web request.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29/ByteMatchStatement AWS API Documentation

Constants

SENSITIVE