You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::DescribeChangeSetOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::DescribeChangeSetOutput
- Defined in:
- (unknown)
Overview
Instance Attribute Summary collapse
-
#capabilities ⇒ Array<String>
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
-
#change_set_id ⇒ String
The ARN of the change set.
-
#change_set_name ⇒ String
The name of the change set.
-
#changes ⇒ Array<Types::Change>
A list of
Change
structures that describes the resources AWS CloudFormation changes if you execute the change set. -
#creation_time ⇒ Time
The start time when the change set was created, in UTC.
-
#description ⇒ String
Information about the change set.
-
#execution_status ⇒ String
If the change set execution status is
AVAILABLE
, you can execute the change set. -
#include_nested_stacks ⇒ Boolean
Verifies if
IncludeNestedStacks
is set toTrue
. -
#next_token ⇒ String
If the output exceeds 1 MB, a string that identifies the next page of changes.
-
#notification_arns ⇒ Array<String>
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
-
#parameters ⇒ Array<Types::Parameter>
A list of
Parameter
structures that describes the input parameters and their values used to create the change set. -
#parent_change_set_id ⇒ String
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
-
#rollback_configuration ⇒ Types::RollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
-
#root_change_set_id ⇒ String
Specifies the change set ID of the root change set in the current nested change set hierarchy.
-
#stack_id ⇒ String
The ARN of the stack that is associated with the change set.
-
#stack_name ⇒ String
The name of the stack that is associated with the change set.
-
#status ⇒ String
The current status of the change set, such as
CREATE_IN_PROGRESS
,CREATE_COMPLETE
, orFAILED
. -
#status_reason ⇒ String
A description of the change set\'s status.
-
#tags ⇒ Array<Types::Tag>
If you execute the change set, the tags that will be associated with the stack.
Instance Attribute Details
#capabilities ⇒ Array<String>
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
#change_set_id ⇒ String
The ARN of the change set.
#change_set_name ⇒ String
The name of the change set.
#changes ⇒ Array<Types::Change>
A list of Change
structures that describes the resources AWS
CloudFormation changes if you execute the change set.
#creation_time ⇒ Time
The start time when the change set was created, in UTC.
#description ⇒ String
Information about the change set.
#execution_status ⇒ String
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.
Possible values:
- UNAVAILABLE
- AVAILABLE
- EXECUTE_IN_PROGRESS
- EXECUTE_COMPLETE
- EXECUTE_FAILED
- OBSOLETE
#include_nested_stacks ⇒ Boolean
Verifies if IncludeNestedStacks
is set to True
.
#next_token ⇒ String
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_arns ⇒ Array<String>
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
#parameters ⇒ Array<Types::Parameter>
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 ⇒ String
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
#rollback_configuration ⇒ Types::RollbackConfiguration
The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
#root_change_set_id ⇒ String
Specifies the change set ID of the root change set in the current nested change set hierarchy.
#stack_id ⇒ String
The ARN of the stack that is associated with the change set.
#stack_name ⇒ String
The name of the stack that is associated with the change set.
#status ⇒ String
The current status of the change set, such as CREATE_IN_PROGRESS
,
CREATE_COMPLETE
, or FAILED
.
Possible values:
- CREATE_PENDING
- CREATE_IN_PROGRESS
- CREATE_COMPLETE
- DELETE_PENDING
- DELETE_IN_PROGRESS
- DELETE_COMPLETE
- DELETE_FAILED
- FAILED
#status_reason ⇒ String
A description of the change set\'s status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
#tags ⇒ Array<Types::Tag>
If you execute the change set, the tags that will be associated with the stack.