/AWS1/CL_FRMDESCRCHANGESETOUT¶
The output for the DescribeChangeSet action.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_CHANGESETNAME TYPE /AWS1/FRMCHANGESETNAME /AWS1/FRMCHANGESETNAME¶
The name of the change set.
IV_CHANGESETID TYPE /AWS1/FRMCHANGESETID /AWS1/FRMCHANGESETID¶
The Amazon Resource Name (ARN) of the change set.
IV_STACKID TYPE /AWS1/FRMSTACKID /AWS1/FRMSTACKID¶
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
IV_STACKNAME TYPE /AWS1/FRMSTACKNAME /AWS1/FRMSTACKNAME¶
The name of the stack that's associated with the change set.
IV_DESCRIPTION TYPE /AWS1/FRMDESCRIPTION /AWS1/FRMDESCRIPTION¶
Information about the change set.
IT_PARAMETERS TYPE /AWS1/CL_FRMPARAMETER=>TT_PARAMETERS TT_PARAMETERS¶
A list of
Parameterstructures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
IV_CREATIONTIME TYPE /AWS1/FRMCREATIONTIME /AWS1/FRMCREATIONTIME¶
The start time when the change set was created, in UTC.
IV_EXECUTIONSTATUS TYPE /AWS1/FRMEXECUTIONSTATUS /AWS1/FRMEXECUTIONSTATUS¶
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 anUNAVAILABLEstate because CloudFormation is still creating it or in anOBSOLETEstate because the stack was already updated.
IV_STATUS TYPE /AWS1/FRMCHANGESETSTATUS /AWS1/FRMCHANGESETSTATUS¶
The current status of the change set, such as
CREATE_IN_PROGRESS,CREATE_COMPLETE, orFAILED.
IV_STATUSREASON TYPE /AWS1/FRMCHANGESETSTATUSREASON /AWS1/FRMCHANGESETSTATUSREASON¶
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
IT_NOTIFICATIONARNS TYPE /AWS1/CL_FRMNOTIFICATIONARNS_W=>TT_NOTIFICATIONARNS TT_NOTIFICATIONARNS¶
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
IO_ROLLBACKCONFIGURATION TYPE REF TO /AWS1/CL_FRMROLLBACKCONF /AWS1/CL_FRMROLLBACKCONF¶
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
IT_CAPABILITIES TYPE /AWS1/CL_FRMCAPABILITIES_W=>TT_CAPABILITIES TT_CAPABILITIES¶
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
IT_TAGS TYPE /AWS1/CL_FRMTAG=>TT_TAGS TT_TAGS¶
If you execute the change set, the tags that will be associated with the stack.
IT_CHANGES TYPE /AWS1/CL_FRMCHANGE=>TT_CHANGES TT_CHANGES¶
A list of
Changestructures that describes the resources CloudFormation changes if you execute the change set.
IV_NEXTTOKEN TYPE /AWS1/FRMNEXTTOKEN /AWS1/FRMNEXTTOKEN¶
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.
IV_INCLUDENESTEDSTACKS TYPE /AWS1/FRMINCLUDENESTEDSTACKS /AWS1/FRMINCLUDENESTEDSTACKS¶
Verifies if
IncludeNestedStacksis set toTrue.
IV_PARENTCHANGESETID TYPE /AWS1/FRMCHANGESETID /AWS1/FRMCHANGESETID¶
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
IV_ROOTCHANGESETID TYPE /AWS1/FRMCHANGESETID /AWS1/FRMCHANGESETID¶
Specifies the change set ID of the root change set in the current nested change set hierarchy.
IV_ONSTACKFAILURE TYPE /AWS1/FRMONSTACKFAILURE /AWS1/FRMONSTACKFAILURE¶
Determines what action will be taken if stack creation fails. When this parameter is specified, the
DisableRollbackparameter 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.
IV_IMPORTEXISTINGRESOURCES TYPE /AWS1/FRMIMPORTEXISTINGRESRCS /AWS1/FRMIMPORTEXISTINGRESRCS¶
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.
Queryable Attributes¶
ChangeSetName¶
The name of the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANGESETNAME() |
Getter for CHANGESETNAME, with configurable default |
ASK_CHANGESETNAME() |
Getter for CHANGESETNAME w/ exceptions if field has no value |
HAS_CHANGESETNAME() |
Determine if CHANGESETNAME has a value |
ChangeSetId¶
The Amazon Resource Name (ARN) of the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANGESETID() |
Getter for CHANGESETID, with configurable default |
ASK_CHANGESETID() |
Getter for CHANGESETID w/ exceptions if field has no value |
HAS_CHANGESETID() |
Determine if CHANGESETID has a value |
StackId¶
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STACKID() |
Getter for STACKID, with configurable default |
ASK_STACKID() |
Getter for STACKID w/ exceptions if field has no value |
HAS_STACKID() |
Determine if STACKID has a value |
StackName¶
The name of the stack that's associated with the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STACKNAME() |
Getter for STACKNAME, with configurable default |
ASK_STACKNAME() |
Getter for STACKNAME w/ exceptions if field has no value |
HAS_STACKNAME() |
Determine if STACKNAME has a value |
Description¶
Information about the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
Parameters¶
A list of
Parameterstructures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARAMETERS() |
Getter for PARAMETERS, with configurable default |
ASK_PARAMETERS() |
Getter for PARAMETERS w/ exceptions if field has no value |
HAS_PARAMETERS() |
Determine if PARAMETERS has a value |
CreationTime¶
The start time when the change set was created, in UTC.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
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 anUNAVAILABLEstate because CloudFormation is still creating it or in anOBSOLETEstate because the stack was already updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXECUTIONSTATUS() |
Getter for EXECUTIONSTATUS, with configurable default |
ASK_EXECUTIONSTATUS() |
Getter for EXECUTIONSTATUS w/ exceptions if field has no val |
HAS_EXECUTIONSTATUS() |
Determine if EXECUTIONSTATUS has a value |
Status¶
The current status of the change set, such as
CREATE_IN_PROGRESS,CREATE_COMPLETE, orFAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusReason¶
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
NotificationARNs¶
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NOTIFICATIONARNS() |
Getter for NOTIFICATIONARNS, with configurable default |
ASK_NOTIFICATIONARNS() |
Getter for NOTIFICATIONARNS w/ exceptions if field has no va |
HAS_NOTIFICATIONARNS() |
Determine if NOTIFICATIONARNS has a value |
RollbackConfiguration¶
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLLBACKCONFIGURATION() |
Getter for ROLLBACKCONFIGURATION |
Capabilities¶
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPABILITIES() |
Getter for CAPABILITIES, with configurable default |
ASK_CAPABILITIES() |
Getter for CAPABILITIES w/ exceptions if field has no value |
HAS_CAPABILITIES() |
Determine if CAPABILITIES has a value |
Tags¶
If you execute the change set, the tags that will be associated with the stack.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
Changes¶
A list of
Changestructures that describes the resources CloudFormation changes if you execute the change set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CHANGES() |
Getter for CHANGES, with configurable default |
ASK_CHANGES() |
Getter for CHANGES w/ exceptions if field has no value |
HAS_CHANGES() |
Determine if CHANGES has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NEXTTOKEN() |
Getter for NEXTTOKEN, with configurable default |
ASK_NEXTTOKEN() |
Getter for NEXTTOKEN w/ exceptions if field has no value |
HAS_NEXTTOKEN() |
Determine if NEXTTOKEN has a value |
IncludeNestedStacks¶
Verifies if
IncludeNestedStacksis set toTrue.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INCLUDENESTEDSTACKS() |
Getter for INCLUDENESTEDSTACKS, with configurable default |
ASK_INCLUDENESTEDSTACKS() |
Getter for INCLUDENESTEDSTACKS w/ exceptions if field has no |
HAS_INCLUDENESTEDSTACKS() |
Determine if INCLUDENESTEDSTACKS has a value |
ParentChangeSetId¶
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARENTCHANGESETID() |
Getter for PARENTCHANGESETID, with configurable default |
ASK_PARENTCHANGESETID() |
Getter for PARENTCHANGESETID w/ exceptions if field has no v |
HAS_PARENTCHANGESETID() |
Determine if PARENTCHANGESETID has a value |
RootChangeSetId¶
Specifies the change set ID of the root change set in the current nested change set hierarchy.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROOTCHANGESETID() |
Getter for ROOTCHANGESETID, with configurable default |
ASK_ROOTCHANGESETID() |
Getter for ROOTCHANGESETID w/ exceptions if field has no val |
HAS_ROOTCHANGESETID() |
Determine if ROOTCHANGESETID has a value |
OnStackFailure¶
Determines what action will be taken if stack creation fails. When this parameter is specified, the
DisableRollbackparameter 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ONSTACKFAILURE() |
Getter for ONSTACKFAILURE, with configurable default |
ASK_ONSTACKFAILURE() |
Getter for ONSTACKFAILURE w/ exceptions if field has no valu |
HAS_ONSTACKFAILURE() |
Determine if ONSTACKFAILURE has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMPORTEXISTINGRESOURCES() |
Getter for IMPORTEXISTINGRESOURCES, with configurable defaul |
ASK_IMPORTEXISTINGRESOURCES() |
Getter for IMPORTEXISTINGRESOURCES w/ exceptions if field ha |
HAS_IMPORTEXISTINGRESOURCES() |
Determine if IMPORTEXISTINGRESOURCES has a value |