Package Exports

aws-opensearch-connector

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (aws-opensearch-connector) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

aws-opensearch-connector

A tiny Amazon Signature Version 4 connection class for the official Opensearch Node.js client, for compatibility with AWS OpenSearch and IAM authentication.

Supports AWS SDK global or specific configuration instances (AWS.Config), including asyncronous credentials from IAM roles and credential refreshing.

Example usage

Using global configuration

const { Client } = require('@opensearch-project/opensearch')
const AWS = require('aws-sdk')
const createAwsOpensearchConnector = require('aws-opensearch-connector')

// (Optional) load profile credentials from file
AWS.config.update({
  profile: 'my-profile'
})

const client = new Client({
  ...createAwsOpensearchConnector(AWS.config),
  node: 'https://my-opensearch-cluster.us-east-1.es.amazonaws.com'
})

Using specific configuration

const { Client } = require('@opensearch-project/opensearch')
const AWS = require('aws-sdk')
const createAwsOpensearchConnector = require('aws-opensearch-connector')

const awsConfig = new AWS.Config({
  // Your credentials and settings here, see
  // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Config.html#constructor-property
})

const client = new Client({
  ...createAwsOpensearchConnector(awsConfig),
  node: 'https://my-opensearch-cluster.us-east-1.es.amazonaws.com'
})

Test

npm test

# Run integration tests against a real endpoint
AWS_PROFILE=your-profile npm run test:integration -- \
  --endpoint https://my-opensearch-cluster.us-east-1.es.amazonaws.com