RuleGroupReferenceStatement
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group
reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
Contents
- ARN
-
The Amazon Resource Name (ARN) of the entity.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
.*\S.*Required: Yes
- ExcludedRules
-
Rules in the referenced rule group whose actions are set to
Count.Note
Instead of this option, use
RuleActionOverrides. It accepts any valid action setting, includingCount.Type: Array of ExcludedRule objects
Array Members: Maximum number of 100 items.
Required: No
- RuleActionOverrides
-
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
Note
Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting.
You can use overrides for testing, for example you can override all of rule actions to
Countand then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.Type: Array of RuleActionOverride objects
Array Members: Maximum number of 100 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
