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

Class: Aws::CloudFormation::Types::DescribeChangeSetOutput

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

Overview

The output for the DescribeChangeSet action.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

Returns:

  • (Array<String>)

    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

#change_set_idString

The ARN of the change set.

Returns:

  • (String)

    The ARN of the change set.

#change_set_nameString

The name of the change set.

Returns:

  • (String)

    The name of the change set.

#changesArray<Types::Change>

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

Returns:

  • (Array<Types::Change>)

    A list of Change structures that describes the resources AWS CloudFormation changes if you execute 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

Information about the change set.

Returns:

  • (String)

    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.

#next_tokenString

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)

    If the output exceeds 1 MB, a string that identifies the next page of changes.

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

    The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

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

    A list of Parameter structures that describes the input parameters and their values used to create the change set.

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

    The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

#stack_idString

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

Returns:

  • (String)

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

#stack_nameString

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

Returns:

  • (String)

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

#statusString

The current status 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 current status 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 attempt to create a change set failed, AWS CloudFormation shows the error message.

Returns:

  • (String)

    A description of the change set\'s status.

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

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