Skip to content

Commit e8a86f0

Browse files
authored
readme updates for documentation completeness (#84)
1 parent 0d79c3b commit e8a86f0

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

packages/node-postgres/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,24 @@ Amazon Aurora DSQL is a cloud-native distributed database with PostgreSQL compat
1717

1818
The Aurora DSQL Connector for node-postgres bridges this gap by implementing an authentication middleware that works seamlessly with node-postgres. This approach allows developers to maintain their existing node-postgres code while gaining secure IAM-based access to Aurora DSQL clusters through automated token management.
1919

20+
### What is Aurora DSQL Authentication?
21+
22+
In Aurora DSQL, authentication involves:
23+
24+
- **IAM Authentication:** All connections use IAM-based authentication with time-limited tokens
25+
- **Token Generation:** Authentication tokens are generated using AWS credentials and have configurable lifetimes
26+
27+
The Aurora DSQL Connector for node-postgres is designed to understand these requirements and automatically generate IAM authentication tokens when establishing connections.
28+
2029
### Features
2130

2231
- **Automatic IAM Authentication** - Handles DSQL token generation and refresh
2332
- **Built on node-postgres** - Leverages the popular PostgreSQL client for Node.js
33+
- **Seamless Integration** - Works with existing node-postgres connection patterns
2434
- **Region Auto-Discovery** - Extracts AWS region from DSQL cluster hostname
2535
- **Full TypeScript Support** - Provides full type safety
26-
- **Custom Credentials** - Support for custom AWS credential providers
36+
- **AWS Credentials Support** - Supports various AWS credential providers (default, profile-based, custom)
37+
- **Connection Pooling Compatibility** - Works seamlessly with built-in connection pooling
2738

2839
## Example Application
2940

@@ -34,8 +45,9 @@ There is an included sample application in [example](https://github.com/awslabs/
3445
### Requirements
3546

3647
- Node.js 20+
48+
- [Access to an Aurora DSQL cluster](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/getting-started.html)
49+
- Set up appropriate IAM permissions to allow your application to connect to Aurora DSQL.
3750
- AWS credentials configured (via AWS CLI, environment variables, or IAM roles)
38-
- Access to an Aurora DSQL cluster
3951

4052
## Installation
4153

packages/postgres-js/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Aurora DSQL Connector for Postgres.js is designed as an authentication plugi
1212
Postgres.js client to enable applications to authenticate with Amazon Aurora DSQL using IAM credentials. The connector
1313
does not connect directly to the database, but provides seamless IAM authentication on top of the underlying Postgres.js driver.
1414

15-
## Benefits of the Connector
15+
## About the Connector
1616

1717
Amazon Aurora DSQL is a distributed SQL database service that provides high availability and scalability for
1818
PostgreSQL-compatible applications. Aurora DSQL requires IAM-based authentication with time-limited tokens that
@@ -24,21 +24,33 @@ client that handles IAM token generation, allowing users to connect to Aurora DS
2424
The Aurora DSQL Connector for Postgres.js works with most versions of Postgres.js. Users provide their own version by installing
2525
Postgres.js directly.
2626

27+
### What is Aurora DSQL Authentication?
28+
29+
In Aurora DSQL, authentication involves:
30+
31+
- **IAM Authentication:** All connections use IAM-based authentication with time-limited tokens
32+
- **Token Generation:** Authentication tokens are generated using AWS credentials and have configurable lifetimes
33+
34+
The Aurora DSQL Connector for Postgres.js is designed to understand these requirements and automatically generate IAM authentication tokens when establishing connections.
35+
2736
### Features
2837

2938
- **Automatic IAM Authentication** - Handles DSQL token generation and refresh
3039
- **Built on Postgres.js** - Leverages the fast PostgreSQL client for Node.js
40+
- **Seamless Integration** - Works with existing Postgres.js connection patterns
3141
- **Region Auto-Discovery** - Extracts AWS region from DSQL cluster hostname
3242
- **Full TypeScript Support** - Provides full type safety
33-
- **Custom Credentials** - Support for custom AWS credential providers
43+
- **AWS Credentials Support** - Supports various AWS credential providers (default, profile-based, custom)
44+
- **Connection Pooling Compatibility** - Works seamlessly with Postgres.js' built-in connection pooling
3445

3546
## Quick start guide
3647

3748
### Requirements
3849

3950
- Node.js 20+
51+
- [Access to an Aurora DSQL cluster](https://docs.aws.amazon.com/aurora-dsql/latest/userguide/getting-started.html)
52+
- Set up appropriate IAM permissions to allow your application to connect to Aurora DSQL.
4053
- AWS credentials configured (via AWS CLI, environment variables, or IAM roles)
41-
- Access to an Aurora DSQL cluster
4254

4355
### Installation
4456

0 commit comments

Comments
 (0)