Takomo
  • What is Takomo?
  • Getting started
    • Installation
    • Quick start
    • Tutorial
  • Configuration
    • AWS credentials
    • Directory structure
    • Stacks and stack groups
    • Project configuration
  • Stack properties
    • Name
    • Regions
    • Template
    • Template bucket
    • Command role
    • Account ids
    • Depends
    • Parameters
    • Tags
    • Inherit tags
    • Termination protection
    • Timeout
    • Capabilities
    • Stack policy
    • Ignore
    • Obsolete
    • Hooks
    • Data
    • Schemas
  • Variables and templating
    • Introduction
    • Handlebars syntax
    • Environment variables
    • Command-line variables
    • Partials
    • Helpers
    • Available variables
  • Parameter resolvers
    • Built-in parameter resolvers
      • Stack output resolver
      • External stack output resolver
      • Command resolver
      • File contents resolver
      • Hook output resolver
      • SSM parameter resolver
      • Secret resolver
    • Custom parameter resolvers
  • Hooks
    • Built-in hooks
    • Custom hooks
    • Sharing data between hooks
  • Validation schemas
    • Custom validation schemas
  • Command-line usage
    • Common options
    • Deploy stacks
    • Undeploy stacks
    • Prune stacks
    • List stacks
    • Detect drift
    • Generate IAM policies
    • Inspect stack configuration
    • Inspect stack dependencies
  • Support
    • Getting help
    • Troubleshooting
  • Development
    • Change log
Powered by GitBook
On this page
  • Usage
  • Positional arguments
  • Options
  • IAM permissions
  • Examples

Was this helpful?

Export as PDF
  1. Command-line usage

List stacks

PreviousPrune stacksNextDetect drift

Last updated 3 years ago

Was this helpful?

List stacks within the given command path.

Usage

tkm stacks list [command-path] [--output <format>]

Positional arguments

  • command-path

    • Command path to select which stacks to list.

    • Optional, by default, Takomo lists all stacks.

Options

In addition to the , this command has the following options.

  • --output <format>

    • Print the command result using this format

    • Supported values: text, json, yaml

IAM permissions

These are the minimum IAM permissions required to run this command.

Statement: 
  - Sid: Stacks
    Effect: Allow
    Action: cloudformation:DescribeStacks
    Resource: "*"

  # IAM permissions needed only if command roles are used.  
  # Specify Resource to restrict access to specific roles.  
  - Sid: IAM
    Effect: Allow
    Action: sts:AssumeRole
    Resource: "*"

Examples

List all stacks:

tkm stacks list

List stacks within the given command path:

tkm stacks list /prod
common options