config

Parameter and secret management.

config

Config domain — parameter and secret management.

validateProvider(provider) ⇒ ConfigProvider

Validates that a provider satisfies the ConfigProvider contract.

ParamType
providerobject

getProvider() ⇒ ConfigProvider

Returns the active config provider (creates default AWS SSM provider if none set).

setProvider(provider)

Replaces the active config provider.

ParamType
providerConfigProvider

get(name) ⇒ Promise.<string>

Gets a single parameter value (handles SecureString decryption).

ParamTypeDescription
namestringFull parameter name

Example

const { config } = require("@beem/sdk");

const apiKey = await config.get("/beem/app/api-key");

getByPrefix(pathPrefix) ⇒ Promise.<Object.<string, string>>

Gets all parameters under a path prefix.

Returns: Promise.<Object.<string, string>> - Flat object keyed by parameter name suffix

ParamTypeDescription
pathPrefixstringSSM path prefix

Example

const { config } = require("@beem/sdk");

const params = await config.getByPrefix("/beem/redshift");
// { host: "cluster-id", port: "5439", database: "mydb", ... }

ConfigProvider : object

Properties

NameTypeDescription
getfunctionGet a single parameter value
getByPrefixfunctionGet all parameters under a prefix