AWS::WAFv2::WebACL RateLimitHeader

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

Syntax

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

JSON

{
  "Name" : String,
  "TextTransformations" : [ TextTransformation, ... ]
}

YAML

  Name: String
  TextTransformations: 
    - TextTransformation

Properties

Name

The name of the header to use.

Required: Yes

Type: String

Pattern: .*\S.*

Minimum: 1

Maximum: 64

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. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

Required: Yes

Type: Array of TextTransformation

Minimum: 1

Update requires: No interruption