AwsWafRateBasedRuleDetails - AWS Security Hub CSPM
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

AwsWafRateBasedRuleDetails

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

Contents

MatchPredicates

The predicates to include in the rate-based rule.

Type: Array of AwsWafRateBasedRuleMatchPredicate objects

Required: No

MetricName

The name of the metrics for the rate-based rule.

Type: String

Pattern: .*\S.*

Required: No

Name

The name of the rate-based rule.

Type: String

Pattern: .*\S.*

Required: No

RateKey

The field that AWS WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

Type: String

Pattern: .*\S.*

Required: No

RateLimit

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, AWS WAF triggers the action for the rule.

Type: Long

Required: No

RuleId

The unique identifier for the rate-based rule.

Type: String

Pattern: .*\S.*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: