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
  • Examples

Was this helpful?

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

SSM parameter resolver

The SSM parameter resolver reads parameter values from SSM parameter store. The parameter can be encrypted.

Properties

Here are the properties of the SSM parameter resolver:

Key
Required
Type
Description

resolver

yes

string

Resolver name, this must be ssm.

name

yes

string

Name of the SSM parameter.

region

no

string

Region where the SSM parameter resides. By default, Takomo uses the region of the stack where the parameter resolver is used.

commandRole

no

string

IAM role used to access the SSM parameter. Command role is optional. By default, credentials associated with the current stack are used.

confidential

no

boolean

Conceal the resolved parameter value from logs, defaults to false

immutable

no

boolean

Mark the parameter as immutable, defaults to false

Examples

Read value from an SSM parameter /database/password that resides in the same region as the current stack:

parameters:
  Password:
    resolver: ssm
    name: /database/password

Read value from an SSM parameter /database/username that resides in eu-north-1 region:

parameters:
  Username:
    resolver: ssm
    region: eu-north-1
    name: /database/username

Read value from an SSM parameter using custom IAM role:

parameters:
  Password:
    resolver: ssm
    commandRole: arn:aws:iam::123456789012:role/read-only
    name: MyParam
PreviousHook output resolverNextSecret resolver

Last updated 3 years ago

Was this helpful?