Class Stack
- All Implemented Interfaces:
IConstruct
,IDependable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
- Direct Known Subclasses:
IntegTestCaseStack
,NestedStack
,ProductStack
Example:
import software.amazon.awscdk.core.*; import software.amazon.awscdk.services.servicediscovery.*; App app = new App(); Stack stack = new Stack(app, "aws-servicediscovery-integ"); PublicDnsNamespace namespace = PublicDnsNamespace.Builder.create(stack, "Namespace") .name("foobar.com") .build(); Service service = namespace.createService("Service", DnsServiceProps.builder() .name("foo") .dnsRecordType(DnsRecordType.A) .dnsTtl(Duration.seconds(30)) .healthCheck(HealthCheckConfig.builder() .type(HealthCheckType.HTTPS) .resourcePath("/healthcheck") .failureThreshold(2) .build()) .build()); service.registerIpInstance("IpInstance", IpInstanceBaseProps.builder() .ipv4("54.239.25.192") .port(443) .build()); app.synth();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default, IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionStack()
Creates a new stack.protected
Stack
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Stack
(software.amazon.jsii.JsiiObjectRef objRef) Stack
(software.constructs.Construct scope) Creates a new stack.Creates a new stack.Stack
(software.constructs.Construct scope, String id, StackProps props) Creates a new stack. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDependency
(Stack target) Add a dependency between this stack and another stack.void
addDependency
(Stack target, String reason) Add a dependency between this stack and another stack.Deprecated.addFileAsset
(FileAssetSource asset) Deprecated.Usestack.synthesizer.addFileAsset()
if you are calling, and a different IStackSynthesizer class if you are implementing.void
addTransform
(String transform) Add a Transform to this stack.protected String
allocateLogicalId
(CfnElement cfnElement) Returns the naming scheme used to allocate logical IDs.exportValue
(Object exportedValue) Create a CloudFormation Export for a value.exportValue
(Object exportedValue, ExportValueOptions options) Create a CloudFormation Export for a value.formatArn
(ArnComponents components) Creates an ARN from components.The AWS account into which this stack will be deployed.The ID of the cloud assembly artifact for this stack.Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.Indicates whether the stack requires bundling or not.Return the stacks this stack depends on.The environment coordinates in which this stack is deployed.getLogicalId
(CfnElement element) Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.Indicates if this is a nested stack, in which caseparentStack
will include a reference to it's parent.If this is a nested stack, returns it's parent stack.If this is a nested stack, this represents itsAWS::CloudFormation::Stack
resource.Returns the list of notification Amazon Resource Names (ARNs) for the current stack.Deprecated.usenestedStackParent
The partition in which this stack is defined.The AWS region into which this stack will be deployed (e.g.The ID of the stack.The concrete CloudFormation physical stack name.Synthesis method for this stack.getTags()
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).Whether termination protection is enabled for this stack.The Amazon domain suffix for the region in which this stack is defined.static Boolean
Return whether the given object is a Stack.static Stack
of
(software.constructs.IConstruct construct) Looks up the first stack scope in whichconstruct
is defined.Deprecated.use splitArn insteadDeprecated.use splitArn insteadDeprecated.use splitArn insteadprotected IResolvable
prepareCrossReference
(Stack _sourceStack, Reference reference) Deprecated.cross reference handling has been moved toApp.prepare()
.regionalFact
(String factName) Look up a fact value for the given fact for the region of this stack.regionalFact
(String factName, String defaultValue) Look up a fact value for the given fact for the region of this stack.void
renameLogicalId
(String oldId, String newId) Rename a generated logical identities.void
reportMissingContext
(MissingContext report) Deprecated.usereportMissingContextKey()
void
Indicate that a context key was expected.Resolve a tokenized value in the context of the current stack.Splits the provided ARN into its components.toJsonString
(Object obj) Convert an object, potentially containing tokens, to a JSON 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, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.constructs.Construct
toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, 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 Details
-
Stack
protected Stack(software.amazon.jsii.JsiiObjectRef objRef) -
Stack
protected Stack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
Stack
@Stability(Stable) public Stack(@Nullable software.constructs.Construct scope, @Nullable String id, @Nullable StackProps props) Creates a new stack.- Parameters:
scope
- Parent of this stack, usually anApp
or aStage
, but could be any construct.id
- The construct ID of this stack.props
- Stack properties.
-
Stack
Creates a new stack.- Parameters:
scope
- Parent of this stack, usually anApp
or aStage
, but could be any construct.id
- The construct ID of this stack.
-
Stack
@Stability(Stable) public Stack(@Nullable software.constructs.Construct scope) Creates a new stack.- Parameters:
scope
- Parent of this stack, usually anApp
or aStage
, but could be any construct.
-
Stack
@Stability(Stable) public Stack()Creates a new stack.
-
-
Method Details
-
isStack
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(Stable) @NotNull public static Stack of(@NotNull software.constructs.IConstruct construct) Looks up the first stack scope in whichconstruct
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
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.
- Parameters:
target
- This parameter is required.reason
-
-
addDependency
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.
- Parameters:
target
- This parameter is required.
-
addDockerImageAsset
@Stability(Deprecated) @Deprecated @NotNull public DockerImageAssetLocation addDockerImageAsset(@NotNull DockerImageAssetSource asset) Deprecated.Usestack.synthesizer.addDockerImageAsset()
if you are calling, and a differentIStackSynthesizer
class if you are implementing.(deprecated) Register a docker image asset on this Stack.- Parameters:
asset
- This parameter is required.
-
addFileAsset
@Stability(Deprecated) @Deprecated @NotNull public FileAssetLocation addFileAsset(@NotNull FileAssetSource asset) Deprecated.Usestack.synthesizer.addFileAsset()
if you are calling, and a different IStackSynthesizer class if you are implementing.(deprecated) Register a file asset on this Stack.- Parameters:
asset
- This parameter is required.
-
addTransform
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.
Example:
Stack stack; stack.addTransform("AWS::Serverless-2016-10-31");
- Parameters:
transform
- The transform to add. This parameter is required.- See Also:
-
allocateLogicalId
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 ofL1L2PipelinePipeline<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.
-
exportValue
@Stability(Stable) @NotNull public String exportValue(@NotNull Object exportedValue, @Nullable ExportValueOptions 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 thename
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
andconsumerStack
, andproducerStack
has a bucket calledbucket
, which is referenced byconsumerStack
(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 referencesbucket.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, callthis.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 fromproducerStack
. - 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).
- Parameters:
exportedValue
- This parameter is required.options
-
- Make sure
-
exportValue
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 thename
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
andconsumerStack
, andproducerStack
has a bucket calledbucket
, which is referenced byconsumerStack
(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 referencesbucket.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, callthis.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 fromproducerStack
. - 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).
- Parameters:
exportedValue
- This parameter is required.
- Make sure
-
formatArn
Creates an ARN from components.If
partition
,region
oraccount
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
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 theStack
class and override this method.- Parameters:
element
- The CloudFormation element for which a logical identity is needed. This parameter is required.
-
parseArn
@Stability(Deprecated) @Deprecated @NotNull public ArnComponents parseArn(@NotNull String arn, @Nullable String sepIfToken, @Nullable Boolean hasName) Deprecated.use splitArn instead(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 '/' andresourceName
will be the rest. In case there is no '/',resource
will be set to the 6th components andresourceName
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 resultingArnComponents
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
.- 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(Deprecated) @Deprecated @NotNull public ArnComponents parseArn(@NotNull String arn, @Nullable String sepIfToken) Deprecated.use splitArn instead(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 '/' andresourceName
will be the rest. In case there is no '/',resource
will be set to the 6th components andresourceName
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 resultingArnComponents
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
.- 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
Deprecated.use splitArn instead(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 '/' andresourceName
will be the rest. In case there is no '/',resource
will be set to the 6th components andresourceName
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 resultingArnComponents
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
.- 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.
-
prepareCrossReference
@Stability(Deprecated) @Deprecated @NotNull protected IResolvable prepareCrossReference(@NotNull Stack _sourceStack, @NotNull Reference reference) Deprecated.cross reference handling has been moved toApp.prepare()
.(deprecated) Deprecated.- Parameters:
_sourceStack
- This parameter is required.reference
- This parameter is required.- Returns:
- reference itself without any change
- See Also:
-
regionalFact
@Stability(Stable) @NotNull public String regionalFact(@NotNull String factName, @Nullable String defaultValue) 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.- Parameters:
factName
- This parameter is required.defaultValue
-
-
regionalFact
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.- Parameters:
factName
- This parameter is required.
-
renameLogicalId
Rename a generated logical identities.To modify the naming scheme strategy, extend the
Stack
class and override theallocateLogicalId
method.- Parameters:
oldId
- This parameter is required.newId
- This parameter is required.
-
reportMissingContext
Deprecated.usereportMissingContextKey()
(deprecated) DEPRECATED.- Parameters:
report
- This parameter is required.
-
reportMissingContextKey
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
Resolve a tokenized value in the context of the current stack.- Parameters:
obj
- This parameter is required.
-
splitArn
@Stability(Stable) @NotNull public ArnComponents splitArn(@NotNull String arn, @NotNull ArnFormat 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).
- Parameters:
arn
- the ARN to split into its components. This parameter is required.arnFormat
- the expected format of 'arn' - depends on what format the service 'arn' represents uses. This parameter is required.
-
toJsonString
Convert an object, potentially containing tokens, to a JSON string.- Parameters:
obj
- This parameter is required.space
-
-
toJsonString
Convert an object, potentially containing tokens, to a JSON string.- Parameters:
obj
- This parameter is required.
-
getAccount
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 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 usingAnnotations.of(construct).addError()
) or implement some other region-agnostic behavior. - The value provided to
-
getArtifactId
The ID of the cloud assembly artifact for this stack. -
getAvailabilityZones
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.
-
getBundlingRequired
Indicates whether the stack requires bundling or not. -
getDependencies
Return the stacks this stack depends on. -
getEnvironment
The environment coordinates in which this stack is deployed.In the form
aws://account/region
. Usestack.account
andstack.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
orstack.region
are not concrete values (e.g.Aws.account
orAws.region
) the special stringsunknown-account
and/orunknown-region
will be used respectively to indicate this stack is region/account-agnostic. -
getNested
Indicates if this is a nested stack, in which caseparentStack
will include a reference to it's parent. -
getNotificationArns
Returns the list of notification Amazon Resource Names (ARNs) for the current stack. -
getPartition
The partition in which this stack is defined. -
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:
- The value provided to
env.region
when the stack is defined. This can either be a concerete region (e.g.us-west-2
) or theAws.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)
returnstrue
), 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 usingAnnotations.of(construct).addError()
) or implement some other region-agnostic behavior. - The value provided to
-
getStackId
The ID of the stack.Example:
// After resolving, looks like "arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123";
-
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 constructid
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. -
getSynthesizer
Synthesis method for this stack. -
getTags
Tags to be applied to the stack. -
getTemplateFile
The name of the CloudFormation template file emitted to the output directory during synthesis.Example value:
MyStack.template.json
-
getTemplateOptions
Options for CloudFormation template (like version, transform, description). -
getUrlSuffix
The Amazon domain suffix for the region in which this stack is defined. -
getNestedStackParent
If this is a nested stack, returns it's parent stack. -
getNestedStackResource
If this is a nested stack, this represents itsAWS::CloudFormation::Stack
resource.undefined
for top-level (non-nested) stacks. -
getParentStack
Deprecated.usenestedStackParent
(deprecated) Returns the parent of a nested stack. -
getTerminationProtection
Whether termination protection is enabled for this stack.
-
stack.synthesizer.addDockerImageAsset()
if you are calling, and a differentIStackSynthesizer
class if you are implementing.