# es-aws-iam-http-connector

> Plugin for Elasticsearch client to sign requests with AWS IAMv4 so that the client can talk to AWS ES domains secured via IAM policies

Latest version **1.0.0** (published 2015-12-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install es-aws-iam-http-connector
pnpm add es-aws-iam-http-connector
yarn add es-aws-iam-http-connector
bun add es-aws-iam-http-connector
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-12-27 |
| First published | 2015-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Peter Mounce |
| Maintainers | petemounce |
| Keywords | Elasticsearch, AWS, IAM, IAMv4, Lambda |

## Links

- npm: https://www.npmjs.com/package/es-aws-iam-http-connector
- Repository: https://github.com/petemounce/es-aws-iam-http-connector
- Homepage: https://github.com/petemounce/es-aws-iam-http-connector#readme
- Issues: https://github.com/petemounce/es-aws-iam-http-connector/issues
- npm.io page: https://npm.io/package/es-aws-iam-http-connector

## Dependencies (3)

- [merge](https://npm.io/package/merge.md) ^1.2.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.2.22
- [elasticsearch](https://npm.io/package/elasticsearch.md) ^10.0.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-12-27
- 0.0.4 — 2015-12-27
- 0.0.3 — 2015-12-15
- 0.0.2 — 2015-12-15
- 0.0.1 — 2015-12-15
- 0.0.0 — 2015-12-15

## README

# es-aws-iam-http-connector

This http connector [extends](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/extending_core_components.html) [Elasticsearch-js client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html) to allow you to use it against your [AWS ES domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/what-is-amazon-elasticsearch-service.html) that are [secured via AWS IAM-based access policies](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies).

This allows you to lock down your AWS ES domain - no need for IP-based access policies, and very granular security.

## Example

See [example/ping.js](example/ping.js).

## Credentials

### Local file

Stored in your profile's `~/.aws/credentials` file:
```js
aws: {
  credentials: new AWS.SharedIniFileCredentials({profile:'default'})
}
```

### From environment

For example, IAM instance profiles or AWS Lambda:
```js
aws: {
  credentials: new AWS.EnvironmentCredentials('AWS')
}
```

---
_Source: https://npm.io/package/es-aws-iam-http-connector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
