Skip to content

CreateRuleOutput

Source code in docs_src/capo_network_security_manager/types/create_rule_output.py
class CreateRuleOutput(TypedDict, closed=True):
    rule_id: "capo_network_security_manager.types.rule_id.RuleId"
    """<p>The service-generated id of the rule.</p>"""
    rule_arn: "capo_network_security_manager.types.rule_arn.RuleArn"
    """<p>The Amazon Resource Name (ARN) of the rule.</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: NotRequired["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.</p>"""
    status: "capo_network_security_manager.types.entity_status.EntityStatus"
    """<p>The current status of the resource: <code>DRAFT</code> (unpublished, editable) or <code>ACTIVE</code> (published, in use).</p>"""
    version: "capo_network_security_manager.types.entity_version.EntityVersion"
    """<p>The version of the resource.</p>"""
    update_token: NotRequired[
        "capo_network_security_manager.types.update_token.UpdateToken"
    ]
    """<p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>"""
    is_snapshot: NotRequired[
        "capo_network_security_manager.types.is_snapshot.IsSnapshot"
    ]
    """<p>Specifies whether the resource is a snapshot of a published version.</p>"""
    has_published_version: NotRequired[
        "capo_network_security_manager.types.has_published_version.HasPublishedVersion"
    ]
    """<p>Specifies whether a published version of the resource exists.</p>"""
    updated_at: NotRequired[
        "capo_network_security_manager.types.date_timestamp.DateTimestamp"
    ]
    """<p>The time when the resource was last updated.</p>"""

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.

firewall_type instance-attribute

firewall_type: RuleFirewallType

The firewall type associated with the resource.

has_published_version instance-attribute

has_published_version: NotRequired[HasPublishedVersion]

Specifies whether a published version of the resource exists.

is_snapshot instance-attribute

is_snapshot: NotRequired[IsSnapshot]

Specifies whether the resource is a snapshot of a published version.

rule_arn instance-attribute

rule_arn: RuleArn

The Amazon Resource Name (ARN) of the rule.

rule_description instance-attribute

rule_description: NotRequired[Description]

A description of the rule.

rule_id instance-attribute

rule_id: RuleId

The service-generated id of the rule.

rule_name instance-attribute

rule_name: RuleName

The name of the rule.

rule_type instance-attribute

rule_type: NotRequired[RuleType]

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

status instance-attribute

status: EntityStatus

The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

update_token instance-attribute

update_token: NotRequired[UpdateToken]

A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

updated_at instance-attribute

updated_at: NotRequired[DateTimestamp]

The time when the resource was last updated.

version instance-attribute

version: EntityVersion

The version of the resource.