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

Interface DestroyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SharedOptions

All Known Implementing Classes:

DestroyOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:11.855Z")
@Stability(Experimental)
public interface DestroyOptions
extends software.amazon.jsii.JsiiSerializable, SharedOptions

(experimental) Options to use with cdk destroy.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DestroyOptions.Builder	builder()
default Boolean	getExclusively()	(experimental) Only destroy the given stack.
default Boolean	getRequireApproval()	(experimental) Should the script prompt for approval before destroying stacks.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.cli.lib.alpha.SharedOptions

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

Method Details

getExclusively

@Stability(Experimental)
@Nullable
default Boolean getExclusively()

(experimental) Only destroy the given stack.

Default: false

getRequireApproval

@Stability(Experimental)
@Nullable
default Boolean getRequireApproval()

(experimental) Should the script prompt for approval before destroying stacks.

Default: false

builder

@Stability(Experimental)
static DestroyOptions.Builder builder()

Returns:

a DestroyOptions.Builder of DestroyOptions