Expand description
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.
If you’re using the service, you’re probably looking for ElastiCacheClient and ElastiCache.
Structs§
- AddTags
ToResource Message Represents the input of an AddTagsToResource operation.
- Allowed
Node Type Modifications Message Represents the allowed node types you can use to modify your cluster or replication group.
- Authorize
Cache Security Group Ingress Message Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
- Authorize
Cache Security Group Ingress Result - Availability
Zone Describes an Availability Zone in which the cluster is launched.
- Batch
Apply Update Action Message - Batch
Stop Update Action Message - Cache
Cluster Contains all of the attributes of a specific cluster.
- Cache
Cluster Message Represents the output of a
DescribeCacheClustersoperation.- Cache
Engine Version Provides all of the details about a particular cache engine version.
- Cache
Engine Version Message Represents the output of a DescribeCacheEngineVersions operation.
- Cache
Node Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
-
General purpose:
-
Current generation:
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.medium -
Previous generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
-
-
Compute optimized:
-
Previous generation: (not recommended)
C1 node types:
cache.c1.xlarge
-
-
Memory optimized:
-
Current generation:
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlarge -
Previous generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 node types:
cache.r3.large,cache.r3.xlarge,cache.r3.2xlarge,cache.r3.4xlarge,cache.r3.8xlarge
-
Additional node type info
-
All current generation instance types are created in Amazon VPC by default.
-
Redis append-only files (AOF) are not supported for T1 or T2 instances.
-
Redis Multi-AZ with automatic failover is not supported on T1 instances.
-
Redis configuration variables
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
-
- Cache
Node Type Specific Parameter A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a
cache.m1.largecache node type would have a largermaxmemoryvalue than acache.m1.smalltype.- Cache
Node Type Specific Value A value that applies only to a certain cache node type.
- Cache
Node Update Status The status of the service update on the cache node
- Cache
Parameter Group Represents the output of a
CreateCacheParameterGroupoperation.- Cache
Parameter Group Details Represents the output of a
DescribeCacheParametersoperation.- Cache
Parameter Group Name Message Represents the output of one of the following operations:
-
ModifyCacheParameterGroup -
ResetCacheParameterGroup
-
- Cache
Parameter Group Status Status of the cache parameter group.
- Cache
Parameter Groups Message Represents the output of a
DescribeCacheParameterGroupsoperation.- Cache
Security Group Represents the output of one of the following operations:
-
AuthorizeCacheSecurityGroupIngress -
CreateCacheSecurityGroup -
RevokeCacheSecurityGroupIngress
-
- Cache
Security Group Membership Represents a cluster's status within a particular cache security group.
- Cache
Security Group Message Represents the output of a
DescribeCacheSecurityGroupsoperation.- Cache
Subnet Group Represents the output of one of the following operations:
-
CreateCacheSubnetGroup -
ModifyCacheSubnetGroup
-
- Cache
Subnet Group Message Represents the output of a
DescribeCacheSubnetGroupsoperation.- Complete
Migration Message - Complete
Migration Response - Configure
Shard Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
- Copy
Snapshot Message Represents the input of a
CopySnapshotMessageoperation.- Copy
Snapshot Result - Create
Cache Cluster Message Represents the input of a CreateCacheCluster operation.
- Create
Cache Cluster Result - Create
Cache Parameter Group Message Represents the input of a
CreateCacheParameterGroupoperation.- Create
Cache Parameter Group Result - Create
Cache Security Group Message Represents the input of a
CreateCacheSecurityGroupoperation.- Create
Cache Security Group Result - Create
Cache Subnet Group Message Represents the input of a
CreateCacheSubnetGroupoperation.- Create
Cache Subnet Group Result - Create
Global Replication Group Message - Create
Global Replication Group Result - Create
Replication Group Message Represents the input of a
CreateReplicationGroupoperation.- Create
Replication Group Result - Create
Snapshot Message Represents the input of a
CreateSnapshotoperation.- Create
Snapshot Result - Customer
Node Endpoint The endpoint from which data should be migrated.
- Decrease
Node Groups InGlobal Replication Group Message - Decrease
Node Groups InGlobal Replication Group Result - Decrease
Replica Count Message - Decrease
Replica Count Result - Delete
Cache Cluster Message Represents the input of a
DeleteCacheClusteroperation.- Delete
Cache Cluster Result - Delete
Cache Parameter Group Message Represents the input of a
DeleteCacheParameterGroupoperation.- Delete
Cache Security Group Message Represents the input of a
DeleteCacheSecurityGroupoperation.- Delete
Cache Subnet Group Message Represents the input of a
DeleteCacheSubnetGroupoperation.- Delete
Global Replication Group Message - Delete
Global Replication Group Result - Delete
Replication Group Message Represents the input of a
DeleteReplicationGroupoperation.- Delete
Replication Group Result - Delete
Snapshot Message Represents the input of a
DeleteSnapshotoperation.- Delete
Snapshot Result - Describe
Cache Clusters Message Represents the input of a
DescribeCacheClustersoperation.- Describe
Cache Engine Versions Message Represents the input of a
DescribeCacheEngineVersionsoperation.- Describe
Cache Parameter Groups Message Represents the input of a
DescribeCacheParameterGroupsoperation.- Describe
Cache Parameters Message Represents the input of a
DescribeCacheParametersoperation.- Describe
Cache Security Groups Message Represents the input of a
DescribeCacheSecurityGroupsoperation.- Describe
Cache Subnet Groups Message Represents the input of a
DescribeCacheSubnetGroupsoperation.- Describe
Engine Default Parameters Message Represents the input of a
DescribeEngineDefaultParametersoperation.- Describe
Engine Default Parameters Result - Describe
Events Message Represents the input of a
DescribeEventsoperation.- Describe
Global Replication Groups Message - Describe
Global Replication Groups Result - Describe
Replication Groups Message Represents the input of a
DescribeReplicationGroupsoperation.- Describe
Reserved Cache Nodes Message Represents the input of a
DescribeReservedCacheNodesoperation.- Describe
Reserved Cache Nodes Offerings Message Represents the input of a
DescribeReservedCacheNodesOfferingsoperation.- Describe
Service Updates Message - Describe
Snapshots List Message Represents the output of a
DescribeSnapshotsoperation.- Describe
Snapshots Message Represents the input of a
DescribeSnapshotsMessageoperation.- Describe
Update Actions Message - Disassociate
Global Replication Group Message - Disassociate
Global Replication Group Result - EC2Security
Group Provides ownership and status information for an Amazon EC2 security group.
- Elasti
Cache Client - A client for the Amazon ElastiCache API.
- Endpoint
Represents the information required for client programs to connect to a cache node.
- Engine
Defaults Represents the output of a
DescribeEngineDefaultParametersoperation.- Event
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
- Events
Message Represents the output of a
DescribeEventsoperation.- Failover
Global Replication Group Message - Failover
Global Replication Group Result - Global
Node Group Indicates the slot configuration and global identifier for a slice group.
- Global
Replication Group Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
-
The GlobalReplicationGroupIdSuffix represents the name of the Global Datastore, which is what you use to associate a secondary cluster.
-
- Global
Replication Group Info The name of the Global Datastore and role of this replication group in the Global Datastore.
- Global
Replication Group Member A member of a Global Datastore. It contains the Replication Group Id, the AWS region and the role of the replication group.
- Increase
Node Groups InGlobal Replication Group Message - Increase
Node Groups InGlobal Replication Group Result - Increase
Replica Count Message - Increase
Replica Count Result - List
Allowed Node Type Modifications Message The input parameters for the
ListAllowedNodeTypeModificationsoperation.- List
Tags ForResource Message The input parameters for the
ListTagsForResourceoperation.- Modify
Cache Cluster Message Represents the input of a
ModifyCacheClusteroperation.- Modify
Cache Cluster Result - Modify
Cache Parameter Group Message Represents the input of a
ModifyCacheParameterGroupoperation.- Modify
Cache Subnet Group Message Represents the input of a
ModifyCacheSubnetGroupoperation.- Modify
Cache Subnet Group Result - Modify
Global Replication Group Message - Modify
Global Replication Group Result - Modify
Replication Group Message Represents the input of a
ModifyReplicationGroupsoperation.- Modify
Replication Group Result - Modify
Replication Group Shard Configuration Message Represents the input for a
ModifyReplicationGroupShardConfigurationoperation.- Modify
Replication Group Shard Configuration Result - Node
Group Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
- Node
Group Configuration Node group (shard) configuration options. Each node group (shard) configuration has the following:
Slots,PrimaryAvailabilityZone,ReplicaAvailabilityZones,ReplicaCount.- Node
Group Member Represents a single node within a node group (shard).
- Node
Group Member Update Status The status of the service update on the node group member
- Node
Group Update Status The status of the service update on the node group
- Node
Snapshot Represents an individual cache node in a snapshot of a cluster.
- Notification
Configuration Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
- Parameter
Describes an individual setting that controls some aspect of ElastiCache behavior.
- Parameter
Name Value Describes a name-value pair that is used to update the value of a parameter.
- Pending
Modified Values A group of settings that are applied to the cluster in the future, or that are currently being applied.
- Processed
Update Action Update action that has been processed for the corresponding apply/stop request
- Purchase
Reserved Cache Nodes Offering Message Represents the input of a
PurchaseReservedCacheNodesOfferingoperation.- Purchase
Reserved Cache Nodes Offering Result - Rebalance
Slots InGlobal Replication Group Message - Rebalance
Slots InGlobal Replication Group Result - Reboot
Cache Cluster Message Represents the input of a
RebootCacheClusteroperation.- Reboot
Cache Cluster Result - Recurring
Charge Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
- Regional
Configuration A list of the replication groups
- Remove
Tags From Resource Message Represents the input of a
RemoveTagsFromResourceoperation.- Replication
Group Contains all of the attributes of a specific Redis replication group.
- Replication
Group Message Represents the output of a
DescribeReplicationGroupsoperation.- Replication
Group Pending Modified Values The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.
- Reserved
Cache Node Represents the output of a
PurchaseReservedCacheNodesOfferingoperation.- Reserved
Cache Node Message Represents the output of a
DescribeReservedCacheNodesoperation.- Reserved
Cache Nodes Offering Describes all of the attributes of a reserved cache node offering.
- Reserved
Cache Nodes Offering Message Represents the output of a
DescribeReservedCacheNodesOfferingsoperation.- Reset
Cache Parameter Group Message Represents the input of a
ResetCacheParameterGroupoperation.- Resharding
Configuration A list of
PreferredAvailabilityZonesobjects that specifies the configuration of a node group in the resharded cluster.- Resharding
Status The status of an online resharding operation.
- Revoke
Cache Security Group Ingress Message Represents the input of a
RevokeCacheSecurityGroupIngressoperation.- Revoke
Cache Security Group Ingress Result - Security
Group Membership Represents a single cache security group and its status.
- Service
Update An update that you can apply to your Redis clusters.
- Service
Updates Message - Slot
Migration Represents the progress of an online resharding operation.
- Snapshot
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
- Start
Migration Message - Start
Migration Response - Subnet
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
- Tag
A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.
- TagList
Message Represents the output from the
AddTagsToResource,ListTagsForResource, andRemoveTagsFromResourceoperations.- Test
Failover Message - Test
Failover Result - Time
Range Filter Filters update actions from the service updates that are in available status during the time range.
- Unprocessed
Update Action Update action that has failed to be processed for the corresponding apply/stop request
- Update
Action The status of the service update for a specific replication group
- Update
Action Results Message - Update
Actions Message
Enums§
- AddTags
ToResource Error - Errors returned by AddTagsToResource
- Authorize
Cache Security Group Ingress Error - Errors returned by AuthorizeCacheSecurityGroupIngress
- Batch
Apply Update Action Error - Errors returned by BatchApplyUpdateAction
- Batch
Stop Update Action Error - Errors returned by BatchStopUpdateAction
- Complete
Migration Error - Errors returned by CompleteMigration
- Copy
Snapshot Error - Errors returned by CopySnapshot
- Create
Cache Cluster Error - Errors returned by CreateCacheCluster
- Create
Cache Parameter Group Error - Errors returned by CreateCacheParameterGroup
- Create
Cache Security Group Error - Errors returned by CreateCacheSecurityGroup
- Create
Cache Subnet Group Error - Errors returned by CreateCacheSubnetGroup
- Create
Global Replication Group Error - Errors returned by CreateGlobalReplicationGroup
- Create
Replication Group Error - Errors returned by CreateReplicationGroup
- Create
Snapshot Error - Errors returned by CreateSnapshot
- Decrease
Node Groups InGlobal Replication Group Error - Errors returned by DecreaseNodeGroupsInGlobalReplicationGroup
- Decrease
Replica Count Error - Errors returned by DecreaseReplicaCount
- Delete
Cache Cluster Error - Errors returned by DeleteCacheCluster
- Delete
Cache Parameter Group Error - Errors returned by DeleteCacheParameterGroup
- Delete
Cache Security Group Error - Errors returned by DeleteCacheSecurityGroup
- Delete
Cache Subnet Group Error - Errors returned by DeleteCacheSubnetGroup
- Delete
Global Replication Group Error - Errors returned by DeleteGlobalReplicationGroup
- Delete
Replication Group Error - Errors returned by DeleteReplicationGroup
- Delete
Snapshot Error - Errors returned by DeleteSnapshot
- Describe
Cache Clusters Error - Errors returned by DescribeCacheClusters
- Describe
Cache Engine Versions Error - Errors returned by DescribeCacheEngineVersions
- Describe
Cache Parameter Groups Error - Errors returned by DescribeCacheParameterGroups
- Describe
Cache Parameters Error - Errors returned by DescribeCacheParameters
- Describe
Cache Security Groups Error - Errors returned by DescribeCacheSecurityGroups
- Describe
Cache Subnet Groups Error - Errors returned by DescribeCacheSubnetGroups
- Describe
Engine Default Parameters Error - Errors returned by DescribeEngineDefaultParameters
- Describe
Events Error - Errors returned by DescribeEvents
- Describe
Global Replication Groups Error - Errors returned by DescribeGlobalReplicationGroups
- Describe
Replication Groups Error - Errors returned by DescribeReplicationGroups
- Describe
Reserved Cache Nodes Error - Errors returned by DescribeReservedCacheNodes
- Describe
Reserved Cache Nodes Offerings Error - Errors returned by DescribeReservedCacheNodesOfferings
- Describe
Service Updates Error - Errors returned by DescribeServiceUpdates
- Describe
Snapshots Error - Errors returned by DescribeSnapshots
- Describe
Update Actions Error - Errors returned by DescribeUpdateActions
- Disassociate
Global Replication Group Error - Errors returned by DisassociateGlobalReplicationGroup
- Failover
Global Replication Group Error - Errors returned by FailoverGlobalReplicationGroup
- Increase
Node Groups InGlobal Replication Group Error - Errors returned by IncreaseNodeGroupsInGlobalReplicationGroup
- Increase
Replica Count Error - Errors returned by IncreaseReplicaCount
- List
Allowed Node Type Modifications Error - Errors returned by ListAllowedNodeTypeModifications
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Modify
Cache Cluster Error - Errors returned by ModifyCacheCluster
- Modify
Cache Parameter Group Error - Errors returned by ModifyCacheParameterGroup
- Modify
Cache Subnet Group Error - Errors returned by ModifyCacheSubnetGroup
- Modify
Global Replication Group Error - Errors returned by ModifyGlobalReplicationGroup
- Modify
Replication Group Error - Errors returned by ModifyReplicationGroup
- Modify
Replication Group Shard Configuration Error - Errors returned by ModifyReplicationGroupShardConfiguration
- Purchase
Reserved Cache Nodes Offering Error - Errors returned by PurchaseReservedCacheNodesOffering
- Rebalance
Slots InGlobal Replication Group Error - Errors returned by RebalanceSlotsInGlobalReplicationGroup
- Reboot
Cache Cluster Error - Errors returned by RebootCacheCluster
- Remove
Tags From Resource Error - Errors returned by RemoveTagsFromResource
- Reset
Cache Parameter Group Error - Errors returned by ResetCacheParameterGroup
- Revoke
Cache Security Group Ingress Error - Errors returned by RevokeCacheSecurityGroupIngress
- Start
Migration Error - Errors returned by StartMigration
- Test
Failover Error - Errors returned by TestFailover
Traits§
- Elasti
Cache - Trait representing the capabilities of the Amazon ElastiCache API. Amazon ElastiCache clients implement this trait.