Values.CreateRateBasedRuleResponseSourceThis 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.
type nonrec t = {rule : RateBasedRule.t option;The RateBasedRule that is returned in the CreateRateBasedRule response.
*)changeToken : ChangeToken.t option;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.
*)}type nonrec error = [ | `WAFBadRequestException of WAFBadRequestException.t| `WAFDisallowedNameException of WAFDisallowedNameException.t| `WAFInternalErrorException of WAFInternalErrorException.t| `WAFInvalidParameterException of WAFInvalidParameterException.t| `WAFLimitsExceededException of WAFLimitsExceededException.t| `WAFStaleDataException of WAFStaleDataException.t| `WAFTagOperationException of WAFTagOperationException.t| `WAFTagOperationInternalErrorException of
WAFTagOperationInternalErrorException.t| `Unknown_operation_error of string * string option ]val error_of_json :
string ->
Yojson.Safe.t ->
[> `Unknown_operation_error of string * string option
| `WAFBadRequestException of WAFBadRequestException.t
| `WAFDisallowedNameException of WAFDisallowedNameException.t
| `WAFInternalErrorException of WAFInternalErrorException.t
| `WAFInvalidParameterException of WAFInvalidParameterException.t
| `WAFLimitsExceededException of WAFLimitsExceededException.t
| `WAFStaleDataException of WAFStaleDataException.t
| `WAFTagOperationException of WAFTagOperationException.t
| `WAFTagOperationInternalErrorException of
WAFTagOperationInternalErrorException.t ]val error_of_xml :
string ->
Awso.Xml.t ->
[> `Unknown_operation_error of string * string option
| `WAFBadRequestException of WAFBadRequestException.t
| `WAFDisallowedNameException of WAFDisallowedNameException.t
| `WAFInternalErrorException of WAFInternalErrorException.t
| `WAFInvalidParameterException of WAFInvalidParameterException.t
| `WAFLimitsExceededException of WAFLimitsExceededException.t
| `WAFStaleDataException of WAFStaleDataException.t
| `WAFTagOperationException of WAFTagOperationException.t
| `WAFTagOperationInternalErrorException of
WAFTagOperationInternalErrorException.t ]val to_value :
t ->
[> `Structure of
(string
* [> `String of ChangeToken.t
| `Structure of
(string
* [> `Enum of string
| `List of
[> `Structure of
(string
* [> `Boolean of Negated.t
| `Enum of string
| `String of ResourceId.t ])
list ]
list
| `Long of RateLimit.t
| `String of ResourceId.t ])
list ])
list ]