Skip to content

Commit f56a616

Browse files
Merge pull request #12 from fabrizio11/feature/aws-iam-authentication
Feature/aws iam authentication
2 parents 7400c08 + c8f007a commit f56a616

File tree

6 files changed

+1655
-187
lines changed

6 files changed

+1655
-187
lines changed

docs/docs/connection-reference.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,35 @@ node dist/src/index.js --postgresql --host dbserver.example.com --database sampl
7575
| `--mysql` | Specifies MySQL mode | - | Yes |
7676
| `--host` | MySQL hostname or IP | - | Yes |
7777
| `--database` | Database name | - | Yes |
78-
| `--user` | MySQL username | - | No |
79-
| `--password` | MySQL password | - | No |
78+
| `--user` | MySQL username | - | No* |
79+
| `--password` | MySQL password | - | No* |
8080
| `--port` | MySQL port | 3306 | No |
8181
| `--ssl` | Use SSL connection (true/false or object) | false | No |
8282
| `--connection-timeout` | Connection timeout in ms | 30000 | No |
83+
| `--aws-iam-auth` | Enable AWS IAM authentication | false | No |
84+
| `--aws-region` | AWS region for RDS IAM auth | - | No** |
8385

84-
### Example
86+
*Required for standard authentication
87+
**Required when using `--aws-iam-auth`
88+
89+
### Standard Authentication Example
8590

8691
```bash
8792
node dist/src/index.js --mysql --host localhost --database sample_db --port 3306 --user root --password secret
8893
```
8994

95+
### AWS IAM Authentication Example
96+
97+
**Prerequisites:** AWS credentials must be configured using the default credential provider chain:
98+
- `aws configure` (default profile)
99+
- `AWS_PROFILE=myprofile` environment variable
100+
- `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
101+
- IAM roles (if running on EC2)
102+
103+
```bash
104+
node dist/src/index.js --mysql --aws-iam-auth --host rds-endpoint.region.rds.amazonaws.com --database sample_db --user aws-username --aws-region us-east-1
105+
```
106+
90107
## Environment Variables
91108

92109
Instead of specifying sensitive credentials on the command line, you can use environment variables:

0 commit comments

Comments
 (0)