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

Class: Aws::CloudFormation::Types::Stack

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

Overview

The Stack data type.

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

The capabilities allowed in the stack.

Returns:

  • (Array<String>)

    The capabilities allowed in the stack.

#change_set_idString

The unique ID of the change set.

Returns:

  • (String)

    The unique ID of the change set.

#creation_timeTime

The time at which the stack was created.

Returns:

  • (Time)

    The time at which the stack was created.

#deletion_timeTime

The time the stack was deleted.

Returns:

  • (Time)

    The time the stack was deleted.

#descriptionString

A user-defined description associated with the stack.

Returns:

  • (String)

    A user-defined description associated with the stack.

#disable_rollbackBoolean

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

Returns:

  • (Boolean)

    Boolean to enable or disable rollback on stack creation failures:.

#enable_termination_protectionBoolean

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.

Returns:

  • (Boolean)

    Whether termination protection is enabled for the stack.

#last_updated_timeTime

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

Returns:

  • (Time)

    The time the stack was last updated.

#notification_arnsArray<String>

SNS topic ARNs to which stack related events are published.

Returns:

  • (Array<String>)

    SNS topic ARNs to which stack related events are published.

#outputsArray<Types::Output>

A list of output structures.

Returns:

#parametersArray<Types::Parameter>

A list of Parameter structures.

Returns:

#parent_idString

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

Returns:

  • (String)

    For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.

#role_arnString

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role\'s credentials to make calls on your behalf.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack.

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

#root_idString

For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

Returns:

  • (String)

    For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.

#stack_idString

Unique identifier of the stack.

Returns:

  • (String)

    Unique identifier of the stack.

#stack_nameString

The name associated with the stack.

Returns:

  • (String)

    The name associated with the stack.

#stack_statusString

Current status of the stack.

Possible values:

  • CREATE_IN_PROGRESS
  • CREATE_FAILED
  • CREATE_COMPLETE
  • ROLLBACK_IN_PROGRESS
  • ROLLBACK_FAILED
  • ROLLBACK_COMPLETE
  • DELETE_IN_PROGRESS
  • DELETE_FAILED
  • DELETE_COMPLETE
  • UPDATE_IN_PROGRESS
  • UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
  • UPDATE_COMPLETE
  • UPDATE_ROLLBACK_IN_PROGRESS
  • UPDATE_ROLLBACK_FAILED
  • UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
  • UPDATE_ROLLBACK_COMPLETE
  • REVIEW_IN_PROGRESS

Returns:

  • (String)

    Current status of the stack.

#stack_status_reasonString

Success/failure message associated with the stack status.

Returns:

  • (String)

    Success/failure message associated with the stack status.

#tagsArray<Types::Tag>

A list of Tags that specify information about the stack.

Returns:

  • (Array<Types::Tag>)

    A list of Tags that specify information about the stack.

#timeout_in_minutesInteger

The amount of time within which stack creation should complete.

Returns:

  • (Integer)

    The amount of time within which stack creation should complete.