Overview and basic usage
deploy
Deploys your stack to AWS.
If the stack doesn't exist, it creates a new one. If it already exists, it updates it. This command requires a valid
Stacktape configuration file (stacktape.yml) in the current directory, or you can specify a path using the
--configPath option.
API reference
region (--r)Required
AWS Region
Type: string
Possible values: af-south-1ap-east-1ap-northeast-1ap-northeast-2ap-northeast-3ap-south-1ap-southeast-1ap-southeast-2ca-central-1eu-central-1eu-north-1eu-south-1eu-west-1eu-west-2eu-west-3me-south-1sa-east-1us-east-1us-east-2us-west-1us-west-2
The AWS region for the operation. For a list of available regions, see the AWS documentation.
stage (--s)Required
Stage
Type: string
The stage for the operation (e.g., production, staging, dev-john). You can set a default stage using the defaults:configure command. The maximum length is 12 characters.
autoConfirmOperation (--aco)
Auto-Confirm Operation
Type: boolean
If true, automatically confirms prompts during deploy or delete operations, skipping the manual confirmation step.
awsAccount (--aa)
AWS Account
Type: string
The name of the AWS account to use for the operation. The account must first be connected in the Stacktape console.
configPath (--cp)
Config File Path
Type: string
The path to your Stacktape configuration file, relative to the current working directory.
currentWorkingDirectory (--cwd)
Current Working Directory
Type: string
The working directory for the operation. All file paths in your configuration will be resolved relative to this directory. By default, this is the directory containing the configuration file.
disableAutoRollback (--dar)
Disable Auto-Rollback
Type: boolean
If true, disables automatic rollback on deployment failure.
- With auto-rollback (default): If a deployment fails, the stack is automatically rolled back to the last known good state.
- Without auto-rollback: If a deployment fails, the stack remains in the
UPDATE_FAILEDstate. You can then either fix the issues and redeploy or manually roll back using thestacktape rollbackcommand.
disableDriftDetection (--ddd)
Disable Drift Detection
Type: boolean
Disables detection of manual changes (drift) made to the stack outside of CloudFormation (e.g., via the AWS console or CLI). By default, Stacktape blocks updates to a stack that has drifted.
dockerArgs (--da)
Docker Arguments
Type: array
Additional arguments to pass to the docker run or docker build commands.
help (--h)
Show Help
Type: string
If provided, the command will not execute and will instead print help information.
hotSwap (--hs)
Hotswap
Type: boolean
If true, attempts a faster deployment for code-only changes by updating functions and multi-container-workloads directly, without using CloudFormation. This is recommended only for development stacks. Hotswap will only be used if all stack changes are hot-swappable.
logFormat (--lf)
Log Format
Type: string
Possible values: basicfancyjsonnormal
The format of logs printed to the console.
fancy: Colorized and dynamically re-rendered logs.normal: Colorized but not dynamically re-rendered logs.basic: Simple text only.json: Logs printed as JSON objects.
logLevel (--ll)
Log Level
Type: string
Possible values: debugerrorinfo
The level of logs to print to the console.
info: Basic information about the operation.error: Only errors.debug: Detailed information for debugging.
noCache (--nc)
No Cache
Type: boolean
If true, disables the use of cached artifacts and forces a fresh build of compute resources.
preserveTempFiles (--ptf)
Preserve Temporary Files
Type: boolean
If true, preserves the temporary files generated by the operation, such as the CloudFormation template and packaged resources. These files are saved to .stacktape/[invocation-id].
profile (--p)
AWS Profile
Type: string
The AWS profile to use for the command. You can manage profiles using the aws-profile:* commands and set a default profile with defaults:configure.
projectName (--prj)
Project Name
Type: string
The name of the Stacktape project for this operation.
showSensitiveValues (--ssv)
Show Sensitive Values
Type: boolean
If true, includes sensitive values in the output of the stack:info and deploy commands. Be cautious when using this flag, as mishandling sensitive data can create security risks.
templateId (--ti)
Template ID
Type: string
The ID of the template to download. You can find a list of available templates on the Config Builder page.