Search Results for

    Show / Hide Table of Contents

    Interface IParameterProvider<TConfigurationBuilder>

    Represents a type used to retrieve parameter values from a store.

    Inherited Members
    IParameterProvider.Get(string)
    IParameterProvider.GetAsync(string)
    IParameterProvider.Get<T>(string)
    IParameterProvider.GetAsync<T>(string)
    IParameterProvider.GetMultiple(string)
    IParameterProvider.GetMultipleAsync(string)
    IParameterProvider.GetMultiple<T>(string)
    IParameterProvider.GetMultipleAsync<T>(string)
    Namespace: AWS.Lambda.Powertools.Parameters.Provider
    Assembly: AWS.Lambda.Powertools.Parameters.dll
    Syntax
    public interface IParameterProvider<out TConfigurationBuilder> : IParameterProvider where TConfigurationBuilder : ParameterProviderConfigurationBuilder
    Type Parameters
    Name Description
    TConfigurationBuilder

    The type of ConfigurationBuilder

    Methods

    ForceFetch()

    Forces provider to fetch the latest value from the store regardless if already available in cache.

    Declaration
    TConfigurationBuilder ForceFetch()
    Returns
    Type Description
    TConfigurationBuilder

    Provider Configuration Builder instance

    WithMaxAge(TimeSpan)

    Set the cache maximum age

    Declaration
    TConfigurationBuilder WithMaxAge(TimeSpan maxAge)
    Parameters
    Type Name Description
    TimeSpan maxAge

    The maximum cache age

    Returns
    Type Description
    TConfigurationBuilder

    Provider Configuration Builder instance

    WithTransformation(ITransformer)

    Transforms the latest value from after retrieved from the store.

    Declaration
    TConfigurationBuilder WithTransformation(ITransformer transformer)
    Parameters
    Type Name Description
    ITransformer transformer

    The instance of the transformer.

    Returns
    Type Description
    TConfigurationBuilder

    Provider Configuration Builder instance

    WithTransformation(Transformation)

    Transforms the latest value from after retrieved from the store.

    Declaration
    TConfigurationBuilder WithTransformation(Transformation transformation)
    Parameters
    Type Name Description
    Transformation transformation

    The transformation type.

    Returns
    Type Description
    TConfigurationBuilder

    Provider Configuration Builder instance

    WithTransformation(string)

    Transforms the latest value from after retrieved from the store.

    Declaration
    TConfigurationBuilder WithTransformation(string transformerName)
    Parameters
    Type Name Description
    string transformerName

    The name of the registered transformer.

    Returns
    Type Description
    TConfigurationBuilder

    Provider Configuration Builder instance

    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)
    In this article
    Back to top Powertools for AWS Lambda (.NET) API Documentation