Nighttime Pachinko Marathon

    @jwhance/http-aws-es

    6.1.2 • Public • Published

    Connection handler for Amazon ES

    Makes elasticsearch-js compatible with Amazon ES. It uses the aws-sdk to make signed requests to an Amazon ES endpoint.

    Forked from https://github.com/TheDeveloper/http-aws-es which breaks when used with the latest elasticsearch library v16.7.2. This original repo seems to have\n been abandoned with no PR in a long time.

    Installation

    # Install the connector, elasticsearch client and aws-sdk
    npm install --save @jwhance/http-aws-es aws-sdk elasticsearch

    package.json

    Something like this:
    
      "dependencies": {
        "@jwhance/http-aws-es": "6.1.2",
        "aws-sdk": "2.831.0",
        "elasticsearch": "16.7.2",
    
    

    Usage

    // create an elasticsearch client for your Amazon ES
    let es = require("elasticsearch").Client({
      hosts: ["https://amazon-es-host.us-east-1.es.amazonaws.com"],
      connectionClass: require("@jwhance/http-aws-es"),
    });

    Region + Credentials

    The connector uses aws-sdk's default behaviour to obtain region + credentials from your environment. If you would like to set these manually, you can set them on aws-sdk:

    let AWS = require("aws-sdk");
    AWS.config.update({
      credentials: new AWS.Credentials(accessKeyId, secretAccessKey),
      region: "us-east-1",
    });

    Options

    let options = {
      hosts: [], // array of amazon es hosts (required)
      connectionClass: require("http-aws-es"), // use this connector (required)
      awsConfig: new AWS.Config({ region }), // set an aws config e.g. for multiple clients to different regions
      httpOptions: {}, // set httpOptions on aws-sdk's request. default to aws-sdk's config.httpOptions
    };
    let es = require("elasticsearch").Client(options);

    Test

    npm test
    # test against a real endpoint
    AWS_PROFILE=your-profile npm run integration-test -- --endpoint https://amazon-es-host.us-east-1.es.amazonaws.com --region us-east-1

    Install

    npm i @jwhance/http-aws-es

    DownloadsWeekly Downloads

    36

    Version

    6.1.2

    License

    MIT

    Unpacked Size

    17.4 kB

    Total Files

    16

    Last publish

    Collaborators

    • jwhance