software.amazon.awscdk.core

Class Stack

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Stack

All Implemented Interfaces:

IConstruct, IDependable, ITaggable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.20.8 (build bd5ef4d)",
           date="2019-11-25T14:22:09.471Z")
 @Stability(value=Stable)
public class Stack
extends Construct
implements ITaggable

A root construct which represents a single CloudFormation stack.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stack.Builder A fluent builder for Stack.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.ITaggable

ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Stack() Creates a new stack.
	Stack(Construct scope) Creates a new stack.
	Stack(Construct scope, String id) Creates a new stack.
	Stack(Construct scope, String id, StackProps props) Creates a new stack.
protected	Stack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Stack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addDependency(Stack stack) Add a dependency between this stack and another stack.
void	addDependency(Stack stack, String reason) Add a dependency between this stack and another stack.
DockerImageAssetLocation	addDockerImageAsset(DockerImageAssetSource asset)
FileAssetLocation	addFileAsset(FileAssetSource asset)
protected String	allocateLogicalId(CfnElement cfnElement) Returns the naming scheme used to allocate logical IDs.
String	formatArn(ArnComponents components) Creates an ARN from components.
String	getAccount() The AWS account into which this stack will be deployed.
String	getArtifactId() The ID of the cloud assembly artifact for this stack.
List<String>	getAvailabilityZones() Returnst the list of AZs that are availability in the AWS environment (account/region) associated with this stack.
List<Stack>	getDependencies() Return the stacks this stack depends on.
String	getEnvironment() The environment coordinates in which this stack is deployed.
String	getLogicalId(CfnElement element) Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
Boolean	getNested() Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent.
List<String>	getNotificationArns() Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
Stack	getParentStack() Returns the parent stack if this stack is nested.
String	getPartition() The partition in which this stack is defined.
String	getRegion() The AWS region into which this stack will be deployed (e.g.
String	getStackId() The ID of the stack.
String	getStackName() The concrete CloudFormation physical stack name.
TagManager	getTags() Tags to be applied to the stack.
String	getTemplateFile() The name of the CloudFormation template file emitted to the output directory during synthesis.
ITemplateOptions	getTemplateOptions() Options for CloudFormation template (like version, transform, description).
String	getTemplateUrl() An attribute (late-bound) that represents the URL of the template file in the deployment bucket.
String	getUrlSuffix() The Amazon domain suffix for the region in which this stack is defined.
static Boolean	isStack(Object x) Return whether the given object is a Stack.
static Stack	of(IConstruct construct) Looks up the first stack scope in which `construct` is defined.
ArnComponents	parseArn(String arn) Given an ARN, parses it and returns components.
ArnComponents	parseArn(String arn, String sepIfToken) Given an ARN, parses it and returns components.
ArnComponents	parseArn(String arn, String sepIfToken, Boolean hasName) Given an ARN, parses it and returns components.
protected void	prepare() Prepare stack.
protected IResolvable	prepareCrossReference(Stack sourceStack, Reference reference) Exports a resolvable value for use in another stack.
void	renameLogicalId(String oldId, String newId) Rename a generated logical identities.
void	reportMissingContext(MissingContext report) Indicate that a context key was expected.
Object	resolve(Object obj) Resolve a tokenized value in the context of the current stack.
protected void	synthesize(ISynthesisSession session) Allows this construct to emit artifacts into the cloud assembly during synthesis.
String	toJsonString(Object obj) Convert an object, potentially containing tokens, to a JSON string.
String	toJsonString(Object obj, Number space) Convert an object, potentially containing tokens, to a JSON string.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Stack

protected Stack(software.amazon.jsii.JsiiObjectRef objRef)

Stack

protected Stack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Stack

@Stability(value=Stable)
public Stack(Construct scope,
                                      String id,
                                      StackProps props)

Creates a new stack.

Parameters:

scope - Parent of this stack, usually a Program instance.

id - The construct ID of this stack.

props - Stack properties.

Stack

@Stability(value=Stable)
public Stack(Construct scope,
                                      String id)

Creates a new stack.

Parameters:

scope - Parent of this stack, usually a Program instance.

id - The construct ID of this stack.

Stack

@Stability(value=Stable)
public Stack(Construct scope)

Creates a new stack.

Parameters:

scope - Parent of this stack, usually a Program instance.

Stack

@Stability(value=Stable)
public Stack()

Creates a new stack.

Method Detail

isStack

@Stability(value=Stable)
public static Boolean isStack(Object x)

Return whether the given object is a Stack.

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

Parameters:

x - This parameter is required.

of

@Stability(value=Stable)
public static Stack of(IConstruct construct)

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

Fails if there is no stack up the tree.

Parameters:

construct - The construct to start the search from. This parameter is required.

addDependency

@Stability(value=Stable)
public void addDependency(Stack stack,
                                                   String reason)

Add a dependency between this stack and another stack.

Parameters:

stack - This parameter is required.

reason -

addDependency

@Stability(value=Stable)
public void addDependency(Stack stack)

Add a dependency between this stack and another stack.

Parameters:

stack - This parameter is required.

addDockerImageAsset

@Stability(value=Stable)
public DockerImageAssetLocation addDockerImageAsset(DockerImageAssetSource asset)

Parameters:

asset - This parameter is required.

addFileAsset

@Stability(value=Stable)
public FileAssetLocation addFileAsset(FileAssetSource asset)

Parameters:

asset - This parameter is required.

allocateLogicalId

@Stability(value=Stable)
protected String allocateLogicalId(CfnElement 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.

Parameters:

cfnElement - The element for which the logical ID is allocated. This parameter is required.

formatArn

@Stability(value=Stable)
public String formatArn(ArnComponents 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'.

Parameters:

components - This parameter is required.

getLogicalId

@Stability(value=Stable)
public String getLogicalId(CfnElement 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.

Parameters:

element - The CloudFormation element for which a logical identity is needed. This parameter is required.

parseArn

@Stability(value=Stable)
public ArnComponents parseArn(String arn,
                                                       String sepIfToken,
                                                       Boolean hasName)

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

Parameters:

arn - The ARN string to parse. This parameter is required.

sepIfToken - The separator used to separate resource from resourceName.

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

Returns:

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

parseArn

@Stability(value=Stable)
public ArnComponents parseArn(String arn,
                                                       String sepIfToken)

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

Parameters:

arn - The ARN string to parse. This parameter is required.

sepIfToken - The separator used to separate resource from resourceName.

Returns:

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

parseArn

@Stability(value=Stable)
public ArnComponents parseArn(String arn)

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

Parameters:

arn - The ARN string to parse. This parameter is required.

Returns:

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

prepare

@Stability(value=Stable)
protected void prepare()

Prepare stack.

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

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

Overrides:

prepare in class Construct

prepareCrossReference

@Stability(value=Stable)
protected IResolvable prepareCrossReference(Stack sourceStack,
                                                                     Reference reference)

Exports a resolvable value for use in another stack.

Parameters:

sourceStack - This parameter is required.

reference - This parameter is required.

Returns:

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

renameLogicalId

@Stability(value=Stable)
public void renameLogicalId(String oldId,
                                                     String newId)

Rename a generated logical identities.

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

Parameters:

oldId - This parameter is required.

newId - This parameter is required.

reportMissingContext

@Stability(value=Stable)
public void reportMissingContext(MissingContext 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.

Parameters:

report - The set of parameters needed to obtain the context. This parameter is required.

resolve

@Stability(value=Stable)
public Object resolve(Object obj)

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

Parameters:

obj - This parameter is required.

synthesize

@Stability(value=Stable)
protected void synthesize(ISynthesisSession session)

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

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

Overrides:

synthesize in class Construct

Parameters:

session - This parameter is required.

toJsonString

@Stability(value=Stable)
public String toJsonString(Object obj,
                                                    Number space)

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

Parameters:

obj - This parameter is required.

space -

toJsonString

@Stability(value=Stable)
public String toJsonString(Object obj)

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

Parameters:

obj - This parameter is required.

getAccount

@Stability(value=Stable)
public String getAccount()

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

getArtifactId

@Stability(value=Stable)
public String getArtifactId()

The ID of the cloud assembly artifact for this stack.

getAvailabilityZones

@Stability(value=Stable)
public List<String> getAvailabilityZones()

Returnst the list of AZs that are availability 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.

getDependencies

@Stability(value=Stable)
public List<Stack> getDependencies()

Return the stacks this stack depends on.

getEnvironment

@Stability(value=Stable)
public String getEnvironment()

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.

getNested

@Stability(value=Stable)
public Boolean getNested()

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

getNotificationArns

@Stability(value=Stable)
public List<String> getNotificationArns()

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

getPartition

@Stability(value=Stable)
public String getPartition()

The partition in which this stack is defined.

getRegion

@Stability(value=Stable)
public String getRegion()

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

getStackId

@Stability(value=Stable)
public String getStackId()

The ID of the stack. Example:

 // This example is in TypeScript, examples in Java are coming soon.
 After resolving, looks like arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123
 

getStackName

@Stability(value=Stable)
public String getStackName()

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.

getTags

@Stability(value=Stable)
public TagManager getTags()

Tags to be applied to the stack.

Specified by:

getTags in interface ITaggable

getTemplateFile

@Stability(value=Stable)
public String getTemplateFile()

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

 // This example is in TypeScript, examples in Java are coming soon.
 MyStack.template.json
 

getTemplateOptions

@Stability(value=Stable)
public ITemplateOptions getTemplateOptions()

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

getTemplateUrl

@Stability(value=Experimental)
public String getTemplateUrl()

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

getUrlSuffix

@Stability(value=Stable)
public String getUrlSuffix()

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

getParentStack

@Stability(value=Experimental)
public Stack getParentStack()

Returns the parent stack if this stack is nested. EXPERIMENTAL