Menu
AWS CloudFormation
API Reference (API Version 2010-05-15)

ChangeSetSummary

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

Contents

ChangeSetId

The ID of the change set.

Type: String

Length Constraints: Minimum length of 1.

Pattern: arn:[-a-zA-Z0-9:/]*

Required: No

ChangeSetName

The name of the change set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z][-a-zA-Z0-9]*

Required: No

CreationTime

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

Type: Timestamp

Required: No

Description

Descriptive information about the change set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

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 AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

Type: String

Valid Values: UNAVAILABLE | AVAILABLE | EXECUTE_IN_PROGRESS | EXECUTE_COMPLETE | EXECUTE_FAILED | OBSOLETE

Required: No

StackId

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

Type: String

Required: No

StackName

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

Type: String

Required: No

Status

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

Type: String

Valid Values: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | DELETE_COMPLETE | FAILED

Required: No

StatusReason

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: