feat: use botocore.config.Config for parameter providers

Author: nmoutschen

aws_lambda_powertools/utilities/parameters/dynamodb.py

@@ -7,6 +7,7 @@
 
 import boto3
 from boto3.dynamodb.conditions import Key
+from botocore.config import Config
 
 from .base import BaseProvider
 
@@ -21,16 +22,14 @@ class DynamoDBProvider(BaseProvider):
     value_attr = None
 
     def __init__(
-        self, table_name: str, key_attr: str = "id", value_attr: str = "value", region: Optional[str] = None,
+        self, table_name: str, key_attr: str = "id", value_attr: str = "value", config: Optional[Config] = None,
     ):
         """
         Initialize the DynamoDB client
         """
 
-        client_kwargs = {}
-        if region:
-            client_kwargs["region_name"] = region
-        self.table = boto3.resource("dynamodb", **client_kwargs).Table(table_name)
+        config = config or Config()
+        self.table = boto3.resource("dynamodb", config=config).Table(table_name)
 
         self.key_attr = key_attr
         self.value_attr = value_attr

aws_lambda_powertools/utilities/parameters/secrets.py

@@ -6,6 +6,7 @@
 from typing import Dict, Optional, Union
 
 import boto3
+from botocore.config import Config
 
 from .base import DEFAULT_PROVIDERS, BaseProvider
 
@@ -17,16 +18,14 @@ class SecretsProvider(BaseProvider):
 
     client = None
 
-    def __init__(self, region: Optional[str] = None):
+    def __init__(self, config: Optional[Config] = None):
         """
         Initialize the Secrets Manager client
         """
 
-        client_kwargs = {}
-        if region:
-            client_kwargs["region_name"] = region
+        config = config or Config()
 
-        self.client = boto3.client("secretsmanager", **client_kwargs)
+        self.client = boto3.client("secretsmanager", config=config)
 
         super().__init__()
 

aws_lambda_powertools/utilities/parameters/ssm.py

@@ -6,6 +6,7 @@
 from typing import Dict, Optional, Union
 
 import boto3
+from botocore.config import Config
 
 from .base import DEFAULT_PROVIDERS, BaseProvider
 
@@ -18,17 +19,14 @@ class SSMProvider(BaseProvider):
     client = None
 
     def __init__(
-        self, region: Optional[str] = None,
+        self, config: Optional[Config] = None,
     ):
         """
         Initialize the SSM Parameter Store client
         """
 
-        client_kwargs = {}
-        if region:
-            client_kwargs["region_name"] = region
-
-        self.client = boto3.client("ssm", **client_kwargs)
+        config = config or Config()
+        self.client = boto3.client("ssm", config=config)
 
         super().__init__()
 

tests/functional/test_utilities_parameters.py

@@ -8,6 +8,7 @@
 import pytest
 from boto3.dynamodb.conditions import Key
 from botocore import stub
+from botocore.config import Config
 
 from aws_lambda_powertools.utilities import parameters
 from aws_lambda_powertools.utilities.parameters.base import BaseProvider, ExpirableValue
@@ -30,15 +31,20 @@ def mock_version():
     return random.randrange(1, 1000)
 
 
-def test_dynamodb_provider_get(mock_name, mock_value):
+@pytest.fixture(scope="module")
+def config():
+    return Config(region_name="us-east-1")
+
+
+def test_dynamodb_provider_get(mock_name, mock_value, config):
     """
     Test DynamoDBProvider.get() with a non-cached value
     """
 
     table_name = "TEST_TABLE"
 
     # Create a new provider
-    provider = parameters.DynamoDBProvider(table_name, region="us-east-1")
+    provider = parameters.DynamoDBProvider(table_name, config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.table.meta.client)
@@ -56,9 +62,9 @@ def test_dynamodb_provider_get(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_dynamodb_provider_get_default_region(monkeypatch, mock_name, mock_value):
+def test_dynamodb_provider_get_default_config(monkeypatch, mock_name, mock_value):
     """
-    Test DynamoDBProvider.get() without setting a region
+    Test DynamoDBProvider.get() without setting a config
     """
 
     monkeypatch.setenv("AWS_DEFAULT_REGION", "us-east-1")
@@ -84,15 +90,15 @@ def test_dynamodb_provider_get_default_region(monkeypatch, mock_name, mock_value
         stubber.deactivate()
 
 
-def test_dynamodb_provider_get_cached(mock_name, mock_value):
+def test_dynamodb_provider_get_cached(mock_name, mock_value, config):
     """
     Test DynamoDBProvider.get() with a cached value
     """
 
     table_name = "TEST_TABLE"
 
     # Create a new provider
-    provider = parameters.DynamoDBProvider(table_name, region="us-east-1")
+    provider = parameters.DynamoDBProvider(table_name, config=config)
 
     # Inject value in the internal store
     provider.store[(mock_name, None)] = ExpirableValue(mock_value, datetime.now() + timedelta(seconds=60))
@@ -110,15 +116,15 @@ def test_dynamodb_provider_get_cached(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_dynamodb_provider_get_expired(mock_name, mock_value):
+def test_dynamodb_provider_get_expired(mock_name, mock_value, config):
     """
     Test DynamoDBProvider.get() with a cached but expired value
     """
 
     table_name = "TEST_TABLE"
 
     # Create a new provider
-    provider = parameters.DynamoDBProvider(table_name, region="us-east-1")
+    provider = parameters.DynamoDBProvider(table_name, config=config)
 
     # Inject value in the internal store
     provider.store[(mock_name, None)] = ExpirableValue(mock_value, datetime.now() - timedelta(seconds=60))
@@ -139,7 +145,7 @@ def test_dynamodb_provider_get_expired(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_dynamodb_provider_get_multiple(mock_name, mock_value):
+def test_dynamodb_provider_get_multiple(mock_name, mock_value, config):
     """
     Test DynamoDBProvider.get_multiple() with a non-cached path
     """
@@ -148,7 +154,7 @@ def test_dynamodb_provider_get_multiple(mock_name, mock_value):
     table_name = "TEST_TABLE"
 
     # Create a new provider
-    provider = parameters.DynamoDBProvider(table_name, region="us-east-1")
+    provider = parameters.DynamoDBProvider(table_name, config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.table.meta.client)
@@ -175,7 +181,7 @@ def test_dynamodb_provider_get_multiple(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_dynamodb_provider_get_multiple_next_token(mock_name, mock_value):
+def test_dynamodb_provider_get_multiple_next_token(mock_name, mock_value, config):
     """
     Test DynamoDBProvider.get_multiple() with a non-cached path
     """
@@ -184,7 +190,7 @@ def test_dynamodb_provider_get_multiple_next_token(mock_name, mock_value):
     table_name = "TEST_TABLE"
 
     # Create a new provider
-    provider = parameters.DynamoDBProvider(table_name, region="us-east-1")
+    provider = parameters.DynamoDBProvider(table_name, config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.table.meta.client)
@@ -228,13 +234,13 @@ def test_dynamodb_provider_get_multiple_next_token(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_ssm_provider_get(mock_name, mock_value, mock_version):
+def test_ssm_provider_get(mock_name, mock_value, mock_version, config):
     """
     Test SSMProvider.get() with a non-cached value
     """
 
     # Create a new provider
-    provider = parameters.SSMProvider(region="us-east-1")
+    provider = parameters.SSMProvider(config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.client)
@@ -263,9 +269,9 @@ def test_ssm_provider_get(mock_name, mock_value, mock_version):
         stubber.deactivate()
 
 
-def test_ssm_provider_get_default_region(monkeypatch, mock_name, mock_value, mock_version):
+def test_ssm_provider_get_default_config(monkeypatch, mock_name, mock_value, mock_version):
     """
-    Test SSMProvider.get() without specifying the region
+    Test SSMProvider.get() without specifying the config
     """
 
     monkeypatch.setenv("AWS_DEFAULT_REGION", "us-east-1")
@@ -300,13 +306,13 @@ def test_ssm_provider_get_default_region(monkeypatch, mock_name, mock_value, moc
         stubber.deactivate()
 
 
-def test_ssm_provider_get_cached(mock_name, mock_value):
+def test_ssm_provider_get_cached(mock_name, mock_value, config):
     """
     Test SSMProvider.get() with a cached value
     """
 
     # Create a new provider
-    provider = parameters.SSMProvider(region="us-east-1")
+    provider = parameters.SSMProvider(config=config)
 
     # Inject value in the internal store
     provider.store[(mock_name, None)] = ExpirableValue(mock_value, datetime.now() + timedelta(seconds=60))
@@ -324,13 +330,13 @@ def test_ssm_provider_get_cached(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_ssm_provider_get_expired(mock_name, mock_value, mock_version):
+def test_ssm_provider_get_expired(mock_name, mock_value, mock_version, config):
     """
     Test SSMProvider.get() with a cached but expired value
     """
 
     # Create a new provider
-    provider = parameters.SSMProvider(region="us-east-1")
+    provider = parameters.SSMProvider(config=config)
 
     # Inject value in the internal store
     provider.store[(mock_name, None)] = ExpirableValue(mock_value, datetime.now() - timedelta(seconds=60))
@@ -362,15 +368,15 @@ def test_ssm_provider_get_expired(mock_name, mock_value, mock_version):
         stubber.deactivate()
 
 
-def test_ssm_provider_get_multiple(mock_name, mock_value, mock_version):
+def test_ssm_provider_get_multiple(mock_name, mock_value, mock_version, config):
     """
     Test SSMProvider.get_multiple() with a non-cached path
     """
 
     mock_param_names = ["A", "B", "C"]
 
     # Create a new provider
-    provider = parameters.SSMProvider(region="us-east-1")
+    provider = parameters.SSMProvider(config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.client)
@@ -406,15 +412,15 @@ def test_ssm_provider_get_multiple(mock_name, mock_value, mock_version):
         stubber.deactivate()
 
 
-def test_ssm_provider_get_multiple_different_path(mock_name, mock_value, mock_version):
+def test_ssm_provider_get_multiple_different_path(mock_name, mock_value, mock_version, config):
     """
     Test SSMProvider.get_multiple() with a non-cached path and names that don't start with the path
     """
 
     mock_param_names = ["A", "B", "C"]
 
     # Create a new provider
-    provider = parameters.SSMProvider(region="us-east-1")
+    provider = parameters.SSMProvider(config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.client)
@@ -450,15 +456,15 @@ def test_ssm_provider_get_multiple_different_path(mock_name, mock_value, mock_ve
         stubber.deactivate()
 
 
-def test_ssm_provider_get_multiple_next_token(mock_name, mock_value, mock_version):
+def test_ssm_provider_get_multiple_next_token(mock_name, mock_value, mock_version, config):
     """
     Test SSMProvider.get_multiple() with a non-cached path with multiple calls
     """
 
     mock_param_names = ["A", "B", "C"]
 
     # Create a new provider
-    provider = parameters.SSMProvider(region="us-east-1")
+    provider = parameters.SSMProvider(config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.client)
@@ -516,13 +522,13 @@ def test_ssm_provider_get_multiple_next_token(mock_name, mock_value, mock_versio
         stubber.deactivate()
 
 
-def test_secrets_provider_get(mock_name, mock_value):
+def test_secrets_provider_get(mock_name, mock_value, config):
     """
     Test SecretsProvider.get() with a non-cached value
     """
 
     # Create a new provider
-    provider = parameters.SecretsProvider(region="us-east-1")
+    provider = parameters.SecretsProvider(config=config)
 
     # Stub the boto3 client
     stubber = stub.Stubber(provider.client)
@@ -546,9 +552,9 @@ def test_secrets_provider_get(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_secrets_provider_get_default_region(monkeypatch, mock_name, mock_value):
+def test_secrets_provider_get_default_config(monkeypatch, mock_name, mock_value):
     """
-    Test SecretsProvider.get() without specifying a region
+    Test SecretsProvider.get() without specifying a config
     """
 
     monkeypatch.setenv("AWS_DEFAULT_REGION", "us-east-1")
@@ -578,13 +584,13 @@ def test_secrets_provider_get_default_region(monkeypatch, mock_name, mock_value)
         stubber.deactivate()
 
 
-def test_secrets_provider_get_cached(mock_name, mock_value):
+def test_secrets_provider_get_cached(mock_name, mock_value, config):
     """
     Test SecretsProvider.get() with a cached value
     """
 
     # Create a new provider
-    provider = parameters.SecretsProvider(region="us-east-1")
+    provider = parameters.SecretsProvider(config=config)
 
     # Inject value in the internal store
     provider.store[(mock_name, None)] = ExpirableValue(mock_value, datetime.now() + timedelta(seconds=60))
@@ -602,13 +608,13 @@ def test_secrets_provider_get_cached(mock_name, mock_value):
         stubber.deactivate()
 
 
-def test_secrets_provider_get_expired(mock_name, mock_value):
+def test_secrets_provider_get_expired(mock_name, mock_value, config):
     """
     Test SecretsProvider.get() with a cached but expired value
     """
 
     # Create a new provider
-    provider = parameters.SecretsProvider(region="us-east-1")
+    provider = parameters.SecretsProvider(config=config)
 
     # Inject value in the internal store
     provider.store[(mock_name, None)] = ExpirableValue(mock_value, datetime.now() - timedelta(seconds=60))