Rule
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.
A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you
want to allow, block, or count. For example, you might create a Rule
that includes the following predicates:
-
An
IPSet
that causes AWS WAF to search for web requests that originate from the IP address192.0.2.44
-
A
ByteMatchSet
that causes AWS WAF to search for web requests for which the value of theUser-Agent
header isBadBot
.
To match the settings in this Rule
, a request must originate from 192.0.2.44
AND include a User-Agent
header for which the value is BadBot
.
Contents
- Predicates
-
The
Predicates
object contains onePredicate
element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in aRule
.Type: Array of Predicate objects
Required: Yes
- RuleId
-
A unique identifier for a
Rule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
from AWS WAF (see DeleteRule).RuleId
is returned by CreateRule and by ListRules.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: Yes
- MetricName
-
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 changeMetricName
after you create theRule
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: No
- Name
-
The friendly name or description for the
Rule
. You can't change the name of aRule
after you create it.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: