Package software.amazon.awscdk.cli.lib.alpha

Class AwsCdkCli

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cli.lib.alpha.AwsCdkCli

All Implemented Interfaces:

IAwsCdkCli, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.241Z")
@Stability(Experimental)
public class AwsCdkCli
extends software.amazon.jsii.JsiiObject
implements IAwsCdkCli

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

Example:

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cli.lib.alpha.IAwsCdkCli

IAwsCdkCli.Jsii$Default, IAwsCdkCli.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AwsCdkCli(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsCdkCli(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	bootstrap()	(experimental) cdk bootstrap.
void	bootstrap(BootstrapOptions options)	(experimental) cdk bootstrap.
void	deploy()	(experimental) cdk deploy.
void	deploy(DeployOptions options)	(experimental) cdk deploy.
void	destroy()	(experimental) cdk destroy.
void	destroy(DestroyOptions options)	(experimental) cdk destroy.
static AwsCdkCli	fromCdkAppDirectory()	(experimental) Create the CLI from a directory containing an AWS CDK app.
static AwsCdkCli	fromCdkAppDirectory(String directory)	(experimental) Create the CLI from a directory containing an AWS CDK app.
static AwsCdkCli	fromCdkAppDirectory(String directory, CdkAppDirectoryProps props)	(experimental) Create the CLI from a directory containing an AWS CDK app.
static AwsCdkCli	fromCloudAssemblyDirectoryProducer(ICloudAssemblyDirectoryProducer producer)	(experimental) Create the CLI from a CloudAssemblyDirectoryProducer.
void	list()	(experimental) cdk list.
void	list(ListOptions options)	(experimental) cdk list.
void	synth()	(experimental) cdk synth.
void	synth(SynthOptions options)	(experimental) cdk synth.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

AwsCdkCli

protected AwsCdkCli(software.amazon.jsii.JsiiObjectRef objRef)

AwsCdkCli

protected AwsCdkCli(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Details

fromCdkAppDirectory

@Stability(Experimental)
@NotNull
public static AwsCdkCli fromCdkAppDirectory(@Nullable
 String directory,
 @Nullable
 CdkAppDirectoryProps props)

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

Parameters:

directory - the directory of the AWS CDK app.

props - additional configuration properties.

Returns:

an instance of AwsCdkCli

fromCdkAppDirectory

@Stability(Experimental)
@NotNull
public static AwsCdkCli fromCdkAppDirectory(@Nullable
 String directory)

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

Parameters:

directory - the directory of the AWS CDK app.

Returns:

an instance of AwsCdkCli

fromCdkAppDirectory

@Stability(Experimental)
@NotNull
public static AwsCdkCli fromCdkAppDirectory()

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

Returns:

an instance of AwsCdkCli

fromCloudAssemblyDirectoryProducer

@Stability(Experimental)
@NotNull
public static AwsCdkCli fromCloudAssemblyDirectoryProducer(@NotNull
 ICloudAssemblyDirectoryProducer producer)

(experimental) Create the CLI from a CloudAssemblyDirectoryProducer.

Parameters:

producer - This parameter is required.

bootstrap

@Stability(Experimental)
public void bootstrap(@Nullable
 BootstrapOptions options)

(experimental) cdk bootstrap.

Specified by:

bootstrap in interface IAwsCdkCli

Parameters:

options -

bootstrap

@Stability(Experimental)
public void bootstrap()

(experimental) cdk bootstrap.

Specified by:

bootstrap in interface IAwsCdkCli

deploy

@Stability(Experimental)
public void deploy(@Nullable
 DeployOptions options)

(experimental) cdk deploy.

Specified by:

deploy in interface IAwsCdkCli

Parameters:

options -

deploy

@Stability(Experimental)
public void deploy()

(experimental) cdk deploy.

Specified by:

deploy in interface IAwsCdkCli

destroy

@Stability(Experimental)
public void destroy(@Nullable
 DestroyOptions options)

(experimental) cdk destroy.

Specified by:

destroy in interface IAwsCdkCli

Parameters:

options -

destroy

@Stability(Experimental)
public void destroy()

(experimental) cdk destroy.

Specified by:

destroy in interface IAwsCdkCli

list

@Stability(Experimental)
public void list(@Nullable
 ListOptions options)

(experimental) cdk list.

Specified by:

list in interface IAwsCdkCli

Parameters:

options -

list

@Stability(Experimental)
public void list()

(experimental) cdk list.

Specified by:

list in interface IAwsCdkCli

synth

@Stability(Experimental)
public void synth(@Nullable
 SynthOptions options)

(experimental) cdk synth.

Specified by:

synth in interface IAwsCdkCli

Parameters:

options -

synth

@Stability(Experimental)
public void synth()

(experimental) cdk synth.

Specified by:

synth in interface IAwsCdkCli