software.amazon.lambda.powertools.parameters

Class AppConfigProvider

java.lang.Object

software.amazon.lambda.powertools.parameters.BaseProvider

software.amazon.lambda.powertools.parameters.AppConfigProvider

All Implemented Interfaces:

ParamProvider

public class AppConfigProvider
extends BaseProvider

Implements a ParamProvider on top of the AppConfig service. AppConfig provides a mechanism to retrieve and update configuration of applications over time. AppConfig requires the user to create an application, environment, and configuration profile. The configuration profile's value can then be retrieved, by key name, through this provider.

Because AppConfig is designed to handle rollouts of configuration over time, we must first establish a session for each key we wish to retrieve, and then poll the session for the latest value when the user re-requests it. This means we must hold a keyed set of session tokens and values.

See Also:

Parameters provider documentation, AppConfig documentation

Field Summary

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

cacheManager, PARAMETERS

Method Summary

Modifier and Type	Method and Description
static software.amazon.lambda.powertools.parameters.AppConfigProvider.Builder	builder() Create a builder that can be used to configure and create a AppConfigProvider.
protected java.util.Map<java.lang.String,java.lang.String>	getMultipleValues(java.lang.String path) Retrieve multiple parameter values from the underlying parameter store. Abstract: Implement this method in a child class of BaseProvider
protected java.lang.String	getValue(java.lang.String key) Retrieve the parameter value from the AppConfig parameter store.

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

defaultMaxAge, get, get, getMultiple, now, resetToDefaults, setTransformationManager, withMaxAge, withTransformation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static software.amazon.lambda.powertools.parameters.AppConfigProvider.Builder builder()

Create a builder that can be used to configure and create a AppConfigProvider.

Returns:

a new instance of AppConfigProvider.Builder

getValue

protected java.lang.String getValue(java.lang.String key)

Retrieve the parameter value from the AppConfig parameter store.

Specified by:

getValue in class BaseProvider

Parameters:

key - key of the parameter. This ties back to AppConfig's 'profile' concept

Returns:

the value of the parameter identified by the key

getMultipleValues

protected java.util.Map<java.lang.String,java.lang.String> getMultipleValues(java.lang.String path)

Description copied from class: BaseProvider

Retrieve multiple parameter values from the underlying parameter store.
Abstract: Implement this method in a child class of BaseProvider

Specified by:

getMultipleValues in class BaseProvider

Parameters:

path - Parameter store path

Returns:

Return map of parameter name value pairs