@aws-cdk_cli-lib-alpha.AwsCdkCli

class AwsCdkCli ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.Cli.Lib.Alpha.AwsCdkCli
Gogithub.com/aws/aws-cdk-go/awscdkclilibalpha/v2#AwsCdkCli
Javasoftware.amazon.awscdk.cli.lib.alpha.AwsCdkCli
Pythonaws_cdk.cli_lib_alpha.AwsCdkCli
TypeScript (source)@aws-cdk/cli-lib-alpha ยป AwsCdkCli

Implements IAwsCdkCli

Provides a programmatic interface for interacting with the AWS CDK CLI.

Example

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

Methods

NameDescription
bootstrap(options?)๐Ÿ”นcdk bootstrap.
deploy(options?)๐Ÿ”นcdk deploy.
destroy(options?)๐Ÿ”นcdk destroy.
list(options?)๐Ÿ”นcdk list.
synth(options?)๐Ÿ”นcdk synth.
static fromCdkAppDirectory(directory?, props?)๐Ÿ”นCreate the CLI from a directory containing an AWS CDK app.
static fromCloudAssemblyDirectoryProducer(producer)๐Ÿ”น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 CdkAppDirectoryProps โ€” additional configuration properties.

Returns

  • AwsCdkCli

Create the CLI from a directory containing an AWS CDK app.


static fromCloudAssemblyDirectoryProducer(producer)๐Ÿ”น

public static fromCloudAssemblyDirectoryProducer(producer: ICloudAssemblyDirectoryProducer): AwsCdkCli

Parameters

  • producer ICloudAssemblyDirectoryProducer

Returns

  • AwsCdkCli

Create the CLI from a CloudAssemblyDirectoryProducer.