Giter VIP home page Giter VIP logo

node-aws-es-utils's Introduction

AWS Elasticsearch Utils

Greenkeeper badge

NPM

Build Status Coverage Status Known Vulnerabilities

Sign request

If you limit your Amazon Elasticsearch Service with an IAM role, you will need to sign every http request made to the service. The function createESConnectorClass creates a new class that can be used as a drop-in replacement for Elasticsearch default class. For example:

var elasticsearch = require('elasticsearch');
var esHttpConnector = require('elasticsearch/src/lib/connectors/http');
var AWS = require('aws-sdk');
var awsEs = require('aws-es-utils');
var let client = new elasticsearch.Client({
  host: 'https://xxxx.ap-southeast-2.es.amazonaws.com',
  connectionClass: awsEs.createESConnectorClass({
    AWS: AWS,
    superClass: esHttpConnector
  }),
  awsRequestSigning: true
});

Extra config to Elasticsearch client constructor

  • awsRequestSigning (boolean): enable AWS request signing
  • awsRegion (string | optional): AWS region. If this property is missing, the class will try to parse the region from the host name.
  • awsCredential (object | optional): optional AWS credentials. If this property is missing, the class will try to use AWS.CredentialProviderChain to retrieve the default credential. This property could be either an AWS.Credentials object or a normal object with the following properties:
    • accessKeyId (string): the AWS access key ID
    • secretAccessKey (string): the AWS secret access key
    • sessionToken (string): the optional AWS session token (the string you received from AWS STS when you obtained temporary security credentials))

License

This project is licensed under the terms of the Apache license.

node-aws-es-utils's People

Contributors

vickvu avatar greenkeeper[bot] avatar

Watchers

Tom avatar James Cloos avatar josh shepard avatar David Zafrani avatar Jono Wells avatar Andrew Loesch avatar Ben Yuan avatar Evan Uyehara avatar Charlotte Koch avatar kushel avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.