libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.Types.RateBasedRule

Description

 
Synopsis

Documentation

data RateBasedRule Source #

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 the User-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.

See: newRateBasedRule smart constructor.

Constructors

RateBasedRule' 

Fields

  • metricName :: Maybe Text

    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 :: Maybe Text

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

  • ruleId :: Text

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

  • matchPredicates :: [Predicate]

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

  • rateKey :: 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.

  • rateLimit :: Natural

    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.

Instances

Instances details
Eq RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

Read RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

Show RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

Generic RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

Associated Types

type Rep RateBasedRule :: Type -> Type #

NFData RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

Methods

rnf :: RateBasedRule -> () #

Hashable RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

FromJSON RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

type Rep RateBasedRule Source # 
Instance details

Defined in Amazonka.WAF.Types.RateBasedRule

newRateBasedRule Source #

Create a value of RateBasedRule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metricName:RateBasedRule', rateBasedRule_metricName - 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.

$sel:name:RateBasedRule', rateBasedRule_name - A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

$sel:ruleId:RateBasedRule', rateBasedRule_ruleId - 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).

$sel:matchPredicates:RateBasedRule', rateBasedRule_matchPredicates - The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

$sel:rateKey:RateBasedRule', rateBasedRule_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.

$sel:rateLimit:RateBasedRule', rateBasedRule_rateLimit - 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.

rateBasedRule_metricName :: Lens' RateBasedRule (Maybe Text) Source #

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.

rateBasedRule_name :: Lens' RateBasedRule (Maybe Text) Source #

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

rateBasedRule_ruleId :: Lens' RateBasedRule Text Source #

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

rateBasedRule_matchPredicates :: Lens' RateBasedRule [Predicate] Source #

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

rateBasedRule_rateKey :: Lens' RateBasedRule RateKey Source #

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.

rateBasedRule_rateLimit :: Lens' RateBasedRule Natural Source #

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.