This release is a pre-release and may not be stable for production use.
AWS CDK CLI Library
---
The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
⚠️ Experimental module
This package is highly experimental. Expect frequent API changes and incomplete features. Known issues include:
- 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
Overview
Provides a library to interact with the AWS CDK CLI programmatically from jsii supported languages. Currently the package includes implementations for:
cdk deploycdk synthcdk bootstrapcdk destroycdk list
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'],
});
1 maintainer
Release files for aws-cdk.cli-lib-alpha 3.0.0a0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws_cdk_cli_lib_alpha-3.0.0a0.tar.gz | 5.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_cdk_cli_lib_alpha-3.0.0a0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.7 MB
Release files / aws_cdk_cli_lib_alpha-3.0.0a0.tar.gz
| Download URL | aws_cdk_cli_lib_alpha-3.0.0a0.tar.gz |
|---|---|
| Size | 5.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9d964d5a4f481d9d84923885ae0667a4b7ec57d60d30db09c3dfe61faad0b462
|
|
BLAKE2b-256 checksum How to use checksums |
afad2bd06e079691e5cdb2b1342fc8d36759033d8ade9d065c8e02356d973418
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.2
|
Release files / aws_cdk_cli_lib_alpha-3.0.0a0-py3-none-any.whl
| Download URL | aws_cdk_cli_lib_alpha-3.0.0a0-py3-none-any.whl |
|---|---|
| Size | 5.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
68462ff449eb0fdc573319c2321b1994b53ec2ca47e6e48cb77db91294f53151
|
|
BLAKE2b-256 checksum How to use checksums |
77eb3a56ce2cd43951ecacf832b1643f3feaf2e291cdf944aebad387b334d3c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.2
|
