AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The Stack data type.

Inheritance Hierarchy

System.Object
  Amazon.CloudFormation.Model.Stack

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public class Stack

The Stack type exposes the following members

Constructors

NameDescription
Public Method Stack()

Properties

NameTypeDescription
Public Property Capabilities System.Collections.Generic.List<System.String>

Gets and sets the property Capabilities.

The capabilities allowed in the stack.

Public Property ChangeSetId System.String

Gets and sets the property ChangeSetId.

The unique ID of the change set.

Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

The time at which the stack was created.

Public Property DeletionTime System.DateTime

Gets and sets the property DeletionTime.

The time the stack was deleted.

Public Property Description System.String

Gets and sets the property Description.

A user-defined description associated with the stack.

Public Property DetailedStatus Amazon.CloudFormation.DetailedStatus

Gets and sets the property DetailedStatus.

The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

Public Property DisableRollback System.Boolean

Gets and sets the property DisableRollback.

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback.

  • false: enable rollback.

Public Property DriftInformation Amazon.CloudFormation.Model.StackDriftInformation

Gets and sets the property DriftInformation.

Information about whether a stack's actual configuration differs, or has drifted, from its 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.

Public Property EnableTerminationProtection System.Boolean

Gets and sets the property EnableTerminationProtection.

Whether termination protection is enabled for the stack.

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

Public Property LastUpdatedTime System.DateTime

Gets and sets the property LastUpdatedTime.

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

Public Property NotificationARNs System.Collections.Generic.List<System.String>

Gets and sets the property NotificationARNs.

Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

Public Property Outputs System.Collections.Generic.List<Amazon.CloudFormation.Model.Output>

Gets and sets the property Outputs.

A list of output structures.

Public Property Parameters System.Collections.Generic.List<Amazon.CloudFormation.Model.Parameter>

Gets and sets the property Parameters.

A list of Parameter structures.

Public Property ParentId System.String

Gets and sets the property 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.

Public Property RetainExceptOnCreate System.Boolean

Gets and sets the property RetainExceptOnCreate.

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

Public Property RoleARN System.String

Gets and sets the property RoleARN.

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

Public Property RollbackConfiguration Amazon.CloudFormation.Model.RollbackConfiguration

Gets and sets the property RollbackConfiguration.

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

Public Property RootId System.String

Gets and sets the property 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.

Public Property StackId System.String

Gets and sets the property StackId.

Unique identifier of the stack.

Public Property StackName System.String

Gets and sets the property StackName.

The name associated with the stack.

Public Property StackStatus Amazon.CloudFormation.StackStatus

Gets and sets the property StackStatus.

Current status of the stack.

Public Property StackStatusReason System.String

Gets and sets the property StackStatusReason.

Success/failure message associated with the stack status.

Public Property Tags System.Collections.Generic.List<Amazon.CloudFormation.Model.Tag>

Gets and sets the property Tags.

A list of Tags that specify information about the stack.

Public Property TimeoutInMinutes System.Int32

Gets and sets the property TimeoutInMinutes.

The amount of time within which stack creation should complete.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5