RuleGroupByteMatchStatement

data class RuleGroupByteMatchStatement(val fieldToMatch: RuleGroupFieldToMatch, val positionalConstraint: RuleGroupPositionalConstraint, val searchString: String? = null, val searchStringBase64: String? = null, val textTransformations: List<RuleGroupTextTransformation>)

Byte Match statement.

Constructors

Link copied to clipboard
constructor(fieldToMatch: RuleGroupFieldToMatch, positionalConstraint: RuleGroupPositionalConstraint, searchString: String? = null, searchStringBase64: String? = null, textTransformations: List<RuleGroupTextTransformation>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val searchString: String? = null

A string value that you want AWS WAF to search for. AWS 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 AWS WAF to search for. AWS 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 .

Link copied to clipboard

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 .

Link copied to clipboard

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