Skip to content

Commit 92cf8af

Browse files
authored
docs: Using the federated authentication plugin (#386)
1 parent 418a245 commit 92cf8af

File tree

4 files changed

+76
-29
lines changed

4 files changed

+76
-29
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -82,28 +82,28 @@ and how to integrate it within your project and with your Python driver of choic
8282
### Connection Properties
8383
The following table lists the common connection properties used with the AWS Advanced Python Wrapper.
8484

85-
| Parameter | Documentation Link |
86-
|----------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------:|
85+
| Parameter | Documentation Link |
86+
|----------------------------------------------|:------------------------------------------------------------------------------------------------------------------------:|
8787
| `wrapper_dialect` | [Dialects](./docs/using-the-python-driver/DatabaseDialects.md), and whether you should include it. |
8888
| `plugins` | [Connection Plugin Manager](./docs/using-the-python-driver/UsingThePythonDriver.md#connection-plugin-manager-parameters) |
89-
| `secrets_manager_secret_id` | [SecretsManagerPlugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
90-
| `secrets_manager_region` | [SecretsManagerPlugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
91-
| `enable_failover` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
92-
| `failover_mode` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
93-
| `cluster_instance_host_pattern` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
94-
| `failover_cluster_topology_refresh_rate_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
95-
| `failover_reader_connect_timeout_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
96-
| `failover_timeout_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
97-
| `failover_writer_reconnect_interval_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
98-
| `failure_detection_count` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
99-
| `failure_detection_enabled` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
100-
| `failure_detection_interval_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
101-
| `failure_detection_time_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
102-
| `monitor_disposal_time_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
103-
| `iam_default_port` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
104-
| `iam_host` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
105-
| `iam_region` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
106-
| `iam_expiration` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
89+
| `secrets_manager_secret_id` | [SecretsManagerPlugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
90+
| `secrets_manager_region` | [SecretsManagerPlugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md) |
91+
| `enable_failover` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
92+
| `failover_mode` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
93+
| `cluster_instance_host_pattern` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
94+
| `failover_cluster_topology_refresh_rate_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
95+
| `failover_reader_connect_timeout_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
96+
| `failover_timeout_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
97+
| `failover_writer_reconnect_interval_sec` | [FailoverPlugin](./docs/using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md) |
98+
| `failure_detection_count` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
99+
| `failure_detection_enabled` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
100+
| `failure_detection_interval_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
101+
| `failure_detection_time_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
102+
| `monitor_disposal_time_ms` | [HostMonitoringPlugin](./docs/using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md) |
103+
| `iam_default_port` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
104+
| `iam_host` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
105+
| `iam_region` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
106+
| `iam_expiration` | [IamAuthenticationPlugin](./docs/using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md) |
107107

108108
### Using the AWS Advanced Python Driver
109109

docs/Documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [Plugins](./using-the-python-driver/UsingThePythonDriver.md#plugins)
1010
- [Failover Plugin](./using-the-python-driver/using-plugins/UsingTheFailoverPlugin.md)
1111
- [Failover Configuration Guide](./using-the-python-driver/FailoverConfigurationGuide.md)
12+
- [Federated Authentication Plugin](./using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)
1213
- [Host Monitoring Plugin](./using-the-python-driver/using-plugins/UsingTheHostMonitoringPlugin.md)
1314
- [IAM Authentication Plugin](./using-the-python-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
1415
- [AWS Secrets Manager Plugin](./using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)

0 commit comments

Comments
 (0)