docs

jslib

aws
httpx
k6chaijs
utils
k6.ioapp.k6.io

No results for “”

Powered byAlgolia

KMSClient

jslibsuggest edits

KMSClient interacts with the AWS Key Management Service. With it, the user can list all the Key Management Service keys in the caller's AWS account and region. They can also generate symmetric data keys to use outside of AWS Key Management Service. KMSClient operations are blocking. k6 recommends reserving their use to the setup and teardown stages as much as possible.

Both the dedicated kms.js jslib bundle and the all-encompassing aws.js bundle include the KMSClient.

Methods

FunctionDescription
listKeysList the all the Key Management Service keys in the caller's AWS account and region.
generateDataKeyGenerate a symmetric data key for use outside of the AWS Key Management Service.

Throws

KMSClient methods throw errors in case of failure.

ErrorCondition
InvalidSignatureErrorwhen using invalid credentials
KMSServiceErrorwhen AWS replied to the requested operation with an error

Example

import { textSummary } from 'https://jslib.k6.io/k6-summary/0.0.2/index.js';


import { AWSConfig, KMSClient } from 'https://jslib.k6.io/aws/0.7.1/kms.js';


const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});


const kms = new KMSClient(awsConfig);
const keyAlias = 'alias/k6-key';


export function setup() {
  // Create a symmetric data key
  return {
    dataKey: kms.generateDataKey(keyAlias, 32),
  };
}


export default function (data) {
  // Use the data key to encrypt data
}


export function handleSummary(data) {
  return {
    'stdout': textSummary(data, { indent: ' ', enableColors: true }),
    './test-run.key': data.dataKey,
  };
}