aws-cdk-lib.cloud_assembly_schema.DeployOptions

interface DeployOptions

LanguageType name
.NETAmazon.CDK.CloudAssembly.Schema.DeployOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#DeployOptions
Javasoftware.amazon.awscdk.cloudassembly.schema.DeployOptions
Pythonaws_cdk.cloud_assembly_schema.DeployOptions
TypeScript (source)aws-cdk-lib » cloud_assembly_schema » DeployOptions

Options to use with cdk deploy.

Example

const app = new App();

const stackUnderTest = new Stack(app, 'StackUnderTest', /* ... */);

const stack = new Stack(app, 'stack');

const testCase = new IntegTest(app, 'CustomizedDeploymentWorkflow', {
  testCases: [stackUnderTest],
  diffAssets: true,
  stackUpdateWorkflow: true,
  cdkCommandOptions: {
    deploy: {
      args: {
        requireApproval: RequireApproval.NEVER,
        json: true,
      },
    },
    destroy: {
      args: {
        force: true,
      },
    },
  },
});

Properties

NameTypeDescription
all?booleanDeploy all stacks.
app?stringcommand-line for executing your app or a cloud assembly directory e.g. "node bin/my-app.js" or "cdk.out".
assetMetadata?booleanInclude "aws:asset:*" CloudFormation metadata for resources that use assets.
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.
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.
output?stringEmits the synthesized cloud assembly into a directory.
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.
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.

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.


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: 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: [])

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.