AWS::WAFv2::WebACL RuleGroupReferenceStatement - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::WAFv2::WebACL RuleGroupReferenceStatement

A rule statement used to run the rules that are defined in a AWS::WAFv2::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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Arn" : String,
  "ExcludedRules" : [ ExcludedRule, ... ],
  "RuleActionOverrides" : [ RuleActionOverride, ... ]
}

Properties

Arn

The Amazon Resource Name (ARN) of the entity.

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: No interruption

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, including Count.

Required: No

Type: Array of ExcludedRule

Maximum: 100

Update requires: No interruption

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

Verify the rule names in your overrides carefully. With managed rule groups, Amazon WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

You can use overrides for testing, for example you can override all of rule actions to Count and 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.

Required: No

Type: Array of RuleActionOverride

Maximum: 100

Update requires: No interruption