diff --git a/docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md b/docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md index 98b21bb4..2807a6f5 100644 --- a/docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md +++ b/docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md @@ -100,20 +100,20 @@ The Wrapper behaves like the target driver when no plugins are used. The AWS Advanced NodeJS Wrapper 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 clusters and RDS Multi-AZ DB clusters. Prevents opening a wrong connection to an old writer instance due to stale DNS after a failover event. This plugin is enabled by default. | None | -| [Host Monitoring Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. This plugin is enabled by default. | None | -| Execution Time Connection Plugin | `executeTime` | Any database | Logs the time taken to execute any client method. | None | -| [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) | `iam` | Aurora | Enables users to connect to their Amazon Aurora clusters using AWS Identity and Access Management (IAM). | [@aws-sdk/rds-signer](https://www.npmjs.com/package/@aws-sdk/rds-signer) | -| [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `secretsManager` | Any database | Enables fetching database credentials from the AWS Secrets Manager service. | [@aws-sdk/client-secrets-manager](https://www.npmjs.com/package/@aws-sdk/client-secrets-manager) | -| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthPlugin.md) | `federatedAuth` | Aurora | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | | -| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthPlugin.md) | `okta` | Aurora | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | | -| Aurora Stale DNS Plugin | `staleDns` | 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 host. This plugin is enabled by default. | 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 | -| [Aurora Initial Connection Strategy Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. | None | -| [Aurora Limitless Connection Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `limitless` | Aurora | Allows users to use Aurora Limitless Database and effectively load-balance load between available transaction routers. | 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 clusters and RDS Multi-AZ DB clusters. Prevents opening a wrong connection to an old writer instance due to stale DNS after a failover event. This plugin is enabled by default. | None | +| [Host Monitoring Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. This plugin is enabled by default. | None | +| Execution Time Connection Plugin | `executeTime` | Any database | Logs the time taken to execute any client method. | None | +| [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) | `iam` | Aurora | Enables users to connect to their Amazon Aurora clusters using AWS Identity and Access Management (IAM). | See the IAM Authentication Connection Plugin [prerequisites](./using-plugins/UsingTheIamAuthenticationPlugin.md#Prerequisites) | +| [AWS Secrets Manager Connection Plugin](./using-plugins/UsingTheAwsSecretsManagerPlugin.md) | `secretsManager` | Any database | Enables fetching database credentials from the AWS Secrets Manager service. | See the IAM Authentication Connection Plugin [prerequisites](./using-plugins/UsingTheAwsSecretsManagerPlugin.md#Prerequisites) | +| [Federated Authentication Plugin](./using-plugins/UsingTheFederatedAuthPlugin.md) | `federatedAuth` | Aurora | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | See the Federated Authentication Plugin [prerequisites](./using-plugins/UsingTheFederatedAuthPlugin.md#Prerequisites) | +| [Okta Authentication Plugin](./using-plugins/UsingTheOktaAuthPlugin.md) | `okta` | Aurora | Enables users to authenticate using Federated Identity and then connect to their Amazon Aurora Cluster using AWS Identity and Access Management (IAM). | See the Okta Authentication Plugin [prerequisites](./using-plugins/UsingTheOktaAuthPlugin.md#Prerequisites) | +| Aurora Stale DNS Plugin | `staleDns` | 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 host. This plugin is enabled by default. | 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 | +| [Aurora Initial Connection Strategy Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. | None | +| [Aurora Limitless Connection Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `limitless` | Aurora | Allows users to use Aurora Limitless Database and effectively load-balance load between available transaction routers. | None | In addition to the built-in plugins, you can also create custom plugins more suitable for your needs. For more information, see [Custom Plugins](../development-guide/LoadablePlugins.md#using-custom-plugins). diff --git a/docs/using-the-nodejs-wrapper/using-plugins/UsingTheFederatedAuthPlugin.md b/docs/using-the-nodejs-wrapper/using-plugins/UsingTheFederatedAuthPlugin.md index dc30eb68..ba213062 100644 --- a/docs/using-the-nodejs-wrapper/using-plugins/UsingTheFederatedAuthPlugin.md +++ b/docs/using-the-nodejs-wrapper/using-plugins/UsingTheFederatedAuthPlugin.md @@ -3,6 +3,14 @@ The Federated Authentication Plugin adds support for authentication via Federated Identity and then database access via IAM. Currently, Microsoft Active Directory Federation Services (AD FS) and Okta are supported. To see information on how to configure and use Okta authentication, see [Using the Okta Authentication Plugin](./UsingTheOktaAuthPlugin.md). +## Prerequisites + +- This plugin requires the following packages to be installed: + - [@aws-sdk/rds-signer](https://www.npmjs.com/package/@aws-sdk/rds-signer) + - [aws-sdk](https://www.npmjs.com/package/aws-sdk) + - [axios-cookiejar-support](https://www.npmjs.com/package/axios-cookiejar-support) + - [entities](https://www.npmjs.com/package/entities) + ## What is Federated Identity Federated Identity allows users to use the same set of credentials to access multiple services or resources across different organizations. This works by having Identity Providers (IdP) that manage and authenticate user credentials, and Service Providers (SP) that are services or resources that can be internal, external, and/or belonging to various organizations. Multiple SPs can establish trust relationships with a single IdP. diff --git a/docs/using-the-nodejs-wrapper/using-plugins/UsingTheOktaAuthPlugin.md b/docs/using-the-nodejs-wrapper/using-plugins/UsingTheOktaAuthPlugin.md index 23e40d63..7ece8ba0 100644 --- a/docs/using-the-nodejs-wrapper/using-plugins/UsingTheOktaAuthPlugin.md +++ b/docs/using-the-nodejs-wrapper/using-plugins/UsingTheOktaAuthPlugin.md @@ -2,6 +2,14 @@ The Okta Authentication Plugin adds support for authentication via Federated Identity and then database access via IAM. +## Prerequisites + +- This plugin requires the following packages to be installed: + - [@aws-sdk/rds-signer](https://www.npmjs.com/package/@aws-sdk/rds-signer) + - [aws-sdk](https://www.npmjs.com/package/aws-sdk) + - [axios](https://www.npmjs.com/package/axios) + - [entities](https://www.npmjs.com/package/entities) + ## What is Federated Identity Federated Identity allows users to use the same set of credentials to access multiple services or resources across different organizations. This works by having Identity Providers (IdP) that manage and authenticate user credentials, and Service Providers (SP) that are services or resources that can be internal, external, and/or belonging to various organizations. Multiple SPs can establish trust relationships with a single IdP.