class AwsCdkCli
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Cli.Lib.Alpha.AwsCdkCli |
 Go | github.com/aws/aws-cdk-go/awscdkclilibalpha/v2#AwsCdkCli |
 Java | software.amazon.awscdk.cli.lib.alpha.AwsCdkCli |
 Python | aws_cdk.cli_lib_alpha.AwsCdkCli |
 TypeScript (source) | @aws-cdk/cli-lib-alpha » AwsCdkCli |
Implements
IAws
Provides a programmatic interface for interacting with the AWS CDK CLI.
Example
const cli = AwsCdkCli.fromCdkAppDirectory("/path/to/cdk/app");
Methods
| Name | Description |
|---|---|
| bootstrap(options?) | cdk bootstrap. |
| deploy(options?) | cdk deploy. |
| destroy(options?) | cdk destroy. |
| list(options?) | cdk list. |
| synth(options?) | cdk synth. |
| static from | Create the CLI from a directory containing an AWS CDK app. |
| static from | Create the CLI from a CloudAssemblyDirectoryProducer. |
bootstrap(options?)
public bootstrap(options?: BootstrapOptions): void
Parameters
- options
BootstrapOptions
cdk bootstrap.
deploy(options?)
public deploy(options?: DeployOptions): void
Parameters
- options
DeployOptions
cdk deploy.
destroy(options?)
public destroy(options?: DestroyOptions): void
Parameters
- options
DestroyOptions
cdk destroy.
list(options?)
public list(options?: ListOptions): void
Parameters
- options
ListOptions
cdk list.
synth(options?)
public synth(options?: SynthOptions): void
Parameters
- options
SynthOptions
cdk synth.
static fromCdkAppDirectory(directory?, props?)
public static fromCdkAppDirectory(directory?: string, props?: CdkAppDirectoryProps): AwsCdkCli
Parameters
- directory
string— the directory of the AWS CDK app. - props
Cdk— additional configuration properties.App Directory Props
Returns
Create the CLI from a directory containing an AWS CDK app.
static fromCloudAssemblyDirectoryProducer(producer)
public static fromCloudAssemblyDirectoryProducer(producer: ICloudAssemblyDirectoryProducer): AwsCdkCli
Parameters
- producer
ICloudAssembly Directory Producer
Returns
Create the CLI from a CloudAssemblyDirectoryProducer.