DestroyOptions Struct
Options to use with cdk destroy.
| Source | lib/integ-tests/commands/destroy.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
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,
};
python
from aws_cdk.cloud_assembly_schema import DestroyOptions
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema
destroy_options = DestroyOptions(
all=False,
app="app",
asset_metadata=False,
ca_bundle_path="caBundlePath",
color=False,
context={
"context_key": "context"
},
debug=False,
ec2_creds=False,
exclusively=False,
force=False,
ignore_errors=False,
json=False,
lookups=False,
notices=False,
output="output",
path_metadata=False,
profile="profile",
proxy="proxy",
role_arn="roleArn",
stacks=["stacks"],
staging=False,
strict=False,
trace=False,
verbose=False,
version_reporting=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;
DestroyOptions destroyOptions = DestroyOptions.builder()
.all(false)
.app("app")
.assetMetadata(false)
.caBundlePath("caBundlePath")
.color(false)
.context(Map.of(
"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(List.of("stacks"))
.staging(false)
.strict(false)
.trace(false)
.verbose(false)
.versionReporting(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;
var destroyOptions = new DestroyOptions {
All = false,
App = "app",
AssetMetadata = false,
CaBundlePath = "caBundlePath",
Color = false,
Context = new Dictionary<string, string> {
{ "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 = new [] { "stacks" },
Staging = false,
Strict = false,
Trace = false,
Verbose = false,
VersionReporting = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
destroyOptions := &DestroyOptions{
All: jsii.Boolean(false),
App: jsii.String("app"),
AssetMetadata: jsii.Boolean(false),
CaBundlePath: jsii.String("caBundlePath"),
Color: jsii.Boolean(false),
Context: map[string]*string{
"contextKey": jsii.String("context"),
},
Debug: jsii.Boolean(false),
Ec2Creds: jsii.Boolean(false),
Exclusively: jsii.Boolean(false),
Force: jsii.Boolean(false),
IgnoreErrors: jsii.Boolean(false),
Json: jsii.Boolean(false),
Lookups: jsii.Boolean(false),
Notices: jsii.Boolean(false),
Output: jsii.String("output"),
PathMetadata: jsii.Boolean(false),
Profile: jsii.String("profile"),
Proxy: jsii.String("proxy"),
RoleArn: jsii.String("roleArn"),
Stacks: []*string{
jsii.String("stacks"),
},
Staging: jsii.Boolean(false),
Strict: jsii.Boolean(false),
Trace: jsii.Boolean(false),
Verbose: jsii.Boolean(false),
VersionReporting: jsii.Boolean(false),
}
Properties
Deploy all stacks.
Requried if stacks is not set
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
assetMetadataoptionalbooleanasset_metadataoptionalboolassetMetadataoptionalBooleanAssetMetadataoptionalboolAssetMetadataoptional*bool = true #Include "aws:asset:*" CloudFormation metadata for resources that use assets.
caBundlePathoptionalstringca_bundle_pathoptionalstrcaBundlePathoptionalStringCaBundlePathoptionalstringCaBundlePathoptional*string #Path to CA certificate to use when validating HTTPS requests.
Default: read from AWS_CA_BUNDLE environment variable
coloroptionalbooleancoloroptionalboolcoloroptionalBooleanColoroptionalboolColoroptional*bool = true #Show colors and other style from console output.
contextoptional{ [key: string]: string }contextoptionaltyping.Mapping[str, str]contextoptionalMap<String, String>ContextoptionalIDictionary<string, string>Contextoptional*map[string]*string #Additional context.
Default: no additional context
debugoptionalbooleandebugoptionalbooldebugoptionalBooleanDebugoptionalboolDebugoptional*bool = false #enable emission of additional debugging information, such as creation stack traces of tokens.
ec2Credsoptionalbooleanec2_credsoptionalboolec2CredsoptionalBooleanEc2CredsoptionalboolEc2Credsoptional*bool #Force trying to fetch EC2 instance credentials.
Default: guess EC2 instance status
exclusivelyoptionalbooleanexclusivelyoptionalboolexclusivelyoptionalBooleanExclusivelyoptionalboolExclusivelyoptional*bool = false #Only destroy the given stack.
forceoptionalbooleanforceoptionalboolforceoptionalBooleanForceoptionalboolForceoptional*bool = false #Do not ask for permission before destroying stacks.
ignoreErrorsoptionalbooleanignore_errorsoptionalboolignoreErrorsoptionalBooleanIgnoreErrorsoptionalboolIgnoreErrorsoptional*bool = false #Ignores synthesis errors, which will likely produce an invalid output.
Use JSON output instead of YAML when templates are printed to STDOUT.
lookupsoptionalbooleanlookupsoptionalboollookupsoptionalBooleanLookupsoptionalboolLookupsoptional*bool = true #Perform context lookups.
Synthesis fails if this is disabled and context lookups need to be performed
noticesoptionalbooleannoticesoptionalboolnoticesoptionalBooleanNoticesoptionalboolNoticesoptional*bool = true #Show relevant notices.
outputoptionalstringoutputoptionalstroutputoptionalStringOutputoptionalstringOutputoptional*string = cdk.out #Emits the synthesized cloud assembly into a directory.
pathMetadataoptionalbooleanpath_metadataoptionalboolpathMetadataoptionalBooleanPathMetadataoptionalboolPathMetadataoptional*bool = true #Include "aws:cdk:path" CloudFormation metadata for each resource.
profileoptionalstringprofileoptionalstrprofileoptionalStringProfileoptionalstringProfileoptional*string #Use the indicated AWS profile as the default environment.
Default: no profile is used
Use the indicated proxy.
Default: no proxy
Will read from HTTPS_PROXY environment if specified
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string #Role to pass to CloudFormation for deployment.
Default: use the bootstrap cfn-exec role
stacksoptionalstring[]stacksoptionaltyping.List[str]stacksoptionalList<String>Stacksoptionalstring[]Stacksoptional*[]*string = [] #List of stacks to deploy.
Requried if all is not set
stagingoptionalbooleanstagingoptionalboolstagingoptionalBooleanStagingoptionalboolStagingoptional*bool = false #Copy assets to the output directory.
Needed for local debugging the source files with SAM CLI
strictoptionalbooleanstrictoptionalboolstrictoptionalBooleanStrictoptionalboolStrictoptional*bool = false #Do not construct stacks with warnings.
traceoptionalbooleantraceoptionalbooltraceoptionalBooleanTraceoptionalboolTraceoptional*bool = false #Print trace for stack warnings.
verboseoptionalbooleanverboseoptionalboolverboseoptionalBooleanVerboseoptionalboolVerboseoptional*bool = false #show debug logs.
versionReportingoptionalbooleanversion_reportingoptionalboolversionReportingoptionalBooleanVersionReportingoptionalboolVersionReportingoptional*bool = true #Include "AWS::CDK::Metadata" resource in synthesized templates.