logoStacktape docs


stack:info

Overview and basic usage

Prints information about the specified stack.


You can get the information in 2 ways:

  • simple (default): prints helpful links and parameters of the deployed stack to the terminal.
  • detailed (used if you specify the --detailed flag): saves detailed information about the stack to a file. By default, the output is saved to stack-info.yaml. This can be configured using --outFile and --outFormat options.

In the detailed mode:

  • If the stack is deployed and you specify --stackName, you'll get overview of the deployed stack.
  • If the stack is NOT deployed and you specify --stage, --region and supply a configuration, you'll get an overview of resources that will be created if you deploy the stack.
  • If the stack is deployed and you specify --stage, --region and supply a configuration, you will see both resources from configuration and deployed resources in the result. Depending on the difference between configuration and deployed resources, status of the resource can be either DEPLOYED, TO_BE_CREATED or TO_BE_DELETED, suggesting what will happen to the resource if you deploy (update) the stack.

Sensitive values (such as database credentials) are omitted by default. If you want to include them, use --showSensitiveValues flag.

Copy

stacktape stack:info --region <<region>>

API reference

Options

region (--r)
Required

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

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.
configPath (--cp)

Path to your stacktape configuration file.

Type: string

  • Relative to CWD (current working directory).
detailed (--d)

Creates file with detailed stack information and saves it to a file.

Type: boolean

  • You can specify path to output file using argument --outFile
  • You can specify output format using argument --outFormat
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.
outFile (--out)

Path to a file where the operation output will be saved.

Type: string

outFormat (--of)

Format of the output file used to save stack information

Type: string ENUM

Possible values: jsonyml

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.
stackName (--sn)

The full name of the stack.

Type: string

  • The full name of the stacks deployed using Stacktape is (serviceName)-(stage).
Need help? Ask a question on SlackDiscord or info@stacktape.com.