Class: Aws::CloudFormation::Types::DescribeChangeSetOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::DescribeChangeSetOutput
- Defined in:
- gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb
Overview
The output for the DescribeChangeSet action.
Constant Summary collapse
- SENSITIVE =
[]
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 Amazon Resource Name (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 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. -
#import_existing_resources ⇒ Boolean
Indicates if the change set imports resources that already exist.
-
#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.
-
#on_stack_failure ⇒ String
Determines what action will be taken if stack creation fails.
-
#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 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 Amazon Resource Name (ARN) of the stack that's associated with the change set.
-
#stack_name ⇒ String
The name of the stack that's 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.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#change_set_id ⇒ String
The Amazon Resource Name (ARN) of the change set.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#change_set_name ⇒ String
The name of the change set.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#changes ⇒ Array<Types::Change>
A list of Change
structures that describes the resources
CloudFormation changes if you execute the change set.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#creation_time ⇒ Time
The start time when the change set was created, in UTC.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
Information about the change set.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#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 CloudFormation is still creating it or
in an OBSOLETE
state because the stack was already updated.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#import_existing_resources ⇒ Boolean
Indicates if the change set imports resources that already exist.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#include_nested_stacks ⇒ Boolean
Verifies if IncludeNestedStacks
is set to True
.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#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.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#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.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#on_stack_failure ⇒ String
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 theChangeSetType
parameter 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 specifyingtrue
for theDisableRollback
parameter to the ExecuteChangeSet API operation.ROLLBACK
- if the stack creation fails, roll back the stack. This is equivalent to specifyingfalse
for theDisableRollback
parameter to the ExecuteChangeSet API operation.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#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.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#parent_change_set_id ⇒ String
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#rollback_configuration ⇒ Types::RollbackConfiguration
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#root_change_set_id ⇒ String
Specifies the change set ID of the root change set in the current nested change set hierarchy.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#stack_id ⇒ String
The Amazon Resource Name (ARN) of the stack that's associated with the change set.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#stack_name ⇒ String
The name of the stack that's associated with the change set.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the change set, such as CREATE_IN_PROGRESS
,
CREATE_COMPLETE
, or FAILED
.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#status_reason ⇒ String
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
If you execute the change set, the tags that will be associated with the stack.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2555 class DescribeChangeSetOutput < Struct.new( :change_set_name, :change_set_id, :stack_id, :stack_name, :description, :parameters, :creation_time, :execution_status, :status, :status_reason, :notification_arns, :rollback_configuration, :capabilities, :tags, :changes, :next_token, :include_nested_stacks, :parent_change_set_id, :root_change_set_id, :on_stack_failure, :import_existing_resources) SENSITIVE = [] include Aws::Structure end |