The ID of the cloud assembly artifact for this stack.
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.
If this is a nested stack, this represents its AWS::CloudFormation::Stack
resource. undefined
for top-level (non-nested) stacks.
The construct tree node associated with this construct.
The AWS region into which this stack will be deployed (e.g. us-west-2
).
This value is resolved according to the following rules:
env.region
when the stack is defined. This can
either be a concerete 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 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.
Tags to be applied to the stack.
The name of the CloudFormation template file emitted to the output directory during synthesis.
Options for CloudFormation template (like version, transform, description).
An attribute (late-bound) that represents the URL of the template file in the deployment bucket.
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.
Return the stacks this stack depends on
Indicates if this is a nested stack, in which case parentStack
will include a reference to it's parent.
If this is a nested stack, returns it's parent stack.
Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
Returns the parent of a nested stack.
The partition in which this stack is defined
The ID of the stack
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.
The Amazon domain suffix for the region in which this stack is defined
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.
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.
The transform to add
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:
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>
The element for which the logical ID is allocated.
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'.
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.
The CloudFormation element for which a logical identity is needed.
Perform final modifications before synthesis
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
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.
The synthesis session.
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
An array of validation error messages, or an empty array if there the construct is valid.
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.
The ARN string to parse
The separator used to separate resource from resourceName
Whether there is a name component in the ARN at all. For example, SNS Topics ARNs have the 'resource' component contain the topic name, and no 'resourceName' component.
an ArnComponents object which allows access to the various components of the ARN.
Prepare stack
Find all CloudFormation references and tell them we're consuming them.
Find all dependencies as well and add the appropriate DependsOn fields.
Exports a resolvable value for use in another stack.
a token that can be used to reference the value from the producing stack.
Rename a generated logical identities
To modify the naming scheme strategy, extend the Stack
class and
override the createNamingScheme
method.
Indicate that a context key was expected
Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.
The set of parameters needed to obtain the context
Resolve a tokenized value in the context of the current stack.
Convert an object, potentially containing tokens, to a JSON string
Returns a string representation of this construct.
Validate the current construct.
This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.
An array of validation error messages, or an empty array if there the construct is valid.
Return whether the given object is a Construct
Return whether the given object is a Stack.
We do attribute detection since we can't reliably use 'instanceof'.
Looks up the first stack scope in which construct
is defined. Fails if there is no stack up the tree.
The construct to start the search from.
Generated using TypeDoc
The AWS account into which this stack will be deployed.
This value is resolved according to the following rules:
env.account
when the stack is defined. This can either be a concerete account (e.g.585695031111
) or theAws.accountId
token.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)
returnstrue
), 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 usingnode.addError
) or implement some other region-agnostic behavior.