Name of the parameter
Options to configure the parameter
Optionaldescription?: stringThe description of the parameter
OptionalkmsKeyId?: stringThe KMS key id to use to encrypt the parameter
Optionaloverwrite?: booleanIf the parameter value should be overwritten
OptionalparameterType?: ParameterTypeType of the parameter, can be one of String, StringList, or SecureString
OptionalsdkOptions?: Partial<PutParameterCommandInput>Additional options to pass to the AWS SDK v3 client
Optionaltier?: ParameterTierThe parameter tier to use, can be one of Standard, Advanced, and Intelligent-Tiering
The parameter value
import { setParameter } from '@aws-lambda-powertools/parameters/ssm';
export const handler = async () => {
// Set a parameter
const version = await setParameter('/my-parameter', { value: 'my-value' });
};
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.
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});
};
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.
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,
},
});
};
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.
Set a parameter in AWS Systems Manager Parameter Store.
Basic Usage