@aws-sdk/endpoint-cache

What is @aws-sdk/endpoint-cache?

@aws-sdk/endpoint-cache is a package that provides a caching mechanism for AWS SDK endpoints. It helps in reducing the number of endpoint resolution requests by caching the resolved endpoints, thus improving the performance of AWS SDK operations.

What are @aws-sdk/endpoint-cache's main functionalities?

Creating an Endpoint Cache

This feature allows you to create an instance of the EndpointCache, which can be used to store and retrieve cached endpoints.

const { EndpointCache } = require('@aws-sdk/endpoint-cache');
const cache = new EndpointCache();

Adding an Endpoint to the Cache

This feature allows you to add an endpoint to the cache with a specified key and expiration time.

const endpoint = { address: 'https://example.com', expiration: Date.now() + 60000 };
cache.set('exampleKey', endpoint);

Retrieving an Endpoint from the Cache

This feature allows you to retrieve an endpoint from the cache using a specified key. If the endpoint is found and has not expired, it will be returned.

const cachedEndpoint = cache.get('exampleKey');
if (cachedEndpoint) {
  console.log('Cached endpoint:', cachedEndpoint.address);
} else {
  console.log('Endpoint not found in cache');
}

Deleting an Endpoint from the Cache

This feature allows you to delete an endpoint from the cache using a specified key.

cache.delete('exampleKey');

Other packages similar to @aws-sdk/endpoint-cache

node-cache

node-cache is a simple and fast Node.js internal caching module. It provides similar functionality to @aws-sdk/endpoint-cache by allowing you to store and retrieve cached data with expiration times. However, it is a more general-purpose caching solution and not specifically tailored for AWS SDK endpoints.

memory-cache

memory-cache is another general-purpose caching module for Node.js. It provides in-memory caching with support for time-to-live (TTL) and cache invalidation. Like node-cache, it is not specifically designed for AWS SDK endpoints but can be used for similar caching purposes.

cache-manager

cache-manager is a multi-store caching module for Node.js that supports various storage backends, including memory, Redis, and more. It offers more flexibility and scalability compared to @aws-sdk/endpoint-cache, but it is also more complex to set up and use.

README

@aws-sdk/endpoint-cache

An internal package

Usage

You probably shouldn't, at least directly.

EndpointCache

• uses mnemonist/lru-cache for storing the cache.
• the set operation stores milliseconds elapsed since the UNIX epoch in Expires param based on CachePeriodInMinutes provided in Endpoint.
• the get operation returns all un-expired endpoints with their Expires values.
• the getEndpoint operation returns a randomly selected un-expired endpoint.

Changelog

3.52.0 (2022-02-18)

Bug Fixes

• package.json: set root version to 0.0.0 (#3325) (9a15961)
• package.json: update version to v3.51.0 (#3315) (b77a9b5)
• scripts: generate clients in batches (#3319) (2308e5f)
• scripts: store clients generated in a batch in temp directory (#3323) (2eef0a4)

Features

• clients: update clients as of 2022/02/18 (#3335) (717b06f)
• credential-provider-env: refactor into modular components (#3293) (e0697ed)
• credential-provider-node: refactor into modular components (#3294) (5f351cd)
• credential-provider-sso: refactor into modular components (#3296) (eece76f)
• smithy-client: add ExceptionOptionType type (#3314) (030da71)