Skip to content

CreateRuleInput

Source code in docs_src/capo_network_security_manager/types/create_rule_input.py
class CreateRuleInput(TypedDict, closed=True):
    client_token: NotRequired[
        "capo_network_security_manager.types.idempotency_token.IdempotencyToken"
    ]
    """<p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>"""
    rule_name: "capo_network_security_manager.types.rule_name.RuleName"
    """<p>The name of the rule.</p>"""
    firewall_type: (
        "capo_network_security_manager.types.rule_firewall_type.RuleFirewallType"
    )
    """<p>The firewall type associated with the resource.</p>"""
    rule_type: "capo_network_security_manager.types.rule_type.RuleType"
    """<p>The type of the rule. <code>CONFIGURATION</code> rules contain firewall settings, and <code>INSPECTION</code> rules contain rule groups.</p>"""
    rule_description: NotRequired[
        "capo_network_security_manager.types.description.Description"
    ]
    """<p>A description of the rule.</p>"""
    configuration: "capo_network_security_manager.types.json_document.JsonDocument"
    """<p>The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF <code>INSPECTION</code> rule, provide an AWS WAF rule group. For an AWS WAF <code>CONFIGURATION</code> rule, provide a single web ACL setting, such as <code>DefaultAction</code> or <code>VisibilityConfig</code>; use <code>wafConfigDataType</code> to declare which setting the document contains. For the schema of each setting and complete examples, see <a href="https://docs.aws.amazon.com/network-security-manager/latest/devguide/what-is.html">Writing rule configurations</a> in the <i>AWS Network Security Manager Developer Guide</i>.</p>"""
    is_published: "capo_network_security_manager.types.is_published.IsPublished"
    """<p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>"""
    tags: NotRequired["capo_network_security_manager.types.tag_map.TagMap"]
    """<p>The tags to add to the resource when it is created.</p>"""

client_token instance-attribute

client_token: NotRequired[IdempotencyToken]

A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

configuration instance-attribute

configuration: JsonDocument

The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type. For an AWS WAF INSPECTION rule, provide an AWS WAF rule group. For an AWS WAF CONFIGURATION rule, provide a single web ACL setting, such as DefaultAction or VisibilityConfig; use wafConfigDataType to declare which setting the document contains. For the schema of each setting and complete examples, see Writing rule configurations in the AWS Network Security Manager Developer Guide.

firewall_type instance-attribute

firewall_type: RuleFirewallType

The firewall type associated with the resource.

is_published instance-attribute

is_published: IsPublished

Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.

rule_description instance-attribute

rule_description: NotRequired[Description]

A description of the rule.

rule_name instance-attribute

rule_name: RuleName

The name of the rule.

rule_type instance-attribute

rule_type: RuleType

The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to add to the resource when it is created.