aws-advanced-python-wrapper 1.2.0__tar.gz → 1.4.0__tar.gz

aws_advanced_python_wrapper-1.4.0/NOTICE

@@ -0,0 +1,2 @@
+AWS Advanced Python Wrapper
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

{aws_advanced_python_wrapper-1.2.0 → aws_advanced_python_wrapper-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: aws-advanced-python-wrapper
-Version: 1.2.0
+Name: aws_advanced_python_wrapper
+Version: 1.4.0
 Summary: Amazon Web Services (AWS) Advanced Python Wrapper
 Home-page: https://github.com/awslabs/aws-advanced-python-wrapper
 License: Apache-2.0
@@ -15,12 +15,9 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Requires-Dist: aws-xray-sdk (>=2.13.1,<3.0.0)
 Requires-Dist: boto3 (>=1.34.111,<2.0.0)
 Requires-Dist: opentelemetry-api (>=1.22.0,<2.0.0)
@@ -83,10 +80,9 @@ with AwsWrapperConnection.connect(
         autocommit=True
 ) as awsconn:
     awscursor = awsconn.cursor()
-    awscursor.execute("SELECT aurora_db_instance_identifier()")
-    awscursor.fetchone()
-    for record in awscursor:
-        print(record)
+    awscursor.execute("SELECT pg_catalog.aurora_db_instance_identifier()")
+    row = awscursor.fetchone()
+    print(row)
 ```
 The `AwsWrapperConnection#connect` method accepts the connection configuration through both the connection string and the keyword arguments.
 
@@ -107,9 +103,8 @@ with AwsWrapperConnection.connect(
 ) as awsconn:
     awscursor = awsconn.cursor()
     awscursor.execute("SELECT @@aurora_server_id")
-    awscursor.fetchone()
-    for record in awscursor:
-        print(record)
+    row = awscursor.fetchone()
+    print(row)
 ```
 
 For more details on how to download the AWS Advanced Python Driver, minimum requirements to use it, 
@@ -155,6 +150,8 @@ The following table lists the connection properties used with the AWS Advanced P
 | `secrets_manager_secret_id`                  |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
 | `secrets_manager_region`                     |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
 | `secrets_manager_endpoint`                   |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
+| `secrets_manager_secret_username`            |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
+| `secrets_manager_secret_password`            |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
 | `reader_host_selector_strategy`              | [Connection Strategy](./docs/using-the-python-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#connection-strategies) |
 | `db_user`                                    |   [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)    |
 | `idp_username`                               |   [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)    |
@@ -181,9 +178,13 @@ To find all the documentation and concrete examples on how to use the AWS Advanc
 
 #### Amazon RDS Blue/Green Deployments
 
-This driver currently does not support switchover in Amazon RDS Blue/Green Deployments. In order to execute a Blue/Green deployment with the driver,
-please ensure your application is coded to retry the database connection. Retry will allow the driver to re-establish a connection to an available
-database instance. Without a retry, the driver will not be able to identify an available database instance after  blue/green switchover has occurred.
+Support for Blue/Green deployments using the AWS Advanced Python Driver 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](./docs/using-the-python-driver/using-plugins/UsingTheBlueGreenPlugin.md).
 
 #### MySQL Connector/Python C Extension
 
@@ -236,7 +237,7 @@ For all other questions, please use [GitHub discussions](https://github.com/awsl
 
 1. Set up your environment by following the directions in the [Development Guide](./docs/development-guide/DevelopmentGuide.md).
 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 Python 3.7 if we are supporting Python 3.8 and higher).
+3. Make any changes on your fork. Make sure you are aware of the requirements for the project (e.g. do not require Python 3.7 if we are supporting Python 3.8 - 3.11 (inclusive)).
 4. Create a pull request from your fork. 
 5. Pull requests need to be approved and merged by maintainers into the main branch. <br />
 

{aws_advanced_python_wrapper-1.2.0 → aws_advanced_python_wrapper-1.4.0}/README.md

@@ -48,10 +48,9 @@ with AwsWrapperConnection.connect(
         autocommit=True
 ) as awsconn:
     awscursor = awsconn.cursor()
-    awscursor.execute("SELECT aurora_db_instance_identifier()")
-    awscursor.fetchone()
-    for record in awscursor:
-        print(record)
+    awscursor.execute("SELECT pg_catalog.aurora_db_instance_identifier()")
+    row = awscursor.fetchone()
+    print(row)
 ```
 The `AwsWrapperConnection#connect` method accepts the connection configuration through both the connection string and the keyword arguments.
 
@@ -72,9 +71,8 @@ with AwsWrapperConnection.connect(
 ) as awsconn:
     awscursor = awsconn.cursor()
     awscursor.execute("SELECT @@aurora_server_id")
-    awscursor.fetchone()
-    for record in awscursor:
-        print(record)
+    row = awscursor.fetchone()
+    print(row)
 ```
 
 For more details on how to download the AWS Advanced Python Driver, minimum requirements to use it, 
@@ -120,6 +118,8 @@ The following table lists the connection properties used with the AWS Advanced P
 | `secrets_manager_secret_id`                  |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
 | `secrets_manager_region`                     |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
 | `secrets_manager_endpoint`                   |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
+| `secrets_manager_secret_username`            |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
+| `secrets_manager_secret_password`            |           [Secrets Manager Plugin](./docs/using-the-python-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)           |
 | `reader_host_selector_strategy`              | [Connection Strategy](./docs/using-the-python-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#connection-strategies) |
 | `db_user`                                    |   [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)    |
 | `idp_username`                               |   [Federated Authentication Plugin](./docs/using-the-python-driver/using-plugins/UsingTheFederatedAuthenticationPlugin.md)    |
@@ -146,9 +146,13 @@ To find all the documentation and concrete examples on how to use the AWS Advanc
 
 #### Amazon RDS Blue/Green Deployments
 
-This driver currently does not support switchover in Amazon RDS Blue/Green Deployments. In order to execute a Blue/Green deployment with the driver,
-please ensure your application is coded to retry the database connection. Retry will allow the driver to re-establish a connection to an available
-database instance. Without a retry, the driver will not be able to identify an available database instance after  blue/green switchover has occurred.
+Support for Blue/Green deployments using the AWS Advanced Python Driver 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](./docs/using-the-python-driver/using-plugins/UsingTheBlueGreenPlugin.md).
 
 #### MySQL Connector/Python C Extension
 
@@ -201,7 +205,7 @@ For all other questions, please use [GitHub discussions](https://github.com/awsl
 
 1. Set up your environment by following the directions in the [Development Guide](./docs/development-guide/DevelopmentGuide.md).
 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 Python 3.7 if we are supporting Python 3.8 and higher).
+3. Make any changes on your fork. Make sure you are aware of the requirements for the project (e.g. do not require Python 3.7 if we are supporting Python 3.8 - 3.11 (inclusive)).
 4. Create a pull request from your fork. 
 5. Pull requests need to be approved and merged by maintainers into the main branch. <br />
 

{aws_advanced_python_wrapper-1.2.0 → aws_advanced_python_wrapper-1.4.0}/aws_advanced_python_wrapper/aurora_connection_tracker_plugin.py

@@ -173,19 +173,6 @@ class AuroraConnectionTrackerPlugin(Plugin):
             props: Properties,
             is_initial_connection: bool,
             connect_func: Callable) -> Connection:
-        return self._connect(host_info, connect_func)
-
-    def force_connect(
-            self,
-            target_driver_func: Callable,
-            driver_dialect: DriverDialect,
-            host_info: HostInfo,
-            props: Properties,
-            is_initial_connection: bool,
-            force_connect_func: Callable) -> Connection:
-        return self._connect(host_info, force_connect_func)
-
-    def _connect(self, host_info: HostInfo, connect_func: Callable):
         conn = connect_func()
 
         if conn:

{aws_advanced_python_wrapper-1.2.0 → aws_advanced_python_wrapper-1.4.0}/aws_advanced_python_wrapper/aurora_initial_connection_strategy_plugin.py

@@ -35,9 +35,7 @@ from aws_advanced_python_wrapper.utils.rdsutils import RdsUtils
 
 
 class AuroraInitialConnectionStrategyPlugin(Plugin):
-    _SUBSCRIBED_METHODS: Set[str] = {"init_host_provider",
-                                     "connect",
-                                     "force_connect"}
+    _SUBSCRIBED_METHODS: Set[str] = {"init_host_provider", "connect"}
 
     _host_list_provider_service: Optional[HostListProviderService] = None
 
@@ -52,29 +50,24 @@ class AuroraInitialConnectionStrategyPlugin(Plugin):
 
     def connect(self, target_driver_func: Callable, driver_dialect: DriverDialect, host_info: HostInfo, props: Properties,
                 is_initial_connection: bool, connect_func: Callable) -> Connection:
-        return self._connect(host_info, props, is_initial_connection, connect_func)
-
-    def force_connect(self, target_driver_func: Callable, driver_dialect: DriverDialect, host_info: HostInfo, props: Properties,
-                      is_initial_connection: bool, force_connect_func: Callable) -> Connection:
-        return self._connect(host_info, props, is_initial_connection, force_connect_func)
-
-    def _connect(self, host_info: HostInfo, props: Properties, is_initial_connection: bool, connect_func: Callable):
-        type: RdsUrlType = self._rds_utils.identify_rds_type(host_info.host)
-        if not type.is_rds_cluster:
+        url_type: RdsUrlType = self._rds_utils.identify_rds_type(host_info.host)
+        if not url_type.is_rds_cluster:
             return connect_func()
 
-        if type == RdsUrlType.RDS_WRITER_CLUSTER:
+        if url_type == RdsUrlType.RDS_WRITER_CLUSTER:
             writer_candidate_conn: Optional[Connection] = self._get_verified_writer_connection(props, is_initial_connection, connect_func)
             if writer_candidate_conn is None:
                 return connect_func()
             return writer_candidate_conn
 
-        if type == RdsUrlType.RDS_READER_CLUSTER:
+        if url_type == RdsUrlType.RDS_READER_CLUSTER:
             reader_candidate_conn: Optional[Connection] = self._get_verified_reader_connection(props, is_initial_connection, connect_func)
             if reader_candidate_conn is None:
                 return connect_func()
             return reader_candidate_conn
 
+        return connect_func()
+
     def _get_verified_writer_connection(self, props: Properties, is_initial_connection: bool, connect_func: Callable) -> Connection | None:
         retry_delay_ms: int = WrapperProperties.OPEN_CONNECTION_RETRY_INTERVAL_MS.get_int(props)
         end_time_nano = perf_counter_ns() + (WrapperProperties.OPEN_CONNECTION_RETRY_INTERVAL_MS.get_int(props) * 1000000)
@@ -84,7 +77,6 @@ class AuroraInitialConnectionStrategyPlugin(Plugin):
 
         while perf_counter_ns() < end_time_nano:
             writer_candidate_conn = None
-            writer_candidate = None
 
             try:
                 writer_candidate = self._get_writer()
@@ -94,7 +86,7 @@ class AuroraInitialConnectionStrategyPlugin(Plugin):
                     self._plugin_service.force_refresh_host_list(writer_candidate_conn)
                     writer_candidate = self._plugin_service.identify_connection(writer_candidate_conn)
 
-                    if writer_candidate is not None and writer_candidate.role != HostRole.WRITER:
+                    if writer_candidate is None or writer_candidate.role != HostRole.WRITER:
                         self._close_connection(writer_candidate_conn)
                         self._delay(retry_delay_ms)
                         continue
@@ -141,6 +133,11 @@ class AuroraInitialConnectionStrategyPlugin(Plugin):
                     self._plugin_service.force_refresh_host_list(reader_candidate_conn)
                     reader_candidate = self._plugin_service.identify_connection(reader_candidate_conn)
 
+                    if reader_candidate is None:
+                        self._close_connection(reader_candidate_conn)
+                        self._delay(retry_delay_ms)
+                        continue
+
                     if reader_candidate is not None and reader_candidate.role != HostRole.READER:
                         if self._has_no_readers():
                             # Cluster has no readers. Simulate Aurora reader cluster endpoint logic and return the current writer connection.

{aws_advanced_python_wrapper-1.2.0 → aws_advanced_python_wrapper-1.4.0}/aws_advanced_python_wrapper/aws_secrets_manager_plugin.py

@@ -17,11 +17,13 @@ from __future__ import annotations
 from json import JSONDecodeError, loads
 from re import search
 from types import SimpleNamespace
-from typing import TYPE_CHECKING, Callable, Dict, Optional, Set, Tuple
+from typing import TYPE_CHECKING, Callable, Optional, Set, Tuple
 
 import boto3
 from botocore.exceptions import ClientError, EndpointConnectionError
 
+from aws_advanced_python_wrapper.utils.cache_map import CacheMap
+
 if TYPE_CHECKING:
     from boto3 import Session
     from aws_advanced_python_wrapper.driver_dialect import DriverDialect
@@ -46,8 +48,10 @@ class AwsSecretsManagerPlugin(Plugin):
     _SUBSCRIBED_METHODS: Set[str] = {"connect", "force_connect"}
 
     _SECRETS_ARN_PATTERN = r"^arn:aws:secretsmanager:(?P<region>[^:\n]*):[^:\n]*:([^:/\n]*[:/])?(.*)$"
+    _ONE_YEAR_IN_SECONDS = 60 * 60 * 24 * 365
 
-    _secrets_cache: Dict[Tuple, SimpleNamespace] = {}
+    _secret: Optional[SimpleNamespace] = None
+    _secrets_cache: CacheMap[Tuple, SimpleNamespace] = CacheMap()
     _secret_key: Tuple = ()
 
     @property
@@ -94,7 +98,13 @@ class AwsSecretsManagerPlugin(Plugin):
         return self._connect(props, force_connect_func)
 
     def _connect(self, props: Properties, connect_func: Callable) -> Connection:
-        secret_fetched: bool = self._update_secret()
+        token_expiration_sec: int = WrapperProperties.SECRETS_MANAGER_EXPIRATION.get_int(props)
+        # if value is less than 0, default to one year
+        if token_expiration_sec < 0:
+            token_expiration_sec = AwsSecretsManagerPlugin._ONE_YEAR_IN_SECONDS
+        token_expiration_ns = token_expiration_sec * 1_000_000_000
+
+        secret_fetched: bool = self._update_secret(token_expiration_ns=token_expiration_ns)
 
         try:
             self._apply_secret_to_properties(props)
@@ -105,7 +115,7 @@ class AwsSecretsManagerPlugin(Plugin):
                 raise AwsWrapperError(
                     Messages.get_formatted("AwsSecretsManagerPlugin.ConnectException", e)) from e
 
-            secret_fetched = self._update_secret(True)
+            secret_fetched = self._update_secret(token_expiration_ns=token_expiration_ns, force_refetch=True)
 
             if secret_fetched:
                 try:
@@ -117,9 +127,10 @@ class AwsSecretsManagerPlugin(Plugin):
                                                unhandled_error)) from unhandled_error
             raise AwsWrapperError(Messages.get_formatted("AwsSecretsManagerPlugin.FailedLogin", e)) from e
 
-    def _update_secret(self, force_refetch: bool = False) -> bool:
+    def _update_secret(self, token_expiration_ns: int, force_refetch: bool = False) -> bool:
         """
         Called to update credentials from the cache, or from the AWS Secrets Manager service.
+        :param token_expiration_ns: Expiration time in nanoseconds for secret stored in cache.
         :param force_refetch: Allows ignoring cached credentials and force fetches the latest credentials from the service.
         :return: `True`, if credentials were fetched from the service.
         """
@@ -135,7 +146,7 @@ class AwsSecretsManagerPlugin(Plugin):
                 try:
                     self._secret = self._fetch_latest_credentials()
                     if self._secret:
-                        AwsSecretsManagerPlugin._secrets_cache[self._secret_key] = self._secret
+                        AwsSecretsManagerPlugin._secrets_cache.put(self._secret_key, self._secret, token_expiration_ns)
                         fetched = True
                 except (ClientError, AttributeError) as e:
                     logger.debug("AwsSecretsManagerPlugin.FailedToFetchDbCredentials", e)
@@ -188,12 +199,15 @@ class AwsSecretsManagerPlugin(Plugin):
         """
         Updates credentials in provided properties. Other plugins in the plugin chain may change them if needed.
         Eventually, credentials will be used to open a new connection in :py:class:`DefaultConnectionPlugin`.
-
-        :param properties: Properties to store credentials.
         """
         if self._secret:
-            WrapperProperties.USER.set(properties, self._secret.username)
-            WrapperProperties.PASSWORD.set(properties, self._secret.password)
+            username_key = WrapperProperties.SECRETS_MANAGER_SECRET_USERNAME_KEY.get(properties)
+            username_value = getattr(self._secret, str(username_key))
+            WrapperProperties.USER.set(properties, username_value)
+
+            password_key = WrapperProperties.SECRETS_MANAGER_SECRET_PASSWORD_KEY.get(properties)
+            password_value = getattr(self._secret, str(password_key))
+            WrapperProperties.PASSWORD.set(properties, password_value)
 
     def _get_rds_region(self, secret_id: str, props: Properties) -> str:
         session = self._session if self._session else boto3.Session()