AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to CreateRateBasedRuleAsync.
Namespace: Amazon.WAFRegional
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z
public abstract CreateRateBasedRuleResponse CreateRateBasedRule( CreateRateBasedRuleRequest request )
Container for the necessary parameters to execute the CreateRateBasedRule service method.
| Exception | Condition |
|---|---|
| WAFBadRequestException | |
| WAFDisallowedNameException | The name specified is invalid. |
| WAFInternalErrorException | The operation failed because of a system problem, even though the request was valid. Retry your request. |
| WAFInvalidParameterException | The operation failed because AWS WAF didn't recognize a parameter in the request. For example: You specified an invalid parameter name. You specified an invalid value. You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. You tried to create a WebACL with a DefaultActionType other than ALLOW, BLOCK, or COUNT. You tried to create a RateBasedRule with a RateKey value other than IP. You tried to update a WebACL with a WafActionType other than ALLOW, BLOCK, or COUNT. You tried to update a ByteMatchSet with a FieldToMatchType other than HEADER, METHOD, QUERY_STRING, URI, or BODY. You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. |
| WAFLimitsExceededException | The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide. |
| WAFStaleDataException | The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. |
| WAFTagOperationException | |
| WAFTagOperationInternalErrorException |
.NET Framework:
Supported in: 4.5, 4.0, 3.5