ParameterStore Object

This reference documents the properties and methods available on the ParameterStore object.

Properties

ParameterStore.data DataObject

A DataObject used to store a set of parameters and their corresponding values.

Methods

get

Returns the value of a parameter using the getter function defined by the parameter definition.

parameters.get(parameter);

Arguments

NAMEREQUIREDTYPEDESCRIPTION
parameterTrueStringThe name of the parameter to return.

Returns

String, Number, Boolean, Object, etc.The value of the parameter or property, or undefined if the parameter isn't set.

Examples

// Returns the "signer_id" parameter.
var val = parameters.get('signer_id');  // '[email protected]'

set

Sets the value of one or more parameters, using the setter function defined by the parameter definition. Accepts either a single parameter name and value, or an object of multiple parameter name and value pairs to set.

parameters.set(parameter, value, override);
parameters.set(parameters, override);

Arguments

_NAMEREQUIREDTYPEDESCRIPTION
Option 1parameterTrueStringThe name of the parameter to set.
valueTrueString, Number, Object, Function, etc.The value of the parameter to set.
Option 2parametersTrueObjectAn object containing one or more parameter name and value pairs to set.
`overrideFalseBooleanA flag indicating if the parameters should be set as temporary override values.

Returns

No Return Value

Examples

// Sets the "signer_id" parameter.
parameters.set('signer_id', '[email protected]', false);
// Sets the "contracts" parameter as an override value.
parameters.set('contracts', [ 10, 14 ], true);

Did this page help you?