@aws-cdk_cloud-assembly-schema.DestroyOptions

interface DestroyOptions

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.DestroyOptions
Javasoftware.amazon.awscdk.cloudassembly.schema.DestroyOptions
Pythonaws_cdk.cloud_assembly_schema.DestroyOptions
TypeScript (source)@aws-cdk/cloud-assembly-schema » DestroyOptions

Options to use with cdk destroy.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';
const destroyOptions: cloud_assembly_schema.DestroyOptions = {
  all: false,
  app: 'app',
  assetMetadata: false,
  caBundlePath: 'caBundlePath',
  color: false,
  context: {
    contextKey: 'context',
  },
  debug: false,
  ec2Creds: false,
  exclusively: false,
  force: false,
  ignoreErrors: false,
  json: false,
  lookups: false,
  notices: false,
  output: 'output',
  pathMetadata: false,
  profile: 'profile',
  proxy: 'proxy',
  roleArn: 'roleArn',
  stacks: ['stacks'],
  staging: false,
  strict: false,
  trace: false,
  verbose: false,
  versionReporting: false,
};

Properties

NameTypeDescription
all?booleanDeploy all stacks.
app?stringcommand-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out".
assetMetadata?booleanInclude "aws:asset:*" CloudFormation metadata for resources that use assets.
caBundlePath?stringPath to CA certificate to use when validating HTTPS requests.
color?booleanShow colors and other style from console output.
context?{ [string]: string }Additional context.
debug?booleanenable emission of additional debugging information, such as creation stack traces of tokens.
ec2Creds?booleanForce trying to fetch EC2 instance credentials.
exclusively?booleanOnly destroy the given stack.
force?booleanDo not ask for permission before destroying stacks.
ignoreErrors?booleanIgnores synthesis errors, which will likely produce an invalid output.
json?booleanUse JSON output instead of YAML when templates are printed to STDOUT.
lookups?booleanPerform context lookups.
notices?booleanShow relevant notices.
output?stringEmits the synthesized cloud assembly into a directory.
pathMetadata?booleanInclude "aws:cdk:path" CloudFormation metadata for each resource.
profile?stringUse the indicated AWS profile as the default environment.
proxy?stringUse the indicated proxy.
roleArn?stringRole to pass to CloudFormation for deployment.
stacks?string[]List of stacks to deploy.
staging?booleanCopy assets to the output directory.
strict?booleanDo not construct stacks with warnings.
trace?booleanPrint trace for stack warnings.
verbose?booleanshow debug logs.
versionReporting?booleanInclude "AWS::CDK::Metadata" resource in synthesized templates.

all?

Type: boolean (optional, default: false)

Deploy all stacks.

Requried if stacks is not set


app?

Type: string (optional, default: read from cdk.json)

command-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out".


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)

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.


force?

Type: boolean (optional, default: false)

Do not ask for permission before destroying stacks.


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.


output?

Type: string (optional, default: cdk.out)

Emits the synthesized cloud assembly into a directory.


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


roleArn?

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

Role to pass to CloudFormation for deployment.


stacks?

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

List of stacks to deploy.

Requried if all is not set


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.