Package | Description |
---|---|
software.amazon.lambda.powertools.parameters |
Modifier and Type | Method and Description |
---|---|
SSMProvider |
SSMProvider.defaultMaxAge(int maxAge,
java.time.temporal.ChronoUnit unit)
(Optional) Set the default max age for the cache of all parameters.
|
static SSMProvider |
ParamManager.getSsmProvider()
Get a
SSMProvider with default SsmClient .If you need to customize the region, or other part of the client, use ParamManager.getSsmProvider(SsmClient) instead. |
static SSMProvider |
ParamManager.getSsmProvider(software.amazon.awssdk.services.ssm.SsmClient client)
Get a
SSMProvider with your custom SsmClient .Use this to configure region or other part of the client. |
SSMProvider |
SSMProvider.recursive()
Tells System Manager Parameter Store to retrieve all parameters starting with a path (all levels)
Only used with BaseProvider.getMultiple(String) . |
SSMProvider |
SSMProvider.withDecryption()
Tells System Manager Parameter Store to decrypt the parameter value.
By default, parameter values are not decrypted. Valid both for get and getMultiple. |
SSMProvider |
SSMProvider.withMaxAge(int maxAge,
java.time.temporal.ChronoUnit unit)
(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 set with BaseProvider.defaultMaxAge(int, java.time.temporal.ChronoUnit) ) 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. |
SSMProvider |
SSMProvider.withTransformation(java.lang.Class<? extends Transformer> transformerClass)
Builder method to call before
BaseProvider.get(String) (Optional) or BaseProvider.get(String, Class) (Mandatory). |
Copyright © 2021. All rights reserved.