Skip to content

Commit 17f955b

Browse files
author
Victor Tsang
committed
update README.md
1 parent c8819ba commit 17f955b

1 file changed

Lines changed: 21 additions & 12 deletions

File tree

javascript/cluster_management/README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,38 @@
22

33
## Overview
44

5-
The code examples in this topic show you how to use the JavaScript work with Aurora DSQL.
5+
The code examples in this topic show you how to use the AWS JavaScript SDK v3 with DSQL
6+
to create, update, get, and delete single- and multi-Region clusters.
7+
8+
Each file in the [/src](src) directory demonstrates a minimal
9+
working example for each operation.
610

711
## Run the examples
812

13+
### ⚠️ Important
14+
15+
- Running this code might result in charges to your AWS account.
16+
- We recommend that you grant your code least privilege. At most, grant only the
17+
minimum permissions required to perform the task. For more information, see
18+
[Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
19+
- This code is not tested in every AWS Region. For more information, see
20+
[AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
21+
922
### Prerequisites
1023

11-
* Node version >= 18.0.0 is needed
24+
- [Node 18.0.0](https://nodejs.org) or later.
25+
- Valid AWS credentials can be discovered by the [default provider chain](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials-chain.html).
1226

13-
### Install the required dependencies
27+
### Execute tests to create and delete clusters
1428

15-
```sh
16-
npm install
1729
```
30+
npm install
1831
19-
### Run the example tests
20-
21-
```sh
22-
# Use the account credentials dedicated for JS
23-
npm run test
32+
npm test
2433
```
2534

2635
---
2736

28-
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
37+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2938

30-
SPDX-License-Identifier: MIT-0
39+
SPDX-License-Identifier: MIT-0

0 commit comments

Comments
 (0)