@aws-sdk/client-elasticache is an AWS SDK for JavaScript package that allows developers to interact with Amazon ElastiCache, a web service that makes it easy to deploy, operate, and scale an in-memory cache in the cloud. The package provides a variety of functionalities to manage ElastiCache clusters, replication groups, snapshots, and more.

What are @aws-sdk/client-elasticache's main functionalities?

Create Cache Cluster

This feature allows you to create a new cache cluster in ElastiCache. The code sample demonstrates how to create a Redis cache cluster with one cache node of type 'cache.t2.micro'.

const { ElastiCacheClient, CreateCacheClusterCommand } = require('@aws-sdk/client-elasticache');

const client = new ElastiCacheClient({ region: 'us-west-2' });
const params = {
  CacheClusterId: 'my-cache-cluster',
  Engine: 'redis',
  CacheNodeType: 'cache.t2.micro',
  NumCacheNodes: 1
};

const run = async () => {
  try {
    const data = await client.send(new CreateCacheClusterCommand(params));
    console.log('Cache Cluster Created:', data);
  } catch (err) {
    console.error('Error:', err);
  }
};

run();

Describe Cache Clusters

This feature allows you to retrieve information about all cache clusters. The code sample demonstrates how to describe all cache clusters in the specified region.

const { ElastiCacheClient, DescribeCacheClustersCommand } = require('@aws-sdk/client-elasticache');

const client = new ElastiCacheClient({ region: 'us-west-2' });
const params = {};

const run = async () => {
  try {
    const data = await client.send(new DescribeCacheClustersCommand(params));
    console.log('Cache Clusters:', data.CacheClusters);
  } catch (err) {
    console.error('Error:', err);
  }
};

run();

Delete Cache Cluster

This feature allows you to delete an existing cache cluster. The code sample demonstrates how to delete a cache cluster with the specified CacheClusterId.

const { ElastiCacheClient, DeleteCacheClusterCommand } = require('@aws-sdk/client-elasticache');

const client = new ElastiCacheClient({ region: 'us-west-2' });
const params = {
  CacheClusterId: 'my-cache-cluster'
};

const run = async () => {
  try {
    const data = await client.send(new DeleteCacheClusterCommand(params));
    console.log('Cache Cluster Deleted:', data);
  } catch (err) {
    console.error('Error:', err);
  }
};

run();

Other packages similar to @aws-sdk/client-elasticache

@aws-sdk/client-elasticache

Description

AWS SDK for JavaScript ElastiCache Client for Node.js, Browser and React Native.

Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

Installing

To install this package, simply type add or install @aws-sdk/client-elasticache using your favorite package manager:

npm install @aws-sdk/client-elasticache
yarn add @aws-sdk/client-elasticache
pnpm add @aws-sdk/client-elasticache

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the ElastiCacheClient and the commands you need, for example ListTagsForResourceCommand:

// ES5 example
const { ElastiCacheClient, ListTagsForResourceCommand } = require("@aws-sdk/client-elasticache");

// ES6+ example
import { ElastiCacheClient, ListTagsForResourceCommand } from "@aws-sdk/client-elasticache";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region).
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new ElastiCacheClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListTagsForResourceCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-elasticache";
const client = new AWS.ElastiCache({ region: "REGION" });

// async/await.
try {
  const data = await client.listTagsForResource(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTagsForResource(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listTagsForResource(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-elasticache package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

AddTagsToResource

@aws-sdk/client-elasticache

What is @aws-sdk/client-elasticache?

What are @aws-sdk/client-elasticache's main functionalities?

Other packages similar to @aws-sdk/client-elasticache

ioredis

redis

node-redis

@aws-sdk/client-elasticache

Description

Installing

Getting Started

Import

Usage

Async/await

Promises

Callbacks

v2 compatible style

Troubleshooting

Getting Help

Contributing

License

Client Commands (Operations List)

Related posts

Two Malicious Rust Crates Impersonate Popular Logger to Steal Wallet Keys

Malicious fezbox npm Package Steals Browser Passwords from Cookies via Innovative QR Code Steganographic Technique

Identifying and Preventing Fraudulent Engineering Candidates: An Investigation into 80 Confirmed Cases