Skip to content

/AWS1/CL_WARRATEBASEDRULE

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.

A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

  • The requests come from 192.0.2.44.

  • They contain the value BadBot in the User-Agent header.

In the rule, you also define the rate limit as 1,000.

Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_ruleid TYPE /AWS1/WARRESOURCEID /AWS1/WARRESOURCEID

A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

it_matchpredicates TYPE /AWS1/CL_WARPREDICATE=>TT_PREDICATES TT_PREDICATES

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

iv_ratekey TYPE /AWS1/WARRATEKEY /AWS1/WARRATEKEY

The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

iv_ratelimit TYPE /AWS1/WARRATELIMIT /AWS1/WARRATELIMIT

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 the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Optional arguments:

iv_name TYPE /AWS1/WARRESOURCENAME /AWS1/WARRESOURCENAME

A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

iv_metricname TYPE /AWS1/WARMETRICNAME /AWS1/WARMETRICNAME

A friendly name or description for the metrics for a 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.

Queryable Attributes

RuleId

A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

Accessible with the following methods

Method Description
GET_RULEID() Getter for RULEID, with configurable default
ASK_RULEID() Getter for RULEID w/ exceptions if field has no value
HAS_RULEID() Determine if RULEID has a value

Name

A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

MetricName

A friendly name or description for the metrics for a 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.

Accessible with the following methods

Method Description
GET_METRICNAME() Getter for METRICNAME, with configurable default
ASK_METRICNAME() Getter for METRICNAME w/ exceptions if field has no value
HAS_METRICNAME() Determine if METRICNAME has a value

MatchPredicates

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

Accessible with the following methods

Method Description
GET_MATCHPREDICATES() Getter for MATCHPREDICATES, with configurable default
ASK_MATCHPREDICATES() Getter for MATCHPREDICATES w/ exceptions if field has no val
HAS_MATCHPREDICATES() Determine if MATCHPREDICATES has a value

RateKey

The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

Accessible with the following methods

Method Description
GET_RATEKEY() Getter for RATEKEY, with configurable default
ASK_RATEKEY() Getter for RATEKEY w/ exceptions if field has no value
HAS_RATEKEY() Determine if RATEKEY has a value

RateLimit

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 the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Accessible with the following methods

Method Description
GET_RATELIMIT() Getter for RATELIMIT, with configurable default
ASK_RATELIMIT() Getter for RATELIMIT w/ exceptions if field has no value
HAS_RATELIMIT() Determine if RATELIMIT has a value