aws-elasticsearch-client

aws-elasticsearch-client

Tiny wrapper for elasticsearch and http-aws-es libraries with reasonable defaults that makes work with AWS Elasticsearch Service easier.

Installation

$ npm install aws-elasticsearch-client

Usage

aws-elasticsearch-client takes options object and returns elasticsearch client configured to communicate with AWS Elasticsearch Service.

const aeclient = require('aws-elasticsearch-client');

const options = {
	host: 'your-aws-es-host.amazon.com'
};
const client = aeclient(options);

Library also provides create alias:

const aeclient = require('aws-elasticsearch-client');

const options = {
	host: 'your-aws-es-host.amazon.com'
};
const client = aeclient.create(options);

options

options object supports all the configuration options provided by elasticsearch library. On top of that, aws-elasticsearch-client provides following configuration capabilities:

• [envPrefix] - { String } the prefix for the environment variable names used to retrieve access credentials [defaults to AWS]
• [region] - { String } AWS region [defaults to ${options.envPrefix}_REGION environment variable or us-east-1]
• [credentials] - { AWS.Credentials } an instance of AWS.Credentials class or its descendants [defaults to environment credentials loaded using options.envPrefix]

License

The MIT License (MIT)

Copyright (c) 2016 Anton Bazhal

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.