From 82214ffb586c0198b3631e5658c7c6a159158647 Mon Sep 17 00:00:00 2001 From: sergiyvamz Date: Fri, 31 Oct 2025 15:02:13 -0700 Subject: [PATCH 1/2] deprecate auroraStaleDns plugin --- .../UsingTheJdbcDriver.md | 46 +++++++++---------- .../plugin/staledns/AuroraStaleDnsPlugin.java | 4 +- 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md index 67bc00ac9..ef1caf194 100644 --- a/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md +++ b/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md @@ -94,7 +94,7 @@ These parameters are applicable to any instance of the AWS JDBC Driver. | `resetSessionStateOnClose` | `Boolean` | No | Enables resetting the session state before closing connection. | `true` | | `rollbackOnSwitch` | `Boolean` | No | Enables rolling back a current transaction, if any in effect, before switching to a new connection. | `true` | | `awsProfile` | `String` | No | Allows users to specify a profile name for AWS credentials. This parameter is used by plugins that require AWS credentials, like the [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) and the [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md). | `null` | -| ~~`enableGreenNodeReplacement`~~ | `Boolean` | No | **Deprecated. Use `bg` plugin instead.** Enables replacing a green node host name with the original host name when the green host DNS doesn't exist anymore after a blue/green switchover. Refer to [Overview of Amazon RDS Blue/Green Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html) for more details about green and blue nodes. | `false` | +| ~~`enableGreenNodeReplacement`~~ | `Boolean` | No | **Deprecated. Use `bg` plugin instead.** Enables replacing a green node host name with the original host name when the green host DNS doesn't exist anymore after a blue/green switchover. Refer to [Overview of Amazon RDS Blue/Green Deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html) for more details about green and blue nodes. | `false` | | `wrapperCaseSensitive`,
`wrappercasesensitive` | `Boolean` | No | Allows the driver to change case sensitivity for parameter names in the connection string and in connection properties. Set parameter to `false` to allow case-insensitive parameter names. | `true` | | `skipWrappingForPackages` | `String` | No | Register Java package names (separated by comma) which will be left unwrapped. This setting modifies all future connections established by the driver, not just a particular connection. | `com.pgvector` | @@ -194,28 +194,28 @@ Driver.setConnectionInitFunc((connection, protocol, hostSpec, props) -> { ### List of Available Plugins The AWS JDBC Driver has several built-in plugins that are available to use. Please visit the individual plugin page for more details. -| Plugin name | Plugin Code | Database Compatibility | Description | Additional Required Dependencies | -|-------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. | None | -| [Failover Connection Plugin v2](./using-plugins/UsingTheFailover2Plugin.md) | `failover2` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. This plugin is enabled by default. It is functionally the same as the first version of the Failover Connection Plugin (`failover`) and uses similar configuration parameters. | None | -| [Host Monitoring Connection Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. | None | -| [Host Monitoring Connection Plugin v2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | `efm2` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. This plugin is enabled by default. This plugin is an alternative implementation for host health status monitoring. It is functionally the same as the `efm` plugin and uses the same configuration parameters. | None | -| Data Cache Connection Plugin | `dataCache` | Any database | Caches results from SQL queries matching the regular expression specified in the `dataCacheTriggerCondition` configuration parameter. | None | -| Execution Time Connection Plugin | `executionTime` | Any database | Logs the time taken to execute any JDBC method. | None | -| Log Query Connection Plugin | `logQuery` | Any database | Tracks and logs the SQL statements to be executed. Sometimes SQL statements are not passed directly to the JDBC method as a parameter, such as [executeBatch()](https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html#executeBatch--). Users can set `enhancedLogQueryEnabled` to `true`, allowing the JDBC Wrapper to obtain SQL statements via Java Reflection.

:warning:**Note:** Enabling Java Reflection may cause a performance degradation. | None | -| [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) | `iam` | Aurora, RDS Multi-AZ DB Cluster | Enables users to connect to their Amazon Aurora clusters using AWS Identity and Access Management (IAM). | [AWS Java SDK RDS v2.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds) | -| [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `awsSecretsManager` | Any database | Enables fetching database credentials from the AWS Secrets Manager service. | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Secrets Manager](https://central.sonatype.com/artifact/software.amazon.awssdk/secretsmanager) | -| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthPlugin.md) | `federatedAuth` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | -| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthPlugin.md) | `okta` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | -| Aurora Stale DNS Plugin | `auroraStaleDns` | Aurora | Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event.

:warning:**Note:** Contrary to `failover` plugin, `auroraStaleDns` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed.

:warning:**Note:** This logic is already included in `failover` plugin so you can omit using both plugins at the same time. | None | -| [Aurora Connection Tracker Plugin](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | `auroraConnectionTracker` | Aurora, RDS Multi-AZ DB Cluster | Tracks all the opened connections. In the event of a cluster failover, the plugin will close all the impacted connections to the node. This plugin is enabled by default. | None | -| [Driver Metadata Connection Plugin](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | `driverMetaData` | Any database | Allows user application to override the return value of `DatabaseMetaData#getDriverName` | None | -| [Read Write Splitting Plugin](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | `readWriteSplitting` | Aurora | Enables read write splitting functionality where users can switch between database reader and writer instances. | None | -| [Developer Plugin](./using-plugins/UsingTheDeveloperPlugin.md) | `dev` | Any database | Helps developers test various everyday scenarios including rare events like network outages and database cluster failover. The plugin allows injecting and raising an expected exception, then verifying how applications handle it. | None | -| [Aurora Initial Connection Strategy](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. | None | -| [Limitless Connection Plugin](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | `limitless` | Aurora | Enables client-side load-balancing of Transaction Routers on Amazon Aurora Limitless Databases . | None | -| Fastest Response Strategy Plugin | `fastestResponseStrategy` | Aurora | When read-write splitting is enabled, this plugin selects the reader to switch to based on the host with the fastest response time. The plugin achieves this by periodically monitoring the hosts' response times and storing the fastest host in a cache. **Note:** the `readerHostSelectorStrategy` parameter must be set to `fastestResponse` in the user-defined connection properties in order to enable this plugin. See [reader selection strategies](./ReaderSelectionStrategies.md). | None | -| [Blue/Green Deployment Plugin](./using-plugins/UsingTheBlueGreenPlugin.md) | `bg` | Aurora,
RDS Instance | Enables client-side Blue/Green Deployment support. | None | +| Plugin name | Plugin Code | Database Compatibility | Description | Additional Required Dependencies | +|-------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. | None | +| [Failover Connection Plugin v2](./using-plugins/UsingTheFailover2Plugin.md) | `failover2` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora and RDS Multi-AZ clusters. Prevents opening wrong connections to the old writer node due to stale DNS after a failover event. This plugin is enabled by default. It is functionally the same as the first version of the Failover Connection Plugin (`failover`) and uses similar configuration parameters. | None | +| [Host Monitoring Connection Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. | None | +| [Host Monitoring Connection Plugin v2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | `efm2` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. This plugin is enabled by default. This plugin is an alternative implementation for host health status monitoring. It is functionally the same as the `efm` plugin and uses the same configuration parameters. | None | +| Data Cache Connection Plugin | `dataCache` | Any database | Caches results from SQL queries matching the regular expression specified in the `dataCacheTriggerCondition` configuration parameter. | None | +| Execution Time Connection Plugin | `executionTime` | Any database | Logs the time taken to execute any JDBC method. | None | +| Log Query Connection Plugin | `logQuery` | Any database | Tracks and logs the SQL statements to be executed. Sometimes SQL statements are not passed directly to the JDBC method as a parameter, such as [executeBatch()](https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html#executeBatch--). Users can set `enhancedLogQueryEnabled` to `true`, allowing the JDBC Wrapper to obtain SQL statements via Java Reflection.

:warning:**Note:** Enabling Java Reflection may cause a performance degradation. | None | +| [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) | `iam` | Aurora, RDS Multi-AZ DB Cluster | Enables users to connect to their Amazon Aurora clusters using AWS Identity and Access Management (IAM). | [AWS Java SDK RDS v2.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds) | +| [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `awsSecretsManager` | Any database | Enables fetching database credentials from the AWS Secrets Manager service. | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Secrets Manager](https://central.sonatype.com/artifact/software.amazon.awssdk/secretsmanager) | +| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthPlugin.md) | `federatedAuth` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | +| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthPlugin.md) | `okta` | Aurora, RDS Multi-AZ DB Cluster | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | [Jackson Databind](https://central.sonatype.com/artifact/com.fasterxml.jackson.core/jackson-databind)
[AWS Java SDK RDS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/rds)
[AWS Java SDK STS v2.7.x](https://central.sonatype.com/artifact/software.amazon.awssdk/sts) | +| ~~Aurora Stale DNS Plugin~~ | `auroraStaleDns` | Aurora | **Deprecated**. Use `initialConnection` plugin instead.

Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event.

:warning:**Note:** Contrary to `failover` plugin, `auroraStaleDns` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed.

:warning:**Note:** This logic is already included in `failover` plugin so you can omit using both plugins at the same time. | None | +| [Aurora Connection Tracker Plugin](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | `auroraConnectionTracker` | Aurora, RDS Multi-AZ DB Cluster | Tracks all the opened connections. In the event of a cluster failover, the plugin will close all the impacted connections to the node. This plugin is enabled by default. | None | +| [Driver Metadata Connection Plugin](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | `driverMetaData` | Any database | Allows user application to override the return value of `DatabaseMetaData#getDriverName` | None | +| [Read Write Splitting Plugin](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | `readWriteSplitting` | Aurora | Enables read write splitting functionality where users can switch between database reader and writer instances. | None | +| [Developer Plugin](./using-plugins/UsingTheDeveloperPlugin.md) | `dev` | Any database | Helps developers test various everyday scenarios including rare events like network outages and database cluster failover. The plugin allows injecting and raising an expected exception, then verifying how applications handle it. | None | +| [Aurora Initial Connection Strategy](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event.

This plugin is **strongly** suggested when using cluster writer endpoint, cluster reader endpoint or global database endpoint in the connection string.

:warning:**Note:** Contrary to `failover` and `failover2` plugins, `initialConnection` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed. | None | +| [Limitless Connection Plugin](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | `limitless` | Aurora | Enables client-side load-balancing of Transaction Routers on Amazon Aurora Limitless Databases . | None | +| Fastest Response Strategy Plugin | `fastestResponseStrategy` | Aurora | When read-write splitting is enabled, this plugin selects the reader to switch to based on the host with the fastest response time. The plugin achieves this by periodically monitoring the hosts' response times and storing the fastest host in a cache. **Note:** the `readerHostSelectorStrategy` parameter must be set to `fastestResponse` in the user-defined connection properties in order to enable this plugin. See [reader selection strategies](./ReaderSelectionStrategies.md). | None | +| [Blue/Green Deployment Plugin](./using-plugins/UsingTheBlueGreenPlugin.md) | `bg` | Aurora,
RDS Instance | Enables client-side Blue/Green Deployment support. | None | > [!NOTE]\ diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index a5babfc3c..0577c4b31 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -34,7 +34,9 @@ import software.amazon.jdbc.plugin.AbstractConnectionPlugin; /** - * After Aurora DB cluster fail over is completed and a cluster has elected a new writer node, the corresponding + * Deprecated. Usee 'initialConnection' plugin instead. + * + *

After Aurora DB cluster fail over is completed and a cluster has elected a new writer node, the corresponding * cluster (writer) endpoint contains stale data and points to an old writer node. That old writer node plays * a reader role after fail over and connecting with the cluster endpoint connects to it. In such case a user * application expects a writer connection but practically gets connected to a reader. Any DML statements fail From 67457c390cef2adc45cf75acc496a737cb91fe5b Mon Sep 17 00:00:00 2001 From: sergiyvamz Date: Tue, 4 Nov 2025 15:53:08 -0800 Subject: [PATCH 2/2] update compatibility matrix --- .../CompatibilityCrossPlugins.md | 8 +++---- .../CompatibilityDatabaseTypes.md | 14 +++++------ .../CompatibilityEndpoints.md | 24 +++++++++---------- .../plugin/staledns/AuroraStaleDnsPlugin.java | 2 +- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md b/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md index 0f20293f0..d40aee79d 100644 --- a/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md +++ b/docs/using-the-jdbc-driver/CompatibilityCrossPlugins.md @@ -14,7 +14,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | ✓ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -36,7 +36,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | ✓ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -54,7 +54,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✗ | | | | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✗ | ✗ | | | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✗ | ✗ | ✗ | | -| auroraStaleDns | ✓ | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | ✓ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -67,7 +67,7 @@
-| Plugin codes / Plugin codes | auroraStaleDns | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | +| Plugin codes / Plugin codes | ~~auroraStaleDns~~ | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | |---------------------------------------------------------------------------------------|----------------------------------------------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | | | | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | | | diff --git a/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md b/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md index 733af5f34..0aeb66b9d 100644 --- a/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md +++ b/docs/using-the-jdbc-driver/CompatibilityDatabaseTypes.md @@ -8,20 +8,20 @@ | customEndpoint | ✓ | ✓ | ✓ | | [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ | ✓ | ✓ | | [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ | ✓ | ✓ | -| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | ✓ | ✓ | -| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | ✓ | ✓ | +| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | ✓ | ✓ | +| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | ✓ | ✓ | | [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ | ✓ | ✓ | | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✓ | ✓ | -| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | +| ~~auroraStaleDns~~ | ✓ | ✓ | ✓ | +| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | | connectTime | ✓ | ✓ | ✓ | | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | ✓ | ✓ | ✓ | -| fastestResponseStrategy | ✓ | ✓ | ✓ | -| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | ✓ | ✓ | +| fastestResponseStrategy | ✓ | ✓ | ✓ | +| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | ✓ | ✓ | | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | ✗ | ✓ (PostgreSQL only) | ✓ | | [bg](./using-plugins/UsingTheBlueGreenPlugin.md) | ✗ | ✓ | ✓ |
@@ -41,7 +41,7 @@ | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✗ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✗ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✗ | -| auroraStaleDns | ✗ | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✗ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✗ | ✗ | ✗ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✗ | ✗ | ✗ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | diff --git a/docs/using-the-jdbc-driver/CompatibilityEndpoints.md b/docs/using-the-jdbc-driver/CompatibilityEndpoints.md index 81a17ce70..10c76cdce 100644 --- a/docs/using-the-jdbc-driver/CompatibilityEndpoints.md +++ b/docs/using-the-jdbc-driver/CompatibilityEndpoints.md @@ -23,22 +23,22 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | logQuery | ✓ | | dataCache | ✓ | | customEndpoint | ✗ | -| [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ (requires `initialConnection` plugin) | -| [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ (requires `initialConnection` plugin) | -| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | -| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | -| [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ (requires `initialConnection` plugin) | +| [efm](./using-plugins/UsingTheHostMonitoringPlugin.md) | ✓ (requires `initialConnection` plugin) | +| [efm2](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | ✓ (requires `initialConnection` plugin) | +| [failover](./using-plugins/UsingTheFailoverPlugin.md) | ✓ | +| [failover2](./using-plugins/UsingTheFailover2Plugin.md) | ✓ | +| [iam](./using-plugins/UsingTheIamAuthenticationPlugin.md) | ✓ (requires `initialConnection` plugin) | | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | -| auroraStaleDns | ✓ | -| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | +| ~~auroraStaleDns~~ | ✓ | +| [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | | connectTime | ✓ | | [dev](./using-plugins/UsingTheDeveloperPlugin.md) | ✓ | -| fastestResponseStrategy | ✓ | -| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | +| fastestResponseStrategy | ✓ | +| [initialConnection](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | ✓ | | [limitless](./using-plugins/UsingTheLimitlessConnectionPlugin.md) | ✗ | | [bg](./using-plugins/UsingTheBlueGreenPlugin.md) | ✗ | @@ -58,7 +58,7 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✗ | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✓ | ✗ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -85,7 +85,7 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ | ✓ | ✓ | ✓ | -| auroraStaleDns | ✓ | ✗ | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✓ | ✗ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | ✗ | ✗ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | ✓ | ✗ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | ✓ | ✓ | @@ -113,7 +113,7 @@ There are many different URL types (endpoints) that can be used with The AWS JDB | [awsSecretsManager](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | ✓ (requires special configuration) | ✓ (requires special configuration) | | [federatedAuth](./using-plugins/UsingTheFederatedAuthPlugin.md) | ✓ (requires special configuration) | ✓ (requires special configuration) | | [okta](./using-plugins/UsingTheOktaAuthPlugin.md) | ✓ (requires special configuration) | ✓ (requires special configuration) | -| auroraStaleDns | ✗ | ✗ | +| ~~auroraStaleDns~~ | ✗ | ✗ | | [readWriteSplitting](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | ✓ | ✓ | | [auroraConnectionTracker](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | ✓ | ✓ | | [driverMetaData](./using-plugins/UsingTheDriverMetadataConnectionPlugin.md) | ✓ | ✓ | diff --git a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java index 0577c4b31..6345c27fa 100644 --- a/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java +++ b/wrapper/src/main/java/software/amazon/jdbc/plugin/staledns/AuroraStaleDnsPlugin.java @@ -34,7 +34,7 @@ import software.amazon.jdbc.plugin.AbstractConnectionPlugin; /** - * Deprecated. Usee 'initialConnection' plugin instead. + * Deprecated. Use 'initialConnection' plugin instead. * *

After Aurora DB cluster fail over is completed and a cluster has elected a new writer node, the corresponding * cluster (writer) endpoint contains stale data and points to an old writer node. That old writer node plays