DestroyOptions
- class aws_cdk.cloud_assembly_schema.DestroyOptions(*, all=None, app=None, asset_metadata=None, ca_bundle_path=None, color=None, context=None, debug=None, ec2_creds=None, ignore_errors=None, json=None, lookups=None, notices=None, output=None, path_metadata=None, profile=None, proxy=None, role_arn=None, stacks=None, staging=None, strict=None, trace=None, verbose=None, version_reporting=None, exclusively=None, force=None)
Bases:
DefaultCdkOptions
Options to use with cdk destroy.
- Parameters:
all (
Optional
[bool
]) – Deploy all stacks. Requried ifstacks
is not set Default: - falseapp (
Optional
[str
]) – command-line for executing your app or a cloud assembly directory e.g. “node bin/my-app.js” or “cdk.out”. Default: - read from cdk.jsonasset_metadata (
Optional
[bool
]) – Include “aws:asset:*” CloudFormation metadata for resources that use assets. Default: trueca_bundle_path (
Optional
[str
]) – Path to CA certificate to use when validating HTTPS requests. Default: - read from AWS_CA_BUNDLE environment variablecolor (
Optional
[bool
]) – Show colors and other style from console output. Default: truecontext (
Optional
[Mapping
[str
,str
]]) – Additional context. Default: - no additional contextdebug (
Optional
[bool
]) – enable emission of additional debugging information, such as creation stack traces of tokens. Default: falseec2_creds (
Optional
[bool
]) – Force trying to fetch EC2 instance credentials. Default: - guess EC2 instance statusignore_errors (
Optional
[bool
]) – Ignores synthesis errors, which will likely produce an invalid output. Default: falsejson (
Optional
[bool
]) – Use JSON output instead of YAML when templates are printed to STDOUT. Default: falselookups (
Optional
[bool
]) – Perform context lookups. Synthesis fails if this is disabled and context lookups need to be performed Default: truenotices (
Optional
[bool
]) – Show relevant notices. Default: trueoutput (
Optional
[str
]) – Emits the synthesized cloud assembly into a directory. Default: cdk.outpath_metadata (
Optional
[bool
]) – Include “aws:cdk:path” CloudFormation metadata for each resource. Default: trueprofile (
Optional
[str
]) – Use the indicated AWS profile as the default environment. Default: - no profile is usedproxy (
Optional
[str
]) – Use the indicated proxy. Will read from HTTPS_PROXY environment if specified Default: - no proxyrole_arn (
Optional
[str
]) – Role to pass to CloudFormation for deployment. Default: - use the bootstrap cfn-exec rolestacks (
Optional
[Sequence
[str
]]) – List of stacks to deploy. Requried ifall
is not set Default: - []staging (
Optional
[bool
]) – Copy assets to the output directory. Needed for local debugging the source files with SAM CLI Default: falsestrict (
Optional
[bool
]) – Do not construct stacks with warnings. Default: falsetrace (
Optional
[bool
]) – Print trace for stack warnings. Default: falseverbose (
Optional
[bool
]) – show debug logs. Default: falseversion_reporting (
Optional
[bool
]) – Include “AWS::CDK::Metadata” resource in synthesized templates. Default: trueexclusively (
Optional
[bool
]) – Only destroy the given stack. Default: falseforce (
Optional
[bool
]) – Do not ask for permission before destroying stacks. Default: false
Attributes
- all
Deploy all stacks.
Requried if
stacks
is not set- Default:
false
- app
command-line for executing your app or a cloud assembly directory e.g. “node bin/my-app.js” or “cdk.out”.
- Default:
read from cdk.json
- asset_metadata
*” CloudFormation metadata for resources that use assets.
- Default:
true
- Type:
Include “aws
- Type:
asset
- ca_bundle_path
Path to CA certificate to use when validating HTTPS requests.
- Default:
read from AWS_CA_BUNDLE environment variable
- color
Show colors and other style from console output.
- Default:
true
- context
Additional context.
- Default:
no additional context
- debug
enable emission of additional debugging information, such as creation stack traces of tokens.
- Default:
false
- ec2_creds
Force trying to fetch EC2 instance credentials.
- Default:
guess EC2 instance status
- exclusively
Only destroy the given stack.
- Default:
false
- force
Do not ask for permission before destroying stacks.
- Default:
false
- ignore_errors
Ignores synthesis errors, which will likely produce an invalid output.
- Default:
false
- json
Use JSON output instead of YAML when templates are printed to STDOUT.
- Default:
false
- lookups
Perform context lookups.
Synthesis fails if this is disabled and context lookups need to be performed
- Default:
true
- notices
Show relevant notices.
- Default:
true
- output
Emits the synthesized cloud assembly into a directory.
- Default:
cdk.out
- path_metadata
path” CloudFormation metadata for each resource.
- Default:
true
- Type:
Include “aws
- Type:
cdk
- profile
Use the indicated AWS profile as the default environment.
- Default:
no profile is used
- proxy
Use the indicated proxy.
Will read from HTTPS_PROXY environment if specified
- Default:
no proxy
- role_arn
Role to pass to CloudFormation for deployment.
- Default:
use the bootstrap cfn-exec role
- stacks
List of stacks to deploy.
Requried if
all
is not set- Default:
[]
- staging
Copy assets to the output directory.
Needed for local debugging the source files with SAM CLI
- Default:
false
- strict
Do not construct stacks with warnings.
- Default:
false
- trace
Print trace for stack warnings.
- Default:
false
- verbose
show debug logs.
- Default:
false
- version_reporting
Include “AWS::CDK::Metadata” resource in synthesized templates.
- Default:
true