interface DeployOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CloudAssembly.Schema.DeployOptions |
 Java | software.amazon.awscdk.cloudassembly.schema.DeployOptions |
 Python | aws_cdk.cloud_assembly_schema.DeployOptions |
 TypeScript (source) | @aws-cdk/cloud-assembly-schema » DeployOptions |
Options to use with cdk deploy.
Properties
| Name | Type | Description |
|---|---|---|
| all? | boolean | Deploy all stacks. |
| app? | string | command-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out". |
| asset | boolean | Include "aws:asset:*" CloudFormation metadata for resources that use assets. |
| ca | string | Path to CA certificate to use when validating HTTPS requests. |
| change | string | Optional name to use for the CloudFormation change set. |
| ci? | boolean | Whether we are on a CI system. |
| color? | boolean | Show colors and other style from console output. |
| concurrency? | number | Deploy multiple stacks in parallel. |
| context? | { [string]: string } | Additional context. |
| debug? | boolean | enable emission of additional debugging information, such as creation stack traces of tokens. |
| ec2 | boolean | Force trying to fetch EC2 instance credentials. |
| exclusively? | boolean | Only perform action on the given stack. |
| execute? | boolean | Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet. |
| force? | boolean | Always deploy, even if templates are identical. |
| ignore | 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. |
| notification | string[] | ARNs of SNS topics that CloudFormation will notify with stack related events. |
| output? | string | Emits the synthesized cloud assembly into a directory. |
| outputs | string | Path to file where stack outputs will be written after a successful deploy as JSON. |
| parameters? | { [string]: string } | Additional parameters for CloudFormation at deploy time. |
| path | 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. |
| require | Require | What kind of security changes require approval. |
| reuse | string[] | Reuse the assets with the given asset IDs. |
| role | string | Role to pass to CloudFormation for deployment. |
| rollback? | boolean | Rollback failed deployments. |
| stacks? | string[] | List of stacks to deploy. |
| staging? | boolean | Copy assets to the output directory. |
| strict? | boolean | Do not construct stacks with warnings. |
| toolkit | string | Name of the toolkit stack to use/deploy. |
| trace? | boolean | Print trace for stack warnings. |
| use | boolean | Use previous values for unspecified parameters. |
| verbose? | boolean | show debug logs. |
| version | boolean | Include "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.
changeSetName?
Type:
string
(optional, default: auto generate a name)
Optional name to use for the CloudFormation change set.
If not provided, a name will be generated automatically.
ci?
Type:
boolean
(optional, default: false)
Whether we are on a CI system.
color?
Type:
boolean
(optional, default: true)
Show colors and other style from console output.
concurrency?
Type:
number
(optional, default: 1)
Deploy multiple stacks in parallel.
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 perform action on the given stack.
execute?
Type:
boolean
(optional, default: true)
Whether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.
force?
Type:
boolean
(optional, default: false)
Always deploy, even if templates are identical.
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.
notificationArns?
Type:
string[]
(optional, default: no notifications)
ARNs of SNS topics that CloudFormation will notify with stack related events.
output?
Type:
string
(optional, default: cdk.out)
Emits the synthesized cloud assembly into a directory.
outputsFile?
Type:
string
(optional, default: Outputs are not written to any file)
Path to file where stack outputs will be written after a successful deploy as JSON.
parameters?
Type:
{ [string]: string }
(optional, default: {})
Additional parameters for CloudFormation at deploy time.
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:
Require
(optional, default: RequireApproval.Never)
What kind of security changes require approval.
reuseAssets?
Type:
string[]
(optional, default: do not reuse assets)
Reuse the assets with the given asset IDs.
roleArn?
Type:
string
(optional, default: use the bootstrap cfn-exec role)
Role to pass to CloudFormation for deployment.
rollback?
Type:
boolean
(optional, default: true)
Rollback failed deployments.
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.
toolkitStackName?
Type:
string
(optional, default: CDKToolkit)
Name of the toolkit stack to use/deploy.
trace?
Type:
boolean
(optional, default: false)
Print trace for stack warnings.
usePreviousParameters?
Type:
boolean
(optional, default: true)
Use previous values for unspecified parameters.
If not set, all parameters must be specified for every deployment.
verbose?
Type:
boolean
(optional, default: false)
show debug logs.
versionReporting?
Type:
boolean
(optional, default: true)
Include "AWS::CDK::Metadata" resource in synthesized templates.