software.amazon.awscdk.core

Interface StackProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StackProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.11.0 (build 1e9b8e1)",
           date="2020-09-13T06:02:43.228Z")
 @Stability(value=Stable)
public interface StackProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StackProps.Builder A builder for StackProps
static class	StackProps.Jsii$Proxy An implementation for StackProps

Method Summary

Modifier and Type	Method and Description
static StackProps.Builder	builder()
default String	getDescription() A description of the stack.
default Environment	getEnv() The AWS environment (account/region) where this stack will be deployed.
default String	getStackName() Name to deploy the stack with.
default IStackSynthesizer	getSynthesizer() Synthesis method to use while deploying this stack.
default Map<String,String>	getTags() Stack tags that will be applied to all the taggable resources and the stack itself.
default Boolean	getTerminationProtection() Whether to enable termination protection for this stack.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the stack.

Default: - No description.

getEnv

@Stability(value=Stable)
 @Nullable
default Environment getEnv()

The AWS environment (account/region) where this stack will be deployed.

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered "environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

Default: - The environment of the containing `Stage` if available, otherwise create the stack will be environment-agnostic.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 // Use a concrete account and region to deploy this stack to:
 // `.account` and `.region` will simply return these values.
 MyStack.Builder.create(app, "Stack1")
         .env(Map.of(
                 "account", "123456789012",
                 "region", "us-east-1"))
         .build();
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 // Use the CLI's current credentials to determine the target environment:
 // `.account` and `.region` will reflect the account+region the CLI
 // is configured to use (based on the user CLI credentials)
 MyStack.Builder.create(app, "Stack2")
         .env(Map.of(
                 "account", process.env.getCDK_DEFAULT_ACCOUNT(),
                 "region", process.env.getCDK_DEFAULT_REGION()))
         .build();
 // Define multiple stacks stage associated with an environment
 var myStage = Stage.Builder.create(app, "MyStage")
         .env(Map.of(
                 "account", "123456789012",
                 "region", "us-east-1"))
         .build();
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 // both of these stacks will use the stage's account/region:
 // `.account` and `.region` will resolve to the concrete values as above
 new MyStack(myStage, "Stack1");
 new YourStack(myStage, "Stack1");
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 // Define an environment-agnostic stack:
 // `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
 // which will only resolve to actual values by CloudFormation during deployment.
 new MyStack(app, "Stack1");

getStackName

@Stability(value=Stable)
 @Nullable
default String getStackName()

Name to deploy the stack with.

Default: - Derived from construct path.

getSynthesizer

@Stability(value=Stable)
 @Nullable
default IStackSynthesizer getSynthesizer()

Synthesis method to use while deploying this stack.

Default: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` otherwise.

getTags

@Stability(value=Stable)
 @Nullable
default Map<String,String> getTags()

Stack tags that will be applied to all the taggable resources and the stack itself.

Default: {}

getTerminationProtection

@Stability(value=Stable)
 @Nullable
default Boolean getTerminationProtection()

Whether to enable termination protection for this stack.

Default: false

builder

@Stability(value=Stable)
static StackProps.Builder builder()

Returns:

a StackProps.Builder of StackProps