Documentation

The Stack data type.

See: newStack smart constructor.

Create a value of Stack with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:disableRollback:Stack', stack_disableRollback - Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback
• false: enable rollback

$sel:lastUpdatedTime:Stack', stack_lastUpdatedTime - The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

$sel:rootId:Stack', stack_rootId - For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the nested stack ultimately belongs.

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

$sel:notificationARNs:Stack', stack_notificationARNs - SNS topic ARNs to which stack related events are published.

$sel:stackStatusReason:Stack', stack_stackStatusReason - Success/failure message associated with the stack status.

$sel:enableTerminationProtection:Stack', stack_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 CloudFormation User Guide.

$sel:driftInformation:Stack', stack_driftInformation - Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

$sel:changeSetId:Stack', stack_changeSetId - The unique ID of the change set.

$sel:deletionTime:Stack', stack_deletionTime - The time the stack was deleted.

$sel:outputs:Stack', stack_outputs - A list of output structures.

$sel:parameters:Stack', stack_parameters - A list of Parameter structures.

$sel:stackId:Stack', stack_stackId - Unique identifier of the stack.

$sel:description:Stack', stack_description - A user-defined description associated with the stack.

$sel:capabilities:Stack', stack_capabilities - The capabilities allowed in the stack.

$sel:rollbackConfiguration:Stack', stack_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

$sel:tags:Stack', stack_tags - A list of Tags that specify information about the stack.

$sel:timeoutInMinutes:Stack', stack_timeoutInMinutes - The amount of time within which stack creation should complete.

$sel:parentId:Stack', stack_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 CloudFormation User Guide.

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

$sel:stackName:Stack', stack_stackName - The name associated with the stack.

$sel:creationTime:Stack', stack_creationTime - The time at which the stack was created.

$sel:stackStatus:Stack', stack_stackStatus - Current status of the stack.

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback
• false: enable rollback

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

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

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

SNS topic ARNs to which stack related events are published.

Success/failure message associated with the stack status.

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 CloudFormation User Guide.

Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

The unique ID of the change set.

The time the stack was deleted.

A list of output structures.

A list of Parameter structures.

Unique identifier of the stack.

A user-defined description associated with the stack.

The capabilities allowed in the stack.

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

A list of Tags that specify information about the stack.

The amount of time within which stack creation should complete.

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 CloudFormation User Guide.

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

The name associated with the stack.

The time at which the stack was created.

Current status of the stack.