Skip to content

Commit adec50d

Browse files
authored
docs: add required permissions for non-admin users to B/G plugin docs (#1559)
1 parent 6f025d9 commit adec50d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/using-the-jdbc-driver/using-plugins/UsingTheBlueGreenPlugin.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The AWS JDBC Driver leverages the Blue/Green Deployment approach by intelligentl
1818
>
1919
> Additional Requirements:
2020
> - AWS cluster and instance endpoints must be directly accessible from the client side
21+
> - :warning: If connecting with non-admin users, permissions must be granted to the users so that the blue/green metadata table/function can be properly queried. If the permissions are not granted, the metadata table/function will not be visible and blue/green plugin functionality will not work properly. Please see the [Connecting with non-admin users](#connecting-with-non-admin-users) section below.
2122
> - Connecting to database nodes using CNAME aliases is not supported
2223
>
2324
> **Blue/Green Support Behaviour and Version Compatibility:**
@@ -90,6 +91,16 @@ properties.setProperty("blue-green-monitoring-socketTimeout", "10000");
9091
> **Always ensure you provide a non-zero socket timeout value or a connect timeout value to the Blue/Green Deployment Plugin**
9192
>
9293
94+
## Connecting with non-admin users
95+
> [!WARNING]\
96+
> If connecting with non-admin users, permissions must be granted to the users so that the blue/green metadata table/function can be properly queried. If the permissions are not granted, the metadata table/function will not be visible and blue/green plugin functionality will not work properly.
97+
98+
| Environment | Required permission statements |
99+
|-------------------|-----------------------------------------------------------------------------------------------------------------------|
100+
| Aurora Postgresql | None |
101+
| RDS Postgresql | `GRANT USAGE ON SCHEMA rds_tools TO your_user;`<br>`GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA rds_tools TO your_user;` |
102+
| Aurora MySQL | `GRANT SELECT ON mysql.rds_topology TO 'your_user'@'%';`<br>`FLUSH PRIVILEGES;` |
103+
| RDS MySQL | `GRANT SELECT ON mysql.rds_topology TO 'your_user'@'%';`<br>`FLUSH PRIVILEGES;` |
93104

94105
## Plan your Blue/Green switchover in advance
95106

0 commit comments

Comments
 (0)