Skip to content

DescribeRuleGroupRequest

Source code in docs_src/capo_network_firewall/types/describe_rule_group_request.py 
14
15
16
17
18
19
20
21
22
23
24
class DescribeRuleGroupRequest(TypedDict, closed=True):
    rule_group_name: NotRequired[
        "capo_network_firewall.types.resource_name.ResourceName"
    ]
    """<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"""
    rule_group_arn: NotRequired["capo_network_firewall.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>"""
    type: NotRequired["capo_network_firewall.types.rule_group_type.RuleGroupType"]
    """<p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules. </p> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>"""
    analyze_rule_group: "capo_network_firewall.types.boolean.Boolean"
    """<p>Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to <code>TRUE</code>, Network Firewall runs the analysis.</p>"""

analyze_rule_group instance-attribute 

analyze_rule_group: Boolean

Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior such as asymmetric routing. If set to TRUE, Network Firewall runs the analysis.

rule_group_arn instance-attribute 

rule_group_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the rule group.

You must specify the ARN or the name, and you can specify both.

rule_group_name instance-attribute 

rule_group_name: NotRequired[ResourceName]

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

You must specify the ARN or the name, and you can specify both.

type instance-attribute 

type: NotRequired[RuleGroupType]

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

This setting is required for requests that do not include the RuleGroupARN.