Function setParameter

Example

import { setParameter } from '@aws-lambda-powertools/parameters/ssm';

export const handler = async () => {
  // Set a parameter
  const version = await setParameter('/my-parameter', { value: 'my-value' });
};
Copy

Overwriting a parameter

By default, the provider will not overwrite a parameter if it already exists. You can force the provider to overwrite the parameter by using the overwrite option.

Example

import { setParameter } from '@aws-lambda-powertools/parameters/ssm';

export const handler = async (): Promise<void> => {
 // Set a parameter and overwrite it
 const version = await setParameter('/my-parameter', {
   value: 'my-value',
   overwrite: true,
 });
 console.log(Parameter version: ${version});
};
Copy

Extra SDK options

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

Example

import { setParameter } from '@aws-lambda-powertools/parameters/ssm';

export const handler = async (): Promise<void> => {
 // Set a parameter with extra options
 const version = await setParameter('/my-parameter', {
   value: 'my-value',
   sdkOptions: {
     Overwrite: true,
   },
 });
};
Copy

This object accepts the same options as the AWS SDK v3 for JavaScript PutParameterCommandInput interface.

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

Options

You can customize the storage of the value by passing options to the function:

• value - The value of the parameter, which is a mandatory option.
• overwrite - Whether to overwrite the value if it already exists (default: false)
• description - The description of the parameter
• parameterType - The type of the parameter, can be one of String, StringList, or SecureString (default: String)
• tier - The parameter tier to use, can be one of Standard, Advanced, and Intelligent-Tiering (default: Standard)
• kmsKeyId - The KMS key id to use to encrypt the parameter
• sdkOptions - Extra options to pass to the AWS SDK v3 for JavaScript client

For more usage examples, see our documentation.