Menu
Open source

getSecret

SecretsManagerClient.getSecret downloads a secret from AWS secrets manager.

ParameterTypeDescription
secretIDstringThe ARN or name of the secret to retrieve.

Returns

TypeDescription
Promise<Secret>A Promise that fulfills with a Secret describing and holding the downloaded secret.

Example

JavaScript
import exec from 'k6/execution';

import {
  AWSConfig,
  SecretsManagerClient,
} from 'https://jslib.k6.io/aws/0.12.3/secrets-manager.js';

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

const secretsManager = new SecretsManagerClient(awsConfig);
const testSecretName = 'jslib-test-secret';

export default async function () {
  // List the secrets the AWS authentication configuration
  // gives us access to.
  const secrets = await secretsManager.listSecrets();
  if (secrets.filter((s) => s.name === testSecretName).length == 0) {
    exec.test.abort('test secret not found');
  }

  // Let's get our test secret's value and print it.
  const secret = await secretsManager.getSecret(testSecretName);
  console.log(JSON.stringify(secret));
}

A k6 script that will download a user’s secret from AWS secrets manager