interface DestroyOptions 🔹

Language	Type name
.NET	Amazon.CDK.Cli.Lib.Alpha.DestroyOptions
Go	github.com/aws/aws-cdk-go/awscdkclilibalpha/v2#DestroyOptions
Java	software.amazon.awscdk.cli.lib.alpha.DestroyOptions
Python	aws_cdk.cli_lib_alpha.DestroyOptions
TypeScript (source)	@aws-cdk/cli-lib-alpha » DestroyOptions

Options to use with cdk destroy.

Example

// await this asynchronous method call using a language feature
cli.destroy({
  stacks: ['MyTestStack'],
});

Properties

Name	Type	Description
assetMetadata?🔹	boolean	Include "aws:asset:*" CloudFormation metadata for resources that use assets.
caBundlePath?🔹	string	Path to CA certificate to use when validating HTTPS requests.
color?🔹	boolean	Show colors and other style from console output.
context?🔹	{ [string]: string }	Additional context.
debug?🔹	boolean	enable emission of additional debugging information, such as creation stack traces of tokens.
ec2Creds?🔹	boolean	Force trying to fetch EC2 instance credentials.
exclusively?🔹	boolean	Only destroy the given stack.
ignoreErrors?🔹	boolean	Ignores synthesis errors, which will likely produce an invalid output.
json?🔹	boolean	Use JSON output instead of YAML when templates are printed to STDOUT.
lookups?🔹	boolean	Perform context lookups.
notices?🔹	boolean	Show relevant notices.
pathMetadata?🔹	boolean	Include "aws:cdk:path" CloudFormation metadata for each resource.
profile?🔹	string	Use the indicated AWS profile as the default environment.
proxy?🔹	string	Use the indicated proxy.
requireApproval?🔹	boolean	Should the script prompt for approval before destroying stacks.
roleArn?🔹	string	Role to pass to CloudFormation for deployment.
stacks?🔹	string[]	List of stacks to deploy.
staging?🔹	boolean	Copy assets to the output directory.
strict?🔹	boolean	Do not construct stacks with warnings.
trace?🔹	boolean	Print trace for stack warnings.
verbose?🔹	boolean	show debug logs.
versionReporting?🔹	boolean	Include "AWS::CDK::Metadata" resource in synthesized templates.

---

assetMetadata?🔹

Type: boolean (optional, default: true)

Include "aws:asset:*" CloudFormation metadata for resources that use assets.

---

caBundlePath?🔹

Type: string (optional, default: read from AWS_CA_BUNDLE environment variable)

Path to CA certificate to use when validating HTTPS requests.

---

color?🔹

Type: boolean (optional, default: true unless the environment variable NO_COLOR is set)

Show colors and other style from console output.

---

context?🔹

Type: { [string]: string } (optional, default: no additional context)

Additional context.

---

debug?🔹

Type: boolean (optional, default: false)

enable emission of additional debugging information, such as creation stack traces of tokens.

---

ec2Creds?🔹

Type: boolean (optional, default: guess EC2 instance status)

Force trying to fetch EC2 instance credentials.

---

exclusively?🔹

Type: boolean (optional, default: false)

Only destroy the given stack.

---

ignoreErrors?🔹

Type: boolean (optional, default: false)

Ignores synthesis errors, which will likely produce an invalid output.

---

json?🔹

Type: boolean (optional, default: false)

Use JSON output instead of YAML when templates are printed to STDOUT.

---

lookups?🔹

Type: boolean (optional, default: true)

Perform context lookups.

Synthesis fails if this is disabled and context lookups need to be performed

---

notices?🔹

Type: boolean (optional, default: true)

Show relevant notices.

---

pathMetadata?🔹

Type: boolean (optional, default: true)

Include "aws:cdk:path" CloudFormation metadata for each resource.

---

profile?🔹

Type: string (optional, default: no profile is used)

Use the indicated AWS profile as the default environment.

---

proxy?🔹

Type: string (optional, default: no proxy)

Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified

---

requireApproval?🔹

Type: boolean (optional, default: false)

Should the script prompt for approval before destroying stacks.

---

roleArn?🔹

Type: string (optional, default: use the bootstrap cfn-exec role)

Role to pass to CloudFormation for deployment.

---

stacks?🔹

Type: string[] (optional, default: all stacks)

List of stacks to deploy.

---

staging?🔹

Type: boolean (optional, default: false)

Copy assets to the output directory.

Needed for local debugging the source files with SAM CLI

---

strict?🔹

Type: boolean (optional, default: false)

Do not construct stacks with warnings.

---

trace?🔹

Type: boolean (optional, default: false)

Print trace for stack warnings.

---

verbose?🔹

Type: boolean (optional, default: false)

show debug logs.

---

versionReporting?🔹

Type: boolean (optional, default: true)

Include "AWS::CDK::Metadata" resource in synthesized templates.