interface RateLimitQueryArgumentProperty

Language	Type name
.NET	`Amazon.CDK.AWS.WAFv2.CfnWebACL.RateLimitQueryArgumentProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnWebACL_RateLimitQueryArgumentProperty`
Java	`software.amazon.awscdk.services.wafv2.CfnWebACL.RateLimitQueryArgumentProperty`
Python	`aws_cdk.aws_wafv2.CfnWebACL.RateLimitQueryArgumentProperty`
TypeScript	`aws-cdk-lib` » `aws_wafv2` » `CfnWebACL` » `RateLimitQueryArgumentProperty`

Specifies a query argument in the request as an aggregate key for a rate-based rule.

Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wafv2 as wafv2 } from 'aws-cdk-lib';
const rateLimitQueryArgumentProperty: wafv2.CfnWebACL.RateLimitQueryArgumentProperty = {
  name: 'name',
  textTransformations: [{
    priority: 123,
    type: 'type',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the query argument to use.
textTransformations	`IResolvable` `\|` `IResolvable` `\|` `TextTransformationProperty[]`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.

name

Type: string

The name of the query argument to use.

textTransformations

Type: IResolvable | IResolvable | TextTransformationProperty[]

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.