Index

A B C D G H J N P R S T U W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

applyTransformation(String) - Method in class software.amazon.lambda.powertools.parameters.transform.Base64Transformer
 
applyTransformation(String) - Method in class software.amazon.lambda.powertools.parameters.transform.BasicTransformer
 
applyTransformation(String, Class<String>) - Method in class software.amazon.lambda.powertools.parameters.transform.BasicTransformer
 
applyTransformation(String, Class<T>) - Method in class software.amazon.lambda.powertools.parameters.transform.JsonTransformer
 
applyTransformation(String, Class<T>) - Method in interface software.amazon.lambda.powertools.parameters.transform.Transformer
Apply a transformation on the input value (String)

B

base64 - Static variable in interface software.amazon.lambda.powertools.parameters.transform.Transformer
Convenient access to Base64Transformer, to use in providers (
Base64Transformer - Class in software.amazon.lambda.powertools.parameters.transform
Transformer that take a base64 encoded string and return a decoded string.
Base64Transformer() - Constructor for class software.amazon.lambda.powertools.parameters.transform.Base64Transformer
 
BaseParamAspect - Class in software.amazon.lambda.powertools.parameters
Provides a common base for all parameter aspects.
BaseParamAspect() - Constructor for class software.amazon.lambda.powertools.parameters.BaseParamAspect
 
BaseProvider - Class in software.amazon.lambda.powertools.parameters
Base class for all parameter providers.
BaseProvider(CacheManager, TransformationManager) - Constructor for class software.amazon.lambda.powertools.parameters.BaseProvider
 
BasicTransformer - Class in software.amazon.lambda.powertools.parameters.transform
Abstract transformer that take a String and transform it in another String.
BasicTransformer() - Constructor for class software.amazon.lambda.powertools.parameters.transform.BasicTransformer
 

C

cacheManager - Variable in class software.amazon.lambda.powertools.parameters.BaseProvider
 
CacheManager - Class in software.amazon.lambda.powertools.parameters.cache
Manages caching of parameter values with configurable expiration times.
CacheManager() - Constructor for class software.amazon.lambda.powertools.parameters.cache.CacheManager
 

D

DataStore - Class in software.amazon.lambda.powertools.parameters.cache
Internal store used to cache parameters
DataStore() - Constructor for class software.amazon.lambda.powertools.parameters.cache.DataStore
 

G

get(String) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
Get the value of a parameter, either from the underlying store or a cached value (if not expired).
Using this method, you can apply a basic transformation (to String).
get(String) - Method in class software.amazon.lambda.powertools.parameters.cache.DataStore
 
get(String) - Method in interface software.amazon.lambda.powertools.parameters.ParamProvider
 
get(String, Class<T>) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
Get the value of a parameter, either from the underlying store or a cached value (if not expired).
Using this method, you must apply a transformation (eg. json/xml to Object).
get(String, Class<T>) - Method in interface software.amazon.lambda.powertools.parameters.ParamProvider
 
getAndTransform(String, Class<? extends Transformer>, BaseProvider, FieldSignature) - Method in class software.amazon.lambda.powertools.parameters.BaseParamAspect
Gets the parameter value from the provider and transforms it if necessary.
getIfNotExpired(String, Instant) - Method in class software.amazon.lambda.powertools.parameters.cache.CacheManager
 
getMultiple(String) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
Retrieve multiple parameter values either from the underlying store or a cached value (if not expired).
Cache all values with the 'path' as the key and also individually to be able to BaseProvider.get(String) a single value later
Does not support transformation.
getMultiple(String) - Method in interface software.amazon.lambda.powertools.parameters.ParamProvider
 
getMultipleValues(String) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
Retrieve multiple parameter values from the underlying parameter store.
Abstract: Implement this method in a child class of BaseProvider
getValue(String) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
Retrieve the parameter value from the underlying parameter store.
Abstract: Implement this method in a child class of BaseProvider

H

hasExpired(String, Instant) - Method in class software.amazon.lambda.powertools.parameters.cache.DataStore
 

J

json - Static variable in interface software.amazon.lambda.powertools.parameters.transform.Transformer
Convenient access to JsonTransformer, to use in providers (
JsonTransformer<T> - Class in software.amazon.lambda.powertools.parameters.transform
Transformer that transform a json string into an Object.
JsonTransformer() - Constructor for class software.amazon.lambda.powertools.parameters.transform.JsonTransformer
 

N

now() - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
 

P

PARAMETERS - Static variable in class software.amazon.lambda.powertools.parameters.BaseProvider
 
ParamProvider - Interface in software.amazon.lambda.powertools.parameters
 
performBasicTransformation(String) - Method in class software.amazon.lambda.powertools.parameters.transform.TransformationManager
Transform a String in another String.
performComplexTransformation(String, Class<T>) - Method in class software.amazon.lambda.powertools.parameters.transform.TransformationManager
Transform a String in a Java Object.
put(String, Object, Instant) - Method in class software.amazon.lambda.powertools.parameters.cache.DataStore
 
putInCache(String, T) - Method in class software.amazon.lambda.powertools.parameters.cache.CacheManager
 

R

remove(String) - Method in class software.amazon.lambda.powertools.parameters.cache.DataStore
 
resetExpirationTime() - Method in class software.amazon.lambda.powertools.parameters.cache.CacheManager
 
resetToDefaults() - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
 

S

setDefaultExpirationTime(Duration) - Method in class software.amazon.lambda.powertools.parameters.cache.CacheManager
 
setExpirationTime(Duration) - Method in class software.amazon.lambda.powertools.parameters.cache.CacheManager
 
setTransformer(Class<? extends Transformer>) - Method in class software.amazon.lambda.powertools.parameters.transform.TransformationManager
Set the Transformer to use for transformation.
shouldTransform() - Method in class software.amazon.lambda.powertools.parameters.transform.TransformationManager
 
software.amazon.lambda.powertools.parameters - package software.amazon.lambda.powertools.parameters
 
software.amazon.lambda.powertools.parameters.cache - package software.amazon.lambda.powertools.parameters.cache
 
software.amazon.lambda.powertools.parameters.exception - package software.amazon.lambda.powertools.parameters.exception
 
software.amazon.lambda.powertools.parameters.transform - package software.amazon.lambda.powertools.parameters.transform
 

T

TransformationException - Exception Class in software.amazon.lambda.powertools.parameters.exception
 
TransformationException(Exception) - Constructor for exception class software.amazon.lambda.powertools.parameters.exception.TransformationException
 
TransformationException(String) - Constructor for exception class software.amazon.lambda.powertools.parameters.exception.TransformationException
 
TransformationManager - Class in software.amazon.lambda.powertools.parameters.transform
Manager in charge of transforming parameter values in another format.
TransformationManager() - Constructor for class software.amazon.lambda.powertools.parameters.transform.TransformationManager
 
Transformer<T> - Interface in software.amazon.lambda.powertools.parameters.transform
Interface for parameter transformers.

U

unsetTransformer() - Method in class software.amazon.lambda.powertools.parameters.transform.TransformationManager
Unset the Transformer and clean up thread-local storage.

W

withMaxAge(int, ChronoUnit) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
(Optional) Builder method to call before BaseProvider.get(String) or BaseProvider.get(String, Class) to set cache max age for the parameter to get.

The max age is reset to default (either 5 or a custom value that may be set on the CacheManager) after each get, so you need to use this method for each parameter to cache with non-default max age.

Not Thread Safe: calling this method simultaneously by several threads can lead to unwanted cache time for some parameters.
withTransformation(Class<? extends Transformer>) - Method in class software.amazon.lambda.powertools.parameters.BaseProvider
Builder method to call before BaseProvider.get(String) (Optional) or BaseProvider.get(String, Class) (Mandatory).
A B C D G H J N P R S T U W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form