# rds-iam-pg

> Convenience functions for connecting to RDS Postgres using IAM auth

Latest version **2.1.0** (published 2024-08-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install rds-iam-pg
pnpm add rds-iam-pg
yarn add rds-iam-pg
bun add rds-iam-pg
```

## 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 | 2.1.0 |
| Published | 2024-08-21 |
| First published | 2023-07-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 191.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Metabolize LLC |
| Maintainers | paulmelnikow, jbeard |

## Links

- npm: https://www.npmjs.com/package/rds-iam-pg
- Repository: https://github.com/curvewise/rds-iam-pg
- Homepage: https://github.com/curvewise/rds-iam-pg#readme
- Issues: https://github.com/curvewise/rds-iam-pg/issues
- npm.io page: https://npm.io/package/rds-iam-pg

## Recent versions

- 2.1.0 (latest) — 2024-08-21
- 2.0.0 — 2023-07-13

## README

# rds-iam-pg

Convenience functions for connecting to RDS Postgres using IAM auth.

The `createRdsPgPool()` function uses AWS credentials present in the environment
or filesystem to create a signed token to authenticate with RDS Postgres using
IAM authentication.

It works in Lambda and any other Node environment.

## Usage

```ts
import { createRdsPgPool } from 'rds-iam-pg'

const pgPool = createRdsPgPool({
  awsRegion: 'us-east-1',
  awsProfile: process.env.AWS_PROFILE,
  address: {
    host: 'your.rds.hostname.aws'
    port: 5432,
    user: 'yourusername',
    database: 'yourdb',
  },
})
```

## License

This project is licensed under the Apache license, version 2.0.

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