Skip to content

CreateRateBasedRuleRequest

Source code in docs_src/capo_waf/types/create_rate_based_rule_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
class CreateRateBasedRuleRequest(TypedDict, closed=True):
    name: "capo_waf.types.resource_name.ResourceName"
    """<p>A friendly name or description of the <a>RateBasedRule</a>. You can't change the name of a <code>RateBasedRule</code> after you create it.</p>"""
    metric_name: "capo_waf.types.metric_name.MetricName"
    """<p>A friendly name or description for the metrics for this <code>RateBasedRule</code>. 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 <code>RateBasedRule</code>.</p>"""
    rate_key: "capo_waf.types.rate_key.RateKey"
    """<p>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 <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>.</p>"""
    rate_limit: "capo_waf.types.rate_limit.RateLimit"
    """<p>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</p>"""
    change_token: "capo_waf.types.change_token.ChangeToken"
    """<p>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>.</p>"""
    tags: NotRequired["capo_waf.types.tag_list.TagList"]
    """<p></p>"""

change_token instance-attribute 

change_token: ChangeToken

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.

metric_name instance-attribute 

metric_name: MetricName

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.

name instance-attribute 

name: ResourceName

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

rate_key instance-attribute 

rate_key: RateKey

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.

rate_limit instance-attribute 

rate_limit: RateLimit

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.

tags instance-attribute 

tags: NotRequired[TagList]