Class AwsKmsProvider

constructor

• new AwsKmsProvider(options?: AwsKmsProviderOptions): AwsKmsProvider

  Parameters

  • Optionaloptions: AwsKmsProviderOptions

    AWS connection/injection options

  Returns AwsKmsProvider

OptionalisHealthy

connect

• connect(): Promise<void>

  Establishes any backing connection/client. No-op for stateless providers.

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Releases any backing connection/client. No-op for stateless providers.

  Returns Promise<void>

get

• get(name: string): Promise<string | null>

  Reads a secret from AWS Secrets Manager.

  Parameters

  • name: string

    The secret id

  Returns Promise<string | null>

  The value, or null when absent

isReady

• isReady(): boolean

  Reports whether the provider is ready to serve reads.

  Returns boolean

set

• set(name: string, value: string): Promise<void>

  Writes a new value for a secret.

  Parameters

  • name: string

    The secret id

  • value: string

    The new value

  Returns Promise<void>