Class SecretsProvider
java.lang.Object
software.amazon.lambda.powertools.parameters.BaseProvider
software.amazon.lambda.powertools.parameters.secrets.SecretsProvider
- All Implemented Interfaces:
ParamProvider
AWS Secrets Manager Parameter Provider
Samples:
Samples:
SecretsProvider provider = SecretsProvider.builder().build();
String value = provider.get("key");
System.out.println(value);
>>> "value"
// Get a value and cache it for 30 seconds (all others values will now be cached for 30 seconds)
String value = provider.defaultMaxAge(30, ChronoUnit.SECONDS).get("key");
// Get a value and cache it for 1 minute (all others values are cached for 5 seconds by default)
String value = provider.withMaxAge(1, ChronoUnit.MINUTES).get("key");
// Get a base64 encoded value, decoded into a String, and store it in the cache
String value = provider.withTransformation(Transformer.base64).get("key");
// Get a json value, transform it into an Object, and store it in the cache
TargetObject = provider.withTransformation(Transformer.json).get("key", TargetObject.class);
-
Field Summary
Fields inherited from class software.amazon.lambda.powertools.parameters.BaseProvider
cacheManager, PARAMETERS -
Method Summary
Modifier and TypeMethodDescriptionstatic SecretsProviderBuilderbuilder()Create a builder that can be used to configure and create aSecretsProvider.static SecretsProvidercreate()Create a SecretsProvider with all default settings.getMultipleValues(String path) protected StringRetrieve the parameter value from the AWS Secrets Manager.Methods inherited from class software.amazon.lambda.powertools.parameters.BaseProvider
get, get, getMultiple, now, resetToDefaults, withMaxAge, withTransformation
-
Method Details
-
builder
Create a builder that can be used to configure and create aSecretsProvider.- Returns:
- a new instance of
SecretsProviderBuilder
-
create
Create a SecretsProvider with all default settings. -
getValue
Retrieve the parameter value from the AWS Secrets Manager.- Specified by:
getValuein classBaseProvider- Parameters:
key- key of the parameter- Returns:
- the value of the parameter identified by the key
-
getMultipleValues
- Specified by:
getMultipleValuesin classBaseProvider- Throws:
UnsupportedOperationException- as it is not possible to get multiple values simultaneously from Secrets Manager
-