Struct CreateRateBasedRuleInput

#[non_exhaustive]
pub struct CreateRateBasedRuleInput {
    pub name: Option<String>,
    pub metric_name: Option<String>,
    pub rate_key: Option<RateKey>,
    pub rate_limit: Option<i64>,
    pub change_token: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

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.

name: Option<String>

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

metric_name: Option<String>

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.

rate_key: Option<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: Option<i64>

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.

change_token: Option<String>

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.

tags: Option<Vec<Tag>>

Implementations

impl CreateRateBasedRuleInput

pub fn name(&self) -> Option<&str>

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

pub fn metric_name(&self) -> Option<&str>

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.

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

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

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.

pub fn change_token(&self) -> Option<&str>

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.

pub fn tags(&self) -> &[Tag]

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl CreateRateBasedRuleInput

pub fn builder() -> CreateRateBasedRuleInputBuilder

Creates a new builder-style object to manufacture CreateRateBasedRuleInput.

Trait Implementations

impl Clone for CreateRateBasedRuleInput

fn clone(&self) -> CreateRateBasedRuleInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRateBasedRuleInput

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

Formats the value using the given formatter.

impl PartialEq for CreateRateBasedRuleInput

fn eq(&self, other: &CreateRateBasedRuleInput) -> 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 CreateRateBasedRuleInput