stack:info

Overview and basic usage

stack:info

Prints information about a specified stack.

You can get information in two formats:

  • Simple (default): Prints helpful links and parameters for the deployed stack to the terminal.
  • Detailed (--detailed flag): Saves detailed information about the stack to a file (default: stack-info.yaml). You can customize the output file and format with the --outFile and --outFormat options.

In detailed mode:

  • If the stack is deployed, you'll get an overview of the deployed resources.
  • If you also provide a configuration file, the output will show a diff between the deployed resources and the configuration, indicating which resources will be created, updated, or deleted on the next deployment.
  • If the stack is not deployed, it will show an overview of the resources that will be created.

By default, sensitive values are omitted. To include them, use the --showSensitiveValues flag.


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

API reference

Options
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.

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.

detailed (--d)

Detailed

Type: boolean

If true, creates a file with detailed stack information. You can specify the output file path with --outFile and the format with --outFormat.

help (--h)

Show Help

Type: string

If provided, the command will not execute and will instead print help information.

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.
outFile (--out)

Output File

Type: string

The path to the file where the operation output will be saved.

outFormat (--of)

Output Format

Type: string

Possible values: jsonyml

The format of the output file for stack information.

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.