Class Stack

A root construct which represents a single CloudFormation stack.

Inheritance

System.Object

Construct

Stack

NestedStack

Implements

IConstruct

IDependable

ITaggable

Inherited Members

Construct.IsConstruct(Object)

Construct.ToString()

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK

Assembly: Amazon.CDK.dll

Syntax (csharp)

public class Stack : Construct, IConstruct, IDependable, ITaggable

Syntax (vb)

Public Class Stack
    Inherits Construct
    Implements IConstruct, IDependable, ITaggable

Remarks

stability: Stable

Synopsis

Constructors

Stack(Construct, String, IStackProps)	Creates a new stack.
Stack(ByRefValue)
Stack(DeputyBase.DeputyProps)

Properties

Account	The AWS account into which this stack will be deployed.
AvailabilityZones	Returnst the list of AZs that are availability 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.
NotificationArns	Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
ParentStack	Returns the parent stack if this stack is nested.
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.
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).
TemplateUrl	An attribute (late-bound) that represents the URL of the template file in the deployment bucket.
UrlSuffix	The Amazon domain suffix for the region in which this stack is defined.

Methods

AddDependency(Stack, String)	Add a dependency between this stack and another stack.
AddDockerImageAsset(IDockerImageAssetSource)
AddFileAsset(IFileAssetSource)
AllocateLogicalId(CfnElement)
FormatArn(IArnComponents)	Creates an ARN from components.
GetLogicalId(CfnElement)	Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
IsStack(Object)	Return whether the given object is a Stack.
Of(IConstruct)	Looks up the first stack scope in which construct is defined.
ParseArn(String, String, Nullable<Boolean>)	Given an ARN, parses it and returns components.
Prepare()	Prepare stack.
PrepareCrossReference(Stack, Reference)	Exports a resolvable value for use in another stack.
RenameLogicalId(String, String)	Rename a generated logical identities.
ReportMissingContext(IMissingContext)	Indicate that a context key was expected.
Resolve(Object)	Resolve a tokenized value in the context of the current stack.
Synthesize(ISynthesisSession)	Allows this construct to emit artifacts into the cloud assembly during synthesis.
ToJsonString(Object, Nullable<Double>)	Convert an object, potentially containing tokens, to a JSON string.

Constructors

Stack(Construct, String, IStackProps)

Creates a new stack.

public Stack(Construct scope = null, string name = null, IStackProps props = null)

Parameters

scope Construct

Parent of this stack, usually a Program instance.

name System.String

The name of the CloudFormation stack.

props IStackProps

Stack properties.

Remarks

stability: Stable

Stack(ByRefValue)

protected Stack(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

Stack(DeputyBase.DeputyProps)

protected Stack(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

Properties

Account

The AWS account into which this stack will be deployed.

public virtual string Account { get; }

Property Value

System.String

Remarks

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.
2. 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 node.addError) or implement some other region-agnostic behavior. stability: Stable

AvailabilityZones

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

public virtual string[] AvailabilityZones { get; }

Property Value

System.String[]

Remarks

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. stability: Stable

Dependencies

Return the stacks this stack depends on.

public virtual Stack[] Dependencies { get; }

Property Value

Stack[]

Remarks

stability: Stable

Environment

The environment coordinates in which this stack is deployed.

public virtual string Environment { get; }

Property Value

System.String

Remarks

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. stability: Stable

Nested

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

public virtual bool Nested { get; }

Property Value

System.Boolean

Remarks

stability: Stable

NotificationArns

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

public virtual string[] NotificationArns { get; }

Property Value

System.String[]

Remarks

stability: Stable

ParentStack

Returns the parent stack if this stack is nested.

public virtual Stack ParentStack { get; }

Property Value

Stack

Remarks

stability: Experimental

Partition

The partition in which this stack is defined.

public virtual string Partition { get; }

Property Value

System.String

Remarks

stability: Stable

Region

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

public virtual string Region { get; }

Property Value

System.String

Remarks

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.
2. 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 node.addError) or implement some other region-agnostic behavior. stability: Stable

StackId

The ID of the stack.

public virtual string StackId { get; }

Property Value

System.String

Remarks

stability: Stable example:

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

StackName

The concrete CloudFormation physical stack name.

public virtual string StackName { get; }

Property Value

System.String

Remarks

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. stability: Stable

Tags

Tags to be applied to the stack.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

stability: Stable

TemplateFile

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

public virtual string TemplateFile { get; }

Property Value

System.String

Remarks

stability: Stable example:

MyStack.template.json

TemplateOptions

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

public virtual ITemplateOptions TemplateOptions { get; }

Property Value

ITemplateOptions

Remarks

stability: Stable

TemplateUrl

An attribute (late-bound) that represents the URL of the template file in the deployment bucket.

public virtual string TemplateUrl { get; }

Property Value

System.String

Remarks

stability: Experimental

UrlSuffix

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

public virtual string UrlSuffix { get; }

Property Value

System.String

Remarks

stability: Stable

Methods

AddDependency(Stack, String)

Add a dependency between this stack and another stack.

public virtual void AddDependency(Stack stack, string reason = null)

Parameters

stack Stack

reason System.String

Remarks

stability: Stable

AddDockerImageAsset(IDockerImageAssetSource)

public virtual IDockerImageAssetLocation AddDockerImageAsset(IDockerImageAssetSource asset)

Parameters

asset IDockerImageAssetSource

Returns

IDockerImageAssetLocation

Remarks

stability: Stable

AddFileAsset(IFileAssetSource)

public virtual IFileAssetLocation AddFileAsset(IFileAssetSource asset)

Parameters

asset IFileAssetSource

Returns

IFileAssetLocation

Remarks

stability: Stable

AllocateLogicalId(CfnElement)

protected virtual string AllocateLogicalId(CfnElement cfnElement)

Parameters

cfnElement CfnElement

Returns

System.String

FormatArn(IArnComponents)

Creates an ARN from components.

public virtual string FormatArn(IArnComponents components)

Parameters

components IArnComponents

Returns

System.String

Remarks

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'. stability: Stable

GetLogicalId(CfnElement)

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

public virtual string GetLogicalId(CfnElement element)

Parameters

element CfnElement

The CloudFormation element for which a logical identity is needed.

Returns

System.String

Remarks

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. stability: Stable

IsStack(Object)

Return whether the given object is a Stack.

public static bool IsStack(object x)

Parameters

x System.Object

Returns

System.Boolean

Remarks

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

Of(IConstruct)

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

public static Stack Of(IConstruct construct)

Parameters

construct IConstruct

The construct to start the search from.

Returns

Stack

Remarks

Fails if there is no stack up the tree. stability: Stable

ParseArn(String, String, Nullable<Boolean>)

Given an ARN, parses it and returns components.

public virtual IArnComponents ParseArn(string arn, string sepIfToken = null, Nullable<bool> hasName = null)

Parameters

arn System.String

The ARN string to parse.

sepIfToken System.String

The separator used to separate resource from resourceName.

hasName System.Nullable<System.Boolean>

Whether there is a name component in the ARN at all.

Returns

IArnComponents

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

Remarks

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 includes tokens (or is a token), the ARN cannot be validated, since we don't have the actual value yet at the time of this function call. You will have to know the separator and the type of ARN. The resulting ArnComponents object will contain tokens for the subexpressions of the ARN, not string literals. In this case this function cannot properly parse the complete final resourceName (path) out of ARNs that use '/' to both separate the 'resource' from the 'resourceName' AND to subdivide the resourceName further. For example, in S3 ARNs:

arn:aws:s3:::my_corporate_bucket/path/to/exampleobject.png

After parsing the resourceName will not contain 'path/to/exampleobject.png' but simply 'path'. This is a limitation because there is no slicing functionality in CloudFormation templates. stability: Stable

Prepare()

Prepare stack.

protected override void Prepare()

Overrides

Construct.Prepare()

Remarks

Find all CloudFormation references and tell them we're consuming them.

Find all dependencies as well and add the appropriate DependsOn fields. stability: Stable

PrepareCrossReference(Stack, Reference)

Exports a resolvable value for use in another stack.

protected virtual IResolvable PrepareCrossReference(Stack sourceStack, Reference reference)

Parameters

sourceStack Stack

reference Reference

Returns

IResolvable

a token that can be used to reference the value from the producing stack.

Remarks

stability: Stable

RenameLogicalId(String, String)

Rename a generated logical identities.

public virtual void RenameLogicalId(string oldId, string newId)

Parameters

oldId System.String

newId System.String

Remarks

To modify the naming scheme strategy, extend the Stack class and override the createNamingScheme method. stability: Stable

ReportMissingContext(IMissingContext)

Indicate that a context key was expected.

public virtual void ReportMissingContext(IMissingContext report)

Parameters

report IMissingContext

The set of parameters needed to obtain the context.

Remarks

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

Resolve(Object)

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

public virtual object Resolve(object obj)

Parameters

obj System.Object

Returns

System.Object

Remarks

stability: Stable

Synthesize(ISynthesisSession)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

protected override void Synthesize(ISynthesisSession session)

Parameters

session ISynthesisSession

Overrides

Construct.Synthesize(ISynthesisSession)

Remarks

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly. stability: Stable

ToJsonString(Object, Nullable<Double>)

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

public virtual string ToJsonString(object obj, Nullable<double> space = null)

Parameters

obj System.Object

space System.Nullable<System.Double>

Returns

System.String

Remarks

stability: Stable

Implements

IConstruct

IDependable

ITaggable