Skip to content

ChangeSetSummary

Source code in docs_src/capo_cloudformation/types/change_set_summary.py
class ChangeSetSummary(TypedDict, closed=True):
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The ID of the stack with which the change set is associated.</p>"""
    stack_name: NotRequired["capo_cloudformation.types.stack_name.StackName"]
    """<p>The name of the stack with which the change set is associated.</p>"""
    change_set_id: NotRequired["capo_cloudformation.types.change_set_id.ChangeSetId"]
    """<p>The ID of the change set.</p>"""
    change_set_name: NotRequired[
        "capo_cloudformation.types.change_set_name.ChangeSetName"
    ]
    """<p>The name of the change set.</p>"""
    execution_status: NotRequired[
        "capo_cloudformation.types.execution_status.ExecutionStatus"
    ]
    """<p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>"""
    status: NotRequired["capo_cloudformation.types.change_set_status.ChangeSetStatus"]
    """<p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>"""
    status_reason: NotRequired[
        "capo_cloudformation.types.change_set_status_reason.ChangeSetStatusReason"
    ]
    """<p>A description of the change set's status. For example, if your change set is in the <code>FAILED</code> state, CloudFormation shows the error message.</p>"""
    creation_time: NotRequired["capo_cloudformation.types.creation_time.CreationTime"]
    """<p>The start time when the change set was created, in UTC.</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>Descriptive information about the change set.</p>"""
    include_nested_stacks: NotRequired[
        "capo_cloudformation.types.include_nested_stacks.IncludeNestedStacks"
    ]
    """<p>Specifies the current setting of <code>IncludeNestedStacks</code> for the change set.</p>"""
    parent_change_set_id: NotRequired[
        "capo_cloudformation.types.change_set_id.ChangeSetId"
    ]
    """<p>The parent change set ID.</p>"""
    root_change_set_id: NotRequired[
        "capo_cloudformation.types.change_set_id.ChangeSetId"
    ]
    """<p>The root change set ID.</p>"""
    import_existing_resources: NotRequired[
        "capo_cloudformation.types.import_existing_resources.ImportExistingResources"
    ]
    """<p>Indicates if the change set imports resources that already exist.</p>"""

change_set_id instance-attribute

change_set_id: NotRequired[ChangeSetId]

The ID of the change set.

change_set_name instance-attribute

change_set_name: NotRequired[ChangeSetName]

The name of the change set.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The start time when the change set was created, in UTC.

description instance-attribute

description: NotRequired[Description]

Descriptive information about the change set.

execution_status instance-attribute

execution_status: NotRequired[ExecutionStatus]

If the change set execution status is AVAILABLE, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

import_existing_resources instance-attribute

import_existing_resources: NotRequired[ImportExistingResources]

Indicates if the change set imports resources that already exist.

include_nested_stacks instance-attribute

include_nested_stacks: NotRequired[IncludeNestedStacks]

Specifies the current setting of IncludeNestedStacks for the change set.

parent_change_set_id instance-attribute

parent_change_set_id: NotRequired[ChangeSetId]

The parent change set ID.

root_change_set_id instance-attribute

root_change_set_id: NotRequired[ChangeSetId]

The root change set ID.

stack_id instance-attribute

stack_id: NotRequired[StackId]

The ID of the stack with which the change set is associated.

stack_name instance-attribute

stack_name: NotRequired[StackName]

The name of the stack with which the change set is associated.

status instance-attribute

status: NotRequired[ChangeSetStatus]

The state of the change set, such as CREATE_PENDING, CREATE_COMPLETE, or FAILED.

status_reason instance-attribute

status_reason: NotRequired[ChangeSetStatusReason]

A description of the change set's status. For example, if your change set is in the FAILED state, CloudFormation shows the error message.