@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

$3

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:

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

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

$3

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.

`js
// 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:

`js
// 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.

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

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

`js
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.

`js
// 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

`ts
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.
});
`

$3

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

`js
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

Command API Reference / Input / Output

AuthorizeCacheSecurityGroupIngress

Command API Reference / Input / Output

BatchApplyUpdateAction

Command API Reference / Input / Output

BatchStopUpdateAction

Command API Reference / Input / Output

CompleteMigration

Command API Reference / Input / Output

CopyServerlessCacheSnapshot

Command API Reference / Input / Output

CopySnapshot

Command API Reference / Input / Output

CreateCacheCluster

Command API Reference / Input / Output

CreateCacheParameterGroup

Command API Reference / Input / Output

CreateCacheSecurityGroup

Command API Reference / Input / Output

CreateCacheSubnetGroup

Command API Reference / Input / Output

CreateGlobalReplicationGroup

Command API Reference / Input / Output

CreateReplicationGroup

Command API Reference / Input / Output

CreateServerlessCache

Command API Reference / Input / Output

CreateServerlessCacheSnapshot

Command API Reference / Input / Output

CreateSnapshot

Command API Reference / Input / Output

CreateUser

Command API Reference / Input / Output

CreateUserGroup

Command API Reference / Input / Output

DecreaseNodeGroupsInGlobalReplicationGroup

Command API Reference / Input / Output

DecreaseReplicaCount

Command API Reference / Input / Output

DeleteCacheCluster

Command API Reference / Input / Output

DeleteCacheParameterGroup

Command API Reference / Input / Output

DeleteCacheSecurityGroup

Command API Reference / Input / Output

DeleteCacheSubnetGroup

Command API Reference / Input / Output

DeleteGlobalReplicationGroup

Command API Reference / Input / Output

DeleteReplicationGroup

Command API Reference / Input / Output

DeleteServerlessCache

Command API Reference / Input / Output

DeleteServerlessCacheSnapshot

Command API Reference / Input / Output

DeleteSnapshot

Command API Reference / Input / Output

DeleteUser

Command API Reference / Input / Output

DeleteUserGroup

Command API Reference / Input / Output

DescribeCacheClusters

Command API Reference / Input / Output

DescribeCacheEngineVersions

Command API Reference / Input / Output

DescribeCacheParameterGroups

Command API Reference / Input / Output

DescribeCacheParameters

Command API Reference / Input / Output

DescribeCacheSecurityGroups

Command API Reference / Input / Output

DescribeCacheSubnetGroups

Command API Reference / Input / Output

DescribeEngineDefaultParameters

Command API Reference / Input / Output

DescribeEvents

Command API Reference / Input / Output

DescribeGlobalReplicationGroups

Command API Reference / Input / Output

DescribeReplicationGroups

Command API Reference / Input / Output

DescribeReservedCacheNodes

Command API Reference / Input / Output

DescribeReservedCacheNodesOfferings

Command API Reference / Input / Output

DescribeServerlessCaches

Command API Reference / Input / Output

DescribeServerlessCacheSnapshots

Command API Reference / Input / Output

DescribeServiceUpdates

Command API Reference / Input / Output

DescribeSnapshots

Command API Reference / Input / Output

DescribeUpdateActions

Command API Reference / Input / Output

DescribeUserGroups

Command API Reference / Input / Output

DescribeUsers

Command API Reference / Input / Output

DisassociateGlobalReplicationGroup

Command API Reference / Input / Output

ExportServerlessCacheSnapshot

Command API Reference / Input / Output

FailoverGlobalReplicationGroup

Command API Reference / Input / Output

IncreaseNodeGroupsInGlobalReplicationGroup

Command API Reference / Input / Output

IncreaseReplicaCount

Command API Reference / Input / Output

ListAllowedNodeTypeModifications

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ModifyCacheCluster

Command API Reference / Input / Output

ModifyCacheParameterGroup

Command API Reference / Input / Output

ModifyCacheSubnetGroup

Command API Reference / Input / Output

ModifyGlobalReplicationGroup

Command API Reference / Input / Output

ModifyReplicationGroup

Command API Reference / Input / Output

ModifyReplicationGroupShardConfiguration

Command API Reference / Input / Output

ModifyServerlessCache

Command API Reference / Input / Output

ModifyUser

Command API Reference / Input / Output

ModifyUserGroup

Command API Reference / Input / Output

PurchaseReservedCacheNodesOffering

Command API Reference / Input / Output

RebalanceSlotsInGlobalReplicationGroup

Command API Reference / Input / Output

RebootCacheCluster

Command API Reference / Input / Output

RemoveTagsFromResource

Command API Reference / Input / Output

ResetCacheParameterGroup

Command API Reference / Input / Output

RevokeCacheSecurityGroupIngress

Command API Reference / Input / Output

StartMigration

Command API Reference / Input / Output

TestFailover

Command API Reference / Input / Output

TestMigration

Command API Reference / Input / Output