SSMProvider (AWS Lambda Powertools for Java library Parameters 1.14.0 API)

java.lang.Object
- software.amazon.lambda.powertools.parameters.BaseProvider
- - software.amazon.lambda.powertools.parameters.SSMProvider

All Implemented Interfaces:: ParamProvider

public class SSMProvider
extends BaseProvider

AWS System Manager Parameter Store Provider

Samples:

     SSMProvider provider = ParamManager.getSsmProvider();

     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);

     // Get a decrypted value, and store it in the cache
     String value = provider.withDecryption().get("key");

     // Get multiple parameter values starting with the same path
     Map params = provider.getMultiple("/path/to/paramters");
     >>> /path/to/parameters/key1 -> value1
     >>> /path/to/parameters/key2 -> value2

     // Get multiple parameter values starting with the same path and recursively
     Map params = provider.recursive().getMultiple("/path/to/paramters");
     >>> /path/to/parameters/key1 -> value1
     >>> /path/to/parameters/key2 -> value2
     >>> /path/to/parameters/others/key3 -> value3

Field Summary
- Fields inherited from class software.amazon.lambda.powertools.parameters.BaseProvider
  cacheManager

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static software.amazon.lambda.powertools.parameters.SSMProvider.Builder`	`builder()` Create a builder that can be used to configure and create a `SSMProvider`.
`SSMProvider`	`defaultMaxAge(int maxAge, java.time.temporal.ChronoUnit unit)` (Optional) Set the default max age for the cache of all parameters.
`protected java.util.Map<java.lang.String,java.lang.String>`	`getMultipleValues(java.lang.String path)` Retrieve multiple parameter values from AWS System Manager Parameter Store. Retrieve all parameters starting with the path provided in parameter. eg.
`java.lang.String`	`getValue(java.lang.String key)` Retrieve the parameter value from the AWS System Manager Parameter Store.
`SSMProvider`	`recursive()` Tells System Manager Parameter Store to retrieve all parameters starting with a path (all levels) Only used with `BaseProvider.getMultiple(String)`.
`protected void`	`resetToDefaults()`
`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`	`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`	`withTransformation(java.lang.Class<? extends Transformer> transformerClass)` Builder method to call before `BaseProvider.get(String)` (Optional) or `BaseProvider.get(String, Class)` (Mandatory).

Methods inherited from class software.amazon.lambda.powertools.parameters.BaseProvider
get, get, getMultiple, now, setTransformationManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getValue
```
public java.lang.String getValue(java.lang.String key)
```
    Retrieve the parameter value from the AWS System Manager Parameter Store.
    
    Specified by:
    
    getValue in class BaseProvider
    
    Parameters:
    
    key - key of the parameter
    
    Returns:
    
    the value of the parameter identified by the key
  - defaultMaxAge
```
public SSMProvider defaultMaxAge(int maxAge,
                                 java.time.temporal.ChronoUnit unit)
```
    (Optional) Set the default max age for the cache of all parameters. Override the default 5 seconds.
    If for some parameters, you need to set a different maxAge, use BaseProvider.withMaxAge(int, ChronoUnit).
    Use BaseProvider.withMaxAge(int, ChronoUnit) after {#defaultMaxAge(int, ChronoUnit)} in the chain.
    Overrides:
    
    defaultMaxAge in class BaseProvider
    
    Parameters:
    
    maxAge - Maximum time to cache the parameter, before calling the underlying parameter store.
    
    unit - Unit of time
    
    Returns:
    the provider itself in order to chain calls (eg.
    provider.defaultMaxAge(10, SECONDS).get("key")
    ).
  - withMaxAge
```
public 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.
    Overrides:
    
    withMaxAge in class BaseProvider
    
    Parameters:
    
    maxAge - Maximum time to cache the parameter, before calling the underlying parameter store.
    
    unit - Unit of time
    
    Returns:
    the provider itself in order to chain calls (eg.
    provider.withMaxAge(10, SECONDS).get("key")
    ).
  - withTransformation
```
public SSMProvider withTransformation(java.lang.Class<? extends Transformer> transformerClass)
```
    Builder method to call before BaseProvider.get(String) (Optional) or BaseProvider.get(String, Class) (Mandatory). to provide a Transformer that will transform the String parameter into something else (String, Object, ...)
    
    Base64Transformer and JsonTransformer are provided for respectively base64 and json content. You can also write your own (see Transformer). Not Thread Safe: calling this method simultaneously by several threads can lead to errors (one Transformer for the wrong target type)
    Overrides:
    
    withTransformation in class BaseProvider
    
    Parameters:
    
    transformerClass - Class of the transformer to apply. For convenience, you can use Transformer.json or Transformer.base64 shortcuts.
    
    Returns:
    the provider itself in order to chain calls (eg.
    provider.withTransformation(json).get("key", MyObject.class)
    ).
  - withDecryption
```
public 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.
    Returns:
    the provider itself in order to chain calls (eg.
    provider.withDecryption().get("key")
    ).
  - recursive
```
public SSMProvider recursive()
```
    Tells System Manager Parameter Store to retrieve all parameters starting with a path (all levels)
    Only used with BaseProvider.getMultiple(String).
    Returns:
    the provider itself in order to chain calls (eg.
    provider.recursive().getMultiple("key")
    ).
  - getMultipleValues
```
protected java.util.Map<java.lang.String,java.lang.String> getMultipleValues(java.lang.String path)
```
    Retrieve multiple parameter values from AWS System Manager Parameter Store.
    Retrieve all parameters starting with the path provided in parameter.
    eg. getMultiple("/foo/bar") will retrieve /foo/bar/baz, foo/bar/biz
    Using recursive(), getMultiple("/foo/bar") will retrieve /foo/bar/baz, foo/bar/biz and foo/bar/buz/boz
    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.
    
    Specified by:
    
    getMultipleValues in class BaseProvider
    
    Parameters:
    
    path - path of the parameter
    
    Returns:
    
    a map containing parameters keys and values. The key is a subpart of the path
    eg. getMultiple("/foo/bar") will retrieve [key="baz", value="valuebaz"] for parameter "/foo/bar/baz"
  - resetToDefaults
```
protected void resetToDefaults()
```
    Overrides:
    
    resetToDefaults in class BaseProvider
  - builder
```
public static software.amazon.lambda.powertools.parameters.SSMProvider.Builder builder()
```
    Create a builder that can be used to configure and create a SSMProvider.
    
    Returns:
    
    a new instance of SSMProvider.Builder

Class SSMProvider

Field Summary

Fields inherited from class software.amazon.lambda.powertools.parameters.BaseProvider

Method Summary

Methods inherited from class software.amazon.lambda.powertools.parameters.BaseProvider

Methods inherited from class java.lang.Object

Method Detail

getValue

defaultMaxAge

withMaxAge

withTransformation

withDecryption

recursive

getMultipleValues

resetToDefaults

builder