Classes · @purista/aws-config-store

AWSConfigStore

Config store backed by AWS Systems Manager Parameter Store.

@purista/aws-config-storeSource

Signature

AWSConfigStore.tstypescript
class AWSConfigStore

Examples

example-1.tstypescript
const store = new AWSConfigStore({
  client: { region: 'eu-central-1' },
  cacheTtl: 60_000,
})

await store.setConfig('/tenants/acme/prod/app/theme', 'dark')
const config = await store.getConfig('/tenants/acme/prod/app/theme')

Constructors

1 entry

constructor

Constructor

Source
constructor.tstypescript
new constructor(config: { cacheTtl: number; client: SSMClientConfig; enableCache: boolean; enableGet: boolean; enableRemove: boolean; enableSet: boolean; ... })

Creates an AWS Systems Manager config store.

Properties

5 entries

cache

Property

cache.tstypescript
cache: ConfigStoreCacheMap

Optional local cache used by store implementations that opt in.

client

Property

Source
client.tstypescript
client: SSMClient

AWS SDK client used for SSM requests.

config

Property

config.tstypescript
config: { cacheTtl: number; client: SSMClientConfig; enableCache: boolean; enableGet: boolean; enableRemove: boolean; enableSet: boolean; ... }

Store configuration including operation toggles and cache settings.

logger

Property

logger.tstypescript
logger: Logger

Child logger scoped to the store name.

name

Property

name.tstypescript
name: string

Store name used in logs and diagnostics.

Methods

7 entries

destroy

Method

destroy.tstypescript
destroy(): Promise<void>

Shutdown hook for store adapters.

getConfig

Method

getConfig.tstypescript
getConfig<ConfigNames>(...configNames: ConfigNames): Promise<ObjectWithKeysFromStringArray<ConfigNames>>

Returns the values for given config properties.

getConfigImpl

Method

Source
getConfigImpl.tstypescript
getConfigImpl<ConfigNames>(...configNames: ConfigNames): Promise<ObjectWithKeysFromStringArray<ConfigNames>>

This method must be overwritten by actual store implementation.

removeConfig

Method

removeConfig.tstypescript
removeConfig(configName: string): Promise<void>

Removes the config item given by config name.

removeConfigImpl

Method

Source
removeConfigImpl.tstypescript
removeConfigImpl(configName: string): Promise<void>

This method must be overwritten by actual store implementation.

setConfig

Method

setConfig.tstypescript
setConfig(configName: string, configValue: unknown): Promise<void>

Sets a config value.

setConfigImpl

Method

Source
setConfigImpl.tstypescript
setConfigImpl(configName: string, configValue: string): Promise<void>

This method must be overwritten by actual store implementation.