Overview and basic usage
Compiles CloudFormation template and saves it into the specified file.
- By default, the template is saved to
./compiled-template.yaml
. To override this, use --outFile
Copy
stacktape compile-template --stage <<stage>> --region <<region>>
API reference
Options
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 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.
Path to your stacktape configuration file.
Type: string
- Relative to CWD (current working directory).
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.
Shows help for the command
Type: string
- If specified, the command won't perform any action besides printing help.
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 onlyjson
: Logs are printed as JSON objects
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.
Path to a file where the operation output will be saved.
Type: string
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.
AWS profile to use with the command
Type: string
- You can manage AWS profiles on your system using
aws-profile:create
,aws-profile:update
oraws-profile:delete
command. - You can configure the default profile used with every Stacktape command using the
defaults:configure
command.