interface StackProps

Language	Type name
.NET	Amazon.CDK.StackProps
Java	software.amazon.awscdk.core.StackProps
Python	aws_cdk.core.StackProps
TypeScript (source)	@aws-cdk/core » StackProps

Example

interface StackUnderTestProps extends StackProps {
  architecture?: lambda.Architecture;
}

class StackUnderTest extends Stack {
  constructor(scope: Construct, id: string, props: StackUnderTestProps) {
    super(scope, id, props);

    new lambda.Function(this, 'Handler', {
      runtime: lambda.Runtime.NODEJS_14_X,
      handler: 'index.handler',
      code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
      architecture: props.architecture,
    });
  }
}

// Beginning of the test suite
const app = new App();

new IntegTest(app, 'DifferentArchitectures', {
  testCases: [
    new StackUnderTest(app, 'Stack1', {
      architecture: lambda.Architecture.ARM_64,
    }),
    new StackUnderTest(app, 'Stack2', {
      architecture: lambda.Architecture.X86_64,
    }),
  ],
});

Properties

Name	Type	Description
analyticsReporting?	boolean	Include runtime versioning information in this Stack.
description?	string	A description of the stack.
env?	Environment	The AWS environment (account/region) where this stack will be deployed.
stackName?	string	Name to deploy the stack with.
synthesizer?	IStackSynthesizer	Synthesis method to use while deploying this stack.
tags?	{ [string]: string }	Stack tags that will be applied to all the taggable resources and the stack itself.
terminationProtection?	boolean	Whether to enable termination protection for this stack.

---

analyticsReporting?

Type: boolean (optional, default: analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key)

Include runtime versioning information in this Stack.

---

description?

Type: string (optional, default: No description.)

A description of the stack.

---

env?

Type: Environment (optional, default: The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.)

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. Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// 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)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// 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, 'Stack2');

// 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');

---

stackName?

Type: string (optional, default: Derived from construct path.)

Name to deploy the stack with.

---

synthesizer?

Type: IStackSynthesizer (optional, default: DefaultStackSynthesizer if the @aws-cdk/core:newStyleStackSynthesis feature flag is set, LegacyStackSynthesizer otherwise.)

Synthesis method to use while deploying this stack.

---

tags?

Type: { [string]: string } (optional, default: {})

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

---

terminationProtection?

Type: boolean (optional, default: false)

Whether to enable termination protection for this stack.