Class AwsSecretsManagerAdapter

Loads secrets from AWS Secrets Manager. A SecretsManagerClient instance must be provided.

Hierarchy (View Summary)

BaseSecretsAdapter
- AwsSecretsManagerAdapter

Index

Constructors

Properties

adapterName awsSecretsManager

Methods

destroy loadSecrets

Constructors

constructor

new AwsSecretsManagerAdapter(
awsSecretsManager: Readonly<NeededAwsSecretsManagerClient>,
): AwsSecretsManagerAdapter
Parameters
- awsSecretsManager: Readonly<NeededAwsSecretsManagerClient>
Returns AwsSecretsManagerAdapter
Overrides BaseSecretsAdapter.constructor
- Defined in src/adapters/aws-secrets-manager.adapter.ts:40

Properties

`Readonly`adapterName

adapterName: string

`Protected` `Readonly`awsSecretsManager

awsSecretsManager: Readonly<NeededAwsSecretsManagerClient>

Methods

destroy

destroy(): void
Clean up all resources created by the adapter. This should not cause the adapter to destroy any resources passed to it in its constructor.

Returns void
Inherited from BaseSecretsAdapter.destroy
- Defined in src/adapters/base.adapter.ts:38

loadSecrets

loadSecrets(
secrets: ProcessedSecretDefinitions,
): Promise<
InnerMappedValues<ProcessedSecretDefinitions, Error | Promise<any>>,
>
Loads secrets from the provided SecretsManagerClient.
Parameters
- secrets: ProcessedSecretDefinitions
Returns Promise<InnerMappedValues<ProcessedSecretDefinitions, Error | Promise<any>>>
Overrides BaseSecretsAdapter.loadSecrets
- Defined in src/adapters/aws-secrets-manager.adapter.ts:45