Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WAFRegional.CreateRateBasedRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

An IPSet that matches the IP address 192.0.2.44/32
A ByteMatchSet that matches BadBot in the User-Agent header

Further, you specify a RateLimit of 1,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

A ByteMatchSet with FieldToMatch of URI
A PositionalConstraint of STARTS_WITH
A TargetString of login

Further, you specify a RateLimit of 1,000.

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

To create and configure a RateBasedRule, perform the following steps:

Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.
Submit a CreateRateBasedRule request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.
Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.
Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Synopsis

data CreateRateBasedRule = CreateRateBasedRule' {
- tags :: Maybe (NonEmpty Tag)
- name :: Text
- metricName :: Text
- rateKey :: RateKey
- rateLimit :: Natural
- changeToken :: Text
}
newCreateRateBasedRule :: Text -> Text -> RateKey -> Natural -> Text -> CreateRateBasedRule
createRateBasedRule_tags :: Lens' CreateRateBasedRule (Maybe (NonEmpty Tag))
createRateBasedRule_name :: Lens' CreateRateBasedRule Text
createRateBasedRule_metricName :: Lens' CreateRateBasedRule Text
createRateBasedRule_rateKey :: Lens' CreateRateBasedRule RateKey
createRateBasedRule_rateLimit :: Lens' CreateRateBasedRule Natural
createRateBasedRule_changeToken :: Lens' CreateRateBasedRule Text
data CreateRateBasedRuleResponse = CreateRateBasedRuleResponse' {
- rule :: Maybe RateBasedRule
- changeToken :: Maybe Text
- httpStatus :: Int
}
newCreateRateBasedRuleResponse :: Int -> CreateRateBasedRuleResponse
createRateBasedRuleResponse_rule :: Lens' CreateRateBasedRuleResponse (Maybe RateBasedRule)
createRateBasedRuleResponse_changeToken :: Lens' CreateRateBasedRuleResponse (Maybe Text)
createRateBasedRuleResponse_httpStatus :: Lens' CreateRateBasedRuleResponse Int

Creating a Request

data CreateRateBasedRule Source #

See: newCreateRateBasedRule smart constructor.

Constructors

CreateRateBasedRule'

Fields

tags :: Maybe (NonEmpty Tag)
name :: Text
A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.
metricName :: Text
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.
rateKey :: 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.
rateLimit :: Natural
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.
changeToken :: Text
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.

Instances

Instances details

Eq CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods (==) :: CreateRateBasedRule -> CreateRateBasedRule -> Bool # (/=) :: CreateRateBasedRule -> CreateRateBasedRule -> Bool #
Read CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods readsPrec :: Int -> ReadS CreateRateBasedRule # readList :: ReadS [CreateRateBasedRule] # readPrec :: ReadPrec CreateRateBasedRule # readListPrec :: ReadPrec [CreateRateBasedRule] #
Show CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods showsPrec :: Int -> CreateRateBasedRule -> ShowS # show :: CreateRateBasedRule -> String # showList :: [CreateRateBasedRule] -> ShowS #
Generic CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Associated Types type Rep CreateRateBasedRule :: Type -> Type # Methods from :: CreateRateBasedRule -> Rep CreateRateBasedRule x # to :: Rep CreateRateBasedRule x -> CreateRateBasedRule #
NFData CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods rnf :: CreateRateBasedRule -> () #
Hashable CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods hashWithSalt :: Int -> CreateRateBasedRule -> Int # hash :: CreateRateBasedRule -> Int #
ToJSON CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods toJSON :: CreateRateBasedRule -> Value # toEncoding :: CreateRateBasedRule -> Encoding # toJSONList :: [CreateRateBasedRule] -> Value # toEncodingList :: [CreateRateBasedRule] -> Encoding #
AWSRequest CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Associated Types type AWSResponse CreateRateBasedRule # Methods request :: CreateRateBasedRule -> Request CreateRateBasedRule # response :: MonadResource m => Logger -> Service -> Proxy CreateRateBasedRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRateBasedRule))) #
ToHeaders CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods toHeaders :: CreateRateBasedRule -> [Header] #
ToPath CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods toPath :: CreateRateBasedRule -> ByteString #
ToQuery CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods toQuery :: CreateRateBasedRule -> QueryString #
type Rep CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule type Rep CreateRateBasedRule = D1 ('MetaData "CreateRateBasedRule" "Amazonka.WAFRegional.CreateRateBasedRule" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "CreateRateBasedRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "rateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RateKey) :: (S1 ('MetaSel ('Just "rateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateRateBasedRule Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule type AWSResponse CreateRateBasedRule = CreateRateBasedRuleResponse

newCreateRateBasedRule Source #

Arguments

:: Text	`$sel:name:CreateRateBasedRule'`
-> Text	`$sel:metricName:CreateRateBasedRule'`
-> RateKey	`$sel:rateKey:CreateRateBasedRule'`
-> Natural	`$sel:rateLimit:CreateRateBasedRule'`
-> Text	`$sel:changeToken:CreateRateBasedRule'`
-> CreateRateBasedRule

Create a value of CreateRateBasedRule 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:tags:CreateRateBasedRule', createRateBasedRule_tags -

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

$sel:metricName:CreateRateBasedRule', createRateBasedRule_metricName - 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.

$sel:rateKey:CreateRateBasedRule', createRateBasedRule_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.

$sel:rateLimit:CreateRateBasedRule', createRateBasedRule_rateLimit - 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.

$sel:changeToken:CreateRateBasedRule', createRateBasedRule_changeToken - 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.

Request Lenses

createRateBasedRule_tags :: Lens' CreateRateBasedRule (Maybe (NonEmpty Tag)) Source #

createRateBasedRule_name :: Lens' CreateRateBasedRule Text Source #

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

createRateBasedRule_metricName :: Lens' CreateRateBasedRule Text Source #

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.

createRateBasedRule_rateKey :: Lens' CreateRateBasedRule RateKey Source #

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.

createRateBasedRule_rateLimit :: Lens' CreateRateBasedRule Natural Source #

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.

createRateBasedRule_changeToken :: Lens' CreateRateBasedRule Text Source #

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.

Destructuring the Response

data CreateRateBasedRuleResponse Source #

See: newCreateRateBasedRuleResponse smart constructor.

Constructors

CreateRateBasedRuleResponse'
Fields rule :: Maybe RateBasedRule The RateBasedRule that is returned in the `CreateRateBasedRule` response. changeToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateRateBasedRuleResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods (==) :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool # (/=) :: CreateRateBasedRuleResponse -> CreateRateBasedRuleResponse -> Bool #
Read CreateRateBasedRuleResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods readsPrec :: Int -> ReadS CreateRateBasedRuleResponse # readList :: ReadS [CreateRateBasedRuleResponse] # readPrec :: ReadPrec CreateRateBasedRuleResponse # readListPrec :: ReadPrec [CreateRateBasedRuleResponse] #
Show CreateRateBasedRuleResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods showsPrec :: Int -> CreateRateBasedRuleResponse -> ShowS # show :: CreateRateBasedRuleResponse -> String # showList :: [CreateRateBasedRuleResponse] -> ShowS #
Generic CreateRateBasedRuleResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Associated Types type Rep CreateRateBasedRuleResponse :: Type -> Type # Methods from :: CreateRateBasedRuleResponse -> Rep CreateRateBasedRuleResponse x # to :: Rep CreateRateBasedRuleResponse x -> CreateRateBasedRuleResponse #
NFData CreateRateBasedRuleResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule Methods rnf :: CreateRateBasedRuleResponse -> () #
type Rep CreateRateBasedRuleResponse Source #
Instance details Defined in Amazonka.WAFRegional.CreateRateBasedRule type Rep CreateRateBasedRuleResponse = D1 ('MetaData "CreateRateBasedRuleResponse" "Amazonka.WAFRegional.CreateRateBasedRule" "libZSservicesZSamazonka-waf-regionalZSamazonka-waf-regional" 'False) (C1 ('MetaCons "CreateRateBasedRuleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RateBasedRule)) :: (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateRateBasedRuleResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateRateBasedRuleResponse'`
-> CreateRateBasedRuleResponse

Create a value of CreateRateBasedRuleResponse 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:rule:CreateRateBasedRuleResponse', createRateBasedRuleResponse_rule - The RateBasedRule that is returned in the CreateRateBasedRule response.

$sel:changeToken:CreateRateBasedRule', createRateBasedRuleResponse_changeToken - 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.

$sel:httpStatus:CreateRateBasedRuleResponse', createRateBasedRuleResponse_httpStatus - The response's http status code.

Response Lenses

createRateBasedRuleResponse_rule :: Lens' CreateRateBasedRuleResponse (Maybe RateBasedRule) Source #

The RateBasedRule that is returned in the CreateRateBasedRule response.

createRateBasedRuleResponse_changeToken :: Lens' CreateRateBasedRuleResponse (Maybe Text) Source #

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.

createRateBasedRuleResponse_httpStatus :: Lens' CreateRateBasedRuleResponse Int Source #

The response's http status code.