software.amazon.awscdk.cloudassembly.schema

Interface DestroyOptions

All Superinterfaces:

DefaultCdkOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DestroyOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.856Z")
 @Stability(value=Stable)
public interface DestroyOptions
extends software.amazon.jsii.JsiiSerializable, DefaultCdkOptions

Options to use with cdk destroy.

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 and Description
static class	DestroyOptions.Builder A builder for DestroyOptions
static class	DestroyOptions.Jsii$Proxy An implementation for DestroyOptions

Method Summary

Modifier and Type	Method and Description
static DestroyOptions.Builder	builder()
default Boolean	getExclusively() Only destroy the given stack.
default Boolean	getForce() Do not ask for permission before destroying stacks.

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 Detail

getExclusively

@Stability(value=Stable)
 @Nullable
default Boolean getExclusively()

Only destroy the given stack.

Default: false

getForce

@Stability(value=Stable)
 @Nullable
default Boolean getForce()

Do not ask for permission before destroying stacks.

Default: false

builder

@Stability(value=Stable)
static DestroyOptions.Builder builder()

Specified by:

builder in interface DefaultCdkOptions

Returns:

a DestroyOptions.Builder of DestroyOptions