DeployOptions Struct
Options to use with cdk deploy.
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 deployOptions: cloud_assembly_schema.DeployOptions = {
all: false,
app: 'app',
assetMetadata: false,
caBundlePath: 'caBundlePath',
changeSetName: 'changeSetName',
ci: false,
color: false,
concurrency: 123,
context: {
contextKey: 'context',
},
debug: false,
ec2Creds: false,
exclusively: false,
execute: false,
force: false,
ignoreErrors: false,
json: false,
lookups: false,
notices: false,
notificationArns: ['notificationArns'],
output: 'output',
outputsFile: 'outputsFile',
parameters: {
parametersKey: 'parameters',
},
pathMetadata: false,
profile: 'profile',
proxy: 'proxy',
requireApproval: cloud_assembly_schema.RequireApproval.NEVER,
reuseAssets: ['reuseAssets'],
roleArn: 'roleArn',
rollback: false,
stacks: ['stacks'],
staging: false,
strict: false,
toolkitStackName: 'toolkitStackName',
trace: false,
usePreviousParameters: false,
verbose: false,
versionReporting: 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
changeSetNameoptionalstringchange_set_nameoptionalstrchangeSetNameoptionalStringChangeSetNameoptionalstringChangeSetNameoptional*string#Optional name to use for the CloudFormation change set.
Default: auto generate a name
If not provided, a name will be generated automatically.
Whether we are on a CI system.
Show colors and other style from console output.
concurrencyoptionalnumberconcurrencyoptionalint | floatconcurrencyoptionalNumberConcurrencyoptionaldoubleConcurrencyoptional*float64= 1#Deploy multiple stacks in parallel.
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 perform action on the given stack.
executeoptionalbooleanexecuteoptionalboolexecuteoptionalBooleanExecuteoptionalboolExecuteoptional*bool= true#Whether to execute the ChangeSet Not providing `execute` parameter will result in execution of ChangeSet.
forceoptionalbooleanforceoptionalboolforceoptionalBooleanForceoptionalboolForceoptional*bool= false#Always deploy, even if templates are identical.
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.
notificationArnsoptionalstring[]notification_arnsoptionaltyping.List[str]notificationArnsoptionalList<String>NotificationArnsoptionalstring[]NotificationArnsoptional*[]*string#ARNs of SNS topics that CloudFormation will notify with stack related events.
Default: no notifications
outputoptionalstringoutputoptionalstroutputoptionalStringOutputoptionalstringOutputoptional*string= cdk.out#Emits the synthesized cloud assembly into a directory.
outputsFileoptionalstringoutputs_fileoptionalstroutputsFileoptionalStringOutputsFileoptionalstringOutputsFileoptional*string#Path to file where stack outputs will be written after a successful deploy as JSON.
Default: Outputs are not written to any file
parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string= {}#Additional parameters for CloudFormation at deploy time.
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
requireApprovaloptionalRequireApprovalrequire_approvaloptionalRequireApprovalrequireApprovaloptionalRequireApprovalRequireApprovaloptionalRequireApprovalRequireApprovaloptionalRequireApproval= RequireApproval.NEVER#What kind of security changes require approval.
reuseAssetsoptionalstring[]reuse_assetsoptionaltyping.List[str]reuseAssetsoptionalList<String>ReuseAssetsoptionalstring[]ReuseAssetsoptional*[]*string#Reuse the assets with the given asset IDs.
Default: do not reuse assets
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string#Role to pass to CloudFormation for deployment.
Default: use the bootstrap cfn-exec role
rollbackoptionalbooleanrollbackoptionalboolrollbackoptionalBooleanRollbackoptionalboolRollbackoptional*bool= true#Rollback failed deployments.
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.
toolkitStackNameoptionalstringtoolkit_stack_nameoptionalstrtoolkitStackNameoptionalStringToolkitStackNameoptionalstringToolkitStackNameoptional*string= CDKToolkit#Name of the toolkit stack to use/deploy.
traceoptionalbooleantraceoptionalbooltraceoptionalBooleanTraceoptionalboolTraceoptional*bool= false#Print trace for stack warnings.
usePreviousParametersoptionalbooleanuse_previous_parametersoptionalboolusePreviousParametersoptionalBooleanUsePreviousParametersoptionalboolUsePreviousParametersoptional*bool= true#Use previous values for unspecified parameters.
If not set, all parameters must be specified for every deployment.
verboseoptionalbooleanverboseoptionalboolverboseoptionalBooleanVerboseoptionalboolVerboseoptional*bool= false#show debug logs.
versionReportingoptionalbooleanversion_reportingoptionalboolversionReportingoptionalBooleanVersionReportingoptionalboolVersionReportingoptional*bool= true#Include "AWS::CDK::Metadata" resource in synthesized templates.