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

Interface DeployOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, SharedOptions
All Known Implementing Classes:
DeployOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:11.244Z") @Stability(Experimental) public interface DeployOptions extends software.amazon.jsii.JsiiSerializable, SharedOptions
(experimental) Options to use with cdk deploy.

Example: 

 // await this asynchronous method call using a language feature
 cli.deploy(DeployOptions.builder()
         .stacks(List.of("MyTestStack"))
         .build());

  • Method Details

    • getAssetParallelism

      @Stability(Experimental) @Nullable default Boolean getAssetParallelism()
      (experimental) Whether to build/publish assets in parallel.

      Default: false

    • getAssetPrebuild

      @Stability(Experimental) @Nullable default Boolean getAssetPrebuild()
      (experimental) Whether to build all assets before deploying the first stack (useful for failing Docker builds).

      Default: true

    • getChangeSetName

      @Stability(Experimental) @Nullable default String getChangeSetName()
      (experimental) 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(Experimental) @Nullable default Boolean getCi()
      (experimental) Whether we are on a CI system.

      Default: - `false` unless the environment variable `CI` is set

    • getConcurrency

      @Stability(Experimental) @Nullable default Number getConcurrency()
      (experimental) Maximum number of simultaneous deployments (dependency permitting) to execute.

      Default: 1

    • getExclusively

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

      Default: false

    • getExecute

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

      Default: true

    • getForce

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

      Default: false

    • getHotswap

      @Stability(Experimental) @Nullable default HotswapMode getHotswap()

    • getNotificationArns

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

      Default: - no notifications

    • getOutputsFile

      @Stability(Experimental) @Nullable default String getOutputsFile()
      (experimental) 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(Experimental) @Nullable default Map<String,String> getParameters()
      (experimental) Additional parameters for CloudFormation at deploy time.

      Default: {}

    • getProgress

      @Stability(Experimental) @Nullable default StackActivityProgress getProgress()
      (experimental) Display mode for stack activity events.

      The default in the CLI is StackActivityProgress.BAR. But since this is an API it makes more sense to set the default to StackActivityProgress.EVENTS

      Default: StackActivityProgress.EVENTS

    • getRequireApproval

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

      Default: RequireApproval.Never

    • getReuseAssets

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

      Default: - do not reuse assets

    • getRollback

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

      Default: true

    • getToolkitStackName

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

      Default: CDKToolkit

    • getUsePreviousParameters

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

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

      Default: true

    • builder

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