@effect-aws/ssm

This package provides a fromParameterStore ConfigProvider constructor function. You can use it to read parameters from AWS Systems Manager Parameter Store as a Config schema.

The config primitive name must match the parameter Name or ARN in Parameter Store. For example, Config.String("my_parameter_name") or Config.String("arn:aws:ssm:eu-central-1:123456789012:parameter/my_parameter_name").

Installation

npm install --save @effect-aws/ssm @effect-aws/client-ssm

Usage

With default service layer:

import { SSM } from "@effect-aws/client-ssm"
import { ConfigProvider } from "@effect-aws/ssm"
import { Effect, Config, Console } from "effect"

const program = Effect.gen(function* () {
  const param: string = yield* Config.String("my_parameter_name")

  yield* Console.log("Parameter from Parameter Store: ", param)
})

program.pipe(
  ConfigProvider.withParameterStoreConfigProvider(),
  Effect.provide(SSM.defaultLayer),
  Effect.runPromise
)

With custom service layer:

import { SSM } from "@effect-aws/client-ssm"
import { ConfigProvider } from "@effect-aws/ssm"
import { Config, Console, Effect } from "effect"

const program = Effect.gen(function* () {
  const param: string = yield* Config.String("my_parameter_name")

  yield* Console.log("Parameter from Parameter Store: ", param)
})

const serviceLayer = SSM.layer({ region: "eu-central-1" })

program.pipe(
  Effect.provide(ConfigProvider.setParameterStoreConfigProvider()),
  Effect.provide(serviceLayer),
  Effect.runPromise
)