ConfigProvider overview

Added in v1.0.0

Table of contents

• config
  • setParameterStoreConfigProvider
  • withParameterStoreConfigProvider
• constructors
  • fromParameterStore
• models
  • FromParameterStoreConfig (interface)

config

setParameterStoreConfigProvider

Sets the current ConfigProvider that loads configuration from AWS Systems Manager Parameter Store.

Signature

export declare const setParameterStoreConfigProvider: (
  config?: Partial<FromParameterStoreConfig>
) => Layer.Layer<never, unknown, unknown>

Added in v1.2.0

withParameterStoreConfigProvider

Executes the specified workflow with the parameter store configuration provider.

Signature

export declare const withParameterStoreConfigProvider: (
  config?: Partial<FromParameterStoreConfig>
) => <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, unknown, unknown>

Added in v1.2.0

constructors

fromParameterStore

A config provider that loads configuration from AWS Systems Manager Parameter Store.

Signature

export declare const fromParameterStore: (
  config?: Partial<FromParameterStoreConfig> & { serviceLayer?: Layer.Layer<SSMService> }
) => ConfigProvider.ConfigProvider

Added in v1.0.0

models

FromParameterStoreConfig (interface)

Signature

export interface FromParameterStoreConfig {
  readonly pathDelim: string
}

Added in v1.2.0