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
This commit is contained in:
Fabrizio Ferrigno
2025-07-17 15:35:44 +02:00
parent 72325c95a3
commit c72bac7a87
2 changed files with 14 additions and 0 deletions

View File

@@ -117,6 +117,14 @@ Optional parameters:
For Amazon RDS MySQL instances with IAM database authentication:
**Prerequisites:**
- AWS credentials must be configured (the RDS Signer uses the default credential provider chain)
- Configure using one of these methods:
- `aws configure` (uses default profile)
- `AWS_PROFILE=myprofile` environment variable
- `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
- IAM roles (if running on EC2)
```
node dist/src/index.js --mysql --aws-iam-auth --host <rds-endpoint> --database <database-name> --user <aws-username> --aws-region <region>
```