Struct aws_sdk_wafv2::model::rate_based_statement::Builder

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

A builder for RateBasedStatement

Implementations

impl Builder

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

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 set_limit(self, input: Option<i64>) -> Self

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,
    input: RateBasedStatementAggregateKeyType
) -> Self

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 set_aggregate_key_type(
    self,
    input: Option<RateBasedStatementAggregateKeyType>
) -> Self

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, input: impl Into<Box<Statement>>) -> Self

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 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 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, 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 AggregateKeyType is set to FORWARDED_IP.

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 AggregateKeyType is set to FORWARDED_IP.

pub fn build(self) -> RateBasedStatement

Consumes the builder and constructs a RateBasedStatement

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder