logoStacktape docs


Overview and basic usage

Deploys the stack to AWS.

  • If the stack doesn't exist, creates a new one. If the stack already exists, updates it.
  • Requires a valid stacktape configuration file in the current working directory or configuring a path to the config file using --configPath option.


stacktape deploy --stage <<stage>> --region <<region>>

API reference


region (--r)

AWS region to use for the current operation.

Type: string ENUM

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

stage (--s)

Stage used for the operation.

Type: string

  • Example stages are production, staging, 'testing' or 'dev-john'.
  • You can configure the default stage used with every Stacktape command using the defaults:configure command.
  • Maximum allowed length is 12 characters.
autoConfirmOperation (--aco)

Automatically confirm deploy/delete operations during which critical resources (databases) will be deleted.

Type: boolean

  • By default Stacktape prompts before this operations and user needs to confirm to proceed.
  • By using this switch the prompt is skipped and Stacktape automatically proceeds.
configPath (--cp)

Path to your stacktape configuration file.

Type: string

  • Relative to CWD (current working directory).
currentWorkingDirectory (--cwd)

Current working directory for the current operation.

Type: string

  • Every file path in your config will be resolved relatively to specified cwd.
  • By default, directory containing the configuration file is used.
disableAutoRollback (--dar)

Disables automatic rollback after the deployment failure

Type: boolean

When automatic rollback is enabled (default) and the deployment fails:

  • the stack will be automatically rolled back to the latest working version
  • resources created during the failed deployment will be deleted.
  • to move forward, you should resolve the issues and deploy again

When automatic rollback is disabled and the deployment fails:

  • the stack will remain in the UPDATE_FAILED state
  • all of the successfully created and updated resources will be kept
  • to move forward, you can resolve the issues causing the deployment to fail and then use stacktape deploy again or roll back to the latest working version using the stacktape rollback command.
disableDriftDetection (--ddd)

Disables drift detection (changes made to the stack that weren't made using CloudFormation)

Type: boolean

  • These changes can be made for example using AWS console, aws-cli or aws-sdk.
  • By default, Stacktape won't allow an update to a stack that has "drifted".
dockerArgs (--da)

Additional arguments to pass to Docker run or Docker build commands

Type: array

help (--h)

Shows help for the command

Type: string

  • If specified, the command won't perform any action besides printing help.
logFormat (--lf)

Format of logs printed to your console.

Type: string ENUM

Possible values: basicfancyjsonnormal

Available options:

  • fancy: Logs are colorized and dynamically re-rendered.
  • normal: Logs are colorized but not dynamically re-rendered.
  • basic: Simple text only
  • json: Logs are printed as JSON objects
logLevel (--ll)

Level of logs that are being printed to the console.

Type: string ENUM

Possible values: debugerrorinfo

Available options:

  • info: Prints basic information about everything that's happening.
  • error: Prints only errors.
  • debug: Prints detailed information about everything that's happening.
mode (--md)

Mode in which the stack is deployed

Type: string ENUM

Possible values: developmentproduction

Allowed options:

  • development: The stack is optimized for development. Sensitive data are not redacted and IAM roles can be assumed (this is required for local invoke).
  • production: Development helpers are disabled to enforce a high degree of security.
noCache (--nc)

Disables usage of cached artifacts and deploys freshly built workloads.

Type: boolean

preserveTempFiles (--ptf)

Preserves temporary files that stacktape generates using the operation.

Type: boolean

  • Temp folder includes CloudFormation template, packaged workloads and other files.
  • By default, these changes are saved to .stacktape/[invocation-id].
  • Temp folder location is also printed to the console.
profile (--p)

AWS profile to use with the command

Type: string

  • You can manage AWS profiles on your system using aws-profile:create, aws-profile:update or aws-profile:delete command.
  • You can configure the default profile used with every Stacktape command using the defaults:configure command.
showSensitiveValues (--ssv)

Include sensitive values in output when running stack-info or deploy command.

Type: boolean

  • By default sensitive values are not shown when running stack-info/deploy command.
  • By using this switch, sensitive data will be shown in stack-info/deploy output (or saved to stack-info file).
  • Be aware when using this switch. Mishandling sensitive data can lead to security issues.
Need help? Ask a question on SlackDiscord or info@stacktape.com.