RuleActionOverride - Amazon WAFV2
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).

RuleActionOverride

Action setting to use in the place of a rule action that is 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.

Contents

ActionToUse

The override action to use, in place of the configured action of the rule in the rule group.

Type: RuleAction object

Required: Yes

Name

The name of the rule to override.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[\w\-]+$

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: