support AWS SDK v3

.eslintrc → .eslintrc.yaml

@@ -8,4 +8,4 @@ env:
   es6: true
 
 parserOptions:
-  ecmaVersion: 8
+  ecmaVersion: 2021

CHANGELOG.md

@@ -1 +0,0 @@
-

README.md

@@ -6,6 +6,12 @@ A tiny [Amazon Signature Version 4](https://www.npmjs.com/package/aws4) connecti
 
 Supports AWS SDK global or specific configuration instances (AWS.Config), including asyncronous credentials from IAM roles and credential refreshing.
 
+## Installation
+
+```bash
+npm install --save aws-opensearch-connector
+```
+
 ## Example usage
 
 ### Using global configuration
@@ -17,8 +23,8 @@ const createAwsOpensearchConnector = require('aws-opensearch-connector')
 
 // (Optional) load profile credentials from file
 AWS.config.update({
-  profile: 'my-profile'
-})
+  profile: "my-profile",
+});
 
 const client = new Client({
   ...createAwsOpensearchConnector(AWS.config),
@@ -42,7 +48,47 @@ const client = new Client({
   ...createAwsOpensearchConnector(awsConfig),
   node: 'https://my-opensearch-cluster.us-east-1.es.amazonaws.com'
 })
-````
+
+```
+
+### Using aws-sdk v3
+
+```javascript
+const { STSClient, AssumeRoleCommand } = require("@aws-sdk/client-sts");
+const { Client } = require('@opensearch-project/opensearch')
+const createAwsOpensearchConnector = require("./src/index.js");
+
+async function ping() {
+  const creds = await assumeRole(
+    "arn:aws:iam::0123456789012:role/Administrator",
+    "us-east-1"
+  );
+  const client = new Client({
+    ...createAwsOpensearchConnector({
+      region: "us-east-1",
+      credentials: creds,
+    }),
+    node: "https://my-opensearch-cluster.us-east-1.es.amazonaws.com",
+  });
+  const response = await client.ping();
+  console.log(`Got Response`, response);
+}
+
+async function assumeRole(roleArn, region) {
+  const client = new STSClient({ region });
+  const response = await client.send(
+    new AssumeRoleCommand({
+      RoleArn: roleArn,
+      RoleSessionName: "aws-es-connection",
+    })
+  );
+  return {
+    accessKeyId: response.Credentials.AccessKeyId,
+    secretAccessKey: response.Credentials.SecretAccessKey,
+    sessionToken: response.Credentials.SessionToken,
+  };
+}
+```
 
 ## Test
 

index.d.ts

@@ -0,0 +1,11 @@
+import { Connection, Transport } from '@opensearch-project/opensearch';
+import AWS from 'aws-sdk';
+
+export type Connector = {
+  Connection: typeof Connection;
+  Transport: typeof Transport;
+};
+
+export const ConnectorFactory: (awsConfig: AWS.Config) => Connector;
+
+export default ConnectorFactory;