API reference / @backpack/aws-secrets-manager / CachedSecretsManagerService
Class: CachedSecretsManagerService
Special implementation of SecretsManagerService which caches all values for a given amount of time.
Extends
Constructors
Constructor
ts
new CachedSecretsManagerService(secretsManagerClient, options?): CachedSecretsManagerService;Parameters
| Parameter | Type |
|---|---|
secretsManagerClient | SecretsManagerClient |
options? | CachedSecretsManagerOptions |
Returns
CachedSecretsManagerService
Overrides
SecretsManagerService.constructor
Properties
client
ts
protected readonly client: SecretsManagerClient;Inherited from
Methods
clearCache()
ts
clearCache(): void;Clears the cache.
Returns
void
getJsonSecret()
Call Signature
ts
getJsonSecret<T>(secretId, options?): Promise<T>;Retrieves and parses a cached secret value stored as JSON.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
secretId | string |
options? | { required: true; } |
options.required? | true |
Returns
Promise<T>
Overrides
SecretsManagerService.getJsonSecret
Call Signature
ts
getJsonSecret<T>(secretId, options?): Promise<undefined | T>;Retrieves and parses a cached secret value stored as JSON.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
secretId | string |
options? | { required: boolean; } |
options.required? | boolean |
Returns
Promise<undefined | T>
Overrides
SecretsManagerService.getJsonSecret
getRequiredSecretValue()
ts
getRequiredSecretValue<T>(secretId): Promise<T>;Retrieves and parses a secret value stored as JSON.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type | Description |
|---|---|---|
secretId | string | The id of the secret to retrieve. |
Returns
Promise<T>
Deprecated
use getJsonSecret() instead.
Inherited from
SecretsManagerService.getRequiredSecretValue
getSecretValue()
ts
getSecretValue<T>(secretId): Promise<undefined | T>;Retrieves and parses a secret value stored as JSON.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type | Description |
|---|---|---|
secretId | string | The id of the secret to retrieve. |
Returns
Promise<undefined | T>
Deprecated
use getJsonSecret(secretId, { required: false }) instead.