Skip to content

DescribeChangeSetOutput

Source code in docs_src/capo_cloudformation/types/describe_change_set_output.py
class DescribeChangeSetOutput(TypedDict, closed=True):
    change_set_name: NotRequired[
        "capo_cloudformation.types.change_set_name.ChangeSetName"
    ]
    """<p>The name of the change set.</p>"""
    change_set_id: NotRequired["capo_cloudformation.types.change_set_id.ChangeSetId"]
    """<p>The Amazon Resource Name (ARN) of the change set.</p>"""
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The Amazon Resource Name (ARN) of the stack that's associated with the change set.</p>"""
    stack_name: NotRequired["capo_cloudformation.types.stack_name.StackName"]
    """<p>The name of the stack that's associated with the change set.</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>Information about the change set.</p>"""
    parameters: NotRequired["capo_cloudformation.types.parameters.Parameters"]
    """<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</p>"""
    creation_time: NotRequired["capo_cloudformation.types.creation_time.CreationTime"]
    """<p>The start time when the change set was created, in UTC.</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 current status 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 attempt to create a change set failed, CloudFormation shows the error message.</p>"""
    stack_drift_status: NotRequired[
        "capo_cloudformation.types.stack_drift_status.StackDriftStatus"
    ]
    """<p>The drift status of the stack when the change set was created. Valid values:</p> <ul> <li> <p> <code>DRIFTED</code> – The stack has drifted from its last deployment.</p> </li> <li> <p> <code>IN_SYNC</code> – The stack is in sync with its last deployment.</p> </li> <li> <p> <code>NOT_CHECKED</code> – CloudFormation doesn’t currently return this value.</p> </li> <li> <p> <code>UNKNOWN</code> – The drift status could not be determined.</p> </li> </ul> <p>Only present for drift-aware change sets.</p>"""
    notification_ar_ns: NotRequired[
        "capo_cloudformation.types.notification_ar_ns.NotificationARNs"
    ]
    """<p>The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.</p>"""
    rollback_configuration: NotRequired[
        "capo_cloudformation.types.rollback_configuration.RollbackConfiguration"
    ]
    """<p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>"""
    capabilities: NotRequired["capo_cloudformation.types.capabilities.Capabilities"]
    """<p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>"""
    tags: NotRequired["capo_cloudformation.types.tags.Tags"]
    """<p>If you execute the change set, the tags that will be associated with the stack.</p>"""
    changes: NotRequired["capo_cloudformation.types.changes.Changes"]
    """<p>A list of <code>Change</code> structures that describes the resources CloudFormation changes if you execute the change set.</p>"""
    next_token: NotRequired["capo_cloudformation.types.next_token.NextToken"]
    """<p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.</p>"""
    include_nested_stacks: NotRequired[
        "capo_cloudformation.types.include_nested_stacks.IncludeNestedStacks"
    ]
    """<p>Verifies if <code>IncludeNestedStacks</code> is set to <code>True</code>.</p>"""
    parent_change_set_id: NotRequired[
        "capo_cloudformation.types.change_set_id.ChangeSetId"
    ]
    """<p>Specifies the change set ID of the parent change set in the current nested change set hierarchy.</p>"""
    root_change_set_id: NotRequired[
        "capo_cloudformation.types.change_set_id.ChangeSetId"
    ]
    """<p>Specifies the change set ID of the root change set in the current nested change set hierarchy.</p>"""
    on_stack_failure: NotRequired[
        "capo_cloudformation.types.on_stack_failure.OnStackFailure"
    ]
    """<p>Determines what action will be taken if stack creation fails. When this parameter is specified, the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation must not be specified. This must be one of these values:</p> <ul> <li> <p> <code>DELETE</code> - Deletes the change set if the stack creation fails. This is only valid when the <code>ChangeSetType</code> parameter is set to <code>CREATE</code>. If the deletion of the stack fails, the status of the stack is <code>DELETE_FAILED</code>.</p> </li> <li> <p> <code>DO_NOTHING</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>true</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p> </li> <li> <p> <code>ROLLBACK</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>false</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p> </li> </ul>"""
    import_existing_resources: NotRequired[
        "capo_cloudformation.types.import_existing_resources.ImportExistingResources"
    ]
    """<p>Indicates if the change set imports resources that already exist.</p> <note> <p>This parameter can only import resources that have <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-name.html">custom names</a> in templates. To import resources that do not accept custom names, such as EC2 instances, use the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html">resource import</a> feature instead.</p> </note>"""
    deployment_mode: NotRequired[
        "capo_cloudformation.types.deployment_mode.DeploymentMode"
    ]
    """<p>The deployment mode specified when the change set was created. Valid value is <code>REVERT_DRIFT</code>. Only present for drift-aware change sets.</p>"""
    deployment_config: NotRequired[
        "capo_cloudformation.types.deployment_config.DeploymentConfig"
    ]
    """<p>The deployment configuration specified when the change set was created.</p>"""

capabilities instance-attribute

capabilities: NotRequired[Capabilities]

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

change_set_id instance-attribute

change_set_id: NotRequired[ChangeSetId]

The Amazon Resource Name (ARN) of the change set.

change_set_name instance-attribute

change_set_name: NotRequired[ChangeSetName]

The name of the change set.

changes instance-attribute

changes: NotRequired[Changes]

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

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

deployment_config instance-attribute

deployment_config: NotRequired[DeploymentConfig]

The deployment configuration specified when the change set was created.

deployment_mode instance-attribute

deployment_mode: NotRequired[DeploymentMode]

The deployment mode specified when the change set was created. Valid value is REVERT_DRIFT. Only present for drift-aware change sets.

description instance-attribute

description: NotRequired[Description]

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.

This parameter can only import resources that have custom names in templates. To import resources that do not accept custom names, such as EC2 instances, use the resource import feature instead.

include_nested_stacks instance-attribute

include_nested_stacks: NotRequired[IncludeNestedStacks]

Verifies if IncludeNestedStacks is set to True.

next_token instance-attribute

next_token: NotRequired[NextToken]

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

notification_ar_ns instance-attribute

notification_ar_ns: NotRequired[NotificationARNs]

The ARNs of the Amazon SNS topics that will be associated with the stack if you execute the change set.

on_stack_failure instance-attribute

on_stack_failure: NotRequired[OnStackFailure]

Determines what action will be taken if stack creation fails. When this parameter is specified, the DisableRollback parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:

  • DELETE - Deletes the change set if the stack creation fails. This is only valid when the ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status of the stack is DELETE_FAILED.

  • DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying true for the DisableRollback parameter to the ExecuteChangeSet API operation.

  • ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying false for the DisableRollback parameter to the ExecuteChangeSet API operation.

parameters instance-attribute

parameters: NotRequired[Parameters]

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

parent_change_set_id instance-attribute

parent_change_set_id: NotRequired[ChangeSetId]

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

rollback_configuration instance-attribute

rollback_configuration: NotRequired[RollbackConfiguration]

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

root_change_set_id instance-attribute

root_change_set_id: NotRequired[ChangeSetId]

Specifies the change set ID of the root change set in the current nested change set hierarchy.

stack_drift_status instance-attribute

stack_drift_status: NotRequired[StackDriftStatus]

The drift status of the stack when the change set was created. Valid values:

  • DRIFTED – The stack has drifted from its last deployment.

  • IN_SYNC – The stack is in sync with its last deployment.

  • NOT_CHECKED – CloudFormation doesn’t currently return this value.

  • UNKNOWN – The drift status could not be determined.

Only present for drift-aware change sets.

stack_id instance-attribute

stack_id: NotRequired[StackId]

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

stack_name instance-attribute

stack_name: NotRequired[StackName]

The name of the stack that's associated with the change set.

status instance-attribute

status: NotRequired[ChangeSetStatus]

The current status 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 attempt to create a change set failed, CloudFormation shows the error message.

tags instance-attribute

tags: NotRequired[Tags]

If you execute the change set, the tags that will be associated with the stack.