Class SsmProvider

Provider to retrieve parameter values from AWS Systems Manager Parameter Store.

Inheritance

object

ParameterProvider

ParameterProvider<SsmProviderConfigurationBuilder>

SsmProvider

Implements

ISsmProvider

IParameterProvider<SsmProviderConfigurationBuilder>

IParameterProvider

IParameterProviderConfigurableClient<ISsmProvider, IAmazonSimpleSystemsManagement, AmazonSimpleSystemsManagementConfig>

Inherited Members

ParameterProvider<SsmProviderConfigurationBuilder>.WithMaxAge(TimeSpan)

ParameterProvider<SsmProviderConfigurationBuilder>.ForceFetch()

ParameterProvider<SsmProviderConfigurationBuilder>.WithTransformation(Transformation)

ParameterProvider<SsmProviderConfigurationBuilder>.WithTransformation(ITransformer)

ParameterProvider<SsmProviderConfigurationBuilder>.WithTransformation(string)

ParameterProvider.Cache

ParameterProvider.CacheMode

ParameterProvider.GetMaxAge(ParameterProviderConfiguration)

ParameterProvider.Get(string)

ParameterProvider.GetAsync(string)

ParameterProvider.Get<T>(string)

ParameterProvider.GetAsync<T>(string)

ParameterProvider.GetMultiple(string)

ParameterProvider.GetMultipleAsync(string)

ParameterProvider.GetMultiple<T>(string)

ParameterProvider.GetMultipleAsync<T>(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: AWS.Lambda.Powertools.Parameters.SimpleSystemsManagement

Assembly: AWS.Lambda.Powertools.Parameters.dll

Syntax

public class SsmProvider : ParameterProvider<SsmProviderConfigurationBuilder>, ISsmProvider, IParameterProvider<SsmProviderConfigurationBuilder>, IParameterProvider, IParameterProviderConfigurableClient<ISsmProvider, IAmazonSimpleSystemsManagement, AmazonSimpleSystemsManagementConfig>

Methods

ConfigureClient(RegionEndpoint)

Configure client with the credentials loaded from the application's default configuration.

Declaration

public ISsmProvider ConfigureClient(RegionEndpoint region)

Parameters

Type	Name	Description
RegionEndpoint	region	The region to connect.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(AWSCredentials)

Configure client with AWS credentials.

Declaration

public ISsmProvider ConfigureClient(AWSCredentials credentials)

Parameters

Type	Name	Description
AWSCredentials	credentials	AWS credentials.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(AWSCredentials, RegionEndpoint)

Configure client with AWS credentials.

Declaration

public ISsmProvider ConfigureClient(AWSCredentials credentials, RegionEndpoint region)

Parameters

Type	Name	Description
AWSCredentials	credentials	AWS credentials.
RegionEndpoint	region	The region to connect.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(AWSCredentials, AmazonSimpleSystemsManagementConfig)

Configure client with AWS credentials and a client configuration object.

Declaration

public ISsmProvider ConfigureClient(AWSCredentials credentials, AmazonSimpleSystemsManagementConfig config)

Parameters

Type	Name	Description
AWSCredentials	credentials	AWS credentials.
AmazonSimpleSystemsManagementConfig	config	The client configuration object.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(AmazonSimpleSystemsManagementConfig)

Configure client with the credentials loaded from the application's default configuration.

Declaration

public ISsmProvider ConfigureClient(AmazonSimpleSystemsManagementConfig config)

Parameters

Type	Name	Description
AmazonSimpleSystemsManagementConfig	config	The client configuration object.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(string, string)

Configure client with AWS Access Key ID and AWS Secret Key.

Declaration

public ISsmProvider ConfigureClient(string awsAccessKeyId, string awsSecretAccessKey)

Parameters

Type	Name	Description
string	awsAccessKeyId	AWS Access Key ID
string	awsSecretAccessKey	AWS Secret Access Key

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(string, string, RegionEndpoint)

Configure client with AWS Access Key ID and AWS Secret Key.

Declaration

public ISsmProvider ConfigureClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)

Parameters

Type	Name	Description
string	awsAccessKeyId	AWS Access Key ID
string	awsSecretAccessKey	AWS Secret Access Key
RegionEndpoint	region	The region to connect.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(string, string, AmazonSimpleSystemsManagementConfig)

Configure client with AWS Access Key ID and AWS Secret Key and a client configuration object.

Declaration

public ISsmProvider ConfigureClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonSimpleSystemsManagementConfig config)

Parameters

Type	Name	Description
string	awsAccessKeyId	AWS Access Key ID
string	awsSecretAccessKey	AWS Secret Access Key
AmazonSimpleSystemsManagementConfig	config	The client configuration object.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(string, string, string)

Configure client with AWS Access Key ID and AWS Secret Key.

Declaration

public ISsmProvider ConfigureClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)

Parameters

Type	Name	Description
string	awsAccessKeyId	AWS Access Key ID
string	awsSecretAccessKey	AWS Secret Access Key
string	awsSessionToken	AWS Session Token

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(string, string, string, RegionEndpoint)

Configure client with AWS Access Key ID and AWS Secret Key.

Declaration

public ISsmProvider ConfigureClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)

Parameters

Type	Name	Description
string	awsAccessKeyId	AWS Access Key ID
string	awsSecretAccessKey	AWS Secret Access Key
string	awsSessionToken	AWS Session Token
RegionEndpoint	region	The region to connect.

Returns

Type	Description
ISsmProvider	Provider instance

ConfigureClient(string, string, string, AmazonSimpleSystemsManagementConfig)

Configure client with AWS Access Key ID and AWS Secret Key and a client configuration object.

Declaration

public ISsmProvider ConfigureClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonSimpleSystemsManagementConfig config)

Parameters

Type	Name	Description
string	awsAccessKeyId	AWS Access Key ID
string	awsSecretAccessKey	AWS Secret Access Key
string	awsSessionToken	AWS Session Token
AmazonSimpleSystemsManagementConfig	config	The client configuration object.

Returns

Type	Description
ISsmProvider	Provider instance

GetAsync(string, ParameterProviderConfiguration?)

Get parameter value for the provided key.

Declaration

protected override Task<string?> GetAsync(string key, ParameterProviderConfiguration? config)

Parameters

Type	Name	Description
string	key	The parameter key.
ParameterProviderConfiguration	config	The parameter provider configuration

Returns

Type	Description
Task<string>	The parameter value.

Overrides

ParameterProvider.GetAsync(string, ParameterProviderConfiguration?)

GetMultipleAsync(string, ParameterProviderConfiguration?)

Get multiple parameter values for the provided key.

Declaration

protected override Task<IDictionary<string, string?>> GetMultipleAsync(string key, ParameterProviderConfiguration? config)

Parameters

Type	Name	Description
string	key	The parameter key.
ParameterProviderConfiguration	config	The parameter provider configuration

Returns

Type	Description
Task<IDictionary<string, string>>	Returns a collection parameter key/value pairs.

Overrides

ParameterProvider.GetMultipleAsync(string, ParameterProviderConfiguration?)

NewConfigurationBuilder()

Creates and configures a new instance of SsmProviderConfigurationBuilder.

Declaration

protected override SsmProviderConfigurationBuilder NewConfigurationBuilder()

Returns

Type	Description
SsmProviderConfigurationBuilder	A new instance of SsmProviderConfigurationBuilder.

Overrides

ParameterProvider<SsmProviderConfigurationBuilder>.NewConfigurationBuilder()

Recursive()

Fetches all parameter values recursively based on a path prefix. For GetMultiple() only.

Declaration

public SsmProviderConfigurationBuilder Recursive()

Returns

Type	Description
SsmProviderConfigurationBuilder	The provider configuration builder.

UseClient(IAmazonSimpleSystemsManagement)

Use a custom client

Declaration

public ISsmProvider UseClient(IAmazonSimpleSystemsManagement client)

Parameters

Type	Name	Description
IAmazonSimpleSystemsManagement	client	The custom client

Returns

Type	Description
ISsmProvider	Provider instance

WithDecryption()

Automatically decrypt the parameter.

Declaration

public SsmProviderConfigurationBuilder WithDecryption()

Returns

Type	Description
SsmProviderConfigurationBuilder	The provider configuration builder.

Implements

ISsmProvider

IParameterProvider<TConfigurationBuilder>

IParameterProvider

IParameterProviderConfigurableClient<TProvider, TClient, TConfig>

Extension Methods

ParameterProviderExtensions.AddTransformer<TProvider>(TProvider, string, ITransformer)

ParameterProviderExtensions.DefaultMaxAge<TProvider>(TProvider, TimeSpan)

ParameterProviderExtensions.RaiseTransformationError<TProvider>(TProvider)

ParameterProviderExtensions.RaiseTransformationError<TProvider>(TProvider, bool)

ParameterProviderExtensions.UseCacheManager<TProvider>(TProvider, ICacheManager)

ParameterProviderExtensions.UseTransformerManager<TProvider>(TProvider, ITransformerManager)