Skip to content

Commit bdeaf99

Browse files
committed
Update jslib-aws SystemsManagerClient's to demonstrate async syntax
1 parent 0e346b5 commit bdeaf99

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

src/data/markdown/docs/20 jslib/01 jslib/01 aws/00 SystemsManagerClient.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ excerpt: 'SystemsManagerClient allows interacting with the AWS Systems Manager S
88
<BlockingAwsBlockquote />
99

1010
`SystemsManagerClient` interacts with the AWS Systems Manager Service.
11-
With it, the user can get parameters from the Systems Manager Service in the caller's AWS account and region. `SystemsManagerClient` operations are blocking. k6 recommends reserving their use to the [`setup`](/using-k6/test-lifecycle/) and [`teardown`](/using-k6/test-lifecycle/) stages as much as possible.
11+
12+
With it, the user can get parameters from the Systems Manager Service in the caller's AWS account and region.
1213

1314
Both the dedicated `ssm.js` jslib bundle and the all-encompassing `aws.js` bundle include the `SystemsManagerClient`.
1415

@@ -50,19 +51,19 @@ const testParameterSecretName = 'jslib-test-parameter-secret';
5051
// this value was created with --type SecureString
5152
const testParameterSecretValue = 'jslib-test-secret-value';
5253

53-
export default function () {
54+
export default async function () {
5455
// Currently the parameter needs to be created before hand
5556

5657
// Let's get its value
5758
// getParameter returns a parameter object: e.g. {name: string, value: string...}
58-
const parameter = systemsManager.getParameter(testParameterName);
59+
const parameter = await systemsManager.getParameter(testParameterName);
5960
if (parameter.value !== testParameterValue) {
6061
exec.test.abort('test parameter not found');
6162
}
6263

6364
// Let's get the secret value with decryption
6465
// destructure the parameter object to get to the values you want
65-
const { value: encryptedParameterValue } = systemsManager.getParameter(
66+
const { value: encryptedParameterValue } = await systemsManager.getParameter(
6667
testParameterSecretName,
6768
true
6869
);

src/data/markdown/docs/20 jslib/01 jslib/01 aws/SystemsManagerClient/00 getParameter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ excerpt: "SystemsManagerClient.getParameter gets a Systems Manager parameter in
1010

1111
| Type | Description |
1212
| :---------------------------------------------------------- | :------------------------------------------------------------------------ |
13-
| [`SystemsManagerParameter[]`](/javascript-api/jslib/aws/systemsmanagerclient/systemsmanagerparameter/) | An array of [`SystemsManagerParameter`](/javascript-api/jslib/aws/systemsmanagerclient/systemsmanagerparameter/) objects. |
13+
| [`Promise<SystemsManagerParameter[]>`](/javascript-api/jslib/aws/systemsmanagerclient/systemsmanagerparameter/) | A Promise that fulfills with an array of [`SystemsManagerParameter`](/javascript-api/jslib/aws/systemsmanagerclient/systemsmanagerparameter/) objects. |
1414

1515
### Example
1616

@@ -35,19 +35,19 @@ const testParameterSecretName = 'jslib-test-parameter-secret';
3535
// this value was created with --type SecureString
3636
const testParameterSecretValue = 'jslib-test-secret-value';
3737

38-
export default function () {
38+
export default async function () {
3939
// Currently the parameter needs to be created before hand
4040

4141
// Let's get its value
4242
// getParameter returns a parameter object: e.g. {name: string, value: string...}
43-
const parameter = systemsManager.getParameter(testParameterName);
43+
const parameter = await systemsManager.getParameter(testParameterName);
4444
if (parameter.value !== testParameterValue) {
4545
exec.test.abort('test parameter not found');
4646
}
4747

4848
// Let's get the secret value with decryption
4949
// destructure the parameter object to get to the values you want
50-
const { value: encryptedParameterValue } = systemsManager.getParameter(
50+
const { value: encryptedParameterValue } = await systemsManager.getParameter(
5151
testParameterSecretName,
5252
true
5353
);

src/data/markdown/docs/20 jslib/01 jslib/01 aws/SystemsManagerClient/90 SystemsManagerParameter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,19 @@ const testParameterSecretName = 'jslib-test-parameter-secret';
4141
// this value was created with --type SecureString
4242
const testParameterSecretValue = 'jslib-test-secret-value';
4343

44-
export default function () {
44+
export default async function () {
4545
// Currently the parameter needs to be created before hand
4646

4747
// Let's get its value
4848
// getParameter returns a parameter object: e.g. {name: string, value: string...}
49-
const parameter = systemsManager.getParameter(testParameterName);
49+
const parameter = await systemsManager.getParameter(testParameterName);
5050
if (parameter.value !== testParameterValue) {
5151
exec.test.abort('test parameter not found');
5252
}
5353

5454
// Let's get the secret value with decryption
5555
// destructure the parameter object to get to the values you want
56-
const { value: encryptedParameterValue } = systemsManager.getParameter(
56+
const { value: encryptedParameterValue } = await systemsManager.getParameter(
5757
testParameterSecretName,
5858
true
5959
);

0 commit comments

Comments
 (0)