This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
See https://www.paws-r-sdk.com/docs/wafregional_create_rate_based_rule/ for full documentation.
wafregional_create_rate_based_rule(
Name,
MetricName,
RateKey,
RateLimit,
ChangeToken,
Tags = NULL
)
[required] A friendly name or description of the RateBasedRule. You can't change
the name of a RateBasedRule
after you create it.
[required] 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
.
[required] 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
.
[required] 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.
[required] The ChangeToken
that you used to submit the
create_rate_based_rule
request.
You can also use this value to query the status of the request. For more
information, see
get_change_token_status
.