Amazon Web Services, Inc.

Amazon ElastiCache

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,…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 77

  • POSTAdd tags to resource/#Action=AddTagsToResource?Action=AddTagsToResource&Version=2015-02-02A 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. When you add or…
  • POSTAuthorize cache security group ingress/#Action=AuthorizeCacheSecurityGroupIngress?Action=AuthorizeCacheSecurityGroupIngress&Version=2015-02-02Allows 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…
  • POSTBatch apply update action/#Action=BatchApplyUpdateAction?Action=BatchApplyUpdateAction&Version=2015-02-02Apply the service update. For more information on service updates and applying them, see Applying Service Updates .
  • POSTBatch stop update action/#Action=BatchStopUpdateAction?Action=BatchStopUpdateAction&Version=2015-02-02Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates .
  • POSTComplete migration/#Action=CompleteMigration?Action=CompleteMigration&Version=2015-02-02Completes the migration of data.
  • POSTCopy serverless cache snapshot/#Action=CopyServerlessCacheSnapshot?Action=CopyServerlessCacheSnapshot&Version=2015-02-02Creates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
  • POSTCopy snapshot/#Action=CopySnapshot?Action=CopySnapshot&Version=2015-02-02Makes a copy of an existing snapshot. This operation is valid for Valkey or Redis OSS only. Users or groups that have permissions to use the CopySnapshot…
  • POSTCreate cache cluster/#Action=CreateCacheCluster?Action=CreateCacheCluster&Version=2015-02-02Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS. This operation is…
  • POSTCreate cache parameter group/#Action=CreateCacheParameterGroup?Action=CreateCacheParameterGroup&Version=2015-02-02Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied…
  • POSTCreate cache security group/#Action=CreateCacheSecurityGroup?Action=CreateCacheSecurityGroup&Version=2015-02-02Creates 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…
  • POSTCreate cache subnet group/#Action=CreateCacheSubnetGroup?Action=CreateCacheSubnetGroup&Version=2015-02-02Creates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
  • POSTCreate global replication group/#Action=CreateGlobalReplicationGroup?Action=CreateGlobalReplicationGroup&Version=2015-02-02Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create…
  • POSTCreate replication group/#Action=CreateReplicationGroup?Action=CreateReplicationGroup&Version=2015-02-02Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group. This API can be used to create a…
  • POSTCreate serverless cache/#Action=CreateServerlessCache?Action=CreateServerlessCache&Version=2015-02-02Creates a serverless cache.
  • POSTCreate serverless cache snapshot/#Action=CreateServerlessCacheSnapshot?Action=CreateServerlessCacheSnapshot&Version=2015-02-02This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.
  • POSTCreate snapshot/#Action=CreateSnapshot?Action=CreateSnapshot&Version=2015-02-02Creates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Valkey or Redis OSS only.
  • POSTCreate user/#Action=CreateUser?Action=CreateUser&Version=2015-02-02For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see Using Role Based Access Control (RBAC) .
  • POSTCreate user group/#Action=CreateUserGroup?Action=CreateUserGroup&Version=2015-02-02For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see Using Role Based Access Control (RBAC)
  • POSTDecrease node groups in global replication group/#Action=DecreaseNodeGroupsInGlobalReplicationGroup?Action=DecreaseNodeGroupsInGlobalReplicationGroup&Version=2015-02-02Decreases the number of node groups in a Global datastore
  • POSTDecrease replica count/#Action=DecreaseReplicaCount?Action=DecreaseReplicaCount&Version=2015-02-02Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more…
  • POSTDelete cache cluster/#Action=DeleteCacheCluster?Action=DeleteCacheCluster&Version=2015-02-02Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a…
  • POSTDelete cache parameter group/#Action=DeleteCacheParameterGroup?Action=DeleteCacheParameterGroup&Version=2015-02-02Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the…
  • POSTDelete cache security group/#Action=DeleteCacheSecurityGroup?Action=DeleteCacheSecurityGroup&Version=2015-02-02Deletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.
  • POSTDelete cache subnet group/#Action=DeleteCacheSubnetGroup?Action=DeleteCacheSubnetGroup&Version=2015-02-02Deletes a cache subnet group. You cannot delete a default cache subnet group or one that is associated with any clusters.
  • POSTDelete global replication group/#Action=DeleteGlobalReplicationGroup?Action=DeleteGlobalReplicationGroup&Version=2015-02-02Deleting a Global datastore is a two-step process: First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global…
  • POSTDelete replication group/#Action=DeleteReplicationGroup?Action=DeleteReplicationGroup&Version=2015-02-02Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read…
  • POSTDelete serverless cache/#Action=DeleteServerlessCache?Action=DeleteServerlessCache&Version=2015-02-02Deletes a specified existing serverless cache. CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the…
  • POSTDelete serverless cache snapshot/#Action=DeleteServerlessCacheSnapshot?Action=DeleteServerlessCacheSnapshot&Version=2015-02-02Deletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.
  • POSTDelete snapshot/#Action=DeleteSnapshot?Action=DeleteSnapshot&Version=2015-02-02Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot…
  • POSTDelete user/#Action=DeleteUser?Action=DeleteUser&Version=2015-02-02For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all…
  • POSTDelete user group/#Action=DeleteUserGroup?Action=DeleteUserGroup&Version=2015-02-02For Valkey engine version 7.2 onwards and Redis OSS 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group…
  • POSTDescribe cache clusters/#Action=DescribeCacheClusters?Action=DescribeCacheClusters&Version=2015-02-02Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is…
  • POSTDescribe cache engine versions/#Action=DescribeCacheEngineVersions?Action=DescribeCacheEngineVersions&Version=2015-02-02Returns a list of the available cache engines and their versions.
  • POSTDescribe cache parameter groups/#Action=DescribeCacheParameterGroups?Action=DescribeCacheParameterGroups&Version=2015-02-02Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
  • POSTDescribe cache parameters/#Action=DescribeCacheParameters?Action=DescribeCacheParameters&Version=2015-02-02Returns the detailed parameter list for a particular cache parameter group.
  • POSTDescribe cache security groups/#Action=DescribeCacheSecurityGroups?Action=DescribeCacheSecurityGroups&Version=2015-02-02Returns 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…
  • POSTDescribe cache subnet groups/#Action=DescribeCacheSubnetGroups?Action=DescribeCacheSubnetGroups&Version=2015-02-02Returns 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…
  • POSTDescribe engine default parameters/#Action=DescribeEngineDefaultParameters?Action=DescribeEngineDefaultParameters&Version=2015-02-02Returns the default engine and system parameter information for the specified cache engine.
  • POSTDescribe events/#Action=DescribeEvents?Action=DescribeEvents&Version=2015-02-02Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security…
  • POSTDescribe global replication groups/#Action=DescribeGlobalReplicationGroups?Action=DescribeGlobalReplicationGroups&Version=2015-02-02Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
  • POSTDescribe replication groups/#Action=DescribeReplicationGroups?Action=DescribeReplicationGroups&Version=2015-02-02Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication…
  • POSTDescribe reserved cache nodes/#Action=DescribeReservedCacheNodes?Action=DescribeReservedCacheNodes&Version=2015-02-02Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
  • POSTDescribe reserved cache nodes offerings/#Action=DescribeReservedCacheNodesOfferings?Action=DescribeReservedCacheNodesOfferings&Version=2015-02-02Lists available reserved cache node offerings.
  • POSTDescribe serverless cache snapshots/#Action=DescribeServerlessCacheSnapshots?Action=DescribeServerlessCacheSnapshots&Version=2015-02-02Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a…
  • POSTDescribe serverless caches/#Action=DescribeServerlessCaches?Action=DescribeServerlessCaches&Version=2015-02-02Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging…
  • POSTDescribe service updates/#Action=DescribeServiceUpdates?Action=DescribeServiceUpdates&Version=2015-02-02Returns details of the service updates
  • POSTDescribe snapshots/#Action=DescribeSnapshots?Action=DescribeSnapshots&Version=2015-02-02Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a…
  • POSTDescribe update actions/#Action=DescribeUpdateActions?Action=DescribeUpdateActions&Version=2015-02-02Returns details of the update actions
  • POSTDescribe user groups/#Action=DescribeUserGroups?Action=DescribeUserGroups&Version=2015-02-02Returns a list of user groups.
  • POSTDescribe users/#Action=DescribeUsers?Action=DescribeUsers&Version=2015-02-02Returns a list of users.
  • POSTDisassociate global replication group/#Action=DisassociateGlobalReplicationGroup?Action=DisassociateGlobalReplicationGroup&Version=2015-02-02Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary…
  • POSTExport serverless cache snapshot/#Action=ExportServerlessCacheSnapshot?Action=ExportServerlessCacheSnapshot&Version=2015-02-02Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.
  • POSTFailover global replication group/#Action=FailoverGlobalReplicationGroup?Action=FailoverGlobalReplicationGroup&Version=2015-02-02Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
  • POSTIncrease node groups in global replication group/#Action=IncreaseNodeGroupsInGlobalReplicationGroup?Action=IncreaseNodeGroupsInGlobalReplicationGroup&Version=2015-02-02Increase the number of node groups in the Global datastore
  • POSTIncrease replica count/#Action=IncreaseReplicaCount?Action=IncreaseReplicaCount&Version=2015-02-02Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more…
  • POSTList allowed node type modifications/#Action=ListAllowedNodeTypeModifications?Action=ListAllowedNodeTypeModifications&Version=2015-02-02Lists all available node types that you can scale with your cluster's replication group's current node type. When you use the ModifyCacheCluster or…
  • POSTList tags for resource/#Action=ListTagsForResource?Action=ListTagsForResource&Version=2015-02-02Lists 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…
  • POSTModify cache cluster/#Action=ModifyCacheCluster?Action=ModifyCacheCluster&Version=2015-02-02Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the…
  • POSTModify cache parameter group/#Action=ModifyCacheParameterGroup?Action=ModifyCacheParameterGroup&Version=2015-02-02Modifies 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.
  • POSTModify cache subnet group/#Action=ModifyCacheSubnetGroup?Action=ModifyCacheSubnetGroup&Version=2015-02-02Modifies an existing cache subnet group.
  • POSTModify global replication group/#Action=ModifyGlobalReplicationGroup?Action=ModifyGlobalReplicationGroup&Version=2015-02-02Modifies the settings for a Global datastore.
  • POSTModify replication group/#Action=ModifyReplicationGroup?Action=ModifyReplicationGroup&Version=2015-02-02Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above. Scaling for Valkey or Redis OSS (cluster mode enabled) in…
  • POSTModify replication group shard configuration/#Action=ModifyReplicationGroupShardConfiguration?Action=ModifyReplicationGroupShardConfiguration&Version=2015-02-02Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
  • POSTModify serverless cache/#Action=ModifyServerlessCache?Action=ModifyServerlessCache&Version=2015-02-02This API modifies the attributes of a serverless cache.
  • POSTModify user/#Action=ModifyUser?Action=ModifyUser&Version=2015-02-02Changes user password(s) and/or access string.
  • POSTModify user group/#Action=ModifyUserGroup?Action=ModifyUserGroup&Version=2015-02-02Changes the list of users that belong to the user group.
  • POSTPrepare migration/#Action=PrepareMigration?Action=PrepareMigration&Version=2015-02-02Prepares the serverless cache for data migration by validating the configuration and setting up the migration resources.
  • POSTPurchase reserved cache nodes offering/#Action=PurchaseReservedCacheNodesOffering?Action=PurchaseReservedCacheNodesOffering&Version=2015-02-02Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see…
  • POSTRebalance slots in global replication group/#Action=RebalanceSlotsInGlobalReplicationGroup?Action=RebalanceSlotsInGlobalReplicationGroup&Version=2015-02-02Redistribute slots to ensure uniform distribution across existing shards in the cluster.
  • POSTReboot cache cluster/#Action=RebootCacheCluster?Action=RebootCacheCluster&Version=2015-02-02Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot…
  • POSTRemove tags from resource/#Action=RemoveTagsFromResource?Action=RemoveTagsFromResource&Version=2015-02-02Removes 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…
  • POSTReset cache parameter group/#Action=ResetCacheParameterGroup?Action=ResetCacheParameterGroup&Version=2015-02-02Modifies 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…
  • POSTRevoke cache security group ingress/#Action=RevokeCacheSecurityGroupIngress?Action=RevokeCacheSecurityGroupIngress&Version=2015-02-02Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
  • POSTStart migration/#Action=StartMigration?Action=StartMigration&Version=2015-02-02Starts the migration of data.
  • POSTStop migration/#Action=StopMigration?Action=StopMigration&Version=2015-02-02Stops an ongoing data sync between the source and the serverless cache. The migration remains open and the data sync can be restarted. This operation is valid…
  • POSTTest failover/#Action=TestFailover?Action=TestFailover&Version=2015-02-02Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group…
  • POSTTest migration/#Action=TestMigration?Action=TestMigration&Version=2015-02-02Async API to test connection between source and target replication group.

API details

Base URL
https://elasticache.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
77 operations on 77 pathsPOST 77
Description format
AWS Smithy model, API version 2015-02-02

How to test the Amazon ElastiCache in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon ElastiCache collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add tags to resource” (POST /#Action=AddTagsToResource?Action=AddTagsToResource&Version=2015-02-02), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon ElastiCache?

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,… It is listed under Developer tools and has 77 endpoints.

Who publishes the Amazon ElastiCache?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon ElastiCache?

Requests go to https://elasticache.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon ElastiCache?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon ElastiCache have?

77 operations on 77 paths (77 POST).

Is forking the Amazon ElastiCache free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.