Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS WAF Regional ByteMatchSet ByteMatchTuples

ByteMatchTuples is a property of the AWS::WAFRegional::ByteMatchSet resource that specifies settings for an AWS WAF Regional ByteMatchSet resource, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests.

Syntax

JSON

{ "FieldToMatch" : Field to match, "PositionalConstraint" : String, "TargetString" : String, "TargetStringBase64" : String, "TextTransformation" : String }

YAML

FieldToMatch: Field to match PositionalConstraint: String TargetString: String TargetStringBase64: String TextTransformation: String

Properties

FieldToMatch

The part of a web request that you want AWS WAF to search, such as a specific header or a query string.

Required: Yes

Type: AWS WAF Regional ByteMatchSet ByteMatchTuples FieldToMatch

PositionalConstraint

How AWS WAF finds matches within the part of the web request in which you are searching. For valid values, see the PositionalConstraint content for the ByteMatchTuple data type in the AWS WAF Regional API Reference.

Required: Yes

Type: String

TargetString

The value that AWS WAF searches for. AWS CloudFormation encodes in base64 this value before sending it to AWS WAF.

AWS WAF searches for this value in a specific part of web requests, which you define in the FieldToMatch property.

Valid values depend on the Type value in the FieldToMatch property. For example, for a METHOD type, you must specify HTTP methods, such as DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. For more information, see the TargetString content for the ByteMatchTuple data type in the AWS WAF Regional API Reference.

Required: Conditional. You must specify this property or the TargetStringBase64 property.

Type: String

TargetStringBase64

The base64-encoded value that AWS WAF searches for. AWS CloudFormation sends this value to AWS WAF without encoding it.

AWS WAF searches for this value in a specific part of web requests, which you define in the FieldToMatch property.

Valid values depend on the Type value in the FieldToMatch property. For example, for a METHOD type, you must specify HTTP methods, such as DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. For more information, see the TargetString content for the ByteMatchTuple data type in the AWS WAF Regional API Reference.

Required: Conditional. You must specify this property or the TargetString property.

Type: String

TextTransformation

Specifies how AWS WAF processes the target string value. Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF transforms the target string value before inspecting a web request for a match.

For example, AWS WAF can replace whitespace characters (such as \t and \n) with a single space. For valid values, see the TextTransformation content for the ByteMatchTuple data type in the AWS WAF Regional API Reference.

Required: Yes

Type: String

On this page: