SecretConfig (secret_config v1.0.0)

Handles CRUD operations to interact with AWS SSM Parameter Store. parameters are pushed to SSM as secure strings (encrypted) but then added as plain text into the GenServer's internal state

Link to this section Summary

Functions

delete(key)

Deletes parameter from the AWS Parameter Store, then it triggers a refresh of the GenServer state

fetch(key, default)

Gets parameter from GenServer (returns default value if present)

fetch!(key)

Gets parameter from GenServer (raise error if the value is not present)

key?(key)

Checks for parameter to be present

push(key, value)

Adds parameter to the AWS Parameter Store, then it triggers a refresh of the GenServer state

refresh()

Triggers a refresh of the GenServer state by pulling the latest from the AWS Parameter Store

set_env(env)

Sets the env explicitly as this configuration item may not be able to be set inside a releases.exs or runtime.exs if you perform ensure_all_started(:secret_config)

Link to this section Functions

delete(key)

Specs

delete(key :: binary()) :: {:deleted, binary()} | {:not_exist, binary()}

Deletes parameter from the AWS Parameter Store, then it triggers a refresh of the GenServer state

fetch(key, default)

Specs

fetch(key :: binary(), default :: binary() | nil) :: binary() | nil

Gets parameter from GenServer (returns default value if present)

fetch!(key)

Specs

fetch!(key :: String.t()) :: String.t()

Gets parameter from GenServer (raise error if the value is not present)

key?(key)

Specs

key?(key :: binary()) :: boolean()

Checks for parameter to be present

push(key, value)

Specs

push(key :: binary(), value :: binary()) ::
  {:added, binary()} | {:error, binary()}

Adds parameter to the AWS Parameter Store, then it triggers a refresh of the GenServer state

refresh()

Specs

refresh() :: :ok

Triggers a refresh of the GenServer state by pulling the latest from the AWS Parameter Store

set_env(env)

Specs

set_env(env :: binary()) :: :ok

Sets the env explicitly as this configuration item may not be able to be set inside a releases.exs or runtime.exs if you perform ensure_all_started(:secret_config)