Giter VIP home page Giter VIP logo

aws-es-client's Introduction

GitHub Actions workflows status

Build workflow status Publish workflow status

CodeClimate


Installation

npm i aws-es-client

API documentation

Modules

Module Description
aws-es-client Creates a new client connected to your AWS ElasticSearch cluster.

Typedefs

Name Description
Options ElasticSearch client options

aws-es-client

Creates a new client connected to your AWS ElasticSearch cluster.

Once the client has been instanciated, you can use all the methods available in the regular ElasticSearch Node client. See here for details.

Returns: ES - New ElasticSearch client

Param Type Description
opts Options Options to be passed to instanciate a new client

Example

const ES = require('aws-es-client')({
 url: process.env.ES_CLUSTER_URL,
 id: process.env.ES_ID,
 token: process.env.ES_SECRET
})

Options

ElasticSearch client options

Kind: global typedef
Properties

Name Type Default Description
url string ElasticSearch cluster URL
id string Programmatic user ID (needs access to ElasticSearch cluster)
token string Programmatic user token (needs access to ElasticSearch cluster)
[region] string 'eu-central-1' ElasticSearch cluster region

aws-es-client's People

Contributors

alexlemaire avatar dependabot[bot] avatar holger-will avatar kaskadi-bot avatar

Watchers

 avatar  avatar

Forkers

robertsrk

aws-es-client's Issues

New client

Develop new client based on the new ElasticSearch client

Refer to:

  • this issue refering to http-aws-es
  • this wrapper to make secured connection to ElasticSearch on AWS. Kinda similar to http-aws-es so the current logic shouldn't need too much refactoring
  • new client

The biggest change for us is that the new client doesn't return anymore only the body of the response when using promises, but it now returns the same object for both callback and promise approach:

{
  body: object | boolean
  statusCode: number
  headers: object
  warnings: [string]
  meta: object
}

Access for publishing

@Holger-Will for the auto publish the current action is not working because I am not collaborator for this package on npm (so my token doesn't have publish rights for it)

You can either:

  • add me as collaborator
  • generate a token on your side and replace the secret NPM_TOKEN on this repo and that should do the trick

When you did it just ping me so I can give it a shot again and see if it works! ๐Ÿ‘

missing peer dependency

[email protected] requires a peer of elasticsearch@^15.0.0 but none is installed. You must install peer dependencies yourself.

we probably have to npm i -D elasticsearch to make it go away

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.