Package software.amazon.awscdk.cloud_assembly_schema

Interface DeployOptions

All Superinterfaces:
DefaultCdkOptions, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
DeployOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:16.195Z") @Stability(Stable) public interface DeployOptions extends software.amazon.jsii.JsiiSerializable, DefaultCdkOptions
Options to use with cdk deploy.

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.*;
 DeployOptions deployOptions = 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();

  • Method Details

    • getChangeSetName

      @Stability(Stable) @Nullable default String getChangeSetName()
      Optional name to use for the CloudFormation change set.

      If not provided, a name will be generated automatically.

      Default: - auto generate a name

    • getCi

      @Stability(Stable) @Nullable default Boolean getCi()
      Whether we are on a CI system.

      Default: false

    • getConcurrency

      @Stability(Stable) @Nullable default Number getConcurrency()
      Deploy multiple stacks in parallel.

      Default: 1

    • getExclusively

      @Stability(Stable) @Nullable default Boolean getExclusively()
      Only perform action on the given stack.

      Default: false

    • getExecute

      @Stability(Stable) @Nullable default Boolean getExecute()
      Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.

      Default: true

    • getForce

      @Stability(Stable) @Nullable default Boolean getForce()
      Always deploy, even if templates are identical.

      Default: false

    • getNotificationArns

      @Stability(Stable) @Nullable default List<String> getNotificationArns()
      ARNs of SNS topics that CloudFormation will notify with stack related events.

      Default: - no notifications

    • getOutputsFile

      @Stability(Stable) @Nullable default String getOutputsFile()
      Path to file where stack outputs will be written after a successful deploy as JSON.

      Default: - Outputs are not written to any file

    • getParameters

      @Stability(Stable) @Nullable default Map<String,String> getParameters()
      Additional parameters for CloudFormation at deploy time.

      Default: {}

    • getRequireApproval

      @Stability(Stable) @Nullable default RequireApproval getRequireApproval()
      What kind of security changes require approval.

      Default: RequireApproval.NEVER

    • getReuseAssets

      @Stability(Stable) @Nullable default List<String> getReuseAssets()
      Reuse the assets with the given asset IDs.

      Default: - do not reuse assets

    • getRollback

      @Stability(Stable) @Nullable default Boolean getRollback()
      Rollback failed deployments.

      Default: true

    • getToolkitStackName

      @Stability(Stable) @Nullable default String getToolkitStackName()
      Name of the toolkit stack to use/deploy.

      Default: CDKToolkit

    • getUsePreviousParameters

      @Stability(Stable) @Nullable default Boolean getUsePreviousParameters()
      Use previous values for unspecified parameters.

      If not set, all parameters must be specified for every deployment.

      Default: true

    • builder

      @Stability(Stable) static DeployOptions.Builder builder()
      Returns:
      a DeployOptions.Builder of DeployOptions