Package software.amazon.awscdk

Class Stack

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Stack
All Implemented Interfaces:
ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
DefaultStagingStack, IntegTestCaseStack, NestedStack, ProductStack
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-11T03:45:48.775Z") @Stability(Stable) public class Stack extends software.constructs.Construct implements ITaggable
A root construct which represents a single CloudFormation stack.

Example: 

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.s3.*;
 IBucket bucket;
 App app = new App();
 Stack stack = new Stack(app, "Stack");
 Table.Builder.create(stack, "Table")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .importSource(ImportSourceSpecification.builder()
                 .compressionType(InputCompressionType.GZIP)
                 .inputFormat(InputFormat.csv(CsvOptions.builder()
                         .delimiter(",")
                         .headerList(List.of("id", "name"))
                         .build()))
                 .bucket(bucket)
                 .keyPrefix("prefix")
                 .build())
         .build();

  • 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 an App or a Stage, but could be any construct.
      id - The construct ID of this stack.
      props - Stack properties.

    • Stack

      @Stability(Stable) public Stack(@Nullable software.constructs.Construct scope, @Nullable String id)
      Creates a new stack.

      Parameters:
      scope - Parent of this stack, usually an App or a Stage, 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 an App or a Stage, but could be any construct.

    • Stack

      @Stability(Stable) public Stack()
      Creates a new stack.

  • Method Details

    • isStack

      @Stability(Stable) @NotNull public static Boolean isStack(@NotNull 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(Stable) @NotNull public static Stack of(@NotNull software.constructs.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(Stable) public void addDependency(@NotNull Stack target, @Nullable String reason)
      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

      @Stability(Stable) public void addDependency(@NotNull Stack target)
      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.

    • addMetadata

      @Stability(Stable) public void addMetadata(@NotNull String key, @NotNull Object value)
      Adds an arbitary key-value pair, with information you want to record about the stack.

      These get translated to the Metadata section of the generated template.

      Parameters:
      key - This parameter is required.
      value - This parameter is required.
      See Also:

    • addTransform

      @Stability(Stable) public void addTransform(@NotNull String transform)
      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

      @Stability(Stable) @NotNull protected String allocateLogicalId(@NotNull 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 disambiguation 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.

    • exportStringListValue

      @Stability(Stable) @NotNull public List<String> exportStringListValue(@NotNull Object exportedValue, @Nullable ExportValueOptions options)
      Create a CloudFormation Export for a string list value.

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. 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.

      See exportValue for an example of this process.

      Parameters:
      exportedValue - This parameter is required.
      options -

    • exportStringListValue

      @Stability(Stable) @NotNull public List<String> exportStringListValue(@NotNull Object exportedValue)
      Create a CloudFormation Export for a string list value.

      Returns a string list representing the corresponding Fn.importValue() expression for this Export. The export expression is automatically wrapped with an Fn::Join and the import value with an Fn::Split, since CloudFormation can only export strings. 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.

      See exportValue for an example of this process.

      Parameters:
      exportedValue - This parameter is required.

    • exportValue

      @Stability(Stable) @NotNull public String exportValue(@NotNull Object exportedValue, @Nullable ExportValueOptions options)
      Create a CloudFormation Export for a string value.

      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.

      Example

      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:

      Deployment 1: break the relationship

      • Make sure 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).
      • In the 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.
      • 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 from producerStack.
      • 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 -

    • exportValue

      @Stability(Stable) @NotNull public String exportValue(@NotNull Object exportedValue)
      Create a CloudFormation Export for a string value.

      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.

      Example

      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:

      Deployment 1: break the relationship

      • Make sure 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).
      • In the 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.
      • 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 from producerStack.
      • 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.

    • formatArn

      @Stability(Stable) @NotNull public String formatArn(@NotNull 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(Stable) @NotNull public String getLogicalId(@NotNull 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.

    • 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

      @Stability(Stable) @NotNull public String regionalFact(@NotNull String factName)
      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

      @Stability(Stable) public void renameLogicalId(@NotNull String oldId, @NotNull String newId)
      Rename a generated logical identities.

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

      Parameters:
      oldId - This parameter is required.
      newId - This parameter is required.

    • reportMissingContextKey

      @Stability(Stable) public void reportMissingContextKey(@NotNull 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(Stable) @NotNull public Object resolve(@NotNull Object obj)
      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

      @Stability(Stable) @NotNull public String toJsonString(@NotNull Object obj, @Nullable Number space)
      Convert an object, potentially containing tokens, to a JSON string.

      Parameters:
      obj - This parameter is required.
      space -

    • toJsonString

      @Stability(Stable) @NotNull public String toJsonString(@NotNull Object obj)
      Convert an object, potentially containing tokens, to a JSON string.

      Parameters:
      obj - This parameter is required.

    • toYamlString

      @Stability(Stable) @NotNull public String toYamlString(@NotNull Object obj)
      Convert an object, potentially containing tokens, to a YAML string.

      Parameters:
      obj - This parameter is required.

    • getAccount

      @Stability(Stable) @NotNull 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 concrete account (e.g. 585695031111) or the Aws.ACCOUNT_ID token.
      2. Aws.ACCOUNT_ID, 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 concrete 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.

    • getArtifactId

      @Stability(Stable) @NotNull public String getArtifactId()
      The ID of the cloud assembly artifact for this stack.

    • getAvailabilityZones

      @Stability(Stable) @NotNull public List<String> 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

      @Stability(Stable) @NotNull public Boolean getBundlingRequired()
      Indicates whether the stack requires bundling or not.

    • getDependencies

      @Stability(Stable) @NotNull public List<Stack> getDependencies()
      Return the stacks this stack depends on.

    • getEnvironment

      @Stability(Stable) @NotNull 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_ID 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(Stable) @NotNull public Boolean getNested()
      Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent.

    • getNotificationArns

      @Stability(Stable) @NotNull public List<String> getNotificationArns()
      Returns the list of notification Amazon Resource Names (ARNs) for the current stack.

    • getPartition

      @Stability(Stable) @NotNull public String getPartition()
      The partition in which this stack is defined.

    • getRegion

      @Stability(Stable) @NotNull 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 concrete 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 concrete 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.

    • getStackId

      @Stability(Stable) @NotNull public String 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

      @Stability(Stable) @NotNull 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.STACK_NAME directly.

    • getSynthesizer

      @Stability(Stable) @NotNull public IStackSynthesizer getSynthesizer()
      Synthesis method for this stack.

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tags to be applied to the stack.
      Specified by:
      getTags in interface ITaggable

    • getTemplateFile

      @Stability(Stable) @NotNull public String getTemplateFile()
      The name of the CloudFormation template file emitted to the output directory during synthesis.

      Example value: MyStack.template.json

    • getTemplateOptions

      @Stability(Stable) @NotNull public ITemplateOptions getTemplateOptions()
      Options for CloudFormation template (like version, transform, description).

    • getUrlSuffix

      @Stability(Stable) @NotNull public String getUrlSuffix()
      The Amazon domain suffix for the region in which this stack is defined.

    • getNestedStackParent

      @Stability(Stable) @Nullable public Stack getNestedStackParent()
      If this is a nested stack, returns it's parent stack.

    • getNestedStackResource

      @Stability(Stable) @Nullable public CfnResource getNestedStackResource()
      If this is a nested stack, this represents its AWS::CloudFormation::Stack resource.

      undefined for top-level (non-nested) stacks.

    • getTerminationProtection

      @Stability(Stable) @NotNull public Boolean getTerminationProtection()
      Whether termination protection is enabled for this stack.

    • setTerminationProtection

      @Stability(Stable) public void setTerminationProtection(@NotNull Boolean value)
      Whether termination protection is enabled for this stack.