Skip to main content

atmos aws cloudformation source describe

Use this command to display the source configuration for an aws/cloudformation component. This shows the source URI, version, and any path filters configured for vendoring.

Source-Based Version Pinning

Configure source locations, version pins, and authentication.

atmos aws cloudformation source describe --help

Usage​

atmos aws cloudformation source describe <component> --stack <stack>

Examples​

View Source Configuration​

Display the source configuration for a component:

atmos aws cloudformation source describe vpc --stack dev

Output:

components:
  aws/cloudformation:
    vpc:
      source:
        uri: github.com/cloudposse/cloudformation-aws-components//modules/vpc
        version: 1.0.0
        included_paths:
          - "*.yaml"
          - "modules/**"
        excluded_paths:
          - "*.md"
          - "tests/**"

String Format Source​

When source is configured as a simple string:

atmos aws cloudformation source describe vpc --stack dev

Output:

components:
  aws/cloudformation:
    vpc:
      source:
        uri: github.com/cloudposse/cloudformation-aws-components//modules/vpc?ref=1.0.0

Arguments​

component
The name of the Atmos component to describe. Required for unattended use; when omitted, interactive mode offers component selection if candidates are available.

Flags​

--stack / -s
The Atmos stack name, also settable via ATMOS_STACK. Required for unattended use; when unset, interactive mode offers stack selection if candidates are available.

Description​

Inspect the source URI, version, and path filters before downloading. The result uses the stack manifest's YAML structure.

Output Format​

The command outputs YAML matching the stack manifest schema:

components."aws/cloudformation".<component>.source
The parsed source specification for the component.
source.uri
The go-getter-compatible source URI.
source.version
The version tag, branch, or commit (if specified separately).
source.included_paths
List of glob patterns for files to include.
source.excluded_paths
List of glob patterns for files to exclude.

See Also​