Class SsmConfigSource

Reads configuration from AWS SSM Parameter Store, recursively under a path.

Parameter names are turned into a nested object relative to the path (/app/db/url under /app/ -> { db: { url } }). SecureString parameters are decrypted by default. @aws-sdk/client-ssm is imported lazily as an optional peer dependency.

Implements

ConfigSource

Index

Constructors

Properties

Methods

Constructors

constructor

new SsmConfigSource(options: SsmSourceOptions): SsmConfigSource
Parameters
- options: SsmSourceOptions
  The source options.
Returns SsmConfigSource

Properties

`Readonly`name

name: string = 'ssm'

A human-readable name (e.g. env, file, ssm).

Methods

load

load(): Promise<Record<string, unknown>>

Returns Promise<Record<string, unknown>>

Inherit Doc

Implementation of ConfigSource.load

`Static`create

create(options: SsmSourceOptions): SsmConfigSource
Create an SSM source.
Parameters
- options: SsmSourceOptions
  The source options.
Returns SsmConfigSource
A new source.