Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

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.

Hierarchy

Implements

Implemented by

Constructors

Properties

Methods

addTagsToResource authorizeCacheSecurityGroupIngress batchApplyUpdateAction batchStopUpdateAction completeMigration copySnapshot createCacheCluster createCacheParameterGroup createCacheSecurityGroup createCacheSubnetGroup createGlobalReplicationGroup createReplicationGroup createSnapshot createUser createUserGroup decreaseNodeGroupsInGlobalReplicationGroup decreaseReplicaCount deleteCacheCluster deleteCacheParameterGroup deleteCacheSecurityGroup deleteCacheSubnetGroup deleteGlobalReplicationGroup deleteReplicationGroup deleteSnapshot deleteUser deleteUserGroup describeCacheClusters describeCacheEngineVersions describeCacheParameterGroups describeCacheParameters describeCacheSecurityGroups describeCacheSubnetGroups describeEngineDefaultParameters describeEvents describeGlobalReplicationGroups describeReplicationGroups describeReservedCacheNodes describeReservedCacheNodesOfferings describeServiceUpdates describeSnapshots describeUpdateActions describeUserGroups describeUsers destroy disassociateGlobalReplicationGroup failoverGlobalReplicationGroup increaseNodeGroupsInGlobalReplicationGroup increaseReplicaCount listAllowedNodeTypeModifications listTagsForResource modifyCacheCluster modifyCacheParameterGroup modifyCacheSubnetGroup modifyGlobalReplicationGroup modifyReplicationGroup modifyReplicationGroupShardConfiguration modifyUser modifyUserGroup purchaseReservedCacheNodesOffering rebalanceSlotsInGlobalReplicationGroup rebootCacheCluster removeTagsFromResource resetCacheParameterGroup revokeCacheSecurityGroupIngress send startMigration testFailover

Constructors

Properties

The resolved configuration of ElastiCacheClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

  • Type Parameters

    Parameters

    Returns Promise<OutputType>

  • Type Parameters

    Parameters

    • command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>
    • cb: ((err: any, data?: OutputType) => void)
        • (err: any, data?: OutputType): void
        • Parameters

          • err: any
          • Optional data: OutputType

          Returns void

    Returns void

  • Type Parameters

    Parameters

    • command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<HttpHandlerOptions>>
    • options: HttpHandlerOptions
    • cb: ((err: any, data?: OutputType) => void)
        • (err: any, data?: OutputType): void
        • Parameters

          • err: any
          • Optional data: OutputType

          Returns void

    Returns void