@aws-cdk_cli-lib-alpha.DeployOptions

interface DeployOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.Cli.Lib.Alpha.DeployOptions
Gogithub.com/aws/aws-cdk-go/awscdkclilibalpha/v2#DeployOptions
Javasoftware.amazon.awscdk.cli.lib.alpha.DeployOptions
Pythonaws_cdk.cli_lib_alpha.DeployOptions
TypeScript (source)@aws-cdk/cli-lib-alpha ยป DeployOptions

Options to use with cdk deploy.

Example

// await this asynchronous method call using a language feature
cli.deploy({
  stacks: ['MyTestStack'],
});

Properties

NameTypeDescription
assetMetadata?๐Ÿ”นbooleanInclude "aws:asset:*" CloudFormation metadata for resources that use assets.
assetParallelism?๐Ÿ”นbooleanWhether to build/publish assets in parallel.
assetPrebuild?๐Ÿ”นbooleanWhether to build all assets before deploying the first stack (useful for failing Docker builds).
caBundlePath?๐Ÿ”นstringPath to CA certificate to use when validating HTTPS requests.
changeSetName?๐Ÿ”นstringOptional name to use for the CloudFormation change set.
ci?๐Ÿ”นbooleanWhether we are on a CI system.
color?๐Ÿ”นbooleanShow colors and other style from console output.
concurrency?๐Ÿ”นnumberMaximum number of simultaneous deployments (dependency permitting) to execute.
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 perform action on the given stack.
execute?๐Ÿ”นbooleanWhether to execute the ChangeSet Not providing execute parameter will result in execution of ChangeSet.
force?๐Ÿ”นbooleanAlways deploy, even if templates are identical.
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.
notificationArns?๐Ÿ”นstring[]ARNs of SNS topics that CloudFormation will notify with stack related events.
outputsFile?๐Ÿ”นstringPath to file where stack outputs will be written after a successful deploy as JSON.
parameters?๐Ÿ”น{ [string]: string }Additional parameters for CloudFormation at deploy time.
pathMetadata?๐Ÿ”นbooleanInclude "aws:cdk:path" CloudFormation metadata for each resource.
profile?๐Ÿ”นstringUse the indicated AWS profile as the default environment.
progress?๐Ÿ”นStackActivityProgressDisplay mode for stack activity events.
proxy?๐Ÿ”นstringUse the indicated proxy.
requireApproval?๐Ÿ”นRequireApprovalWhat kind of security changes require approval.
reuseAssets?๐Ÿ”นstring[]Reuse the assets with the given asset IDs.
roleArn?๐Ÿ”นstringRole to pass to CloudFormation for deployment.
rollback?๐Ÿ”นbooleanRollback failed deployments.
stacks?๐Ÿ”นstring[]List of stacks to deploy.
staging?๐Ÿ”นbooleanCopy assets to the output directory.
strict?๐Ÿ”นbooleanDo not construct stacks with warnings.
toolkitStackName?๐Ÿ”นstringName of the toolkit stack to use/deploy.
trace?๐Ÿ”นbooleanPrint trace for stack warnings.
usePreviousParameters?๐Ÿ”นbooleanUse previous values for unspecified parameters.
verbose?๐Ÿ”นbooleanshow debug logs.
versionReporting?๐Ÿ”นbooleanInclude "AWS::CDK::Metadata" resource in synthesized templates.

assetMetadata?๐Ÿ”น

Type: boolean (optional, default: true)

Include "aws:asset:*" CloudFormation metadata for resources that use assets.


assetParallelism?๐Ÿ”น

Type: boolean (optional, default: false)

Whether to build/publish assets in parallel.


assetPrebuild?๐Ÿ”น

Type: boolean (optional, default: true)

Whether to build all assets before deploying the first stack (useful for failing Docker builds).


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 unless the environment variable CI is set)

Whether we are on a CI system.


color?๐Ÿ”น

Type: boolean (optional, default: true unless the environment variable NO_COLOR is set)

Show colors and other style from console output.


concurrency?๐Ÿ”น

Type: number (optional, default: 1)

Maximum number of simultaneous deployments (dependency permitting) to execute.


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.


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.


progress?๐Ÿ”น

Type: StackActivityProgress (optional, default: StackActivityProgress.EVENTS)

Display mode for stack activity events.

The default in the CLI is StackActivityProgress.BAR. But since this is an API it makes more sense to set the default to StackActivityProgress.EVENTS


proxy?๐Ÿ”น

Type: string (optional, default: no proxy)

Use the indicated proxy.

Will read from HTTPS_PROXY environment if specified


requireApproval?๐Ÿ”น

Type: RequireApproval (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: all stacks)

List of stacks to deploy.


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.