Struct aws_sdk_waf::types::builders::RateBasedRuleBuilder

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

A builder for RateBasedRule.

Implementations

impl RateBasedRuleBuilder

pub fn rule_id(self, input: impl Into<String>) -> Self

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).

This field is required.

pub fn set_rule_id(self, input: Option<String>) -> Self

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).

pub fn get_rule_id(&self) -> &Option<String>

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).

pub fn name(self, input: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn get_name(&self) -> &Option<String>

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

pub fn metric_name(self, input: impl Into<String>) -> Self

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.

pub fn set_metric_name(self, input: Option<String>) -> Self

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.

pub fn get_metric_name(&self) -> &Option<String>

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.

pub fn match_predicates(self, input: Predicate) -> Self

Appends an item to match_predicates.

To override the contents of this collection use set_match_predicates.

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

pub fn set_match_predicates(self, input: Option<Vec<Predicate>>) -> Self

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

pub fn get_match_predicates(&self) -> &Option<Vec<Predicate>>

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

pub fn rate_key(self, input: RateKey) -> Self

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.

This field is required.

pub fn set_rate_key(self, input: Option<RateKey>) -> Self

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.

pub fn get_rate_key(&self) -> &Option<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.

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

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.

This field is required.

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

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.

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

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.

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

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

• rule_id
• match_predicates
• rate_key
• rate_limit

Trait Implementations

impl Clone for RateBasedRuleBuilder

fn clone(&self) -> RateBasedRuleBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateBasedRuleBuilder

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

Formats the value using the given formatter.

impl Default for RateBasedRuleBuilder

fn default() -> RateBasedRuleBuilder

Returns the “default value” for a type.

impl PartialEq for RateBasedRuleBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RateBasedRuleBuilder