@Generated(value="jsii-pacmak/1.30.0 (build adae23f)", date="2021-06-30T10:00:44.848Z") @Stability(value=Experimental) public class Stack extends software.constructs.Construct implements ITaggable
| Modifier and Type | Class and Description |
|---|---|
static class |
Stack.Builder
(experimental) A fluent builder for
Stack. |
software.amazon.jsii.JsiiObject.InitializationModeITaggable.Jsii$Default, ITaggable.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
|
Stack()
(experimental) Creates a new stack.
|
|
Stack(software.constructs.Construct scope)
(experimental) Creates a new stack.
|
|
Stack(software.constructs.Construct scope,
String id)
(experimental) Creates a new stack.
|
|
Stack(software.constructs.Construct scope,
String id,
StackProps props)
(experimental) Creates a new stack.
|
protected |
Stack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
Stack(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
void |
addDependency(Stack target)
(experimental) Add a dependency between this stack and another stack.
|
void |
addDependency(Stack target,
String reason)
(experimental) Add a dependency between this stack and another stack.
|
void |
addTransform(String transform)
(experimental) Add a Transform to this stack.
|
protected String |
allocateLogicalId(CfnElement cfnElement)
(experimental) Returns the naming scheme used to allocate logical IDs.
|
String |
exportValue(Object exportedValue)
(experimental) Create a CloudFormation Export for a value.
|
String |
exportValue(Object exportedValue,
ExportValueOptions options)
(experimental) Create a CloudFormation Export for a value.
|
String |
formatArn(ArnComponents components)
(experimental) Creates an ARN from components.
|
String |
getAccount()
(experimental) The AWS account into which this stack will be deployed.
|
String |
getArtifactId()
(experimental) The ID of the cloud assembly artifact for this stack.
|
List<String> |
getAvailabilityZones()
(experimental) Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
|
List<Stack> |
getDependencies()
(experimental) Return the stacks this stack depends on.
|
String |
getEnvironment()
(experimental) The environment coordinates in which this stack is deployed.
|
String |
getLogicalId(CfnElement element)
(experimental) Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
|
Boolean |
getNested()
(experimental) Indicates if this is a nested stack, in which case `parentStack` will include a reference to it's parent.
|
Stack |
getNestedStackParent()
(experimental) If this is a nested stack, returns it's parent stack.
|
CfnResource |
getNestedStackResource()
(experimental) If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.
|
List<String> |
getNotificationArns()
(experimental) Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
|
String |
getPartition()
(experimental) The partition in which this stack is defined.
|
String |
getRegion()
(experimental) The AWS region into which this stack will be deployed (e.g.
|
String |
getStackId()
(experimental) The ID of the stack.
|
String |
getStackName()
(experimental) The concrete CloudFormation physical stack name.
|
IStackSynthesizer |
getSynthesizer()
(experimental) Synthesis method for this stack.
|
TagManager |
getTags()
(experimental) Tags to be applied to the stack.
|
String |
getTemplateFile()
(experimental) The name of the CloudFormation template file emitted to the output directory during synthesis.
|
ITemplateOptions |
getTemplateOptions()
(experimental) Options for CloudFormation template (like version, transform, description).
|
Boolean |
getTerminationProtection()
(experimental) Whether termination protection is enabled for this stack.
|
String |
getUrlSuffix()
(experimental) The Amazon domain suffix for the region in which this stack is defined.
|
static Boolean |
isStack(Object x)
(experimental) Return whether the given object is a Stack.
|
static Stack |
of(software.constructs.IConstruct construct)
(experimental) Looks up the first stack scope in which `construct` is defined.
|
ArnComponents |
parseArn(String arn)
(experimental) Given an ARN, parses it and returns components.
|
ArnComponents |
parseArn(String arn,
String sepIfToken)
(experimental) Given an ARN, parses it and returns components.
|
ArnComponents |
parseArn(String arn,
String sepIfToken,
Boolean hasName)
(experimental) Given an ARN, parses it and returns components.
|
void |
renameLogicalId(String oldId,
String newId)
(experimental) Rename a generated logical identities.
|
void |
reportMissingContextKey(MissingContext report)
(experimental) Indicate that a context key was expected.
|
Object |
resolve(Object obj)
(experimental) Resolve a tokenized value in the context of the current stack.
|
String |
toJsonString(Object obj)
(experimental) Convert an object, potentially containing tokens, to a JSON string.
|
String |
toJsonString(Object obj,
Number space)
(experimental) Convert an object, potentially containing tokens, to a JSON string.
|
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetprotected Stack(software.amazon.jsii.JsiiObjectRef objRef)
protected Stack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Experimental)
public Stack(@Nullable
software.constructs.Construct scope,
@Nullable
String id,
@Nullable
StackProps props)
scope - Parent of this stack, usually an `App` or a `Stage`, but could be any construct.id - The construct ID of this stack.props - Stack properties.@Stability(value=Experimental)
public Stack(@Nullable
software.constructs.Construct scope,
@Nullable
String id)
scope - Parent of this stack, usually an `App` or a `Stage`, but could be any construct.id - The construct ID of this stack.@Stability(value=Experimental)
public Stack(@Nullable
software.constructs.Construct scope)
scope - Parent of this stack, usually an `App` or a `Stage`, but could be any construct.@Stability(value=Experimental) public Stack()
@Stability(value=Experimental) @NotNull public static Boolean isStack(@NotNull Object x)
We do attribute detection since we can't reliably use 'instanceof'.
x - This parameter is required.@Stability(value=Experimental) @NotNull public static Stack of(@NotNull software.constructs.IConstruct construct)
Fails if there is no stack up the tree.
construct - The construct to start the search from. This parameter is required.@Stability(value=Experimental)
public void addDependency(@NotNull
Stack target,
@Nullable
String reason)
This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.
target - This parameter is required.reason - @Stability(value=Experimental)
public void addDependency(@NotNull
Stack target)
This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.
target - This parameter is required.@Stability(value=Experimental)
public void addTransform(@NotNull
String transform)
Duplicate values are removed when stack is synthesized.
Example:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 stack.addTransform("AWS::Serverless-2016-10-31");
transform - The transform to add. This parameter is required.https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html@Stability(value=Experimental) @NotNull protected String allocateLogicalId(@NotNull CfnElement cfnElement)
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>cfnElement - The element for which the logical ID is allocated. This parameter is required.@Stability(value=Experimental) @NotNull public String exportValue(@NotNull Object exportedValue, @Nullable ExportValueOptions options)
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.
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:
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).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.consumerStack, but it's safe to deploy both).
bucket resource from producerStack.exportValue() call as well.producerStack will be changed -- the bucket will be deleted).exportedValue - This parameter is required.options - @Stability(value=Experimental) @NotNull public String exportValue(@NotNull Object exportedValue)
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.
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:
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).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.consumerStack, but it's safe to deploy both).
bucket resource from producerStack.exportValue() call as well.producerStack will be changed -- the bucket will be deleted).exportedValue - This parameter is required.@Stability(value=Experimental) @NotNull public String formatArn(@NotNull ArnComponents 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'.
components - This parameter is required.@Stability(value=Experimental) @NotNull public String getLogicalId(@NotNull CfnElement element)
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.
element - The CloudFormation element for which a logical identity is needed. This parameter is required.@Stability(value=Experimental) @NotNull public ArnComponents parseArn(@NotNull String arn, @Nullable String sepIfToken, @Nullable Boolean hasName)
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.
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.@Stability(value=Experimental) @NotNull public ArnComponents parseArn(@NotNull String arn, @Nullable String sepIfToken)
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.
arn - The ARN string to parse. This parameter is required.sepIfToken - The separator used to separate resource from resourceName.@Stability(value=Experimental) @NotNull public ArnComponents parseArn(@NotNull String arn)
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.
arn - The ARN string to parse. This parameter is required.@Stability(value=Experimental)
public void renameLogicalId(@NotNull
String oldId,
@NotNull
String newId)
To modify the naming scheme strategy, extend the Stack class and
override the allocateLogicalId method.
oldId - This parameter is required.newId - This parameter is required.@Stability(value=Experimental)
public void reportMissingContextKey(@NotNull
MissingContext report)
Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.
report - The set of parameters needed to obtain the context. This parameter is required.@Stability(value=Experimental) @NotNull public Object resolve(@NotNull Object obj)
obj - This parameter is required.@Stability(value=Experimental) @NotNull public String toJsonString(@NotNull Object obj, @Nullable Number space)
obj - This parameter is required.space - @Stability(value=Experimental) @NotNull public String toJsonString(@NotNull Object obj)
obj - This parameter is required.@Stability(value=Experimental) @NotNull public String getAccount()
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 the
Aws.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) 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.
@Stability(value=Experimental) @NotNull public String getArtifactId()
@Stability(value=Experimental) @NotNull public List<String> getAvailabilityZones()
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.
@Stability(value=Experimental) @NotNull public List<Stack> getDependencies()
@Stability(value=Experimental) @NotNull public String getEnvironment()
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(value=Experimental) @NotNull public Boolean getNested()
@Stability(value=Experimental) @NotNull public List<String> getNotificationArns()
@Stability(value=Experimental) @NotNull public String getPartition()
@Stability(value=Experimental) @NotNull public String getRegion()
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 Annotations.of(construct).addError()) or
implement some other region-agnostic behavior.
@Stability(value=Experimental) @NotNull public String getStackId()
Example:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 // After resolving, looks like "arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123";
@Stability(value=Experimental) @NotNull public String getStackName()
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(value=Experimental) @NotNull public IStackSynthesizer getSynthesizer()
@Stability(value=Experimental) @NotNull public TagManager getTags()
@Stability(value=Experimental) @NotNull public String getTemplateFile()
Example:
// Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 "MyStack.template.json";
@Stability(value=Experimental) @NotNull public ITemplateOptions getTemplateOptions()
@Stability(value=Experimental) @NotNull public String getUrlSuffix()
@Stability(value=Experimental) @Nullable public Stack getNestedStackParent()
@Stability(value=Experimental) @Nullable public CfnResource getNestedStackResource()
undefined for top-level (non-nested) stacks.
@Stability(value=Experimental) @Nullable public Boolean getTerminationProtection()
Copyright © 2021. All rights reserved.