Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
SystemsManagerParameter.* methods querying the Systems Manager Service parameters return some SystemsManagerParameter instances. Namely, getParameter returns an array of SystemsManagerParameter objects. The SystemsManagerParameter object describes an Amazon Systems Manager Service parameter.
Name
Type
Description
SystemsManagerParameter.arn
string
The Amazon Resource Name (ARN) of the parameter
SystemsManagerParameter.dataType
string
The data type of the parameter, such as text or aws:ec2:image. The default is text.
SystemsManagerParameter.lastModifiedDate
number
Date the parameter was last changed or updated and the parameter version was created.
SystemsManagerParameter.name
string
The friendly name of the parameter.
SystemsManagerParameter.selector
string
Either the version number or the label used to retrieve the parameter value
SystemsManagerParameter.sourceResult
string
The raw result or response from the source.
SystemsManagerParameter.type
string
The type of parameter
SystemsManagerParameter.value
string
The parameter value
SystemsManagerParameter.version
string
The parameter version
Example
JavaScript
import exec from'k6/execution';import{ AWSConfig, SystemsManagerClient }from'https://jslib.k6.io/aws/0.11.0/ssm.js';const awsConfig =newAWSConfig({region: __ENV.AWS_REGION,accessKeyId: __ENV.AWS_ACCESS_KEY_ID,secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,sessionToken: __ENV.AWS_SESSION_TOKEN,});const systemsManager =newSystemsManagerClient(awsConfig);const testParameterName ='jslib-test-parameter';const testParameterValue ='jslib-test-value';const testParameterSecretName ='jslib-test-parameter-secret';// this value was created with --type SecureStringconst testParameterSecretValue ='jslib-test-secret-value';exportdefaultasyncfunction(){// Currently the parameter needs to be created before hand// Let's get its value// getParameter returns a parameter object: e.g. {name: string, value: string...}const parameter =await systemsManager.getParameter(testParameterName);if(parameter.value !== testParameterValue){
exec.test.abort('test parameter not found');}// Let's get the secret value with decryption// destructure the parameter object to get to the values you wantconst{value: encryptedParameterValue }=await systemsManager.getParameter(
testParameterSecretName,true);if(encryptedParameterValue !== testParameterSecretValue){
exec.test.abort('encrypted test parameter not found');}}
A k6 script querying a user Systems Manager Service parameter