Crate rusoto_elasticache
source · [−]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
Represents the input of an AddTagsToResource operation.
Represents the allowed node types you can use to modify your cluster or replication group.
Indicates whether the user requires a password to authenticate.
Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
Describes an Availability Zone in which the cluster is launched.
Contains all of the attributes of a specific cluster.
Represents the output of a DescribeCacheClusters operation.
Provides all of the details about a particular cache engine version.
Represents the output of a DescribeCacheEngineVersions operation.
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:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.m6g.large,cache.m6g.xlarge,cache.m6g.2xlarge,cache.m6g.4xlarge,cache.m6g.8xlarge,cache.m6g.12xlarge,cache.m6g.16xlargeFor region availability, see Supported Node Types
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:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large,cache.r6g.xlarge,cache.r6g.2xlarge,cache.r6g.4xlarge,cache.r6g.8xlarge,cache.r6g.12xlarge,cache.r6g.16xlargeFor region availability, see Supported Node Types
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.
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.large cache node type would have a larger maxmemory value than a cache.m1.small type.
A value that applies only to a certain cache node type.
The status of the service update on the cache node
Represents the output of a CreateCacheParameterGroup operation.
Represents the output of a DescribeCacheParameters operation.
Represents the output of one of the following operations:
-
ModifyCacheParameterGroup -
ResetCacheParameterGroup
Status of the cache parameter group.
Represents the output of a DescribeCacheParameterGroups operation.
Represents the output of one of the following operations:
-
AuthorizeCacheSecurityGroupIngress -
CreateCacheSecurityGroup -
RevokeCacheSecurityGroupIngress
Represents a cluster's status within a particular cache security group.
Represents the output of a DescribeCacheSecurityGroups operation.
Represents the output of one of the following operations:
-
CreateCacheSubnetGroup -
ModifyCacheSubnetGroup
Represents the output of a DescribeCacheSubnetGroups operation.
The configuration details of the CloudWatch Logs destination.
Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
Represents the input of a CopySnapshotMessage operation.
Represents the input of a CreateCacheCluster operation.
Represents the input of a CreateCacheParameterGroup operation.
Represents the input of a CreateCacheSecurityGroup operation.
Represents the input of a CreateCacheSubnetGroup operation.
Represents the input of a CreateReplicationGroup operation.
Represents the input of a CreateSnapshot operation.
The endpoint from which data should be migrated.
Represents the input of a DeleteCacheCluster operation.
Represents the input of a DeleteCacheParameterGroup operation.
Represents the input of a DeleteCacheSecurityGroup operation.
Represents the input of a DeleteCacheSubnetGroup operation.
Represents the input of a DeleteReplicationGroup operation.
Represents the input of a DeleteSnapshot operation.
Represents the input of a DescribeCacheClusters operation.
Represents the input of a DescribeCacheEngineVersions operation.
Represents the input of a DescribeCacheParameterGroups operation.
Represents the input of a DescribeCacheParameters operation.
Represents the input of a DescribeCacheSecurityGroups operation.
Represents the input of a DescribeCacheSubnetGroups operation.
Represents the input of a DescribeEngineDefaultParameters operation.
Represents the input of a DescribeEvents operation.
Represents the input of a DescribeReplicationGroups operation.
Represents the input of a DescribeReservedCacheNodes operation.
Represents the input of a DescribeReservedCacheNodesOfferings operation.
Represents the output of a DescribeSnapshots operation.
Represents the input of a DescribeSnapshotsMessage operation.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
Provides ownership and status information for an Amazon EC2 security group.
A client for the Amazon ElastiCache API.
Represents the information required for client programs to connect to a cache node.
Represents the output of a DescribeEngineDefaultParameters operation.
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.
Represents the output of a DescribeEvents operation.
Used to streamline results of a search based on the property being filtered.
Indicates the slot configuration and global identifier for a slice 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.
The name of the Global datastore and role of this replication group in the Global datastore.
A member of a Global datastore. It contains the Replication Group Id, the AWS region and the role of the replication group.
The configuration details of the Kinesis Data Firehose destination.
The input parameters for the ListAllowedNodeTypeModifications operation.
The input parameters for the ListTagsForResource operation.
Returns the destination, format and type of the logs.
Specifies the destination, format and type of the logs.
Represents the input of a ModifyCacheCluster operation.
Represents the input of a ModifyCacheParameterGroup operation.
Represents the input of a ModifyCacheSubnetGroup operation.
Represents the input of a ModifyReplicationGroups operation.
Represents the input for a ModifyReplicationGroupShardConfiguration operation.
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 (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
Represents a single node within a node group (shard).
The status of the service update on the node group member
The status of the service update on the node group
Represents an individual cache node in a snapshot of a cluster.
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
Describes an individual setting that controls some aspect of ElastiCache behavior.
Describes a name-value pair that is used to update the value of a parameter.
The log delivery configurations being modified
A group of settings that are applied to the cluster in the future, or that are currently being applied.
Update action that has been processed for the corresponding apply/stop request
Represents the input of a PurchaseReservedCacheNodesOffering operation.
Represents the input of a RebootCacheCluster operation.
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
A list of the replication groups
Represents the input of a RemoveTagsFromResource operation.
Contains all of the attributes of a specific Redis replication group.
Represents the output of a DescribeReplicationGroups operation.
The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.
Represents the output of a PurchaseReservedCacheNodesOffering operation.
Represents the output of a DescribeReservedCacheNodes operation.
Describes all of the attributes of a reserved cache node offering.
Represents the output of a DescribeReservedCacheNodesOfferings operation.
Represents the input of a ResetCacheParameterGroup operation.
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
The status of an online resharding operation.
Represents the input of a RevokeCacheSecurityGroupIngress operation.
Represents a single cache security group and its status.
An update that you can apply to your Redis clusters.
Represents the progress of an online resharding operation.
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
The ID of the outpost subnet.
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. 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. A tag with a null Value is permitted.
Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.
Filters update actions from the service updates that are in available status during the time range.
Update action that has failed to be processed for the corresponding apply/stop request
The status of the service update for a specific replication group
Returns the updates being applied to the user group.
The status of the user group update.
Enums
Errors returned by AddTagsToResource
Errors returned by AuthorizeCacheSecurityGroupIngress
Errors returned by BatchApplyUpdateAction
Errors returned by BatchStopUpdateAction
Errors returned by CompleteMigration
Errors returned by CopySnapshot
Errors returned by CreateCacheCluster
Errors returned by CreateCacheParameterGroup
Errors returned by CreateCacheSecurityGroup
Errors returned by CreateCacheSubnetGroup
Errors returned by CreateGlobalReplicationGroup
Errors returned by CreateReplicationGroup
Errors returned by CreateSnapshot
Errors returned by CreateUser
Errors returned by CreateUserGroup
Errors returned by DecreaseNodeGroupsInGlobalReplicationGroup
Errors returned by DecreaseReplicaCount
Errors returned by DeleteCacheCluster
Errors returned by DeleteCacheParameterGroup
Errors returned by DeleteCacheSecurityGroup
Errors returned by DeleteCacheSubnetGroup
Errors returned by DeleteGlobalReplicationGroup
Errors returned by DeleteReplicationGroup
Errors returned by DeleteSnapshot
Errors returned by DeleteUser
Errors returned by DeleteUserGroup
Errors returned by DescribeCacheClusters
Errors returned by DescribeCacheEngineVersions
Errors returned by DescribeCacheParameterGroups
Errors returned by DescribeCacheParameters
Errors returned by DescribeCacheSecurityGroups
Errors returned by DescribeCacheSubnetGroups
Errors returned by DescribeEngineDefaultParameters
Errors returned by DescribeEvents
Errors returned by DescribeGlobalReplicationGroups
Errors returned by DescribeReplicationGroups
Errors returned by DescribeReservedCacheNodes
Errors returned by DescribeReservedCacheNodesOfferings
Errors returned by DescribeServiceUpdates
Errors returned by DescribeSnapshots
Errors returned by DescribeUpdateActions
Errors returned by DescribeUserGroups
Errors returned by DescribeUsers
Errors returned by DisassociateGlobalReplicationGroup
Errors returned by FailoverGlobalReplicationGroup
Errors returned by IncreaseNodeGroupsInGlobalReplicationGroup
Errors returned by IncreaseReplicaCount
Errors returned by ListAllowedNodeTypeModifications
Errors returned by ListTagsForResource
Errors returned by ModifyCacheCluster
Errors returned by ModifyCacheParameterGroup
Errors returned by ModifyCacheSubnetGroup
Errors returned by ModifyGlobalReplicationGroup
Errors returned by ModifyReplicationGroup
Errors returned by ModifyReplicationGroupShardConfiguration
Errors returned by ModifyUser
Errors returned by ModifyUserGroup
Errors returned by PurchaseReservedCacheNodesOffering
Errors returned by RebalanceSlotsInGlobalReplicationGroup
Errors returned by RebootCacheCluster
Errors returned by RemoveTagsFromResource
Errors returned by ResetCacheParameterGroup
Errors returned by RevokeCacheSecurityGroupIngress
Errors returned by StartMigration
Errors returned by TestFailover
Traits
Trait representing the capabilities of the Amazon ElastiCache API. Amazon ElastiCache clients implement this trait.