AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::ChangeSetSummary

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #change_set_id ⇒ String

  The ID of the change set.

• #change_set_name ⇒ String

  The name of the change set.

• #creation_time ⇒ Time

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

• #description ⇒ String

  Descriptive 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

  Specifies the current setting of IncludeNestedStacks for the change set.

• #parent_change_set_id ⇒ String

  The parent change set ID.

• #root_change_set_id ⇒ String

  The root change set ID.

• #stack_id ⇒ String

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

• #stack_name ⇒ String

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

• #status ⇒ String

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

• #status_reason ⇒ String

  A description of the change set's status.

Instance Attribute Details

#change_set_id ⇒ String

The ID of the change set.

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_name ⇒ String

The name of the change set.

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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

#description ⇒ String

Descriptive information about the change set.

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_stacks ⇒ Boolean

Specifies the current setting of IncludeNestedStacks for the change set.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_id ⇒ String

The parent change set ID.

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_id ⇒ String

The root change set ID.

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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 ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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_reason ⇒ String

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)

# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 291

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