Struct aws_sdk_waf::operation::create_rate_based_rule::builders::CreateRateBasedRuleInputBuilder

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

A builder for CreateRateBasedRuleInput.

Implementations

impl CreateRateBasedRuleInputBuilder

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

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

This field is required.

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

A friendly name or description of the 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 of the 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 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.

This field is required.

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

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 get_metric_name(&self) -> &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.

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

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.

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

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.

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 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 get_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, input: impl Into<String>) -> Self

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.

This field is required.

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

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 get_change_token(&self) -> &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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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

Consumes the builder and constructs a CreateRateBasedRuleInput.

impl CreateRateBasedRuleInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateRateBasedRuleOutput, SdkError<CreateRateBasedRuleError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateRateBasedRuleInputBuilder

fn clone(&self) -> CreateRateBasedRuleInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateRateBasedRuleInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateRateBasedRuleInputBuilder

fn default() -> CreateRateBasedRuleInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateRateBasedRuleInputBuilder

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