Struct aws_sdk_wafv2::types::builders::RateBasedStatementBuilder

#[non_exhaustive]
pub struct RateBasedStatementBuilder { /* private fields */ }

A builder for RateBasedStatement.

Implementations

impl RateBasedStatementBuilder

pub fn limit(self, input: i64) -> Self

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

Examples:

• If you aggregate on just the IP address, this is the limit on requests from any single IP address.

• If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.

This field is required.

pub fn set_limit(self, input: Option<i64>) -> Self

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

Examples:

• If you aggregate on just the IP address, this is the limit on requests from any single IP address.

• If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.

pub fn get_limit(&self) -> &Option<i64>

The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

Examples:

• If you aggregate on just the IP address, this is the limit on requests from any single IP address.

• If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.

pub fn evaluation_window_sec(self, input: i64) -> Self

The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.

This setting doesn't determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.

Default: 300 (5 minutes)

pub fn set_evaluation_window_sec(self, input: Option<i64>) -> Self

The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.

This setting doesn't determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.

Default: 300 (5 minutes)

pub fn get_evaluation_window_sec(&self) -> &Option<i64>

The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.

This setting doesn't determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.

Default: 300 (5 minutes)

pub fn aggregate_key_type( self, input: RateBasedStatementAggregateKeyType ) -> Self

Setting that indicates how to aggregate the request counts.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

• CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement.

  With this option, you must configure the ScopeDownStatement property.

• CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys.

  With this option, you must specify the aggregate keys in the CustomKeys property.

  To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP.

• FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header.

  With this option, you must specify the header to use in the ForwardedIPConfig property.

  To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS.

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

  To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS.

This field is required.

pub fn set_aggregate_key_type( self, input: Option<RateBasedStatementAggregateKeyType> ) -> Self

Setting that indicates how to aggregate the request counts.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

• CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement.

  With this option, you must configure the ScopeDownStatement property.

• CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys.

  With this option, you must specify the aggregate keys in the CustomKeys property.

  To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP.

• FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header.

  With this option, you must specify the header to use in the ForwardedIPConfig property.

  To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS.

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

  To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS.

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

Setting that indicates how to aggregate the request counts.

Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.

• CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement.

  With this option, you must configure the ScopeDownStatement property.

• CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys.

  With this option, you must specify the aggregate keys in the CustomKeys property.

  To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP.

• FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header.

  With this option, you must specify the header to use in the ForwardedIPConfig property.

  To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS.

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

  To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS.

pub fn scope_down_statement(self, input: impl Into<Box<Statement>>) -> Self

An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that 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 set_scope_down_statement(self, input: Option<Box<Statement>>) -> Self

An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that 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 get_scope_down_statement(&self) -> &Option<Box<Statement>>

An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that 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, input: ForwardedIpConfig) -> Self

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 you specify a forwarded IP in the rule's aggregate key settings.

pub fn set_forwarded_ip_config(self, input: Option<ForwardedIpConfig>) -> Self

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 you specify a forwarded IP in the rule's aggregate key settings.

pub fn get_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 you specify a forwarded IP in the rule's aggregate key settings.

pub fn custom_keys(self, input: RateBasedStatementCustomKey) -> Self

Appends an item to custom_keys.

To override the contents of this collection use set_custom_keys.

Specifies the aggregate keys to use in a rate-base rule.

pub fn set_custom_keys( self, input: Option<Vec<RateBasedStatementCustomKey>> ) -> Self

Specifies the aggregate keys to use in a rate-base rule.

pub fn get_custom_keys(&self) -> &Option<Vec<RateBasedStatementCustomKey>>

Specifies the aggregate keys to use in a rate-base rule.

pub fn build(self) -> Result<RateBasedStatement, BuildError>

Consumes the builder and constructs a RateBasedStatement. This method will fail if any of the following fields are not set:

• limit
• aggregate_key_type

Trait Implementations

impl Clone for RateBasedStatementBuilder

fn clone(&self) -> RateBasedStatementBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateBasedStatementBuilder

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

Formats the value using the given formatter.

impl Default for RateBasedStatementBuilder

fn default() -> RateBasedStatementBuilder

Returns the “default value” for a type.

impl PartialEq for RateBasedStatementBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RateBasedStatementBuilder