Skip to content

RuleGroupReferenceStatement

Source code in docs_src/capo_wafv2/types/rule_group_reference_statement.py 
15
16
17
18
19
20
21
22
23
class RuleGroupReferenceStatement(TypedDict, closed=True):
    arn: "capo_wafv2.types.resource_arn.ResourceArn"
    """<p>The Amazon Resource Name (ARN) of the entity.</p>"""
    excluded_rules: NotRequired["capo_wafv2.types.excluded_rules.ExcludedRules"]
    """<p>Rules in the referenced rule group whose actions are set to <code>Count</code>. </p> <note> <p>Instead of this option, use <code>RuleActionOverrides</code>. It accepts any valid action setting, including <code>Count</code>.</p> </note>"""
    rule_action_overrides: NotRequired[
        "capo_wafv2.types.rule_action_overrides.RuleActionOverrides"
    ]
    """<p>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. </p> <note> <p>Verify the rule names in your overrides carefully. With managed rule groups, 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.</p> </note> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> 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.</p>"""

arn instance-attribute 

arn: ResourceArn

The Amazon Resource Name (ARN) of the entity.

excluded_rules instance-attribute 

excluded_rules: NotRequired[ExcludedRules]

Rules in the referenced rule group whose actions are set to Count.

Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count.

rule_action_overrides instance-attribute 

rule_action_overrides: NotRequired[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.

Verify the rule names in your overrides carefully. With managed rule groups, 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.