Create Rule
waf_create_rule | R Documentation |
This is AWS WAF Classic documentation¶
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 Rule
, which contains the IPSet
objects, ByteMatchSet
objects, and other predicates that identify the requests that you want
to block. If you add more than one predicate to a Rule
, a request must
match all of the specifications to be allowed or blocked. For example,
suppose that you add the following to a Rule
:
-
An
IPSet
that matches the IP address192.0.2.44/32
-
A
ByteMatchSet
that matchesBadBot
in theUser-Agent
header
You then add the Rule
to a WebACL
and specify that you want to
blocks 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
.
To create and configure a Rule
, perform the following steps:
-
Create and update the predicates that you want to include in the
Rule
. For more information, seecreate_byte_match_set
,create_ip_set
, andcreate_sql_injection_match_set
. -
Use
get_change_token
to get the change token that you provide in theChangeToken
parameter of acreate_rule
request. -
Submit a
create_rule
request. -
Use
get_change_token
to get the change token that you provide in theChangeToken
parameter of anupdate_rule
request. -
Submit an
update_rule
request to specify the predicates that you want to include in theRule
. -
Create and update a
WebACL
that contains theRule
. For more information, seecreate_web_acl
.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
Usage¶
Arguments¶
Name
[required] A friendly name or description of the Rule. You can't change the name of a
Rule
after you create it.MetricName
[required] A friendly name or description for the metrics for this
Rule
. 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 theRule
.ChangeToken
[required] The value returned by the most recent call to
get_change_token
.Tags
Value¶
A list with the following syntax:
list(
Rule = list(
RuleId = "string",
Name = "string",
MetricName = "string",
Predicates = list(
list(
Negated = TRUE|FALSE,
Type = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch",
DataId = "string"
)
)
),
ChangeToken = "string"
)
Request syntax¶
svc$create_rule(
Name = "string",
MetricName = "string",
ChangeToken = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
Examples¶
## Not run:
# The following example creates a rule named WAFByteHeaderRule.
svc$create_rule(
ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
MetricName = "WAFByteHeaderRule",
Name = "WAFByteHeaderRule"
)
## End(Not run)