Skip to content

Commit c72bac7

Browse files
committed
docs: Add AWS credentials configuration prerequisites
- Document requirement for AWS credentials configuration using default provider chain - Add examples for different credential configuration methods (aws configure, env vars, IAM roles) - Update both README.md and connection reference documentation - Clarify that RDS Signer uses default credential provider chain as per AWS documentation
1 parent 72325c9 commit c72bac7

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/docs/connection-reference.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ node dist/src/index.js --mysql --host localhost --database sample_db --port 3306
9494

9595
### AWS IAM Authentication Example
9696

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+
97103
```bash
98104
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
99105
```

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,14 @@ Optional parameters:
117117

118118
For Amazon RDS MySQL instances with IAM database authentication:
119119

120+
**Prerequisites:**
121+
- AWS credentials must be configured (the RDS Signer uses the default credential provider chain)
122+
- Configure using one of these methods:
123+
- `aws configure` (uses default profile)
124+
- `AWS_PROFILE=myprofile` environment variable
125+
- `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
126+
- IAM roles (if running on EC2)
127+
120128
```
121129
node dist/src/index.js --mysql --aws-iam-auth --host <rds-endpoint> --database <database-name> --user <aws-username> --aws-region <region>
122130
```

0 commit comments

Comments
 (0)