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
  • Properties
  • Environment variables available in the shell command
  • Example

Was this helpful?

Export as PDF
  1. Parameter resolvers
  2. Built-in parameter resolvers

Command resolver

The command resolver executes a specified shell command and uses the command output as a parameter value.

Properties

Here are the properties of the command resolver:

Key
Required
Type
Description

resolver

yes

string

Resolver name, this must be cmd.

command

yes

string

Shell command to execute.

confidential

no

boolean

Conceal the resolved parameter value from logs, defaults to false

immutable

no

boolean

Mark the parameter as immutable, defaults to false

exposeStackCredentials

no

boolean

Make the current stack's AWS credentials available for the shell command. Defaults to false. Added in Takomo v3.11.0.

exposeStackRegion

no

boolean

Make the current stack's region available for the shell command. Defaults to false. Added in Takomo v3.11.0.

capture

no

string

Controls how to capture the output of the executed shell command. By default, all output is captured. To capture only the last line, set this to last-line. Added in Takomo v3.11.0.

Environment variables available in the shell command

The following environment variables are available in the shell command:

Name

Description

AWS_ACCESS_KEY_ID

If exposeStackCredentials is true, this will hold the access key id of credentials of the current stack.

AWS_SECRET_ACCESS_KEY

If exposeStackCredentials is true, this will hold the secret access key of credentials of the current stack.

AWS_SESSION_TOKEN

If exposeStackCredentials is true, this will hold the session token of credentials of the current stack.

AWS_SECURITY_TOKEN

If exposeStackCredentials is true, this will hold the session token of credentials of the current stack.

AWS_DEFAULT_REGION

IF exposeStackRegion is true, this will hold the region of the current stack.

Example

Use contents of the /home/password.txt file as parameter value:

parameters:
  Password:
    resolver: cmd
    command: cat /home/password.txt

PreviousExternal stack output resolverNextFile contents resolver

Last updated 3 years ago

Was this helpful?