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

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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.

• #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.

• #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.

• #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.

• #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.

Returns:

• (Array<String>)

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

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 Aws::Structure
end

#change_set_id ⇒ String

The ARN of the change set.

Returns:

• (String)

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

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 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 1749

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 Aws::Structure
end

#changes ⇒ Array<Types::Change>

A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.

Returns:

• (Array<Types::Change>)

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

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 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 1749

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 Aws::Structure
end

#description ⇒ String

Information about the change set.

Returns:

• (String)

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

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 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 1749

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

Returns:

• (String)

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

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

Returns:

• (Array<String>)

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

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

Returns:

• (Array<Types::Parameter>)

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

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 Aws::Structure
end

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

Returns:

• (Types::RollbackConfiguration)

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

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 Aws::Structure
end

#stack_id ⇒ String

The ARN of the stack that is associated with the change set.

Returns:

• (String)

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

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 Aws::Structure
end

#stack_name ⇒ String

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

Returns:

• (String)

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

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 Aws::Structure
end

#status ⇒ String

The current status 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 1749

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 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, AWS CloudFormation shows the error message.

Returns:

• (String)

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

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 Aws::Structure
end

#tags ⇒ Array<Types::Tag>

If you execute the change set, the tags that will be associated with the stack.

Returns:

• (Array<Types::Tag>)

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

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 Aws::Structure
end