Skip to content

CreatePolicySnapshotOutput

Source code in docs_src/capo_network_security_manager/types/create_policy_snapshot_output.py
class CreatePolicySnapshotOutput(TypedDict, closed=True):
    policy_id: "capo_network_security_manager.types.policy_id.PolicyId"
    """<p>The service-generated id of the policy.</p>"""
    policy_arn: "capo_network_security_manager.types.policy_arn.PolicyArn"
    """<p>The Amazon Resource Name (ARN) of the policy.</p>"""
    policy_name: "capo_network_security_manager.types.policy_name.PolicyName"
    """<p>The name of the policy.</p>"""
    policy_description: NotRequired[
        "capo_network_security_manager.types.description.Description"
    ]
    """<p>A description of the policy.</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>"""
    priority: "capo_network_security_manager.types.priority.Priority"
    """<p>The priority of the resource. A lower number indicates a higher priority.</p>"""
    associated_template_and_rule_list: "capo_network_security_manager.types.associated_template_and_rule_list.AssociatedTemplateAndRuleList"
    """<p>The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.</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>"""
    firewall_type: (
        "capo_network_security_manager.types.policy_firewall_type.PolicyFirewallType"
    )
    """<p>The firewall type associated with the resource.</p>"""
    policy_configuration: NotRequired[
        "capo_network_security_manager.types.policy_configuration.PolicyConfiguration"
    ]
    """<p>The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.</p>"""
    updated_at: NotRequired[
        "capo_network_security_manager.types.date_timestamp.DateTimestamp"
    ]
    """<p>The time when the snapshot was created.</p>"""

associated_template_and_rule_list instance-attribute

associated_template_and_rule_list: AssociatedTemplateAndRuleList

The templates and rules associated with the policy. For AWS WAF policies, this list contains 1 to 100 templates or rules, of which at most 2 can be templates. For AWS Shield Advanced policies, this list is empty.

firewall_type instance-attribute

firewall_type: PolicyFirewallType

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.

policy_arn instance-attribute

policy_arn: PolicyArn

The Amazon Resource Name (ARN) of the policy.

policy_configuration instance-attribute

policy_configuration: NotRequired[PolicyConfiguration]

The configuration settings that control the policy's behavior, including remediation and firewall-type-specific settings.

policy_description instance-attribute

policy_description: NotRequired[Description]

A description of the policy.

policy_id instance-attribute

policy_id: PolicyId

The service-generated id of the policy.

policy_name instance-attribute

policy_name: PolicyName

The name of the policy.

priority instance-attribute

priority: Priority

The priority of the resource. A lower number indicates a higher priority.

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 snapshot was created.

version instance-attribute

version: EntityVersion

The version of the resource.