AWS.ElastiCache — AWS SDK for JavaScript (original) (raw)

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

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addTagsToResource(params = {}, callback) ⇒ AWS.Request

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.

For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

Note: You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

batchApplyUpdateAction(params = {}, callback) ⇒ AWS.Request

batchStopUpdateAction(params = {}, callback) ⇒ AWS.Request

completeMigration(params = {}, callback) ⇒ AWS.Request

Complete the migration of data.

copyServerlessCacheSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a copy of an existing serverless cache’s snapshot. Available for Redis OSS and Serverless Memcached only.

copySnapshot(params = {}, callback) ⇒ AWS.Request

Makes a copy of an existing snapshot.

Note: This operation is valid for Redis OSS only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

• Error Message: The S3 bucket %s is outside of the region.
  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: The S3 bucket %s does not exist.
  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: The S3 bucket %s is not owned by the authenticated user.
  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
  Solution: Contact your system administrator to get the needed permissions.
• Error Message: The S3 bucket %s already contains an object with key %s.
  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
  Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
  Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
  Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

createCacheCluster(params = {}, callback) ⇒ AWS.Request

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis OSS.

This operation is not supported for Redis OSS (cluster mode enabled) clusters.

createCacheParameterGroup(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

• ModifyCacheParameterGroup in the ElastiCache API Reference.
• Parameters and Parameter Groups in the ElastiCache User Guide.

createCacheSecurityGroup(params = {}, callback) ⇒ AWS.Request

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

createCacheSubnetGroup(params = {}, callback) ⇒ AWS.Request

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

createGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Global Datastore for Redis OSS offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis OSS, you can create cross-region read replica clusters for ElastiCache (Redis OSS) to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.

• The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
• The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

createReplicationGroup(params = {}, callback) ⇒ AWS.Request

Creates a Redis OSS (cluster mode disabled) or a Redis OSS (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.

A Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.

The node or shard limit can be increased to a maximum of 500 per cluster if the Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.

To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.

When a Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use ElastiCache (Redis OSS) scaling. For more information, see Scaling ElastiCache (Redis OSS) Clusters in the ElastiCache User Guide.

Note: This operation is valid for Redis OSS only.

createServerlessCache(params = {}, callback) ⇒ AWS.Request

Creates a serverless cache.

createServerlessCacheSnapshot(params = {}, callback) ⇒ AWS.Request

This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis OSS and Serverless Memcached only.

createSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a copy of an entire cluster or replication group at a specific moment in time.

Note: This operation is valid for Redis OSS only.

createUserGroup(params = {}, callback) ⇒ AWS.Request

decreaseNodeGroupsInGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Decreases the number of node groups in a Global datastore

decreaseReplicaCount(params = {}, callback) ⇒ AWS.Request

Dynamically decreases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

deleteCacheCluster(params = {}, callback) ⇒ AWS.Request

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

• Redis OSS (cluster mode enabled) clusters
• Redis OSS (cluster mode disabled) clusters
• A cluster that is the last read replica of a replication group
• A cluster that is the primary node of a replication group
• A node group (shard) that has Multi-AZ mode enabled
• A cluster from a Redis OSS (cluster mode enabled) replication group
• A cluster that is not in the available state

deleteCacheParameterGroup(params = {}, callback) ⇒ AWS.Request

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.

deleteCacheSecurityGroup(params = {}, callback) ⇒ AWS.Request

Deletes a cache security group.

Note: You cannot delete a cache security group if it is associated with any clusters.

deleteCacheSubnetGroup(params = {}, callback) ⇒ AWS.Request

Deletes a cache subnet group.

Note: You cannot delete a default cache subnet group or one that is associated with any clusters.

deleteGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Deleting a Global datastore is a two-step process:

• First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
• Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.

Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

deleteReplicationGroup(params = {}, callback) ⇒ AWS.Request

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

Note:

• CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.
• This operation is valid for Redis OSS only.

deleteServerlessCache(params = {}, callback) ⇒ AWS.Request

Deletes a specified existing serverless cache.

Note: CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

deleteServerlessCacheSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes an existing serverless cache snapshot. Available for Redis OSS and Serverless Memcached only.

deleteSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

Note: This operation is valid for Redis OSS only.

deleteUser(params = {}, callback) ⇒ AWS.Request

For Redis OSS engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).

deleteUserGroup(params = {}, callback) ⇒ AWS.Request

For Redis OSS engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

describeCacheClusters(params = {}, callback) ⇒ AWS.Request

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

describeCacheEngineVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of the available cache engines and their versions.

describeCacheParameterGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

describeCacheParameters(params = {}, callback) ⇒ AWS.Request

Returns the detailed parameter list for a particular cache parameter group.

describeCacheSecurityGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

describeCacheSubnetGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

describeEngineDefaultParameters(params = {}, callback) ⇒ AWS.Request

Returns the default engine and system parameter information for the specified cache engine.

describeEvents(params = {}, callback) ⇒ AWS.Request

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

describeGlobalReplicationGroups(params = {}, callback) ⇒ AWS.Request

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

describeReplicationGroups(params = {}, callback) ⇒ AWS.Request

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

Note: This operation is valid for Redis OSS only.

describeReservedCacheNodes(params = {}, callback) ⇒ AWS.Request

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

describeReservedCacheNodesOfferings(params = {}, callback) ⇒ AWS.Request

Lists available reserved cache node offerings.

describeServerlessCaches(params = {}, callback) ⇒ AWS.Request

Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.

describeServerlessCacheSnapshots(params = {}, callback) ⇒ AWS.Request

Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis OSS and Serverless Memcached only.

describeServiceUpdates(params = {}, callback) ⇒ AWS.Request

Returns details of the service updates

describeSnapshots(params = {}, callback) ⇒ AWS.Request

Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

Note: This operation is valid for Redis OSS only.

describeUpdateActions(params = {}, callback) ⇒ AWS.Request

Returns details of the update actions

describeUserGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of user groups.

describeUsers(params = {}, callback) ⇒ AWS.Request

disassociateGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.

exportServerlessCacheSnapshot(params = {}, callback) ⇒ AWS.Request

Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis OSS only.

failoverGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.

increaseNodeGroupsInGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Increase the number of node groups in the Global datastore

increaseReplicaCount(params = {}, callback) ⇒ AWS.Request

Dynamically increases the number of replicas in a Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

listAllowedNodeTypeModifications(params = {}, callback) ⇒ AWS.Request

Lists all available node types that you can scale your Redis OSS cluster's or replication group's current node type.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags currently on a named resource.

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

If the cluster is not in the available state, ListTagsForResource returns an error.

modifyCacheCluster(params = {}, callback) ⇒ AWS.Request

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

modifyCacheParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

modifyCacheSubnetGroup(params = {}, callback) ⇒ AWS.Request

Modifies an existing cache subnet group.

modifyGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Modifies the settings for a Global datastore.

modifyReplicationGroup(params = {}, callback) ⇒ AWS.Request

modifyReplicationGroupShardConfiguration(params = {}, callback) ⇒ AWS.Request

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

modifyServerlessCache(params = {}, callback) ⇒ AWS.Request

This API modifies the attributes of a serverless cache.

modifyUser(params = {}, callback) ⇒ AWS.Request

Changes user password(s) and/or access string.

modifyUserGroup(params = {}, callback) ⇒ AWS.Request

Changes the list of users that belong to the user group.

purchaseReservedCacheNodesOffering(params = {}, callback) ⇒ AWS.Request

rebalanceSlotsInGlobalReplicationGroup(params = {}, callback) ⇒ AWS.Request

Redistribute slots to ensure uniform distribution across existing shards in the cluster.

rebootCacheCluster(params = {}, callback) ⇒ AWS.Request

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Redis OSS (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

removeTagsFromResource(params = {}, callback) ⇒ AWS.Request

Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.

resetCacheParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

revokeCacheSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

startMigration(params = {}, callback) ⇒ AWS.Request

Start the migration of data.

testFailover(params = {}, callback) ⇒ AWS.Request

Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

Note the following

• A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
• If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
• If calling this operation multiple times on different shards in the same Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
• To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
  1. Replication group message: Test Failover API called for node group <node-group-id>
  2. Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
  3. Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
  4. Cache cluster message: Recovering cache nodes <node-id>
  5. Cache cluster message: Finished recovery for cache nodes <node-id>
     For more information see:
  • Viewing ElastiCache Events in the ElastiCache User Guide
  • DescribeEvents in the ElastiCache API Reference

Also see, Testing Multi-AZ in the ElastiCache User Guide.

testMigration(params = {}, callback) ⇒ AWS.Request

Async API to test connection between source and target replication group.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given ElastiCache resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.