software.amazon.lambda.powertools.parameters

Annotation Type Param

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Param

Param is used to signal that the annotated field should be populated with a value retrieved from a parameter store through a ParamProvider.

By default Param use SSMProvider as parameter provider. This can be overridden specifying the annotation variable Param(provider = <Class-of-the-provider>).
The library provide a provider for AWS System Manager Parameters Store (SSMProvider) and a provider for AWS Secrets Manager (SecretsProvider). The user can implement a custom provider by extending the abstract class BaseProvider.

If the parameter value requires transformation before being assigned to the annotated field users can specify a Transformer

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	key

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends BaseProvider>	provider
java.lang.Class<? extends Transformer>	transformer

Element Detail

key

public abstract java.lang.String key

provider

public abstract java.lang.Class<? extends BaseProvider> provider

Default:

software.amazon.lambda.powertools.parameters.SSMProvider.class

transformer

public abstract java.lang.Class<? extends Transformer> transformer

Default:

software.amazon.lambda.powertools.parameters.transform.Transformer.class