Skip to content

AwsWafWebAclRule

Source code in docs_src/capo_securityhub/types/aws_waf_web_acl_rule.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class AwsWafWebAclRule(TypedDict, closed=True):
    action: NotRequired["capo_securityhub.types.waf_action.WafAction"]
    """<p>Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule. </p>"""
    excluded_rules: NotRequired[
        "capo_securityhub.types.waf_excluded_rule_list.WafExcludedRuleList"
    ]
    """<p>Rules to exclude from a rule group.</p>"""
    override_action: NotRequired[
        "capo_securityhub.types.waf_override_action.WafOverrideAction"
    ]
    """<p>Use the <code>OverrideAction</code> to test your <code>RuleGroup</code>.</p> <p>Any rule in a <code>RuleGroup</code> can potentially block a request. If you set the <code>OverrideAction</code> to <code>None</code>, the <code>RuleGroup</code> blocks a request if any individual rule in the <code>RuleGroup</code> matches the request and is configured to block that request.</p> <p>However, if you first want to test the <code>RuleGroup</code>, set the <code>OverrideAction</code> to <code>Count</code>. The <code>RuleGroup</code> then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.</p> <p> <code>ActivatedRule</code>|<code>OverrideAction</code> applies only when updating or adding a <code>RuleGroup</code> to a web ACL. In this case you don't use <code>ActivatedRule</code> <code>Action</code>. For all other update requests, <code>ActivatedRule</code> <code>Action</code> is used instead of <code>ActivatedRule</code> <code>OverrideAction</code>.</p>"""
    priority: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for <code>Priority</code> are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values don't need to be consecutive.</p>"""
    rule_id: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The identifier for a rule.</p>"""
    type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The rule type.</p> <p>Valid values: <code>REGULAR</code> | <code>RATE_BASED</code> | <code>GROUP</code> </p> <p>The default is <code>REGULAR</code>.</p>"""

action instance-attribute 

action: NotRequired[WafAction]

Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.

excluded_rules instance-attribute 

excluded_rules: NotRequired[WafExcludedRuleList]

Rules to exclude from a rule group.

override_action instance-attribute 

override_action: NotRequired[WafOverrideAction]

Use the OverrideAction to test your RuleGroup.

Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request.

However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted.

ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you don't use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.

priority instance-attribute 

priority: NotRequired[Integer]

Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values don't need to be consecutive.

rule_id instance-attribute 

rule_id: NotRequired[NonEmptyString]

The identifier for a rule.

type instance-attribute 

type: NotRequired[NonEmptyString]

The rule type.

Valid values: REGULAR | RATE_BASED | GROUP

The default is REGULAR.