You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#change_set_idString

The ID of the change set.

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end

#change_set_nameString

The name of the change set.

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end

#creation_timeTime

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

Returns:

  • (Time)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end

#descriptionString

Descriptive information about the change set.

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  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 AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end

#stack_idString

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

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end

#stack_nameString

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

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  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, AWS CloudFormation shows the error message.

Returns:

  • (String)


171
172
173
174
175
176
177
178
179
180
181
182
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 171

class ChangeSetSummary < Struct.new(
  :stack_id,
  :stack_name,
  :change_set_id,
  :change_set_name,
  :execution_status,
  :status,
  :status_reason,
  :creation_time,
  :description)
  include Aws::Structure
end