| 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.UpdateRateBasedRule
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.
Inserts or deletes Predicate objects in a rule and updates the
RateLimit in the rule.
Each Predicate object identifies a predicate, such as a ByteMatchSet
or an IPSet, that specifies the web requests that you want to block or
count. The RateLimit specifies the number of requests every five
minutes that triggers the rule.
If you add more than one predicate to a RateBasedRule, a request must
match all the predicates and exceed the RateLimit to be counted or
blocked. For example, suppose you add the following to a
RateBasedRule:
- An
IPSetthat matches the IP address192.0.2.44/32 - A
ByteMatchSetthat matchesBadBotin theUser-Agentheader
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 satisfy 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 much be received at a rate of more than 1,000
every five minutes. If the rate drops below this limit, 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
ByteMatchSetwithFieldToMatchofURI - A
PositionalConstraintofSTARTS_WITH - A
TargetStringoflogin
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.
Synopsis
- data UpdateRateBasedRule = UpdateRateBasedRule' {
- ruleId :: Text
- changeToken :: Text
- updates :: [RuleUpdate]
- rateLimit :: Natural
- newUpdateRateBasedRule :: Text -> Text -> Natural -> UpdateRateBasedRule
- updateRateBasedRule_ruleId :: Lens' UpdateRateBasedRule Text
- updateRateBasedRule_changeToken :: Lens' UpdateRateBasedRule Text
- updateRateBasedRule_updates :: Lens' UpdateRateBasedRule [RuleUpdate]
- updateRateBasedRule_rateLimit :: Lens' UpdateRateBasedRule Natural
- data UpdateRateBasedRuleResponse = UpdateRateBasedRuleResponse' {
- changeToken :: Maybe Text
- httpStatus :: Int
- newUpdateRateBasedRuleResponse :: Int -> UpdateRateBasedRuleResponse
- updateRateBasedRuleResponse_changeToken :: Lens' UpdateRateBasedRuleResponse (Maybe Text)
- updateRateBasedRuleResponse_httpStatus :: Lens' UpdateRateBasedRuleResponse Int
Creating a Request
data UpdateRateBasedRule Source #
See: newUpdateRateBasedRule smart constructor.
Constructors
| UpdateRateBasedRule' | |
Fields
| |
Instances
newUpdateRateBasedRule Source #
Arguments
| :: Text | |
| -> Text | |
| -> Natural | |
| -> UpdateRateBasedRule |
Create a value of UpdateRateBasedRule 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:ruleId:UpdateRateBasedRule', updateRateBasedRule_ruleId - The RuleId of the RateBasedRule that you want to update. RuleId is
returned by CreateRateBasedRule and by ListRateBasedRules.
$sel:changeToken:UpdateRateBasedRule', updateRateBasedRule_changeToken - The value returned by the most recent call to GetChangeToken.
$sel:updates:UpdateRateBasedRule', updateRateBasedRule_updates - An array of RuleUpdate objects that you want to insert into or delete
from a RateBasedRule.
$sel:rateLimit:UpdateRateBasedRule', updateRateBasedRule_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.
Request Lenses
updateRateBasedRule_ruleId :: Lens' UpdateRateBasedRule Text Source #
The RuleId of the RateBasedRule that you want to update. RuleId is
returned by CreateRateBasedRule and by ListRateBasedRules.
updateRateBasedRule_changeToken :: Lens' UpdateRateBasedRule Text Source #
The value returned by the most recent call to GetChangeToken.
updateRateBasedRule_updates :: Lens' UpdateRateBasedRule [RuleUpdate] Source #
An array of RuleUpdate objects that you want to insert into or delete
from a RateBasedRule.
updateRateBasedRule_rateLimit :: Lens' UpdateRateBasedRule 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.
Destructuring the Response
data UpdateRateBasedRuleResponse Source #
See: newUpdateRateBasedRuleResponse smart constructor.
Constructors
| UpdateRateBasedRuleResponse' | |
Fields
| |
Instances
newUpdateRateBasedRuleResponse Source #
Create a value of UpdateRateBasedRuleResponse 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:changeToken:UpdateRateBasedRule', updateRateBasedRuleResponse_changeToken - The ChangeToken that you used to submit the UpdateRateBasedRule
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
$sel:httpStatus:UpdateRateBasedRuleResponse', updateRateBasedRuleResponse_httpStatus - The response's http status code.
Response Lenses
updateRateBasedRuleResponse_changeToken :: Lens' UpdateRateBasedRuleResponse (Maybe Text) Source #
The ChangeToken that you used to submit the UpdateRateBasedRule
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.
updateRateBasedRuleResponse_httpStatus :: Lens' UpdateRateBasedRuleResponse Int Source #
The response's http status code.