Menu
AWS CloudFormation
API Reference (API Version 2010-05-15)

Stack

The Stack data type.

Contents

Capabilities.member.N

The capabilities allowed in the stack.

Type: Array of strings

Valid Values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM

Required: No

ChangeSetId

The unique ID of the change set.

Type: String

Length Constraints: Minimum length of 1.

Pattern: arn:[-a-zA-Z0-9:/]*

Required: No

CreationTime

The time at which the stack was created.

Type: Timestamp

Required: Yes

DeletionTime

The time the stack was deleted.

Type: Timestamp

Required: No

Description

A user-defined description associated with the stack.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

DisableRollback

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

Type: Boolean

Required: No

EnableTerminationProtection

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.

Type: Boolean

Required: No

LastUpdatedTime

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

Type: Timestamp

Required: No

NotificationARNs.member.N

SNS topic ARNs to which stack related events are published.

Type: Array of strings

Array Members: Maximum number of 5 items.

Required: No

Outputs.member.N

A list of output structures.

Type: Array of Output objects

Required: No

Parameters.member.N

A list of Parameter structures.

Type: Array of Parameter objects

Required: No

ParentId

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.

Type: String

Required: No

RoleARN

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

RollbackConfiguration

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

Type: RollbackConfiguration object

Required: No

RootId

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.

Type: String

Required: No

StackId

Unique identifier of the stack.

Type: String

Required: No

StackName

The name associated with the stack.

Type: String

Required: Yes

StackStatus

Current status of the stack.

Type: String

Valid 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

Required: Yes

StackStatusReason

Success/failure message associated with the stack status.

Type: String

Required: No

Tags.member.N

A list of Tags that specify information about the stack.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: No

TimeoutInMinutes

The amount of time within which stack creation should complete.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: