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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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)

    The ID of the change set.

#change_set_nameString

The name of the change set.

Returns:

  • (String)

    The name of the change set.

#creation_timeTime

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

Returns:

  • (Time)

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

#descriptionString

Descriptive information about the change set.

Returns:

  • (String)

    Descriptive information about the change set.

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

Possible values:

  • UNAVAILABLE
  • AVAILABLE
  • EXECUTE_IN_PROGRESS
  • EXECUTE_COMPLETE
  • EXECUTE_FAILED
  • OBSOLETE

Returns:

  • (String)

    If the change set execution status is AVAILABLE, you can execute the change set.

#stack_idString

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

Returns:

  • (String)

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

#stack_nameString

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

Returns:

  • (String)

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

#statusString

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

Possible values:

  • CREATE_PENDING
  • CREATE_IN_PROGRESS
  • CREATE_COMPLETE
  • DELETE_COMPLETE
  • FAILED

Returns:

  • (String)

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

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

    A description of the change set\'s status.