Skip to content

Commit 8089f8a

Browse files
fix(parameters): invalidate cache after set_parameter and set_secret (#8622)
* fix(parameters): invalidate cache after set_parameter and set_secret * test(parameters): fix SSM cache invalidation test fixtures --------- Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
1 parent ede714e commit 8089f8a

4 files changed

Lines changed: 397 additions & 21 deletions

File tree

‎aws_lambda_powertools/utilities/parameters/base.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,30 @@ def _get_multiple(self, path: str, **sdk_options) -> dict[str, str]:
206206
def clear_cache(self):
207207
self.store.clear()
208208

209+
def _invalidate_cache(self, name: str) -> None:
210+
"""Remove cached values for a single parameter or secret name, across all transforms
211+
212+
Only entries holding a single value are removed. Grouped entries, created by
213+
``get_multiple``, hold the values of multiple names under a single key, so they
214+
are kept intact to avoid evicting unrelated values. Use ``force_fetch=True``
215+
on the next read to refresh grouped results.
216+
217+
Parameters
218+
----------
219+
name: str
220+
Parameter or secret name whose cached values should be removed
221+
"""
222+
for key in list(self.store):
223+
if key[0] != name:
224+
continue
225+
226+
# Grouped entries hold multiple values under one key; their third element is is_nested=True.
227+
# Keys can also carry a fourth sdk_options element and can be two-element batch keys.
228+
if len(key) >= 3 and key[2]:
229+
continue
230+
231+
del self.store[key]
232+
209233
def fetch_from_cache(self, key: tuple):
210234
return self.store[key].value if key in self.store else {}
211235

‎aws_lambda_powertools/utilities/parameters/secrets.py‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,13 +411,18 @@ def set(
411411

412412
try:
413413
logger.debug(f"Attempting to update secret {name}")
414-
return self._update_secret(name=name, **sdk_options)
414+
response = self._update_secret(name=name, **sdk_options)
415415
except self.client.exceptions.ResourceNotFoundException:
416416
logger.debug(f"Secret {name} doesn't exist, creating a new one")
417-
return self._create_secret(name=name, **sdk_options)
417+
response = self._create_secret(name=name, **sdk_options)
418418
except Exception as exc:
419419
raise SetSecretError(f"Error setting secret - {str(exc)}") from exc
420420

421+
# Remove any cached value for this secret so the next read returns what we just wrote
422+
self._invalidate_cache(name)
423+
424+
return response
425+
421426

422427
@overload
423428
def get_secret(

‎aws_lambda_powertools/utilities/parameters/ssm.py‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,10 +364,15 @@ def set(
364364
opts["KeyId"] = kms_key_id
365365

366366
try:
367-
return self.client.put_parameter(**opts)
367+
response = self.client.put_parameter(**opts)
368368
except Exception as exc:
369369
raise SetParameterError(f"Error setting parameter - {str(exc)}") from exc
370370

371+
# Remove any cached value for this parameter so the next read returns what we just wrote
372+
self._invalidate_cache(name)
373+
374+
return response
375+
371376
def _get(self, name: str, decrypt: bool = False, **sdk_options) -> str:
372377
"""
373378
Retrieve a parameter value from AWS Systems Manager Parameter Store

0 commit comments

Comments
 (0)