https://github.com/kaskadi/aws-es-client

a client to connect to ElasticSearch service on AWS
https://github.com/kaskadi/aws-es-client

aws-elasticsearch node-module npm-package

Last synced: about 2 months ago
JSON representation

a client to connect to ElasticSearch service on AWS

• Host: GitHub
• URL: https://github.com/kaskadi/aws-es-client
• Owner: kaskadi
• License: mit
• Created: 2020-01-07T08:46:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T14:10:33.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T22:04:54.473Z (3 months ago)
• Topics: aws-elasticsearch, node-module, npm-package
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/aws-es-client
• Size: 379 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](https://img.shields.io/github/package-json/v/kaskadi/aws-es-client)

![](https://img.shields.io/badge/code--style-standard-blue)

![](https://img.shields.io/github/license/kaskadi/aws-es-client?color=blue)

**GitHub Actions workflows status**

[![Build workflow status](https://img.shields.io/github/workflow/status/kaskadi/aws-es-client/build?label=build&logo=mocha)](https://github.com/kaskadi/aws-es-client/actions?query=workflow%3Abuild)

[![Publish workflow status](https://img.shields.io/github/workflow/status/kaskadi/aws-es-client/publish?label=publish&logo=npm)](https://github.com/kaskadi/aws-es-client/actions?query=workflow%3Apublish)

**CodeClimate**

[![](https://img.shields.io/codeclimate/maintainability/kaskadi/aws-es-client?label=maintainability&logo=Code%20Climate)](https://codeclimate.com/github/kaskadi/aws-es-client)

[![](https://img.shields.io/codeclimate/tech-debt/kaskadi/aws-es-client?label=technical%20debt&logo=Code%20Climate)](https://codeclimate.com/github/kaskadi/aws-es-client)

[![](https://img.shields.io/codeclimate/coverage/kaskadi/aws-es-client?label=test%20coverage&logo=Code%20Climate)](https://codeclimate.com/github/kaskadi/aws-es-client)

****

# 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**  

```js

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]:#aws-es-client

[Options]:#options

[here]:https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html

[`Options`]:#options