class Aws::WAFRegional::Types::CreateRateBasedRuleRequest
@note When making an API call, you may pass CreateRateBasedRuleRequest
data as a hash: { name: "ResourceName", # required metric_name: "MetricName", # required rate_key: "IP", # required, accepts IP rate_limit: 1, # required change_token: "ChangeToken", # required tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], }
@!attribute [rw] name
A friendly name or description of the RateBasedRule. You can't change the name of a `RateBasedRule` after you create it. @return [String]
@!attribute [rw] metric_name
A friendly name or description for the metrics for this `RateBasedRule`. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default\_Action." You can't change the name of the metric after you create the `RateBasedRule`. @return [String]
@!attribute [rw] rate_key
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for `RateKey` is `IP`. `IP` indicates that requests that arrive from the same IP address are subject to the `RateLimit` that is specified in the `RateBasedRule`. @return [String]
@!attribute [rw] rate_limit
The maximum number of requests, which have an identical value in the field that is specified by `RateKey`, allowed in a five-minute period. If the number of requests exceeds the `RateLimit` and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. @return [Integer]
@!attribute [rw] change_token
The `ChangeToken` that you used to submit the `CreateRateBasedRule` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. @return [String]
@!attribute [rw] tags
@return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/CreateRateBasedRuleRequest AWS API Documentation
Constants
- SENSITIVE