AWS CDK CLI Library (deprecated)

This package has been deprecated in favor of @aws-cdk/toolkit-lib, a newer approach providing similar functionality to what this package offered. Please migrate as soon as possible. For any migration problems, please open an issue. We are committed to supporting the same feature set that this package offered.

⚠️ Deprecated module

This package is has been deprecated. Already published versions can be used, but no support is provided whatsoever and we will soon stop publishing new versions.

Instead, please use @aws-cdk/toolkit-lib.

Overview

Provides a library to interact with the AWS CDK CLI programmatically from jsii supported languages. Currently the package includes implementations for:

• cdk deploy
• cdk synth
• cdk bootstrap
• cdk destroy
• cdk list

Known issues

• JavaScript/TypeScript only
  The jsii packages are currently not in a working state.
• No useful return values
  All output is currently printed to stdout/stderr
• Missing or Broken options
  Some CLI options might not be available in this package or broken

Due to the deprecation of the package, this issues will not be resolved.

Setup

AWS CDK app directory

Obtain an AwsCdkCli class from an AWS CDK app directory (containing a cdk.json file):

const cli = AwsCdkCli.fromCdkAppDirectory("/path/to/cdk/app");

Cloud Assembly Directory Producer

You can also create AwsCdkCli from a class implementing ICloudAssemblyDirectoryProducer. AWS CDK apps might need to be synthesized multiple times with additional context values before they are ready.

The produce() method of the ICloudAssemblyDirectoryProducer interface provides this multi-pass ability. It is invoked with the context values of the current iteration and should use these values to synthesize a Cloud Assembly. The return value is the path to the assembly directory.

A basic implementation would look like this:

class MyProducer implements ICloudAssemblyDirectoryProducer {
  async produce(context: Record<string, any>) {
    const app = new cdk.App({ context });
    const stack = new cdk.Stack(app);
    return app.synth().directory;
  }
}

For all features (e.g. lookups) to work correctly, cdk.App() must be instantiated with the received context values. Since it is not possible to update the context of an app, it must be created as part of the produce() method.

The producer can than be used like this:

const cli = AwsCdkCli.fromCloudAssemblyDirectoryProducer(new MyProducer());

Commands

list

// await this asynchronous method call using a language feature
cli.list();

synth

// await this asynchronous method call using a language feature
cli.synth({
  stacks: ['MyTestStack'],
});

bootstrap

// await this asynchronous method call using a language feature
cli.bootstrap();

deploy

// await this asynchronous method call using a language feature
cli.deploy({
  stacks: ['MyTestStack'],
});

destroy

// await this asynchronous method call using a language feature
cli.destroy({
  stacks: ['MyTestStack'],
});