Class SecretsManager

Hierarchy

SecretsManager

Index

Constructors

Properties

cache? envPrefix options secrets ssmClient

Methods

get getCache getLoaded loadSecrets saveSecret

Constructors

constructor

new SecretsManager(config?: SecretsManagerConfig): SecretsManager
Parameters
- Optional config: SecretsManagerConfig
Returns SecretsManager
- Defined in SecretsManager.ts:23

Properties

`Private` `Optional` cache

cache?: MemoryCache

`Readonly` envPrefix

envPrefix: string

`Private` `Readonly` options

options: SecretsManagerLoadConfig & SecretsManagerLoadOptions

`Private` `Readonly` secrets

secrets: Record<string, undefined | string>

`Private` `Readonly` ssmClient

ssmClient: SsmClient

Methods

get

get(secretName: string, options?: SecretsManagerLoadOptions): Promise<undefined | string>
Parameters
- secretName: string
- Optional options: SecretsManagerLoadOptions
Returns Promise<undefined | string>
- Defined in SecretsManager.ts:107

`Private` getCache

getCache(): Promise<MemoryCache>
Returns Promise<MemoryCache>
- Defined in SecretsManager.ts:57

getLoaded

getLoaded(secretName: string): undefined | string
Parameters
- secretName: string
Returns undefined | string
- Defined in SecretsManager.ts:103

loadSecrets

loadSecrets(secretNames: string[], options?: SecretsManagerLoadOptions): Promise<Record<string, undefined | string>>
Parameters
- secretNames: string[]
- Optional options: SecretsManagerLoadOptions
Returns Promise<Record<string, undefined | string>>
- Defined in SecretsManager.ts:80

saveSecret

saveSecret(name: string, value: string, options?: SecretsManagerLoadOptions): Promise<void>
Parameters
- name: string
- value: string
- Optional options: SecretsManagerLoadOptions
Returns Promise<void>
- Defined in SecretsManager.ts:67

Generated using TypeDoc