logoStacktape docs

deploy

Deploys stack with specified stage to AWS. If stack doesn't exist, creates new one. If stack already exists, updates it.

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

API reference

Command options API reference
region (--r)
Required

AWS region for given command.

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)
Required

Stage to deploy your stack to. Example stages are production, staging, etc.

Type: string

autoRollback (--ar)

Enables automatic rollback after the deployment failure

  • By default automatic rollback is disabled

  • When rollback is disabled and deployment fails:

    • the stack will be in UPDATE_FAILED state,
    • all of the successfully created/updated resources will be kept,
    • the stack which is in UPDATE_FAILED state can either be:
      • updated using stacktape deploy command (after you fix problems),
      • rolled back using stacktape rollback command.

  • When rollback is enabled and deployment fails:

    • stack will rollback to the old version (version before this stacktape deploy),
    • new resources which were created during the failed deploy will be deleted.

Type: boolean

configPath (--cp)

Path (relative to cwd) to your stacktape configuration file. By default, it's stacktape.yml.

Type: string

currentWorkingDirectory (--cwd)

Current working directory. All file paths in your config will be resolved relatively to specified cwd. Default: directory containing configuration file.

Type: string

disableDriftDetection (--ddd)

Ignores changes made to given stack that weren't made using cloudformation (typically changes made using AWS console, aws-cli or aws-sdk).

Type: boolean

dockerArgs (--da)

Arguments to pass to docker run or docker build

Type: array

logFormat (--lf)

Format of logs that are being printed to your console. You can learn more at https://docs.stacktape.com/cli/using-cli Default: 'fancy'

Type: string ENUM

Possible values: basicfancyjsonnormal

logLevel (--ll)

Level of logs that are being printed to the console. You can use 'debug' for more information about what's being done, or 'error' to show only errors. Default: 'info'

Type: string ENUM

Possible values: debugerrorinfo

mode (--md)

Specifes the mode for this stack. Using production you can increase security by disabling some of the helpers made for development purposes.

Type: string ENUM

Possible values: developmentproduction

noCache (--nc)

Disables usage of cached artifacts. Deploys freshly built workloads.

Type: boolean

preserveTempFiles (--ptf)

Preserves temporary files that stacktape generates.

Type: boolean

profile (--p)

AWS profile to use.

Type: string