use env variable for all examples

Author: Victor Tsang

javascript/cluster_management/README.md

@@ -24,6 +24,40 @@ working example for each operation.
 - [Node 18.0.0](https://nodejs.org) or later.
 - 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).
 
+### Configure the environment
+
+Set environment variables with your cluster details as required.
+
+#### Single-region clusters
+
+```bash
+# Only relevant for delete/get/update examples.
+# e.g. "foo0bar1baz2quux3quuux4"
+export CLUSTER_ID="<your id>"
+
+# Relevant for all examples.
+# e.g. "us-east-1"
+export CLUSTER_REGION="<your region>"
+```
+
+#### Multi-region clusters
+
+```bash
+# Only relevant for delete/get/update examples.
+# e.g. "foo0bar1baz2quux3quuux4" and "foo5bar6baz7quux8quuux9"
+export CLUSTER_1_ID="<your id 1>"
+export CLUSTER_2_ID="<your id 2>"
+
+# Relevant for all examples.
+# e.g. "us-east-1" and "us-east-2"
+export CLUSTER_1_REGION="<your region 1>"
+export CLUSTER_2_REGION="<your region 2>"
+
+# Only relevant for create examples.
+# e.g. "us-west-2"
+export WITNESS_REGION="<your region 3>"
+```
+
 ### Execute tests to create and delete clusters
 
 ```
@@ -32,6 +66,16 @@ npm install
 npm test
 ```
 
+### Executing single operations
+
+Files in the [/src](src) directory have a main() method that lets you exercise single operations.
+
+```
+# Check each operation for its expected environment variables
+REGION_1="us-east-1" CLUSTER_ID="<your cluster id>" \
+node ./src/get_cluster.js
+```
+
 ---
 
 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

javascript/cluster_management/src/create_multi_region_clusters.js

@@ -88,9 +88,9 @@ export async function createMultiRegionCluster(region1, region2, witnessRegion)
 }
 
 async function main() {
-    const region1 = "us-east-1";
-    const region2 = "us-east-2";
-    const witnessRegion = "us-west-2";
+    const region1 = process.env.CLUSTER_1_REGION || "us-east-1";
+    const region2 = process.env.CLUSTER_2_REGION || "us-east-2";
+    const witnessRegion = process.env.WITNESS_REGION || "us-west-2";
 
     await createMultiRegionCluster(region1, region2, witnessRegion);
 }

javascript/cluster_management/src/create_single_region_cluster.js

@@ -33,7 +33,7 @@ export async function createCluster(region) {
 }
 
 async function main() {
-    const region = "us-east-1";
+    const region = process.env.CLUSTER_REGION || "us-east-1";
     const cluster = await createCluster(region);
     console.log(`Created ${cluster}`);
 }

javascript/cluster_management/src/delete_multi_region_clusters.js

@@ -1,18 +1,18 @@
 import { DSQLClient, DeleteClusterCommand, waitUntilClusterNotExists } from "@aws-sdk/client-dsql";
 
-export async function deleteMultiRegionClusters(region1, cluster1_id, region2, cluster2_id) {
+export async function deleteMultiRegionClusters(region1, cluster1Id, region2, cluster2Id) {
 
     const client1 = new DSQLClient({ region: region1 });
     const client2 = new DSQLClient({ region: region2 });
 
     try {
         const deleteClusterCommand1 = new DeleteClusterCommand({
-            identifier: cluster1_id,
+            identifier: cluster1Id,
         });
         const response1 = await client1.send(deleteClusterCommand1);
 
         const deleteClusterCommand2 = new DeleteClusterCommand({
-            identifier: cluster2_id,
+            identifier: cluster2Id,
         });
         const response2 = await client2.send(deleteClusterCommand2);
 
@@ -51,13 +51,18 @@ export async function deleteMultiRegionClusters(region1, cluster1_id, region2, c
 }
 
 async function main() {
-    const region1 = "us-east-1";
-    const cluster1_id = "<CLUSTER_ID_1>";
-    const region2 = "us-east-2";
-    const cluster2_id = "<CLUSTER_ID_2>";
+    const region1 = process.env.CLUSTER_1_REGION || "us-east-1";
+    const cluster1Id = process.env.CLUSTER_1_ID;
+    const region2 = process.env.CLUSTER_2_REGION || "us-east-2";
+    const cluster2Id = process.env.CLUSTER_2_ID;
 
-    const response = await deleteMultiRegionClusters(region1, cluster1_id, region2, cluster2_id);
-    console.log(`Deleted ${cluster1_id} in ${region1} and ${cluster2_id} in ${region2}`);
+    if (!cluster1_id || !cluster2_id) {
+        console.error("Error: CLUSTER_1_ID and CLUSTER_2_ID environment variables must be set");
+        process.exit(1);
+    }
+
+    await deleteMultiRegionClusters(region1, cluster1Id, region2, cluster2Id);
+    console.log(`Deleted ${cluster1Id} in ${region1} and ${cluster2Id} in ${region2}`);
 }
 
 if (process.env.NODE_ENV !== 'test') {

javascript/cluster_management/src/delete_single_region_cluster.js

@@ -34,8 +34,13 @@ export async function deleteCluster(region, clusterId) {
 }
 
 async function main() {
-  const region = "us-east-1";
-  const clusterId = "<CLUSTER_ID>";
+  const region = process.env.CLUSTER_REGION || "us-east-1";
+  const clusterId = process.env.CLUSTER_ID;
+
+  if (!clusterId) {
+    console.error("Error: CLUSTER_ID environment variables must be set");
+    process.exit(1);
+  }
 
   await deleteCluster(region, clusterId);
 }

javascript/cluster_management/src/get_cluster.js

@@ -19,8 +19,13 @@ export async function getCluster(region, clusterId) {
 }
 
 async function main() {
-  const region = "us-east-1";
-  const clusterId = "<CLUSTER_ID>";
+  const region = process.env.CLUSTER_REGION || "us-east-1";
+  const clusterId = process.env.CLUSTER_ID;
+
+  if (!clusterId) {
+    console.error("Error: CLUSTER_ID environment variables must be set");
+    process.exit(1);
+  }
 
   const response = await getCluster(region, clusterId);
   console.log("Cluster: ", response);

javascript/cluster_management/src/update_cluster.js

@@ -18,8 +18,13 @@ export async function updateCluster(region, clusterId, deletionProtectionEnabled
 }
 
 async function main() {
-  const region = "us-east-1";
-  const clusterId = "<CLUSTER_ID>";
+  const region = process.env.CLUSTER_REGION || "us-east-1";
+  const clusterId = process.env.CLUSTER_ID;
+
+  if (!clusterId) {
+    console.error("Error: CLUSTER_ID environment variables must be set");
+    process.exit(1);
+  }
 
   const response = await updateCluster(region, clusterId, false);
   console.log(`Updated ${response.arn}`);

javascript/cluster_management/test/index.test.js

@@ -29,9 +29,9 @@ test('Single region cluster test', async function () {
 
 test('Multi region clusters test', async function () {
 
-    const region1 = 'us-east-1';
-    const region2 = 'us-east-2';
-    const witnessRegion = 'us-west-2';
+    const region1 = process.env.CLUSTER_1_REGION || "us-east-1";
+    const region2 = process.env.CLUSTER_2_REGION || "us-east-2";
+    const witnessRegion = process.env.WITNESS_REGION || "us-west-2";
 
     console.log("Starting multi region clusters lifecycle run");
     const { cluster1Id, cluster2Id } = await createMultiRegionCluster(region1, region2, witnessRegion);