software.amazon.lambda.powertools.parameters

Class ParamManager

java.lang.Object

software.amazon.lambda.powertools.parameters.ParamManager

public final class ParamManager
extends java.lang.Object

Utility class to retrieve instances of parameter providers. Each instance is unique (singleton).

Constructor Summary

Constructors

Constructor and Description
ParamManager()

Method Summary

Modifier and Type	Method and Description
static AppConfigProvider	getAppConfigProvider(software.amazon.awssdk.services.appconfigdata.AppConfigDataClient client, java.lang.String environment, java.lang.String application) Get a AppConfigProvider with your custom AppConfigDataClient. Use this to configure region or other part of the client.
static AppConfigProvider	getAppConfigProvider(java.lang.String environment, java.lang.String application) Get a AppConfigProvider with default AppConfigDataClient. If you need to customize the region, or other part of the client, use getAppConfigProvider(AppConfigDataClient, String, String) instead.
static CacheManager	getCacheManager()
static DynamoDbProvider	getDynamoDbProvider(software.amazon.awssdk.services.dynamodb.DynamoDbClient client, java.lang.String table) Get a DynamoDbProvider with your custom DynamoDbClient. Use this to configure region or other part of the client.
static DynamoDbProvider	getDynamoDbProvider(java.lang.String tableName) Get a DynamoDbProvider with default DynamoDbClient If you need to customize the region, or other part of the client, use getDynamoDbProvider(DynamoDbClient, String)
static <T extends BaseProvider> T	getProvider(java.lang.Class<T> providerClass) Deprecated. You should not use this method directly but a typed one (getSecretsProvider, getSsmProvider, getDynamoDbProvider, getAppConfigProvider), will be removed in v2
static SecretsProvider	getSecretsProvider() Get a SecretsProvider with default SecretsManagerClient. If you need to customize the region, or other part of the client, use getSecretsProvider(SecretsManagerClient) instead.
static SecretsProvider	getSecretsProvider(software.amazon.awssdk.services.secretsmanager.SecretsManagerClient client) Get a SecretsProvider with your custom SecretsManagerClient. Use this to configure region or other part of the client.
static SSMProvider	getSsmProvider() Get a SSMProvider with default SsmClient. If you need to customize the region, or other part of the client, use getSsmProvider(SsmClient) instead.
static SSMProvider	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.
static TransformationManager	getTransformationManager()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamManager

public ParamManager()

Method Detail

getProvider

public static <T extends BaseProvider> T getProvider(java.lang.Class<T> providerClass)

Deprecated. You should not use this method directly but a typed one (getSecretsProvider, getSsmProvider, getDynamoDbProvider, getAppConfigProvider), will be removed in v2

Get a concrete implementation of BaseProvider.
You can specify SecretsProvider, SSMProvider or create your custom provider by extending BaseProvider if you need to integrate with a different parameter store.

Returns:

a SecretsProvider

getSecretsProvider

public static SecretsProvider getSecretsProvider()

Get a SecretsProvider with default SecretsManagerClient.
If you need to customize the region, or other part of the client, use getSecretsProvider(SecretsManagerClient) instead.

Returns:

a SecretsProvider

getSsmProvider

public static SSMProvider getSsmProvider()

Get a SSMProvider with default SsmClient.
If you need to customize the region, or other part of the client, use getSsmProvider(SsmClient) instead.

Returns:

a SSMProvider

getDynamoDbProvider

public static DynamoDbProvider getDynamoDbProvider(java.lang.String tableName)

Get a DynamoDbProvider with default DynamoDbClient
If you need to customize the region, or other part of the client, use getDynamoDbProvider(DynamoDbClient, String)

getAppConfigProvider

public static AppConfigProvider getAppConfigProvider(java.lang.String environment,
                                                     java.lang.String application)

Get a AppConfigProvider with default AppConfigDataClient.
If you need to customize the region, or other part of the client, use getAppConfigProvider(AppConfigDataClient, String, String) instead.

Returns:

a AppConfigProvider

getSecretsProvider

public static SecretsProvider getSecretsProvider(software.amazon.awssdk.services.secretsmanager.SecretsManagerClient client)

Get a SecretsProvider with your custom SecretsManagerClient.
Use this to configure region or other part of the client. Use getSsmProvider() if you don't need this customization.

Returns:

a SecretsProvider

getSsmProvider

public static SSMProvider 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. Use getSsmProvider() if you don't need this customization.

Returns:

a SSMProvider

getDynamoDbProvider

public static DynamoDbProvider getDynamoDbProvider(software.amazon.awssdk.services.dynamodb.DynamoDbClient client,
                                                   java.lang.String table)

Get a DynamoDbProvider with your custom DynamoDbClient.
Use this to configure region or other part of the client. Use getDynamoDbProvider(String) )} if you don't need this customization.

Returns:

a DynamoDbProvider

getAppConfigProvider

public static AppConfigProvider getAppConfigProvider(software.amazon.awssdk.services.appconfigdata.AppConfigDataClient client,
                                                     java.lang.String environment,
                                                     java.lang.String application)

Get a AppConfigProvider with your custom AppConfigDataClient.
Use this to configure region or other part of the client. Use getAppConfigProvider(String, String) if you don't need this customization.

Returns:

a AppConfigProvider

getCacheManager

public static CacheManager getCacheManager()

getTransformationManager

public static TransformationManager getTransformationManager()