[ aws . waf-regional ]
Note
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 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 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 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.
See also: AWS API Documentation
update-rate-based-rule
--rule-id <value>
--change-token <value>
--updates <value>
--rate-limit <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--rule-id
(string)
The
RuleId
of theRateBasedRule
that you want to update.RuleId
is returned byCreateRateBasedRule
and by ListRateBasedRules .
--change-token
(string)
The value returned by the most recent call to GetChangeToken .
--updates
(list)
An array of
RuleUpdate
objects that you want to insert into or delete from a RateBasedRule .(structure)
Note
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.
Specifies a
Predicate
(such as anIPSet
) and indicates whether you want to add it to aRule
or delete it from aRule
.Action -> (string)
Specify
INSERT
to add aPredicate
to aRule
. UseDELETE
to remove aPredicate
from aRule
.Predicate -> (structure)
The ID of the
Predicate
(such as anIPSet
) that you want to add to aRule
.Negated -> (boolean)
Set
Negated
toFalse
if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , or SizeConstraintSet . For example, if anIPSet
includes the IP address192.0.2.44
, AWS WAF will allow or block requests based on that IP address.Set
Negated
toTrue
if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , or SizeConstraintSet . For example, if anIPSet
includes the IP address192.0.2.44
, AWS WAF will allow, block, or count requests based on all IP addresses except192.0.2.44
.Type -> (string)
The type of predicate in a
Rule
, such asByteMatch
orIPSet
.DataId -> (string)
A unique identifier for a predicate in a
Rule
, such asByteMatchSetId
orIPSetId
. The ID is returned by the correspondingCreate
orList
command.Shorthand Syntax:
Action=string,Predicate={Negated=boolean,Type=string,DataId=string} ...JSON Syntax:
[ { "Action": "INSERT"|"DELETE", "Predicate": { "Negated": true|false, "Type": "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch", "DataId": "string" } } ... ]
--rate-limit
(long)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 theRateLimit
and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Output¶
ChangeToken -> (string)
The
ChangeToken
that you used to submit theUpdateRateBasedRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus .