Skip to main content

atmos terraform metadata

Use this command to retrieve Terraform metadata functions for an Atmos component in a stack.

atmos terraform metadata --help

Usage​

Execute the terraform metadata command like this:

atmos terraform metadata <component> -s <stack> [options]

This command provides metadata functions for Terraform configurations. This is primarily used for advanced Terraform Cloud operations.

Atmos Behavior

Atmos provides standard setup for this command including automatic terraform init and workspace selection. The metadata operations are handled by native Terraform.

Examples​

Metadata Functions​

# Access metadata functions
atmos terraform metadata vpc -s dev functions

Arguments​

component (required)

Atmos component name.

Flags​

--stack / -s (required)

Atmos stack name where the component is defined.

--skip-init (optional)

Skip running terraform init before executing the command.

atmos terraform metadata vpc -s dev --skip-init
--dry-run (optional)

Show what would be executed without actually running the command.

atmos terraform metadata vpc -s dev --dry-run

Native Terraform Flags​

This command supports native terraform metadata flags such as Subcommands include functions for function metadata..

Related Commands​