Class: Aws::CloudFormation::Types::ChangeSetSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#change_set_idString

The ID of the change set.

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#change_set_nameString

The name of the change set.

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeTime

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

Returns:

  • (Time)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Descriptive information about the change set.

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#execution_statusString

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.

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#include_nested_stacksBoolean

Specifies the current setting of `IncludeNestedStacks` for the change set.

Returns:

  • (Boolean)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#parent_change_set_idString

The parent change set ID.

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#root_change_set_idString

The root change set ID.

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_idString

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

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

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

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

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

Returns:

  • (String)

496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/aws-sdk-cloudformation/types.rb', line 496

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description,
  :include_nested_stacks,
  :parent_change_set_id,
  :root_change_set_id)
  SENSITIVE = []
  include Aws::Structure
end