Function getSecret

Example

import { getSecret } from '@aws-lambda-powertools/parameters/secrets';

export const handler = async (): Promise<void> => {
  // Retrieve a secret
  const secret = await getSecret('my-secret');
};
Copy

Advanced usage

Caching

By default, the provider will cache parameters retrieved in-memory for 5 seconds. You can adjust how long values should be kept in cache by using the maxAge parameter.

Example

import { getSecret } from '@aws-lambda-powertools/parameters/secrets';

export const handler = async (): Promise<void> => {
  // Retrieve a secret and cache it for 10 seconds
  const secret = await getSecret('my-secret', { maxAge: 10 });
};
Copy

If instead you'd like to always ensure you fetch the latest parameter from the store regardless if already available in cache, use the forceFetch parameter.

Example

import { getSecret } from '@aws-lambda-powertools/parameters/secrets';

export const handler = async (): Promise<void> => {
  // Retrieve a secret and always fetch the latest value
  const secret = await getSecret('my-secret', { forceFetch: true });
};
Copy

Transformations

For parameters stored as JSON or base64-encoded strings, you can use the transform argument set to json or binary for deserialization.

Example

import { getSecret } from '@aws-lambda-powertools/parameters/secrets';

export const handler = async (): Promise<void> => {
  // Retrieve a secret and parse it as JSON
  const secret = await getSecret('my-secret', { transform: 'json' });
};
Copy

Extra SDK options

When retrieving a secret, you can pass extra options to the AWS SDK v3 for JavaScript client by using the sdkOptions parameter.

Example

import { getSecret } from '@aws-lambda-powertools/parameters/secrets';

export const handler = async (): Promise<void> => {
  // Retrieve a secret and pass extra options to the AWS SDK v3 for JavaScript client
  const secret = await getSecret('my-secret', {
    sdkOptions: {
      VersionId: 1,
    },
  });
};
Copy

This object accepts the same options as the AWS SDK v3 for JavaScript Secrets Manager client.

Built-in provider class

For greater flexibility such as configuring the underlying SDK client used by built-in providers, you can use the SecretsProvider class.

For more usage examples, see our documentation.