How to set the Stack Name of a CDK Deployment

Explicitly setting the Stack Name in AWS CDK #

In order to explicitly set the stack name in CDK we have to provide the stackName prop when creating the Stack.

Copied!
const app = new cdk.App();

new MyCdkStack(app, 'my-construct-id', {
  // 👇 explicitly setting stack name
  stackName: `my-cdk-stack`,
});

For Python users - the property is named stack_name, instead of stackName.

If we now deploy our stack by running npx cdk deploy, the name is set to my-cdk-stack:

Accessing the Stack Name in AWS CDK #

In order to get the name of a CDK Stack we have to access the stackName property on the Stack class.

Copied!
export class MyCdkStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    console.log('stackName 👉 ', cdk.Stack.of(this).stackName);
  }
}

The output from the console.log call shows the stack name:

Default Behavior Without setting Stack Name #

The default behavior is that if we deploy a stack without providing the stackName property, CDK sets the stack name to be inferred to the construct id of the stack.

Copied!
const app = new cdk.App();

new MyCdkStack(app, 'my-construct-id');

In the above scenario our stack will be named my-construct-id.

Further Reading #

• AWS CDK Tutorial for Beginners - Step-by-Step Guide
• How does AWS CDK work
• What is a Token in AWS CDK
• CDK Constructs - Complete Guide
• What is an identifier (id) in AWS CDK
• How to use Context in AWS CDK
• How to use Parameters in AWS CDK