Struct rusoto_waf::RateBasedRule
source · [−]pub struct RateBasedRule {
pub match_predicates: Vec<Predicate>,
pub metric_name: Option<String>,
pub name: Option<String>,
pub rate_key: String,
pub rate_limit: i64,
pub rule_id: String,
}
Expand description
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
A RateBasedRule
is identical to a regular Rule, with one addition: a RateBasedRule
counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule
that includes the following conditions:
-
The requests come from 192.0.2.44.
-
They contain the value
BadBot
in theUser-Agent
header.
In the rule, you also define the rate limit as 1,000.
Requests that meet both of these conditions and exceed 1,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.
Fields
match_predicates: Vec<Predicate>
The Predicates
object contains one Predicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule
.
metric_name: 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
.
name: Option<String>
A friendly name or description for a RateBasedRule
. You can't change the name of a RateBasedRule
after you create it.
rate_key: String
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
.
rate_limit: 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.
rule_id: 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).
Trait Implementations
sourceimpl Clone for RateBasedRule
impl Clone for RateBasedRule
sourcefn clone(&self) -> RateBasedRule
fn clone(&self) -> RateBasedRule
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for RateBasedRule
impl Debug for RateBasedRule
sourceimpl Default for RateBasedRule
impl Default for RateBasedRule
sourcefn default() -> RateBasedRule
fn default() -> RateBasedRule
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for RateBasedRule
impl<'de> Deserialize<'de> for RateBasedRule
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<RateBasedRule> for RateBasedRule
impl PartialEq<RateBasedRule> for RateBasedRule
sourcefn eq(&self, other: &RateBasedRule) -> bool
fn eq(&self, other: &RateBasedRule) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &RateBasedRule) -> bool
fn ne(&self, other: &RateBasedRule) -> bool
This method tests for !=
.
impl StructuralPartialEq for RateBasedRule
Auto Trait Implementations
impl RefUnwindSafe for RateBasedRule
impl Send for RateBasedRule
impl Sync for RateBasedRule
impl Unpin for RateBasedRule
impl UnwindSafe for RateBasedRule
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more