Package software.amazon.awscdk.cloudassembly.schema

Interface DeployOptions

All Superinterfaces:

DefaultCdkOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeployOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:54.671Z")
@Stability(Stable)
public interface DeployOptions
extends software.amazon.jsii.JsiiSerializable, DefaultCdkOptions

Options to use with cdk deploy.

Example:

 App app = new App();
 Stack stackUnderTest = new Stack(app, "StackUnderTest");
 Stack stack = new Stack(app, "stack");
 IntegTest testCase = IntegTest.Builder.create(app, "CustomizedDeploymentWorkflow")
         .testCases(List.of(stackUnderTest))
         .diffAssets(true)
         .stackUpdateWorkflow(true)
         .cdkCommandOptions(CdkCommands.builder()
                 .deploy(DeployCommand.builder()
                         .args(DeployOptions.builder()
                                 .requireApproval(RequireApproval.NEVER)
                                 .json(true)
                                 .build())
                         .build())
                 .destroy(DestroyCommand.builder()
                         .args(DestroyOptions.builder()
                                 .force(true)
                                 .build())
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DeployOptions.Builder	builder()
default String	getChangeSetName()	Optional name to use for the CloudFormation change set.
default Boolean	getCi()	Whether we are on a CI system.
default Boolean	getExclusively()	Only perform action on the given stack.
default Boolean	getExecute()	Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.
default Boolean	getForce()	Always deploy, even if templates are identical.
default List<String>	getNotificationArns()	ARNs of SNS topics that CloudFormation will notify with stack related events.
default String	getOutputsFile()	Path to file where stack outputs will be written after a successful deploy as JSON.
default Map<String,String>	getParameters()	Additional parameters for CloudFormation at deploy time.
default RequireApproval	getRequireApproval()	What kind of security changes require approval.
default List<String>	getReuseAssets()	Reuse the assets with the given asset IDs.
default Boolean	getRollback()	Rollback failed deployments.
default String	getToolkitStackName()	Name of the toolkit stack to use/deploy.
default Boolean	getUsePreviousParameters()	Use previous values for unspecified parameters.

Methods inherited from interface software.amazon.awscdk.cloudassembly.schema.DefaultCdkOptions

getAll, getApp, getAssetMetadata, getCaBundlePath, getColor, getContext, getDebug, getEc2Creds, getIgnoreErrors, getJson, getLookups, getNotices, getOutput, getPathMetadata, getProfile, getProxy, getRoleArn, getStacks, getStaging, getStrict, getTrace, getVerbose, getVersionReporting

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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