Struct aws_sdk_wafv2::model::RateBasedStatement

#[non_exhaustive]
pub struct RateBasedStatement {
    pub limit: i64,
    pub aggregate_key_type: Option<RateBasedStatementAggregateKeyType>,
    pub scope_down_statement: Option<Box<Statement>>,
    pub forwarded_ip_config: Option<ForwardedIpConfig>,
}

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.

When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

• An IP match statement with an IP set that specified the address 192.0.2.44.

• A string match statement that searches in the User-Agent header for the string BadBot.

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can define a RateBasedStatement inside a web ACL and inside a rule group.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

limit: i64

The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

aggregate_key_type: Option<RateBasedStatementAggregateKeyType>

Setting that indicates how to aggregate the request counts. The options are the following:

• IP - Aggregate the request counts on the IP address from the web request origin.

• FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

scope_down_statement: Option<Box<Statement>>

An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

forwarded_ip_config: Option<ForwardedIpConfig>

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

This is required if AggregateKeyType is set to FORWARDED_IP.

Implementations

impl RateBasedStatement

pub fn limit(&self) -> i64

The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

pub fn aggregate_key_type(&self) -> Option<&RateBasedStatementAggregateKeyType>

Setting that indicates how to aggregate the request counts. The options are the following:

• IP - Aggregate the request counts on the IP address from the web request origin.

• FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

pub fn scope_down_statement(&self) -> Option<&Statement>

An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.

pub fn forwarded_ip_config(&self) -> Option<&ForwardedIpConfig>

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.

This is required if AggregateKeyType is set to FORWARDED_IP.

impl RateBasedStatement

pub fn builder() -> Builder

Creates a new builder-style object to manufacture RateBasedStatement

Trait Implementations

impl Clone for RateBasedStatement

fn clone(&self) -> RateBasedStatement

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RateBasedStatement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RateBasedStatement> for RateBasedStatement

fn eq(&self, other: &RateBasedStatement) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RateBasedStatement) -> bool

This method tests for !=.

impl StructuralPartialEq for RateBasedStatement