Amazon Web Services (AWS) JDBC Driver

The Amazon Web Services (AWS) JDBC Driver has been redesigned as an advanced JDBC wrapper.

The wrapper is complementary to an existing JDBC driver and aims to extend the functionality of the driver to enable applications to take full advantage of the features of clustered databases such as Amazon Aurora. In other words, the AWS Advanced JDBC Wrapper does not connect directly to any database, but enables support of AWS and Aurora functionalities on top of an underlying JDBC driver of the user’s choice. This approach enables service-specific enhancements, without requiring users to change their workflow and existing JDBC driver tooling.

The AWS Advanced JDBC Wrapper is targeted to work with any existing JDBC driver. Currently, the AWS Advanced JDBC Wrapper has been validated to support the PostgreSQL JDBC Driver, MySQL JDBC Driver, and MariaDB JDBC Driver.

The AWS Advanced JDBC Wrapper provides modular functionality through feature plugins, with each plugin being relevant to specific database services based on their architecture and capabilities. For example, AWS Identity and Access Management (IAM) authentication is supported across multiple services, while AWS Secrets Manager applies to services that support password-based authentication. The fast failover plugin provides reduced recovery time during failover for Aurora PostgreSQL and Aurora MySQL clusters.

Benefits of the AWS Advanced JDBC Wrapper for All Aurora and RDS Database Services

Seamless AWS Authentication Service Integration

Built-in support for AWS Identity and Access Management (IAM) authentication eliminates the need to manage database passwords, while AWS Secrets Manager integration provides secure credential management for services that require password-based authentication.

Seamless Query Caching Integration

The driver includes Remote Query Cache Plugin that stores cacheable read-only query results in a remote Valkey cache along with support for plain username/password authentication and IAM authentication with AWS ElastiCache. Applications can opt‑in per query using a SQL query hint that specifies a time‑to‑live (TTL).

Preserve Existing Workflows

The wrapper design allows developers to continue using their preferred JDBC drivers and existing database code while gaining service-specific enhancements. No application rewrites are required.

Modular Plugin Architecture

The plugin-based design ensures applications only load the functionality they need, reducing dependencies and overhead.

Benefits of the AWS Advanced JDBC Wrapper for Aurora PostgreSQL, Aurora MySQL, and RDS

Faster Failover and Reduced Downtime

For Aurora PostgreSQL, Aurora MySQL, and RDS Multi-AZ DB clusters, the driver significantly reduces connection recovery time during database failovers. By maintaining a real-time cache of cluster topology and bypassing DNS resolution delays, applications can reconnect to healthy database instances in seconds rather than minutes.

Enhanced Failure Detection

The driver includes Enhanced Failure Monitoring (EFM) that proactively monitors database node health, detecting failures faster than traditional timeout-based approaches. This allows applications to respond to issues before they impact end users.

Using the AWS Advanced JDBC Wrapper with…

Amazon Aurora PostgreSQL and Aurora MySQL

The AWS Advanced JDBC Wrapper provides fast failover capabilities for Aurora PostgreSQL and Aurora MySQL clusters, significantly reducing connection recovery time during database failovers.

Visit Using Failover 2 for more details.

Amazon RDS Multi-AZ DB Clusters

The AWS RDS Multi-AZ DB Clusters are capable of switching over the current writer node to another node in the cluster within approximately 1 second or less, in case of minor engine version upgrade or OS maintenance operations. The AWS Advanced JDBC Wrapper has been optimized for such fast failover when working with AWS RDS Multi-AZ DB Clusters.

With the failover plugin, the downtime during certain DB cluster operations, such as engine minor version upgrades, can be reduced to one second or even less with finely tuned parameters. It supports both MySQL and PostgreSQL clusters.

Visit Support for RDS MultiAZ for more details.

Using the AWS Advanced JDBC Wrapper with Amazon Aurora Global Databases

As of version 3.0.0, the driver supports in-region failover and cross-region planned failover and switchover of Amazon Aurora Global Databases. A Global Writer Endpoint is also recognized and can be handled to minimize potential stale DNS issues. Please check failover plugin, failover2 plugin and Aurora Initial Connection Strategy plugin for more information.

For detailed configuration instructions, see Aurora Global Databases.

Plain Amazon RDS databases

The AWS Advanced JDBC Wrapper also provides limited functionality for RDS provided databases that are not Aurora, see the compatability matrix for details.

RDS Proxy

As of version 3.0.0 the Simple R/W Splitting Plugin can be used with RDS Proxy. There are limitations with the AWS Advanced JDBC Wrapper and RDS Proxy. This is currently intended, by design, since the main reason is that RDS Proxy transparently re-routes requests to a single database instance. RDS Proxy decides which database instance is used based on many criteria (on a per-request basis). Due to this, functionality like Failover, Enhanced Host Monitoring, and Read/Write Splitting is not compatible since the driver relies on cluster topology and RDS Proxy handles this automatically.

The driver remains useful with RDS Proxy for authentication workflows, such as IAM authentication and AWS Secrets Manager integration. See Compatibility for compatibility information and refer to the using plugins documentation for details.

Visit Using Plain RDS for more details.

Getting Started

For more information on how to download the AWS Advanced JDBC Wrapper, minimum requirements to use it, and how to integrate it within your project and with your JDBC driver of choice, please visit the Getting Started page.

Maven Central

You can find our driver by searching in The Central Repository with GroupId and ArtifactId software.amazon:aws-advanced-jdbc-wrapper.

<!-- Add the following dependency to your pom.xml, -->
<!-- replacing LATEST with the specific version as required -->

<dependency>
  <groupId>software.amazon.jdbc</groupId>
  <artifactId>aws-advanced-jdbc-wrapper</artifactId>
  <version>LATEST</version>
</dependency>

Properties

Parameter	Reference	Documentation Link
appId	OktaAuthPlugin.APP_ID	Okta Authentication Plugin
auditLoggingEnabled	EncryptionConfig.AUDIT_LOGGING_ENABLED	KMS Encryption Plugin
autoSortWrapperPluginOrder	PropertyDefinition.AUTO_SORT_PLUGIN_ORDER	Plugins
awsProfile	PropertyDefinition.AWS_PROFILE	AWS Advanced JDBC Wrapper Parameters
bgBaselineMs	BlueGreenStatusProvider.BG_INTERVAL_BASELINE_MS	Blue/Green Deployment Plugin
bgdId	BlueGreenConnectionPlugin.BGD_ID	Blue/Green Deployment Plugin
bgConnectTimeoutMs	BlueGreenConnectionPlugin.BG_CONNECT_TIMEOUT	Blue/Green Deployment Plugin
bgDropBlueConnections	BlueGreenStatusProvider.BG_DROP_BLUE_CONNECTIONS	Blue/Green Deployment Plugin
bgHighMs	BlueGreenStatusProvider.BG_INTERVAL_HIGH_MS	Blue/Green Deployment Plugin
bgIncreasedMs	BlueGreenStatusProvider.BG_INTERVAL_INCREASED_MS	Blue/Green Deployment Plugin
bgSwitchoverTimeoutMs	BlueGreenStatusProvider.BG_SWITCHOVER_TIMEOUT_MS	Blue/Green Deployment Plugin
clusterId	RdsHostListProvider.CLUSTER_ID	ClusterId
clusterInstanceHostPattern	RdsHostListProvider.CLUSTER_INSTANCE_HOST_PATTERN	Failover Plugin
clusterTopologyHighRefreshRateMs	RdsHostListProvider.CLUSTER_TOPOLOGY_HIGH_REFRESH_RATE_MS	Failover Plugin v2
clusterTopologyRefreshRateMs	RdsHostListProvider.CLUSTER_TOPOLOGY_REFRESH_RATE_MS	Failover Plugin v2
connectTimeout	PropertyDefinition.CONNECT_TIMEOUT	AWS Advanced JDBC Wrapper Parameters
connectionPoolType	PropertyDefinition.CONNECTION_POOL_TYPE	AWS Advanced JDBC Wrapper Parameters
customEndpointInfoMaxRefreshRateMs	CustomEndpointPlugin.CUSTOM_ENDPOINT_INFO_MAX_REFRESH_RATE_MS	Custom Endpoint Plugin
customEndpointInfoRefreshRateBackoffFactor	CustomEndpointPlugin.CUSTOM_ENDPOINT_INFO_REFRESH_RATE_BACKOFF_FACTOR	Custom Endpoint Plugin
customEndpointInfoRefreshRateMs	CustomEndpointPlugin.CUSTOM_ENDPOINT_INFO_REFRESH_RATE_MS	Custom Endpoint Plugin
dataCacheTriggerCondition	DataLocalCacheConnectionPlugin.DATA_CACHE_TRIGGER_CONDITION	Using the AWS Advanced JDBC Wrapper
dataKeyCacheEnabled	EncryptionConfig.DATA_KEY_CACHE_ENABLED	KMS Encryption Plugin
dataKeyCacheExpirationMs	EncryptionConfig.DATA_KEY_CACHE_EXPIRATION_MS	KMS Encryption Plugin
dataKeyCacheMaxSize	EncryptionConfig.DATA_KEY_CACHE_MAX_SIZE	KMS Encryption Plugin
cacheEndpointAddrRw	CacheConnection.CACHE_RW_ENDPOINT_ADDR	Remote Query Cache Plugin
cacheEndpointAddrRo	CacheConnection.CACHE_RO_ENDPOINT_ADDR	Remote Query Cache Plugin
cacheUseSSL	CacheConnection.CACHE_USE_SSL	Remote Query Cache Plugin
cacheTlsCaCertPath	CacheConnection.CACHE_TLS_CA_CERT_PATH	Remote Query Cache Plugin
cacheUsername	CacheConnection.CACHE_USERNAME	Remote Query Cache Plugin
cachePassword	CacheConnection.CACHE_PASSWORD	Remote Query Cache Plugin
cacheName	CacheConnection.CACHE_NAME	Remote Query Cache Plugin
cacheIamRegion	CacheConnection.CACHE_IAM_REGION	Remote Query Cache Plugin
cacheMaxQuerySize	RemoteQueryCachePlugin.CACHE_MAX_QUERY_SIZE	Remote Query Cache Plugin
cacheConnectionTimeoutMs	CacheConnection.CACHE_CONNECTION_TIMEOUT	Remote Query Cache Plugin
cacheConnectionPoolSize	CacheConnection.CACHE_CONNECTION_POOL_SIZE	Remote Query Cache Plugin
cacheKeyPrefix	CacheConnection.CACHE_KEY_PREFIX	Remote Query Cache Plugin
failWhenCacheDown	CacheConnection.FAIL_WHEN_CACHE_DOWN	Remote Query Cache Plugin
cacheInFlightWriteSizeLimitBytes	CacheMonitor.CACHE_IN_FLIGHT_WRITE_SIZE_LIMIT	Remote Query Cache Plugin
cacheHealthCheckInHealthyState	CacheMonitor.CACHE_HEALTH_CHECK_IN_HEALTHY_STATE	Remote Query Cache Plugin
database	PropertyDefinition.DATABASE	AWS Advanced JDBC Wrapper Parameters
defaultHostAvailabilityStrategy	HostAvailabilityStrategyFactory.DEFAULT_HOST_AVAILABILITY_STRATEGY	Host Availability Strategy
enableClusterAwareFailover	FailoverConnectionPlugin.ENABLE_CLUSTER_AWARE_FAILOVER	Failover Plugin
enableTelemetry	PropertyDefinition.ENABLE_TELEMETRY	Monitoring
endpointSubstitutionRole	AuroraInitialConnectionStrategyPlugin.ENDPOINT_SUBSTITUTION_ROLE	Aurora Initial Connection Strategy Plugin
enhancedLogQueryEnabled	LogQueryConnectionPlugin.ENHANCED_LOG_QUERY_ENABLED	Using the AWS Advanced JDBC Wrapper
encryptionMetadataSchema	EncryptionConfig.ENCRYPTION_METADATA_SCHEMA	KMS Encryption Plugin
failoverClusterTopologyRefreshRateMs	FailoverConnectionPlugin.FAILOVER_CLUSTER_TOPOLOGY_REFRESH_RATE_MS	Failover Plugin
failoverMode	FailoverConnectionPlugin.FAILOVER_MODE	Failover Plugin
failoverReaderConnectTimeoutMs	FailoverConnectionPlugin.FAILOVER_READER_CONNECT_TIMEOUT_MS	Failover Plugin
failoverReaderHostSelectorStrategy	FailoverConnectionPlugin.FAILOVER_READER_HOST_SELECTOR_STRATEGY	Failover Plugin v2
failoverTimeoutMs	FailoverConnectionPlugin.FAILOVER_TIMEOUT_MS	Failover Plugin Failover Plugin v2
failoverWriterReconnectIntervalMs	FailoverConnectionPlugin.FAILOVER_WRITER_RECONNECT_INTERVAL_MS	Failover Plugin
failureDetectionCount	HostMonitoringConnectionPlugin.FAILURE_DETECTION_COUNT	Host Monitoring Plugin
failureDetectionEnabled	HostMonitoringConnectionPlugin.FAILURE_DETECTION_ENABLED	Host Monitoring Plugin
failureDetectionInterval	HostMonitoringConnectionPlugin.FAILURE_DETECTION_INTERVAL	Host Monitoring Plugin
failureDetectionTime	HostMonitoringConnectionPlugin.FAILURE_DETECTION_TIME	Host Monitoring Plugin
gdbRwHomeRegion	GdbReadWriteSplittingPlugin.RW_HOME_REGION	Global Database (GDB) Read/Write Splitting Plugin
gdbRwRestrictReaderToHomeRegion	GdbReadWriteSplittingPlugin.RESTRICT_READER_TO_HOME_REGION	Global Database (GDB) Read/Write Splitting Plugin
gdbRwRestrictWriterToHomeRegion	GdbReadWriteSplittingPlugin.RESTRICT_WRITER_TO_HOME_REGION	Global Database (GDB) Read/Write Splitting Plugin
globalClusterInstanceHostPatterns	GlobalAuroraHostListProvider.GLOBAL_CLUSTER_INSTANCE_HOST_PATTERNS	Failover Plugin v2 Global Database (GDB) Failover Plugin
hostAvailabilityStrategyInitialBackoffTime	HostAvailabilityStrategyFactory.HOST_AVAILABILITY_STRATEGY_INITIAL_BACKOFF_TIME	Host Availability Strategy
hostAvailabilityStrategyMaxRetries	HostAvailabilityStrategyFactory.HOST_AVAILABILITY_STRATEGY_MAX_RETRIES	Host Availability Strategy
iamAccessTokenPropertyName	IamAuthConnectionPlugin.IAM_TOKEN_PROPERTY_NAME	AWS IAM Authentication Plugin
iamDefaultPort	IamAuthConnectionPlugin.IAM_DEFAULT_PORT	AWS IAM Authentication Plugin
iamExpiration	IamAuthConnectionPlugin.IAM_EXPIRATION	AWS IAM Authentication Plugin
iamHost	IamAuthConnectionPlugin.IAM_HOST	AWS IAM Authentication Plugin
iamIdpArn	OktaAuthPlugin.IAM_IDP_ARN	Okta Authentication Plugin
iamRegion	IamAuthConnectionPlugin.IAM_REGION	AWS IAM Authentication Plugin
iamRoleArn	FederatedAuthPlugin.IAM_ROLE_ARN	Federated Authentication Plugin
iamRoleArn	OktaAuthPlugin.IAM_ROLE_ARN	Okta Authentication Plugin
idpEndpoint	FederatedAuthPlugin.IDP_ENDPOINT	Federated Authentication Plugin
idpEndpoint	OktaAuthPlugin.IDP_ENDPOINT	Okta Authentication Plugin
idpPort	FederatedAuthPlugin.IDP_PORT	Federated Authentication Plugin
inactiveClusterWriterEndpointSubstitutionRole	AuroraInitialConnectionStrategyPlugin.INACTIVE_CLUSTER_WRITER_SUBSTITUTION_ROLE	Aurora Initial Connection Strategy Plugin
initialConnectionHostSelectorStrategy	AuroraInitialConnectionStrategyPlugin.HOST_SELECTOR_STRATEGY	Aurora Initial Connection Strategy Plugin
keyManagementMaxRetries	EncryptionConfig.KEY_MANAGEMENT_MAX_RETRIES	KMS Encryption Plugin
keyManagementRetryBackoffBaseMs	EncryptionConfig.KEY_MANAGEMENT_RETRY_BACKOFF_BASE_MS	KMS Encryption Plugin
kms.region	EncryptionConfig.KMS_REGION	KMS Encryption Plugin
limitlessConnectMaxRetries	LimitlessConnectionPlugin.MAX_RETRIES	Using the Limitless Connection Plugin
limitlessGetTransactionRouterInfoMaxRetries	LimitlessConnectionPlugin.GET_ROUTER_MAX_RETRIES	Using the Limitless Connection Plugin
limitlessGetTransactionRouterInfoRetryIntervalMs	LimitlessConnectionPlugin.GET_ROUTER_RETRY_INTERVAL_MILLIS	Using the Limitless Connection Plugin
limitlessTransactionRouterMonitorDisposalTimeMs	LimitlessRouterServiceImpl.MONITOR_DISPOSAL_TIME_MS	Using the Limitless Connection Plugin
limitlessTransactionRouterMonitorIntervalMs	LimitlessConnectionPlugin.INTERVAL_MILLIS	Using the Limitless Connection Plugin
limitlessWaitForTransactionRouterInfo	LimitlessConnectionPlugin.WAIT_FOR_ROUTER_INFO	Using the Limitless Connection Plugin
loginTimeout	PropertyDefinition.LOGIN_TIMEOUT	AWS Advanced JDBC Wrapper Parameters
metadataCacheEnabled	EncryptionConfig.METADATA_CACHE_ENABLED	KMS Encryption Plugin
metadataCacheExpirationMinutes	EncryptionConfig.METADATA_CACHE_EXPIRATION_MINUTES	KMS Encryption Plugin
metadataCacheRefreshIntervalMs	EncryptionConfig.METADATA_CACHE_REFRESH_INTERVAL_MS	KMS Encryption Plugin
monitorDisposalTime	HostMonitorServiceImpl.MONITOR_DISPOSAL_TIME_MS	Host Monitoring Plugin
openConnectionRetryIntervalMs	AuroraInitialConnectionStrategyPlugin.OPEN_CONNECTION_RETRY_INTERVAL_MS	Aurora Initial Connection Strategy Plugin
openConnectionRetryTimeoutMs	AuroraInitialConnectionStrategyPlugin.OPEN_CONNECTION_RETRY_TIMEOUT_MS	Aurora Initial Connection Strategy Plugin
password	PropertyDefinition.PASSWORD	AWS Advanced JDBC Wrapper Parameters
readerHostSelectorStrategy	ReadWriteSplittingPlugin.READER_HOST_SELECTOR_STRATEGY	Read/Write Splitting Plugin
readerInitialConnectionHostSelectorStrategy	AuroraInitialConnectionStrategyPlugin.READER_HOST_SELECTOR_STRATEGY	Aurora Initial Connection Strategy Plugin
responseMeasurementIntervalMs	FastestResponseStrategyPlugin.RESPONSE_MEASUREMENT_INTERVAL_MILLIS	Using the AWS Advanced JDBC Wrapper
roundRobinDefaultWeight	RoundRobinHostSelector.ROUND_ROBIN_DEFAULT_WEIGHT	Host Selection Strategies
roundRobinHostWeightPairs	RoundRobinHostSelector.ROUND_ROBIN_HOST_WEIGHT_PAIRS	Host Selection Strategies
rpIdentifier	FederatedAuthPlugin.RELAYING_PARTY_ID	Federated Authentication Plugin
secretsManagerEndpoint	AwsSecretsManagerConnectionPlugin.ENDPOINT_PROPERTY	AWS Secrets Manager Plugin
secretsManagerExpirationTimeSec	AwsSecretsManagerConnectionPlugin.SECRETS_MANAGER_EXPIRATION_SEC_PROPERTY	AWS Secrets Manager Plugin
secretsManagerRegion	AwsSecretsManagerConnectionPlugin.REGION_PROPERTY	AWS Secrets Manager Plugin
secretsManagerSecretId	AwsSecretsManagerConnectionPlugin.SECRET_ID_PROPERTY	AWS Secrets Manager Plugin
secretsManagerSecretPasswordProperty	AwsSecretsManagerConnectionPlugin.SECRETS_MANAGER_SECRET_PASSWORD_PROPERTY	AWS Secrets Manager Plugin
secretsManagerSecretUsernameProperty	AwsSecretsManagerConnectionPlugin.SECRETS_MANAGER_SECRET_USERNAME_PROPERTY	AWS Secrets Manager Plugin
singleWriterConnectionString	ConnectionStringHostListProvider.SINGLE_WRITER_CONNECTION_STRING
skipInactiveWriterClusterEndpointCheck	AuroraStaleDnsHelper.SKIP_INACTIVE_WRITER_CLUSTER_CHECK	Global Database (GDB) Failover Plugin
socketTimeout	PropertyDefinition.SOCKET_TIMEOUT	AWS Advanced JDBC Wrapper Parameters
srwConnectRetryIntervalMs	SimpleReadWriteSplittingPlugin.SRW_CONNECT_RETRY_INTERVAL_MS	Simple Read/Write Splitting Plugin
srwConnectRetryTimeoutMs	SimpleReadWriteSplittingPlugin.SRW_CONNECT_RETRY_TIMEOUT_MS	Simple Read/Write Splitting Plugin
srwReadEndpoint	SimpleReadWriteSplittingPlugin.SRW_READ_ENDPOINT	Simple Read/Write Splitting Plugin
srwWriteEndpoint	SimpleReadWriteSplittingPlugin.SRW_WRITE_ENDPOINT	Simple Read/Write Splitting Plugin
targetDriverAutoRegister	TargetDriverDialectManager.TARGET_DRIVER_AUTO_REGISTER	AWS Advanced JDBC Wrapper Parameters
tcpKeepAlive	PropertyDefinition.TCP_KEEP_ALIVE	AWS Advanced JDBC Wrapper Parameters
telemetryFailoverAdditionalTopTrace	FailoverConnectionPlugin.TELEMETRY_FAILOVER_ADDITIONAL_TOP_TRACE	Failover Plugin
telemetryMetricsBackend	PropertyDefinition.TELEMETRY_METRICS_BACKEND	Monitoring
telemetrySubmitToplevel	PropertyDefinition.TELEMETRY_SUBMIT_TOPLEVEL	Monitoring
telemetryTracesBackend	PropertyDefinition.TELEMETRY_TRACES_BACKEND	Monitoring
user	PropertyDefinition.USER	AWS Advanced JDBC Wrapper Parameters
verifyInactiveClusterWriterEndpointConnectionType	AuroraInitialConnectionStrategyPlugin.VERIFY_INACTIVE_CLUSTER_WRITER_CONNECTION_ROLE	Aurora Initial Connection Strategy Plugin
verifyInitialConnectionType	SimpleReadWriteSplittingPlugin.VERIFY_INITIAL_CONNECTION_TYPE	Simple Read/Write Splitting Plugin
verifyNewSrwConnections	SimpleReadWriteSplittingPlugin.VERIFY_NEW_SRW_CONNECTIONS	Simple Read/Write Splitting Plugin
verifyOpenedConnectionType	AuroraInitialConnectionStrategyPlugin.VERIFY_OPENED_CONNECTION_ROLE	Aurora Initial Connection Strategy Plugin
waitForCustomEndpointInfo	CustomEndpointPlugin.WAIT_FOR_CUSTOM_ENDPOINT_INFO	Custom Endpoint Plugin
weightedRandomHostWeightPairs	WeightedRandomHostSelector.WEIGHTED_RANDOM_HOST_WEIGHT_PAIRS	Host Availability Strategy
wrapperCaseSensitive	PropertyDefinition.CASE_SENSITIVE	AWS Advanced JDBC Wrapper Parameters
wrapperDialect	DialectManager.DIALECT	Dialects
wrapperDriverName	DriverMetaDataConnectionPlugin.WRAPPER_DRIVER_NAME	DriverMetaDataConnectionPlugin
wrapperLogUnclosedConnections	PropertyDefinition.LOG_UNCLOSED_CONNECTIONS	AWS Advanced JDBC Wrapper Parameters
wrapperLoggerLevel	PropertyDefinition.LOGGER_LEVEL	Logging
wrapperPlugins	PropertyDefinition.PLUGINS	AWS Advanced JDBC Wrapper Parameters
wrapperProfileName	PropertyDefinition.PROFILE_NAME	Configuration Profiles
wrapperTargetDriverDialect	TargetDriverDialectManager.TARGET_DRIVER_DIALECT	AWS Advanced JDBC Wrapper Parameters

A Secret ARN has the following format: arn:aws:secretsmanager:<Region>:<AccountId>SecretName-6RandomCharacters

Logging

Enabling logging is a very useful mechanism for troubleshooting any issue one might potentially experience while using the AWS Advanced JDBC Wrapper.

In order to learn how to enable and configure logging, check out the Logging section.

Documentation

Technical documentation regarding the functionality of the AWS Advanced JDBC Wrapper will be maintained in this GitHub repository. Since the AWS Advanced JDBC Wrapper requires an underlying JDBC driver, please refer to the individual driver’s documentation for driver-specific information.

Using the AWS Advanced JDBC Wrapper

To find all the documentation and concrete examples on how to use the AWS Advanced JDBC Wrapper, please refer to the AWS Advanced JDBC Wrapper Documentation page.

Known Limitations

Amazon RDS Blue/Green Deployments

Support for Blue/Green deployments using the AWS Advanced JDBC Wrapper requires specific metadata tables. The following service versions provide support for Blue/Green Deployments:

• Supported RDS PostgreSQL Versions: rds_tools v1.7 (17.1, 16.5, 15.9, 14.14, 13.17, 12.21) and above.
• Supported Aurora PostgreSQL Versions: Engine Release 17.5, 16.9, 15.13, 14.18, 13.21 and above.
• Supported Aurora MySQL Versions: Engine Release 3.07 and above.

Please note that Aurora Global Database and RDS Multi-AZ clusters with Blue/Green deployments is currently not supported. For detailed information on supported database versions, refer to the Blue/Green Deployment Plugin Documentation.

Examples

Description	Examples
Using the AWS Advanced JDBC Wrapper to get a simple connection	PostgreSQL
Using the AWS Advanced JDBC Wrapper with failover handling	PostgreSQL
Using the AWS IAM Authentication Plugin with DriverManager	PostgreSQL MySQL MariaDB
Using the AWS IAM Authentication Plugin with DataSource	PostgreSQL and MySQL
Using the AWS Secrets Manager Plugin with DriverManager	PostgreSQL MySQL
Using the AWS Credentials Manager to configure an alternative AWS credentials provider.	PostgreSQL and MySQL
Using the AWS Advanced JDBC Wrapper with AWSWrapperDatasource	PostgreSQL
Using the Driver Metadata Plugin to override driver name, this plugin enables specific database features that may only be available to target drivers	PostgreSQL
Using the Read/Write Splitting Plugin with DriverManager	PostgreSQL MySQL
Using the Read/Write Splitting Plugin with Spring	PostgreSQL MySQL
Using HikariCP with the AWSWrapperDatasource	PostgreSQL
Using HikariCP with the AWSWrapperDatasource with failover handling	PostgreSQL
Using Spring and HikariCP with the AWS Advanced JDBC Wrapper	PostgreSQL
Using Spring and HikariCP with the AWS Advanced JDBC Wrapper and failover handling	PostgreSQL
Using Spring and Hibernate with the AWS Advanced JDBC Wrapper	PostgreSQL
Using Spring and Wildfly with the AWS Advanced JDBC Wrapper	PostgreSQL
Using Vert.x and c3p0 with the AWS Advanced JDBC Wrapper	PostgreSQL
Using the AWS Advanced JDBC Wrapper with Telemetry and using the AWS Distro for OpenTelemetry Collector	PostgreSQL
Using the AWS Advanced JDBC Wrapper with Telemetry and using the AWS X-Ray Daemon	PostgreSQL

Getting Help and Opening Issues

If you encounter a bug with the AWS Advanced JDBC Wrapper, we would like to hear about it. Please search the existing issues to see if others are also experiencing the issue before reporting the problem in a new issue. GitHub issues are intended for bug reports and feature requests.

When opening a new issue, please fill in all required fields in the issue template to help expedite the investigation process.

For all other questions, please use GitHub discussions.

How to Contribute

1. Set up your environment by following the directions in the Development Guide.
2. To contribute, first make a fork of this project.
3. Make any changes on your fork. Make sure you are aware of the requirements for the project (e.g. do not require Java 7 if we are supporting Java 8 and higher).
4. Create a pull request from your fork.
5. Pull requests need to be approved and merged by maintainers into the main branch.
   Note: Before making a pull request, run all tests and verify everything is passing.

Code Style

The project source code is written using the Google checkstyle, and the style is strictly enforced in our automation pipelines. Any contribution that does not respect/satisfy the style will automatically fail at build time.

Releases

The aws-advanced-jdbc-wrapper has a regular monthly release cadence. A new release will occur during the last week of each month. However, if there are no changes since the latest release, then a release will not occur.

Aurora Engine Version Testing

This aws-advanced-jdbc-wrapper is being tested against the following Community and Aurora database versions in our test suite:

Database	Versions
MySQL	8.0.36
PostgreSQL	16.2
Aurora MySQL	- Default version. To check the default version, open the RDS “Create database” page in the AWS console and check the pre-selected database version. - Latest release, as shown on this page.
Aurora PostgreSQL	- Default version. To check the default version, open the RDS “Create database” page in the AWS console and check the pre-selected database version. - Latest release, as shown on this page.

The aws-advanced-jdbc-wrapper is compatible with MySQL 5.7 and MySQL 8.0 as per the Community MySQL Connector/J 8.0 Driver.

License

This software is released under the Apache 2.0 license.