class Stack (construct)

Language	Type name
.NET	`Amazon.CDK.Stack`
Go	`github.com/aws/aws-cdk-go/awscdk/v2#Stack`
Java	`software.amazon.awscdk.Stack`
Python	`aws_cdk.Stack`
TypeScript (source)	`aws-cdk-lib` » `Stack`

Implements IConstruct, IDependable, ITaggable

A root construct which represents a single CloudFormation stack.

Example

import * as cdk from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';

const app = new cdk.App();
const stack = new cdk.Stack(app, 'Stack');

declare const bucket: s3.IBucket;

new dynamodb.Table(stack, 'Table', {
  partitionKey: {
    name: 'id',
    type: dynamodb.AttributeType.STRING,
  },
  importSource: {
    compressionType: dynamodb.InputCompressionType.GZIP,
    inputFormat: dynamodb.InputFormat.csv({
      delimiter: ',',
      headerList: ['id', 'name'],
    }),
    bucket,
    keyPrefix: 'prefix',
  },
});

Initializer

new Stack(scope?: Construct, id?: string, props?: StackProps)

Parameters

scope Construct — Parent of this stack, usually an App or a Stage, but could be any construct.
id string — The construct ID of this stack.
props StackProps — Stack properties.

Creates a new stack.

Construct Props

Name	Type	Description
analyticsReporting?	`boolean`	Include runtime versioning information in this Stack.
crossRegionReferences?	`boolean`	Enable this flag to allow native cross region stack references.
description?	`string`	A description of the stack.
env?	`Environment`	The AWS environment (account/region) where this stack will be deployed.
notificationArns?	`string[]`	SNS Topic ARNs that will receive stack events.
permissionsBoundary?	`PermissionsBoundary`	Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.
propertyInjectors?	`IPropertyInjector[]`	A list of IPropertyInjector attached to this Stack.
stackName?	`string`	Name to deploy the stack with.
suppressTemplateIndentation?	`boolean`	Enable this flag to suppress indentation in generated CloudFormation templates.
synthesizer?	`IStackSynthesizer`	Synthesis method to use while deploying this stack.
tags?	`{ [string]: string }`	Tags that will be applied to the Stack.
terminationProtection?	`boolean`	Whether to enable termination protection for this stack.

analyticsReporting?

Type: boolean (optional, default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key)

Include runtime versioning information in this Stack.

crossRegionReferences?

Type: boolean (optional, default: false)

Enable this flag to allow native cross region stack references.

Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

This feature is currently experimental

description?

Type: string (optional, default: No description.)

A description of the stack.

env?

Type: Environment (optional, default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.)

The AWS environment (account/region) where this stack will be deployed.

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements. Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');

notificationArns?

Type: string[] (optional, default: no notification arns.)

SNS Topic ARNs that will receive stack events.

permissionsBoundary?

Type: PermissionsBoundary (optional, default: no permissions boundary is applied)

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage.

propertyInjectors?

Type: IPropertyInjector[] (optional, default: no PropertyInjectors)

A list of IPropertyInjector attached to this Stack.

stackName?

Type: string (optional, default: Derived from construct path.)

Name to deploy the stack with.

suppressTemplateIndentation?

Type: boolean (optional, default: the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.)

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

synthesizer?

Type: IStackSynthesizer (optional, default: The synthesizer specified on App, or DefaultStackSynthesizer otherwise.)

Synthesis method to use while deploying this stack.

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

tags?

Type: { [string]: string } (optional, default: {})

Tags that will be applied to the Stack.

These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.

However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way.

terminationProtection?

Type: boolean (optional, default: false)

Whether to enable termination protection for this stack.

Properties

Name	Type	Description
account	`string`	The AWS account into which this stack will be deployed.
artifactId	`string`	The ID of the cloud assembly artifact for this stack.
availabilityZones	`string[]`	Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
bundlingRequired	`boolean`	Indicates whether the stack requires bundling or not.
dependencies	`Stack[]`	Return the stacks this stack depends on.
environment	`string`	The environment coordinates in which this stack is deployed.
nested	`boolean`	Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent.
node	`Node`	The tree node.
notificationArns	`string[]`	Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
partition	`string`	The partition in which this stack is defined.
region	`string`	The AWS region into which this stack will be deployed (e.g. `us-west-2`).
stackId	`string`	The ID of the stack.
stackName	`string`	The concrete CloudFormation physical stack name.
synthesizer	`IStackSynthesizer`	Synthesis method for this stack.
tags	`TagManager`	Tags to be applied to the stack.
templateFile	`string`	The name of the CloudFormation template file emitted to the output directory during synthesis.
templateOptions	`ITemplateOptions`	Options for CloudFormation template (like version, transform, description).
terminationProtection	`boolean`	Whether termination protection is enabled for this stack.
urlSuffix	`string`	The Amazon domain suffix for the region in which this stack is defined.
nestedStackParent?	`Stack`	If this is a nested stack, returns it's parent stack.
nestedStackResource?	`CfnResource`	If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.

account

Type: string

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

The value provided to env.account when the stack is defined. This can either be a concrete account (e.g. 585695031111) or the Aws.ACCOUNT_ID token.
Aws.ACCOUNT_ID, which represents the CloudFormation intrinsic reference { "Ref": "AWS::AccountId" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.account) returns true), this implies that the user wishes that this stack will synthesize into an account-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other account-agnostic behavior.

artifactId

Type: string

The ID of the cloud assembly artifact for this stack.

availabilityZones

Type: string[]

Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.

If the stack is environment-agnostic (either account and/or region are tokens), this property will return an array with 2 tokens that will resolve at deploy-time to the first two availability zones returned from CloudFormation's Fn::GetAZs intrinsic function.

If they are not available in the context, returns a set of dummy values and reports them as missing, and let the CLI resolve them by calling EC2 DescribeAvailabilityZones on the target environment.

To specify a different strategy for selecting availability zones override this method.

bundlingRequired

Type: boolean

Indicates whether the stack requires bundling or not.

dependencies

Type: Stack[]

Return the stacks this stack depends on.

environment

Type: string

The environment coordinates in which this stack is deployed.

In the form aws://account/region. Use stack.account and stack.region to obtain the specific values, no need to parse.

You can use this value to determine if two stacks are targeting the same environment.

If either stack.account or stack.region are not concrete values (e.g. Aws.ACCOUNT_ID or Aws.REGION) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

nested

Type: boolean

Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

node

Type: Node

The tree node.

notificationArns

Type: string[]

Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

partition

Type: string

The partition in which this stack is defined.

region

Type: string

The AWS region into which this stack will be deployed (e.g. us-west-2).

This value is resolved according to the following rules:

The value provided to env.region when the stack is defined. This can either be a concrete region (e.g. us-west-2) or the Aws.REGION token.
Aws.REGION, which is represents the CloudFormation intrinsic reference { "Ref": "AWS::Region" } encoded as a string token.

Preferably, you should use the return value as an opaque string and not attempt to parse it to implement your logic. If you do, you must first check that it is a concrete value an not an unresolved token. If this value is an unresolved token (Token.isUnresolved(stack.region) returns true), this implies that the user wishes that this stack will synthesize into a region-agnostic template. In this case, your code should either fail (throw an error, emit a synth error using Annotations.of(construct).addError()) or implement some other region-agnostic behavior.

stackId

Type: string

The ID of the stack. Example

// After resolving, looks like
'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'

stackName

Type: string

The concrete CloudFormation physical stack name.

This is either the name defined explicitly in the stackName prop or allocated based on the stack's location in the construct tree. Stacks that are directly defined under the app use their construct id as their stack name. Stacks that are defined deeper within the tree will use a hashed naming scheme based on the construct path to ensure uniqueness.

If you wish to obtain the deploy-time AWS::StackName intrinsic, you can use Aws.STACK_NAME directly.

synthesizer

Type: IStackSynthesizer

Synthesis method for this stack.

templateFile

Type: string

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

templateOptions

Type: ITemplateOptions

Options for CloudFormation template (like version, transform, description).

terminationProtection

Type: boolean

Whether termination protection is enabled for this stack.

urlSuffix

Type: string

The Amazon domain suffix for the region in which this stack is defined.

nestedStackParent?

Type: Stack (optional)

If this is a nested stack, returns it's parent stack.

nestedStackResource?

Type: CfnResource (optional)

If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.

undefined for top-level (non-nested) stacks.

Methods

Name	Description
addDependency(target, reason?)	Add a dependency between this stack and another stack.
addMetadata(key, value)	Adds an arbitrary key-value pair, with information you want to record about the stack.
addStackTag(tagName, tagValue)	Configure a stack tag.
addTransform(transform)	Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
exportStringListValue(exportedValue, options?)	Create a CloudFormation Export for a string list value.
exportValue(exportedValue, options?)	Create a CloudFormation Export for a string value.
formatArn(components)	Creates an ARN from components.
getLogicalId(element)	Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
regionalFact(factName, defaultValue?)	Look up a fact value for the given fact for the region of this stack.
removeStackTag(tagName)	Remove a stack tag.
renameLogicalId(oldId, newId)	Rename a generated logical identities.
reportMissingContextKey(report)	Indicate that a context key was expected.
resolve(obj)	Resolve a tokenized value in the context of the current stack.
splitArn(arn, arnFormat)	Splits the provided ARN into its components.
toJsonString(obj, space?)	Convert an object, potentially containing tokens, to a JSON string.
toString()	Returns a string representation of this construct.
toYamlString(obj)	Convert an object, potentially containing tokens, to a YAML string.
protected allocateLogicalId(cfnElement)	Returns the naming scheme used to allocate logical IDs.
static isStack(x)	Return whether the given object is a Stack.
static of(construct)	Looks up the first stack scope in which `construct` is defined.

addDependency(target, reason?)

public addDependency(target: Stack, reason?: string): void

Parameters

target Stack
reason string

Add a dependency between this stack and another stack.

This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Adds an arbitrary key-value pair, with information you want to record about the stack.

These get translated to the Metadata section of the generated template.

addStackTag(tagName, tagValue)

public addStackTag(tagName: string, tagValue: string): void

Parameters

tagName string
tagValue string

Configure a stack tag.

At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

addTransform(transform)

public addTransform(transform: string): void

Parameters

transform string — The transform to add.

Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.

Duplicate values are removed when stack is synthesized.

declare const stack: Stack;

stack.addTransform('AWS::Serverless-2016-10-31')

exportStringListValue(exportedValue, options?)

public exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]

Parameters

exportedValue any
options ExportValueOptions

Returns

string[]

Create a CloudFormation Export for a string list value.

Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. You can control the name for the export by passing the name option.

If you don't supply a value for name, the value you're exporting must be a Resource attribute (for example: bucket.bucketName) and it will be given the same name as the automatic cross-stack reference that would be created if you used the attribute in another Stack.

One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.

See exportValue for an example of this process.

exportValue(exportedValue, options?)

public exportValue(exportedValue: any, options?: ExportValueOptions): string

Parameters

exportedValue any
options ExportValueOptions

Returns

string

Create a CloudFormation Export for a string value.

Returns a string representing the corresponding Fn.importValue() expression for this Export. You can control the name for the export by passing the name option.

Here is how the process works. Let's say there are two stacks, producerStack and consumerStack, and producerStack has a bucket called bucket, which is referenced by consumerStack (perhaps because an AWS Lambda Function writes into it, or something like that).

It is not safe to remove producerStack.bucket because as the bucket is being deleted, consumerStack might still be using it.

Instead, the process takes two deployments:

Deployment 1: break the relationship:

Make sure consumerStack no longer references bucket.bucketName (maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether).
In the ProducerStack class, call this.exportValue(this.bucket.bucketName). This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken.
Deploy (this will effectively only change the consumerStack, but it's safe to deploy both).

Deployment 2: remove the bucket resource:

You are now free to remove the bucket resource from producerStack.
Don't forget to remove the exportValue() call as well.
Deploy again (this time only the producerStack will be changed -- the bucket will be deleted).

formatArn(components)

public formatArn(components: ArnComponents): string

Parameters

components ArnComponents

Returns

string

Creates an ARN from components.

If partition, region or account are not specified, the stack's partition, region and account will be used.

If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.

The ARN will be formatted as follows:

arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}

The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.

getLogicalId(element)

public getLogicalId(element: CfnElement): string

Parameters

element CfnElement — The CloudFormation element for which a logical identity is needed.

Returns

string

Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.

This method is called when a CfnElement is created and used to render the initial logical identity of resources. Logical ID renames are applied at this stage.

This method uses the protected method allocateLogicalId to render the logical ID for an element. To modify the naming scheme, extend the Stack class and override this method.

regionalFact(factName, defaultValue?)

public regionalFact(factName: string, defaultValue?: string): string

Parameters

factName string
defaultValue string

Returns

string

Look up a fact value for the given fact for the region of this stack.

Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.

What regions will be included in the lookup map is controlled by the @aws-cdk/core:target-partitions context value: it must be set to a list of partitions, and only regions from the given partitions will be included. If no such context key is set, all regions will be included.

This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts.

If defaultValue is not given, it is an error if the fact is unknown for the given region.

removeStackTag(tagName)

public removeStackTag(tagName: string): void

Parameters

tagName string

Remove a stack tag.

At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.

renameLogicalId(oldId, newId)

public renameLogicalId(oldId: string, newId: string): void

Parameters

oldId string
newId string

Rename a generated logical identities.

To modify the naming scheme strategy, extend the Stack class and override the allocateLogicalId method.

reportMissingContextKey(report)

public reportMissingContextKey(report: MissingContext): void

Parameters

report MissingContext — The set of parameters needed to obtain the context.

Indicate that a context key was expected.

Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.

resolve(obj)

public resolve(obj: any): any

Parameters

obj any

Returns

any

Resolve a tokenized value in the context of the current stack.

splitArn(arn, arnFormat)

public splitArn(arn: string, arnFormat: ArnFormat): ArnComponents

Parameters

arn string — the ARN to split into its components.
arnFormat ArnFormat — the expected format of 'arn' - depends on what format the service 'arn' represents uses.

Returns

ArnComponents

Splits the provided ARN into its components.

Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).

toJsonString(obj, space?)

public toJsonString(obj: any, space?: number): string

Parameters

obj any
space number

Returns

string

Convert an object, potentially containing tokens, to a JSON string.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

toYamlString(obj)

public toYamlString(obj: any): string

Parameters

obj any

Returns

string

Convert an object, potentially containing tokens, to a YAML string.

protected allocateLogicalId(cfnElement)

protected allocateLogicalId(cfnElement: CfnElement): string

Parameters

cfnElement CfnElement — The element for which the logical ID is allocated.

Returns

string

Returns the naming scheme used to allocate logical IDs.

By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

In order to make sure logical IDs are unique and stable, we hash the resource construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as a suffix to the path components joined without a separator (CloudFormation IDs only allow alphanumeric characters).

The result will be:

<path.join('')><md5(path.join('/')> "human" "hash"

If the "human" part of the ID exceeds 240 characters, we simply trim it so the total ID doesn't exceed CloudFormation's 255 character limit.

We only take 8 characters from the md5 hash (0.000005 chance of collision).

Special cases:

If the path only contains a single component (i.e. it's a top-level resource), we won't add the hash to it. The hash is not needed for disambiguation and also, it allows for a more straightforward migration an existing CloudFormation template to a CDK stack without logical ID changes (or renames).
For aesthetic reasons, if the last components of the path are the same (i.e. L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the resulting human portion of the ID more pleasing: L1L2Pipeline<HASH> instead of L1L2PipelinePipeline<HASH>
If a component is named "Default" it will be omitted from the path. This allows refactoring higher level abstractions around constructs without affecting the IDs of already deployed resources.
If a component is named "Resource" it will be omitted from the user-visible path, but included in the hash. This reduces visual noise in the human readable part of the identifier.

static isStack(x)

public static isStack(x: any): boolean

Parameters

x any

Returns

boolean

Return whether the given object is a Stack.

We do attribute detection since we can't reliably use 'instanceof'.

static of(construct)

public static of(construct: IConstruct): Stack

Parameters

construct IConstruct — The construct to start the search from.

Returns

Stack

Looks up the first stack scope in which construct is defined.

Fails if there is no stack up the tree.