Skip to main content

Defined in: src/constructs/custom-stack/custom-stack.ts:23

Properties for configuring a CustomStack.

This interface extends StackProps and provides options for optional dashboard creation and widget management. The stack can optionally create a CloudWatch dashboard and provides methods to manage widgets across the stack lifecycle.

Example​

const customStack = new CustomStack(this, 'MyCustomStack', {
  createDashboard: true,
  dashboardName: 'my-application-monitoring',
  dashboardDescription: 'Comprehensive monitoring for my application',
  env: { region: 'us-east-1' },
});

Extends​

  • StackProps

Properties​

analyticsReporting?​

readonly optional analyticsReporting: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:140

Include runtime versioning information in this Stack

Default​

analyticsReporting setting of containing App, or value of 'aws:cdk:version-reporting' context key

Inherited from​

cdk.StackProps.analyticsReporting

createDashboard?​

optional createDashboard: boolean

Defined in: src/constructs/custom-stack/custom-stack.ts:29

Whether to create a CloudWatch dashboard for this stack.

Default Value​

false - No dashboard is created by default

crossRegionReferences?​

readonly optional crossRegionReferences: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:151

Enable this flag to allow native cross region stack references.

Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

This feature is currently experimental

Default​

false

Inherited from​

cdk.StackProps.crossRegionReferences

dashboardDescription?​

optional dashboardDescription: string

Defined in: src/constructs/custom-stack/custom-stack.ts:45

A descriptive text that will be displayed at the top of the dashboard. Only used if createDashboard is true.

Default Value​

'Dashboard for monitoring resources in the `{stackName}` stack'

dashboardName?​

optional dashboardName: string

Defined in: src/constructs/custom-stack/custom-stack.ts:37

The name for the CloudWatch dashboard. Only used if createDashboard is true.

Default Value​

Derived from the stack's logical ID (e.g., 'MyStack' becomes 'my-stack-dashboard')

dashboardRemovalPolicy?​

optional dashboardRemovalPolicy: RemovalPolicy

Defined in: src/constructs/custom-stack/custom-stack.ts:61

Policy to apply when the dashboard is removed from the stack. Only used if createDashboard is true.

Default Value​

cdk.RemovalPolicy.DESTROY - The dashboard will be deleted when the stack is deleted

description?​

readonly optional description: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:18

A description of the stack.

Default​

- No description.

Inherited from​

cdk.StackProps.description

env?​

readonly optional env: Environment

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:83

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

Default​

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

Inherited from​

cdk.StackProps.env

initialWidgets?​

optional initialWidgets: IWidget[]

Defined in: src/constructs/custom-stack/custom-stack.ts:53

Optional initial widgets to add to the dashboard during stack construction. Only used if createDashboard is true.

Default Value​

No initial widgets are added

notificationArns?​

readonly optional notificationArns: string[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:111

SNS Topic ARNs that will receive stack events.

Default​

- no notification arns.

Inherited from​

cdk.StackProps.notificationArns

permissionsBoundary?​

readonly optional permissionsBoundary: PermissionsBoundary

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:158

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

Default​

- no permissions boundary is applied

Inherited from​

cdk.StackProps.permissionsBoundary

propertyInjectors?​

readonly optional propertyInjectors: IPropertyInjector[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:174

A list of IPropertyInjector attached to this Stack.

Default​

- no PropertyInjectors

Inherited from​

cdk.StackProps.propertyInjectors

stackName?​

readonly optional stackName: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:89

Name to deploy the stack with

Default​

- Derived from construct path.

Inherited from​

cdk.StackProps.stackName

suppressTemplateIndentation?​

readonly optional suppressTemplateIndentation: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:169

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

Default​

  • the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

Inherited from​

cdk.StackProps.suppressTemplateIndentation

synthesizer?​

readonly optional synthesizer: IStackSynthesizer

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:127

Synthesis method to use while deploying this stack

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

Default​

  • The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

Inherited from​

cdk.StackProps.synthesizer

tags?​

readonly optional tags: object

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:103

Tags that will be applied to the Stack

These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.

However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way.

Index Signature​

[key: string]: string

Default​

{}

Inherited from​

cdk.StackProps.tags

terminationProtection?​

readonly optional terminationProtection: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.232.1_constructs@10.0.5/node_modules/aws-cdk-lib/core/lib/stack.d.ts:133

Whether to enable termination protection for this stack.

Default​

false

Inherited from​

cdk.StackProps.terminationProtection