The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.ElastiCache

Inherits:
AWS.Service show all
Identifier:
elasticache
API Version:
2015-02-02
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using ElastiCache

var elasticache = new AWS.ElastiCache();
elasticache.addTagsToResource(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ElastiCache object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var elasticache = new AWS.ElastiCache({apiVersion: '2015-02-02'});

You can also set the API version globally in AWS.config.apiVersions using the elasticache service identifier:

AWS.config.apiVersions = {
  elasticache: '2015-02-02',
  // other service API versions
};

var elasticache = new AWS.ElastiCache();

Version:

  • 2015-02-02

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

cacheClusterAvailable, cacheClusterDeleted, replicationGroupAvailable, replicationGroupDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse