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.
Readonly
configThe resolved configuration of ElastiCacheClient class. This is resolved and normalized from the constructor configuration interface.
Optional
options: HttpHandlerOptionsOptional
data: AddTagsToResourceCommandOutputOptional
data: AddTagsToResourceCommandOutputOptional
options: HttpHandlerOptionsOptional
data: AuthorizeCacheSecurityGroupIngressCommandOutputOptional
data: AuthorizeCacheSecurityGroupIngressCommandOutputOptional
options: HttpHandlerOptionsOptional
data: BatchApplyUpdateActionCommandOutputOptional
data: BatchApplyUpdateActionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: BatchStopUpdateActionCommandOutputOptional
data: BatchStopUpdateActionCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CompleteMigrationCommandOutputOptional
data: CompleteMigrationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CopySnapshotCommandOutputOptional
data: CopySnapshotCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateCacheClusterCommandOutputOptional
data: CreateCacheClusterCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateCacheParameterGroupCommandOutputOptional
data: CreateCacheParameterGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateCacheSecurityGroupCommandOutputOptional
data: CreateCacheSecurityGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateCacheSubnetGroupCommandOutputOptional
data: CreateCacheSubnetGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateGlobalReplicationGroupCommandOutputOptional
data: CreateGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateReplicationGroupCommandOutputOptional
data: CreateReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateSnapshotCommandOutputOptional
data: CreateSnapshotCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateUserCommandOutputOptional
data: CreateUserCommandOutputOptional
options: HttpHandlerOptionsOptional
data: CreateUserGroupCommandOutputOptional
data: CreateUserGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutputOptional
data: DecreaseNodeGroupsInGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DecreaseReplicaCountCommandOutputOptional
data: DecreaseReplicaCountCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteCacheClusterCommandOutputOptional
data: DeleteCacheClusterCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteCacheParameterGroupCommandOutputOptional
data: DeleteCacheParameterGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteCacheSecurityGroupCommandOutputOptional
data: DeleteCacheSecurityGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteCacheSubnetGroupCommandOutputOptional
data: DeleteCacheSubnetGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteGlobalReplicationGroupCommandOutputOptional
data: DeleteGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteReplicationGroupCommandOutputOptional
data: DeleteReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteSnapshotCommandOutputOptional
data: DeleteSnapshotCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteUserCommandOutputOptional
data: DeleteUserCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DeleteUserGroupCommandOutputOptional
data: DeleteUserGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCacheClustersCommandOutputOptional
data: DescribeCacheClustersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCacheEngineVersionsCommandOutputOptional
data: DescribeCacheEngineVersionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCacheParameterGroupsCommandOutputOptional
data: DescribeCacheParameterGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCacheParametersCommandOutputOptional
data: DescribeCacheParametersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCacheSecurityGroupsCommandOutputOptional
data: DescribeCacheSecurityGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeCacheSubnetGroupsCommandOutputOptional
data: DescribeCacheSubnetGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEngineDefaultParametersCommandOutputOptional
data: DescribeEngineDefaultParametersCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeEventsCommandOutputOptional
data: DescribeEventsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeGlobalReplicationGroupsCommandOutputOptional
data: DescribeGlobalReplicationGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeReplicationGroupsCommandOutputOptional
data: DescribeReplicationGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeReservedCacheNodesCommandOutputOptional
data: DescribeReservedCacheNodesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeReservedCacheNodesOfferingsCommandOutputOptional
data: DescribeReservedCacheNodesOfferingsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeServiceUpdatesCommandOutputOptional
data: DescribeServiceUpdatesCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeSnapshotsCommandOutputOptional
data: DescribeSnapshotsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeUpdateActionsCommandOutputOptional
data: DescribeUpdateActionsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeUserGroupsCommandOutputOptional
data: DescribeUserGroupsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: DescribeUsersCommandOutputOptional
data: DescribeUsersCommandOutputDestroy 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.
Optional
options: HttpHandlerOptionsOptional
data: DisassociateGlobalReplicationGroupCommandOutputOptional
data: DisassociateGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: FailoverGlobalReplicationGroupCommandOutputOptional
data: FailoverGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutputOptional
data: IncreaseNodeGroupsInGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: IncreaseReplicaCountCommandOutputOptional
data: IncreaseReplicaCountCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListAllowedNodeTypeModificationsCommandOutputOptional
data: ListAllowedNodeTypeModificationsCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ListTagsForResourceCommandOutputOptional
data: ListTagsForResourceCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyCacheClusterCommandOutputOptional
data: ModifyCacheClusterCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyCacheParameterGroupCommandOutputOptional
data: ModifyCacheParameterGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyCacheSubnetGroupCommandOutputOptional
data: ModifyCacheSubnetGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyGlobalReplicationGroupCommandOutputOptional
data: ModifyGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyReplicationGroupCommandOutputOptional
data: ModifyReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyReplicationGroupShardConfigurationCommandOutputOptional
data: ModifyReplicationGroupShardConfigurationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyUserCommandOutputOptional
data: ModifyUserCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ModifyUserGroupCommandOutputOptional
data: ModifyUserGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: PurchaseReservedCacheNodesOfferingCommandOutputOptional
data: PurchaseReservedCacheNodesOfferingCommandOutputOptional
options: HttpHandlerOptionsOptional
data: RebalanceSlotsInGlobalReplicationGroupCommandOutputOptional
data: RebalanceSlotsInGlobalReplicationGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: RebootCacheClusterCommandOutputOptional
data: RebootCacheClusterCommandOutputOptional
options: HttpHandlerOptionsOptional
data: RemoveTagsFromResourceCommandOutputOptional
data: RemoveTagsFromResourceCommandOutputOptional
options: HttpHandlerOptionsOptional
data: ResetCacheParameterGroupCommandOutputOptional
data: ResetCacheParameterGroupCommandOutputOptional
options: HttpHandlerOptionsOptional
data: RevokeCacheSecurityGroupIngressCommandOutputOptional
data: RevokeCacheSecurityGroupIngressCommandOutputOptional
options: HttpHandlerOptionsOptional
data: OutputTypeOptional
data: OutputTypeOptional
options: HttpHandlerOptionsOptional
data: StartMigrationCommandOutputOptional
data: StartMigrationCommandOutputOptional
options: HttpHandlerOptionsOptional
data: TestFailoverCommandOutputOptional
data: TestFailoverCommandOutput
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.