Class Stack

A root construct which represents a single CloudFormation stack.

stable

Synopsis

Constructors

constructor(scope, id, props)

Creates a new stack.

Properties

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

Methods

addDependency(target, reason)	Add a dependency between this stack and another stack.
addDockerImageAsset(asset)	(deprecated) Register a docker image asset on this Stack.
addFileAsset(asset)	(deprecated) Register a file asset on this Stack.
addTransform(transform)	Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
allocateLogicalId(cfnElement)	Returns the naming scheme used to allocate logical IDs.
exportValue(exportedValue, options)	Create a CloudFormation Export for a value.
formatArn(components)	Creates an ARN from components.
getLogicalId(element)	Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
isStack(x)	Return whether the given object is a Stack.
of(construct)	Looks up the first stack scope in which construct is defined.
parseArn(arn, sepIfToken, hasName)	(deprecated) Given an ARN, parses it and returns components.
prepareCrossReference(_sourceStack, reference)	(deprecated) Deprecated.
renameLogicalId(oldId, newId)	Rename a generated logical identities.
reportMissingContext(report)	(deprecated) DEPRECATED.
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.

Constructors

constructor(scope, id, props)

Creates a new stack.

Declaration

constructor(scope?: Construct, id?: string, props?: StackProps);

Parameters

scope Construct

id string

props StackProps

Properties

account

The AWS account into which this stack will be deployed.

This value is resolved according to the following rules:

1. The value provided to env.account when the stack is defined. This can either be a concerete account (e.g. 585695031111) or the Aws.accountId token. 3. Aws.accountId, 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 concerete 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 a **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 region-agnostic behavior.

stable

Declaration

readonly account: string;

Property Value

string

artifactId

The ID of the cloud assembly artifact for this stack.

stable

Declaration

readonly artifactId: string;

Property Value

string

availabilityZones

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.

stable

Declaration

readonly availabilityZones: string[];

Property Value

string[]

dependencies

Return the stacks this stack depends on.

stable

Declaration

readonly dependencies: Stack[];

Property Value

Stack[]

environment

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 or Aws.region) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

stable

Declaration

readonly environment: string;

Property Value

string

nested

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

stable

Declaration

readonly nested: boolean;

Property Value

boolean

nestedStackParent

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

stable

Declaration

readonly nestedStackParent: Stack | undefined;

Property Value

Stack | undefined

nestedStackResource

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

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

stable

Declaration

readonly nestedStackResource?: CfnResource;

Property Value

CfnResource

notificationArns

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

stable

Declaration

readonly notificationArns: string[];

Property Value

string[]

parentStack

(deprecated) Returns the parent of a nested stack.

Declaration

readonly parentStack: Stack | undefined;

Property Value

Stack | undefined

partition

The partition in which this stack is defined.

stable

Declaration

readonly partition: string;

Property Value

string

region

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

This value is resolved according to the following rules:

1. The value provided to env.region when the stack is defined. This can either be a concerete region (e.g. us-west-2) or the Aws.region token. 3. 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 concerete 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.

stable

Declaration

readonly region: string;

Property Value

string

stackId

The ID of the stack.

stable

Declaration

readonly stackId: string;

Property Value

string

stackName

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.stackName directly.

stable

Declaration

readonly stackName: string;

Property Value

string

synthesizer

Synthesis method for this stack.

stable

Declaration

readonly synthesizer: IStackSynthesizer;

Property Value

IStackSynthesizer

tags

Tags to be applied to the stack.

stable

Declaration

readonly tags: TagManager;

Property Value

TagManager

templateFile

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

stable

Declaration

readonly templateFile: string;

Property Value

string

templateOptions

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

stable

Declaration

readonly templateOptions: ITemplateOptions;

Property Value

ITemplateOptions

terminationProtection

Whether termination protection is enabled for this stack.

stable

Declaration

readonly terminationProtection?: boolean;

Property Value

boolean

urlSuffix

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

stable

Declaration

readonly urlSuffix: string;

Property Value

string

Methods

addDependency(target, reason)

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.

stable

Declaration

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

Parameters

target Stack

reason string

Returns

void

addDockerImageAsset(asset)

(deprecated) Register a docker image asset on this Stack.

Declaration

addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation;

Parameters

asset DockerImageAssetSource

Returns

DockerImageAssetLocation

addFileAsset(asset)

(deprecated) Register a file asset on this Stack.

Declaration

addFileAsset(asset: FileAssetSource): FileAssetLocation;

Parameters

asset FileAssetSource

Returns

FileAssetLocation

addTransform(transform)

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.

Declaration

addTransform(transform: string): void;

Parameters

transform string

Returns

void

allocateLogicalId(cfnElement)

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

Declaration

protected allocateLogicalId(cfnElement: CfnElement): string;

Parameters

cfnElement CfnElement

Returns

string

exportValue(exportedValue, options)

Create a CloudFormation Export for a 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.

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.

## Example

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

  stable

Declaration

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

Parameters

exportedValue any

options ExportValueOptions

Returns

string

formatArn(components)

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

stable

Declaration

formatArn(components: ArnComponents): string;

Parameters

components ArnComponents

Returns

string

getLogicalId(element)

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.

Declaration

getLogicalId(element: CfnElement): string;

Parameters

element CfnElement

Returns

string

isStack(x)

Return whether the given object is a Stack.

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

stable

Declaration

static isStack(x: any): x is Stack;

Parameters

x any

Returns

x is Stack

of(construct)

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

Fails if there is no stack up the tree.

Declaration

static of(construct: IConstruct): Stack;

Parameters

construct IConstruct

Returns

Stack

parseArn(arn, sepIfToken, hasName)

(deprecated) Given an ARN, parses it and returns components.

IF THE ARN IS A CONCRETE STRING...

...it will be parsed and validated. The separator (sep) will be set to '/' if the 6th component includes a '/', in which case, resource will be set to the value before the '/' and resourceName will be the rest. In case there is no '/', resource will be set to the 6th components and resourceName will be set to the rest of the string.

IF THE ARN IS A TOKEN...

...it cannot be validated, since we don't have the actual value yet at the time of this function call. You will have to supply sepIfToken and whether or not ARNs of the expected format usually have resource names in order to parse it properly. The resulting ArnComponents object will contain tokens for the subexpressions of the ARN, not string literals.

If the resource name could possibly contain the separator char, the actual resource name cannot be properly parsed. This only occurs if the separator char is '/', and happens for example for S3 object ARNs, IAM Role ARNs, IAM OIDC Provider ARNs, etc. To properly extract the resource name from a Tokenized ARN, you must know the resource type and call Arn.extractResourceName.

Declaration

parseArn(arn: string, sepIfToken?: string, hasName?: boolean): ArnComponents;

Parameters

arn string

sepIfToken string

hasName boolean

Returns

ArnComponents

an ArnComponents object which allows access to the various components of the ARN.

prepareCrossReference(_sourceStack, reference)

(deprecated) Deprecated.

Declaration

protected prepareCrossReference(_sourceStack: Stack, reference: Reference): IResolvable;

Parameters

_sourceStack Stack

reference Reference

Returns

IResolvable

reference itself without any change https://github.com/aws/aws-cdk/pull/7187

renameLogicalId(oldId, newId)

Rename a generated logical identities.

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

stable

Declaration

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

Parameters

oldId string

newId string

Returns

void

reportMissingContext(report)

(deprecated) DEPRECATED.

Declaration

reportMissingContext(report: cxapi.MissingContext): void;

Parameters

report cxapi.MissingContext

Returns

void

reportMissingContextKey(report)

Indicate that a context key was expected.

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

Declaration

reportMissingContextKey(report: cxschema.MissingContext): void;

Parameters

report cxschema.MissingContext

Returns

void

resolve(obj)

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

stable

Declaration

resolve(obj: any): any;

Parameters

obj any

Returns

any

splitArn(arn, arnFormat)

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

Declaration

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

Parameters

arn string

arnFormat ArnFormat

Returns

ArnComponents

toJsonString(obj, space)

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

stable

Declaration

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

Parameters

obj any

space number

Returns

string