Registry / devops / aws-parameter-cache

aws-parameter-cache

library2.0.15jsnpmunverified

aws-parameter-cache v2.0.15 is a caching layer for AWS Systems Manager Parameter Store and Secrets Manager that reduces API calls and latency by caching parameter values in memory with configurable TTL. It wraps @aws-sdk/client-ssm and @aws-sdk/client-secrets-manager, offering a simple promise-based API. Supports automatic string list parsing and explicit refresh. Compatible with AWS Lambda and Node.js runtimes. Ships TypeScript definitions. Release cadence is active with frequent minor updates.

devops

npm install aws-parameter-cache

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · AWS-PARAMETER-CACH

aws-parameter-cache

devopsjavascriptv2.0.15

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ssmParameter

✓ import { ssmParameter } from 'aws-parameter-cache'

✗ const ssmParameter = require('aws-parameter-cache').ssmParameter

ESM-only; CJS require works but use destructuring for tree-shaking.

secretsManagerParameter

✓ import { secretsManagerParameter } from 'aws-parameter-cache'

✗ const secretsManagerParameter = require('aws-parameter-cache').secretsManagerParameter

ESM-only; CJS require works but use destructuring.

secretsManagerSecret

✓ import { secretsManagerSecret } from 'aws-parameter-cache'

✗ import SecretsManagerSecret from 'aws-parameter-cache'

This is a named export, not default.

Fetches a parameter from AWS SSM Parameter Store with caching and prints its value.

import { ssmParameter } from 'aws-parameter-cache'; const param = ssmParameter({ name: 'my-param', maxAge: 60000 }); const value = await param.value; console.log(value);

Debug

Known issues

breakingv2.0.0 switched from aws-sdk v2 to @aws-sdk v3. Peer dependency changed from aws-sdk to @aws-sdk/client-ssm and @aws-sdk/client-secrets-manager.

fix

Install @aws-sdk/client-ssm and @aws-sdk/client-secrets-manager as peer dependencies.

affects: >=2.0.0

breakingThe constructor signature changed. Options object is now required; name or secretId must be provided.

fix

Pass an options object: ssmParameter({ name: 'foo' }).

affects: >=2.0.0

gotchaCached values are not automatically refreshed; use maxAge or call refresh() explicitly.

fix

Set maxAge in milliseconds or call param.refresh() before reading value.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module '@aws-sdk/client-ssm'

Missing peer dependency @aws-sdk/client-ssm.

fix

npm install @aws-sdk/client-ssm

TypeError: ssmParameter is not a function

Incorrect import or CJS require without destructuring.

fix

Use import { ssmParameter } from 'aws-parameter-cache' or const { ssmParameter } = require('aws-parameter-cache').

Error: No name provided for SSM parameter

Options object missing 'name' property.

fix

Provide name: ssmParameter({ name: 'my-param' })

Upgrade

Version history

2.0.15latest on npm

Audit

Dependencies

@aws-sdk/client-ssmrequiredrequired for SSM Parameter Store operations

@aws-sdk/client-secrets-managerrequiredrequired for Secrets Manager operations

Agent activity

12 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/hupe1980/aws-parameter-cache ↗

packageaws-parameter-cache ↗

homepagehttps://github.com/hupe1980/aws-parameter-cache#readme ↗