Update Rate Based Rule
wafregional_update_rate_based_rule | R Documentation |
This is AWS WAF Classic documentation¶
Description¶
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes Predicate objects in a rule and updates the
RateLimit
in the rule.
Each Predicate
object identifies a predicate, such as a ByteMatchSet
or an IPSet, that specifies the web requests that you want to block or
count. The RateLimit
specifies the number of requests every five
minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule
, a request must
match all the predicates and exceed the RateLimit
to be counted or
blocked. For example, suppose you add the following to a
RateBasedRule
:
-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
Further, you specify a RateLimit
of 1,000.
You then add the RateBasedRule
to a WebACL
and specify that you want
to block requests that satisfy the rule. For a request to be blocked, it
must come from the IP address 192.0.2.44 and the User-Agent
header
in the request must contain the value BadBot
. Further, requests that
match these two conditions much be received at a rate of more than 1,000
every five minutes. If the rate drops below this limit, AWS WAF no
longer blocks the requests.
As a second example, suppose you want to limit requests to a particular
page on your site. To do this, you could add the following to a
RateBasedRule
:
-
A
ByteMatchSet
withFieldToMatch
ofURI
-
A
PositionalConstraint
ofSTARTS_WITH
-
A
TargetString
oflogin
Further, you specify a RateLimit
of 1,000.
By adding this RateBasedRule
to a WebACL
, you could limit requests
to your login page without affecting the rest of your site.
Usage¶
Arguments¶
RuleId
[required] The
RuleId
of theRateBasedRule
that you want to update.RuleId
is returned bycreate_rate_based_rule
and bylist_rate_based_rules
.ChangeToken
[required] The value returned by the most recent call to
get_change_token
.Updates
[required] An array of
RuleUpdate
objects that you want to insert into or delete from a RateBasedRule.RateLimit
[required] The maximum number of requests, which have an identical value in the field specified by the
RateKey
, allowed in a five-minute period. If the number of requests exceeds theRateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
Value¶
A list with the following syntax:
Request syntax¶
svc$update_rate_based_rule(
RuleId = "string",
ChangeToken = "string",
Updates = list(
list(
Action = "INSERT"|"DELETE",
Predicate = list(
Negated = TRUE|FALSE,
Type = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch",
DataId = "string"
)
)
),
RateLimit = 123
)