rv-flex-paramstore

Library for loading values from param store.

configureSSM(config: AWS.Config): void

Allows you to configure the SSM client used to load params from Parameter Store.

Parameters

| Name | Type | Description | |------|------|-------------| | config | AWS.Config | the configuration for SSM |

loadAuthToken(accountSid: string): Promise

Loads the auth token for the specified account.

Parameters

| Name | Type | Description | |------|------|-------------| | accountSid | string | the SID of the Twilio account for which the auth token should be loaded |

Return Value

Promise<string> the auth token

loadTwilioBaseUrl(accountSid: string): Promise

Loads the base URL for Twilio's runtime for the specified account.

Parameters

| Name | Type | Description | |------|------|-------------| | accountSid | string | the SID of the Twilio account for which the auth token should be loaded |

Return Value

Promise<string> the URL for Twilio's runtime for the specified account

loadDncApiKey(): Promise

Loads the API key for RV Gateway for the DNC API.

Return Value

Promise<string> the API key for DNC

loadTcpaApiKey(): Promise

Loads the API key for RV Gateway for the TCPA API.

Return Value

Promise<string> the API key for TCPA

loadChamberParam(service: string, key: string): Promise

Loads the param stored as /{service}/{key}.

Parameters

| Name | Type | Description | |------|------|-------------| | service | string | the first (service) component of the param path | | key | string | the key to load |

Return Value

Promise<string> the value of the specified param

loadParam(path: string): Promise

Loads the param stored as path.

Parameters

| Name | Type | Description | |------|------|-------------| | path | string | the path of the parameter to load |

Return Value

Promise<string> the value of the specified param

loadParams(paths: string[]): Promise<{ [camelizedParamName: string]: string }>

Loads the param stored as path.

Parameters

| Name | Type | Description | |------|------|-------------| | paths | string[] | the paths of the parameters to load |

Return Value

Promise<{ [camelizedParamName: string]: string }> a map of the camelized parameter name (the last part of the parameter) to the parameter value