AbstractProtected Abstract_Retrieve parameter value from the underlying parameter store.
Parameter name
Optionaloptions: unknown
Options to pass to the underlying implemented method
Protected Abstract_Retrieve multiple parameter values from the underlying parameter store.
Parameter name
Optionaloptions: unknown
Options to pass to the underlying implementated method
Add a value to the cache.
Key of the cached value
Value to be cached
Maximum age in seconds for the value to be cached
ProtectedbuildBuild the cache key for a request.
The key covers the method, the name, and every option that can affect the cached value, so requests that would receive different values never share an entry. Object keys are sorted so option order does not matter.
Whether the request is for a single value or multiple values
Parameter name or path
Optionaloptions: object
Options passed to the request
Clear the cache.
Retrieve a parameter value or return the cached value.
Parameter name
Optionaloptions: GetOptionsInterface
Options to configure maximum age, trasformation, AWS SDK options, or force fetch
Retrieve multiple parameter values or return the cached values.
Parameters path
Optionaloptions: GetMultipleOptionsInterface
Options to configure maximum age, trasformation, AWS SDK options, or force fetch
Check whether a key has expired in the cache or not.
It returns true if the key is expired or not present in the cache.
Stringified representation of the key to retrieve
Base class for all providers.
As an abstract class, it should not be used directly, but rather extended by other providers.
It implements the common logic for all providers, such as caching, transformation, etc. Each provider that extends this class must implement the
_getand_getMultipleabstract methods.These methods are responsible for retrieving the values from the underlying parameter store. They are called by the
getandgetMultiplemethods, which are responsible for caching and transformation.Cached values are keyed by the method used, the parameter name, and every request option that can change the value returned by the store (for example
transform,decrypt,recursive, orsdkOptions). Calls that differ in any of these are cached separately, so a value is only ever served to a request that would have produced it.This means that we need to make multiple calls to the underlying parameter store if we need the same parameter in different transforms or with different options. Since a given parameter is usually always requested the same way, this should be an acceptable tradeoff.