Package software.amazon.awscdk.cloud_assembly_schema

Interface CdkCommands

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CdkCommands.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:10.986Z")
@Stability(Stable)
public interface CdkCommands
extends software.amazon.jsii.JsiiSerializable

Options for specific cdk commands that are run as part of the integration test workflow.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 CdkCommands cdkCommands = CdkCommands.builder()
         .deploy(DeployCommand.builder()
                 .args(DeployOptions.builder()
                         .all(false)
                         .app("app")
                         .assetMetadata(false)
                         .caBundlePath("caBundlePath")
                         .changeSetName("changeSetName")
                         .ci(false)
                         .color(false)
                         .concurrency(123)
                         .context(Map.of(
                                 "contextKey", "context"))
                         .debug(false)
                         .ec2Creds(false)
                         .exclusively(false)
                         .execute(false)
                         .force(false)
                         .ignoreErrors(false)
                         .json(false)
                         .lookups(false)
                         .notices(false)
                         .notificationArns(List.of("notificationArns"))
                         .output("output")
                         .outputsFile("outputsFile")
                         .parameters(Map.of(
                                 "parametersKey", "parameters"))
                         .pathMetadata(false)
                         .profile("profile")
                         .proxy("proxy")
                         .requireApproval(RequireApproval.NEVER)
                         .reuseAssets(List.of("reuseAssets"))
                         .roleArn("roleArn")
                         .rollback(false)
                         .stacks(List.of("stacks"))
                         .staging(false)
                         .strict(false)
                         .toolkitStackName("toolkitStackName")
                         .trace(false)
                         .usePreviousParameters(false)
                         .verbose(false)
                         .versionReporting(false)
                         .build())
                 .enabled(false)
                 .expectedMessage("expectedMessage")
                 .expectError(false)
                 .build())
         .destroy(DestroyCommand.builder()
                 .args(DestroyOptions.builder()
                         .all(false)
                         .app("app")
                         .assetMetadata(false)
                         .caBundlePath("caBundlePath")
                         .color(false)
                         .context(Map.of(
                                 "contextKey", "context"))
                         .debug(false)
                         .ec2Creds(false)
                         .exclusively(false)
                         .force(false)
                         .ignoreErrors(false)
                         .json(false)
                         .lookups(false)
                         .notices(false)
                         .output("output")
                         .pathMetadata(false)
                         .profile("profile")
                         .proxy("proxy")
                         .roleArn("roleArn")
                         .stacks(List.of("stacks"))
                         .staging(false)
                         .strict(false)
                         .trace(false)
                         .verbose(false)
                         .versionReporting(false)
                         .build())
                 .enabled(false)
                 .expectedMessage("expectedMessage")
                 .expectError(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CdkCommands.Builder	A builder for CdkCommands
static final class	CdkCommands.Jsii$Proxy	An implementation for CdkCommands

Method Summary

Modifier and Type	Method	Description
static CdkCommands.Builder	builder()
default DeployCommand	getDeploy()	Options to for the cdk deploy command.
default DestroyCommand	getDestroy()	Options to for the cdk destroy command.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeploy

@Stability(Stable)
@Nullable
default DeployCommand getDeploy()

Options to for the cdk deploy command.

Default: - default deploy options

getDestroy

@Stability(Stable)
@Nullable
default DestroyCommand getDestroy()

Options to for the cdk destroy command.

Default: - default destroy options

builder

@Stability(Stable)
static CdkCommands.Builder builder()

Returns:

a CdkCommands.Builder of CdkCommands