RuleGroup
Note
AWS WAF Classic support will end on September 30, 2025.
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 collection of predefined rules that you can add to a web ACL.
Rule groups are subject to the following limits:
-
Three rule groups per account. You can request an increase to this limit by contacting customer support.
-
One rule group per web ACL.
-
Ten rules per rule group.
Contents
- RuleGroupId
-
A unique identifier for a
RuleGroup. You useRuleGroupIdto get more information about aRuleGroup(see GetRuleGroup), update aRuleGroup(see UpdateRuleGroup), insert aRuleGroupinto aWebACLor delete a one from aWebACL(see UpdateWebACL), or delete aRuleGroupfrom AWS WAF (see DeleteRuleGroup).RuleGroupIdis returned by CreateRuleGroup and by ListRuleGroups.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
RuleGroup. 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 theRuleGroup.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
- Name
-
The friendly name or description for the
RuleGroup. You can't change the name of aRuleGroupafter 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:
