Skip to content

docs: permissions for non-admin users accessing MultiAZ clusters #1602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sergiyvamz merged 2 commits into from
Nov 20, 2025
Merged

docs: permissions for non-admin users accessing MultiAZ clusters #1602

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a497675
docs: permissions for non-admin users accessing MultiAZ clusters
sergiyvamz Nov 19, 2025
e9f8f61
Update docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md
sergiyvamz Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/using-the-jdbc-driver/SupportForRDSMultiAzDBCluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ The process of using the AWS JDBC Driver with RDS Multi-AZ DB Cluster is the sam

### MySQL

There are permissions that must be granted to all non-administrative users who need database access. Without proper access, these users cannot utilize many of the driver's advanced features, including failover support. To grant the necessary permissions to non-administrative users, execute the following statement:
Copy link
Contributor

@aaron-congo aaron-congo Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do any other deployment types require extra statements for non-admin users (aurora, mysql instance etc)?

Copy link
Contributor Author

@sergiyvamz sergiyvamz Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other types of DB might also require extra permissions. However, the major concern is MultiAz clusters. The wrapper needs access to cluster topology so permissions for non-admin users are essential. RDS Instance doesn't provide topology so the wrapper doesn't need any extra permissions (as for now). Aurora doesn't require extra permissions either.


```sql
GRANT SELECT ON mysql.rds_topology TO 'non-admin-username'@'%'
```

Preparing a connection with MySQL in a Multi-AZ Cluster remains the same as before:

```java
Expand All @@ -24,6 +30,12 @@ Per AWS documentation and [this blog post](https://aws.amazon.com/blogs/database
CREATE EXTENSION rds_tools;
```

The extension must be granted to all non-administrative users who need database access. Without access to `rds_tools`, non-admin users cannot utilize many of the driver's advanced features, including failover support. To grant the necessary permissions to non-administrative users, execute the following statement:

```sql
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA rds_tools TO non-admin-username;
```

Then, prepare the connection with:

```java
Expand Down