terraform stacks diagnostics reference

Use the terraform stacks diagnostics command to retrieve warnings and errors for a Stack configuration or deployment step.

Usage

$ terraform stacks <global-stacks-flags> diagnostics -id <value> <options>

Description

The terraform stacks diagnostics command retrieves warnings and errors for either a Stack configuration or a deployment step.

A Stack configuration ID (stc-) identifies a specific uploaded version of your Stack configuration. You receive this ID as output from the terraform stacks configuration upload or terraform stacks configuration fetch commands.

A deployment step ID (sds-) identifies a single plan or apply step within a deployment run. You can find step IDs in the output of the terraform stacks deployment-run show command.

The command returns an empty result when no errors or warnings exist for the specified configuration version or deployment step.

Options

• -id: The ID of the Stack configuration or deployment step to retrieve diagnostics for.

  • Required.
  • String.
  • Prefix the ID with stc- for a Stack configuration ID. Prefix the ID with sds- for a deployment step ID.

• -json: Output results in JSON format instead of the default human-readable text format.

  • Optional.
  • Boolean flag.
  • Default: false (human-readable format).

Examples

The following command retrieves diagnostics for a Stack configuration:

$ terraform stacks diagnostics -id stc-abc123

The following command retrieves diagnostics for a deployment step:

$ terraform stacks diagnostics -id sds-abc123

The following command retrieves diagnostics in JSON format:

$ terraform stacks diagnostics -id stc-abc123 -json

Global flags

Refer to Global flags reference for information about flags you can use with all commands.

Related

• Terraform Stacks CLI reference