Class SecretsConfigSource

Reads configuration from an AWS Secrets Manager secret whose value is a JSON object.

@aws-sdk/client-secrets-manager is imported lazily as an optional peer dependency.

Implements

ConfigSource

Index

Constructors

Properties

Methods

Constructors

constructor

new SecretsConfigSource(options: SecretsSourceOptions): SecretsConfigSource
Parameters
- options: SecretsSourceOptions
  The source options.
Returns SecretsConfigSource

Properties

`Readonly`name

name: string = 'secrets'

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: SecretsSourceOptions): SecretsConfigSource
Create a Secrets Manager source.
Parameters
- options: SecretsSourceOptions
  The source options.
Returns SecretsConfigSource
A new source.