Database URL types compatibility
August 6, 2026 · View on GitHub
This document is part of the Compatibility Guide and explains plugin compatibility with various database endpoints.
There are many different URL types (endpoints) that can be used with The AWS Advanced JDBC Wrapper, but certain URL types are not compatible with certain plugins. This page outlines the various URL types and which plugins are compatible with each type.
- Aurora Global Database Endpoint -
<global-db-name>.global-<XYZ>.global.rds.amazonaws.com - Aurora Cluster Writer Endpoint -
<cluster-name>.cluster-<XYZ>.<region>.rds.amazonaws.com - Aurora Cluster Reader Endpoint -
<cluster-name>.cluster-ro-<XYZ>.<region>.rds.amazonaws.com - Aurora Cluster Custom Endpoint -
<custom-endpoint-name>.cluster-custom-<XYZ>.<region>.rds.amazonaws.com - Aurora Instance Endpoint -
<instance-name>.<XYZ>.<region>.rds.amazonaws.com - RDS Multi-AZ DB Cluster Writer Endpoint -
<cluster-name>.cluster-<XYZ>.<region>.rds.amazonaws.com - RDS Multi-AZ DB Cluster Reader Endpoint -
<cluster-name>.cluster-ro-<XYZ>.<region>.rds.amazonaws.com - RDS Instance Endpoint -
<instance-name>.<XYZ>.<region>.rds.amazonaws.com - RDS Proxy Endpoint -
<proxy-name>.proxy-<XYZ>.<region>.rds.amazonaws.com,<endpoint-name>.endpoint.proxy-<XYZ>.<region>.rds.amazonaws.com - DB Shard Group Endpoint (Aurora Limitless) -
<shard-group-name>.shardgrp-<XYZ>.<region>.rds.amazonaws.com - IP address - IPv4 or IPv6 addresses, for example:
8.8.0.0,2001:0db8:85a3:0000:0000:8a2e:0370:7334 - User custom domain (CNAME alias) - any other domain names, for example:
my-database.my-domain.com
| Plugin codes / Database URL types | Aurora Global Database Endpoint |
|---|---|
| customEndpoint | ✗ |
| efm | ✓ (requires initialConnection plugin) |
| efm2 | ✓ (requires initialConnection plugin) |
| failover | ✓ |
| failover2 | ✓ |
| gdbFailover | ✓ |
| iam | ✓ (requires initialConnection plugin) |
| awsSecretsManager | ✓ |
| awsSecretsManager2 | ✓ |
| federatedAuth | ✓ |
| okta | ✓ |
| ✓ | |
| readWriteSplitting | ✓ |
| autoReadWriteSplitting | ✓ |
| srw | ✓ |
| gdbReadWriteSplitting | ✓ |
| auroraConnectionTracker | ✓ |
| connectTime | ✓ |
| fastestResponseStrategy | ✓ |
| initialConnection | ✓ |
| limitless | ✗ |
| bg | ✗ |
| Plugin codes / Database URL types | Aurora Cluster Writer Endpoint | Aurora Cluster Reader Endpoint | Aurora Cluster Custom Endpoint | Aurora Instance Endpoint, RDS Instance Endpoint |
|---|---|---|---|---|
| customEndpoint | ✗ | ✗ | ✓ | ✗ |
| efm | ✓ (requires initialConnection plugin) | ✓ (requires initialConnection plugin) | ✓ | ✓ |
| efm2 | ✓ (requires initialConnection plugin) | ✓ (requires initialConnection plugin) | ✓ | ✓ |
| failover | ✓ | ✓ | ✓ | ✓ |
| failover2 | ✓ | ✓ | ✓ | ✓ |
| gdbFailover | ✓ | ✓ | ✓ | ✓ |
| iam | ✓ | ✓ | ✓ | ✓ |
| awsSecretsManager | ✓ | ✓ | ✓ | ✓ |
| awsSecretsManager2 | ✓ | ✓ | ✓ | ✓ |
| federatedAuth | ✓ | ✓ | ✓ | ✓ |
| okta | ✓ | ✓ | ✓ | ✓ |
| ✓ | ✗ | ✗ | ✗ | |
| readWriteSplitting | ✓ | ✓ | ✓1 | ✓1 |
| autoReadWriteSplitting | ✓ | ✓ | ✓1 | ✓1 |
| srw | ✓ | ✓ | ✓ | ✓ |
| gdbReadWriteSplitting | ✓ | ✓ | ✓1 | ✓1 |
| auroraConnectionTracker | ✓ | ✓ | ✓ | ✓ |
| connectTime | ✓ | ✓ | ✓ | ✓ |
| fastestResponseStrategy | ✓ | ✓ | ✓ | ✓ |
| initialConnection | ✓ | ✓ | ✗ | ✗ |
| limitless | ✓ | ✓ | ✓ | ✗ |
| bg | ✓ | ✓ | ✓ | ✓ |
| Plugin codes / Database URL types | RDS Multi-AZ DB Cluster Writer Endpoint | RDS Multi-AZ DB Cluster Reader Endpoint | RDS Proxy Endpoint | DB Shard Group Endpoint (Aurora Limitless) |
|---|---|---|---|---|
| customEndpoint | ✗ | ✗ | ✗ | ✗ |
| efm | ✓ (requires initialConnection plugin) | ✓ (requires initialConnection plugin) | ✗ | ✗ |
| efm2 | ✓ (requires initialConnection plugin) | ✓ (requires initialConnection plugin) | ✗ | ✗ |
| failover | ✓ | ✓ | ✓ | ✗ |
| failover2 | ✓ | ✓ | ✓ | ✗ |
| gdbFailover | ✓ | ✓ | ✓ | ✗ |
| iam | ✓ | ✓ | ✓ | ✓ |
| awsSecretsManager | ✓ | ✓ | ✓ | ✓ |
| awsSecretsManager2 | ✓ | ✓ | ✓ | ✓ |
| federatedAuth | ✓ | ✓ | ✓ | ✓ |
| okta | ✓ | ✓ | ✓ | ✓ |
| ✓ | ✗ | ✗ | ✗ | |
| readWriteSplitting | ✓ | ✓ | ✗ | ✗ |
| autoReadWriteSplitting | ✓ | ✓ | ✗ | ✗ |
| srw | ✓ | ✓ | ✓ | ✓ |
| gdbReadWriteSplitting | ✓ | ✓ | ✗ | ✗ |
| auroraConnectionTracker | ✓ | ✓ | ✓ | ✗ |
| connectTime | ✓ | ✓ | ✓ | ✓ |
| fastestResponseStrategy | ✓ | ✓ | ✓ | ✗ |
| initialConnection | ✓ | ✓ | ✗ | ✗ |
| limitless | ✗ | ✗ | ✗ | ✓ |
| bg | ✗ | ✗ | ✓ | ✗ |
| Plugin codes / Database URL types | IP address | User custom domain (CNAME alias) |
|---|---|---|
| customEndpoint | ✗ | ✗ |
| efm | ✗ | ✗ |
| efm2 | ✗ | ✗ |
| failover | ✓ (requires special configuration) | ✓ (requires special configuration) |
| failover2 | ✓ (requires special configuration) | ✓ (requires special configuration) |
| gdbFailover | ✓ (requires special configuration) | ✓ (requires special configuration) |
| iam | ✓ (requires special configuration) | ✓ (requires special configuration) |
| awsSecretsManager | ✓ (requires special configuration) | ✓ (requires special configuration) |
| awsSecretsManager2 | ✓ (requires special configuration) | ✓ (requires special configuration) |
| federatedAuth | ✓ (requires special configuration) | ✓ (requires special configuration) |
| okta | ✓ (requires special configuration) | ✓ (requires special configuration) |
| ✗ | ✗ | |
| readWriteSplitting | ✓1 | ✓1 |
| autoReadWriteSplitting | ✓1 | ✓1 |
| srw | ✓ | ✓ |
| gdbReadWriteSplitting | ✓1 | ✓1 |
| auroraConnectionTracker | ✓ | ✓ |
| connectTime | ✓ | ✓ |
| fastestResponseStrategy | ✓ | ✓ |
| initialConnection | ✗ | ✗ |
| limitless | ✓ | ✓ |
| bg | ✓ (requires special configuration) | ✗ |
Footnotes
-
The
verifyInitialConnectionRoleparameter must remaintrue(default) for these endpoint types. The actual host role may differ from the assumed role, and disabling verification can cause incorrect read/write splitting behavior. See Initial Connection Role Verification for details. ↩ ↩2 ↩3 ↩4 ↩5 ↩6 ↩7 ↩8 ↩9 ↩10 ↩11 ↩12