AWS::WAFv2::RuleGroup ByteMatchStatement - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::WAFv2::RuleGroup ByteMatchStatement

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

FieldToMatch

The part of the web request that you want Amazon WAF to inspect.

Required: Yes

Type: FieldToMatch

Update requires: No interruption

PositionalConstraint

The area within the portion of the web request that you want Amazon 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.

Required: Yes

Type: String

Allowed values: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD

Update requires: No interruption

SearchString

A string value that you want Amazon WAF to search for. Amazon WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes. For alphabetic characters A-Z and a-z, the value is case sensitive.

Don't encode this string. Provide the value that you want Amazon WAF to search for. Amazon CloudFormation automatically base64 encodes the value for you.

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 provide the string BadBot in the value of SearchString.

You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement.

Required: No

Type: String

Update requires: No interruption

SearchStringBase64

String to search for in a web request component, base64-encoded. If you don't want to encode the string, specify the unencoded value in SearchString instead.

You must specify either SearchString or SearchStringBase64 in a ByteMatchStatement.

Required: No

Type: String

Update requires: No interruption

TextTransformations

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, Amazon 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.

Required: Yes

Type: Array of TextTransformation

Minimum: 1

Update requires: No interruption