DescribeChangeSetOutput
¶
Source code in docs_src/capo_cloudformation/types/describe_change_set_output.py
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 theChangeSetTypeparameter is set toCREATE. If the deletion of the stack fails, the status of the stack isDELETE_FAILED. -
DO_NOTHING- if the stack creation fails, do nothing. This is equivalent to specifyingtruefor theDisableRollbackparameter to the ExecuteChangeSet API operation. -
ROLLBACK- if the stack creation fails, roll back the stack. This is equivalent to specifyingfalsefor theDisableRollbackparameter 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.