GitHub Actions workflows status
CodeClimate
npm i aws-es-client
Module | Description |
---|---|
aws-es-client | Creates a new client connected to your AWS ElasticSearch cluster. |
Name | Description |
---|---|
Options | ElasticSearch client options |
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
})
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 |