Package-level declarations

Types

Link copied to clipboard

Represents the input of an AddTagsToResource operation.

Link copied to clipboard

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

Link copied to clipboard

The customer has exceeded the allowed rate of API calls.

Link copied to clipboard

Indicates whether the user requires a password to authenticate.

Link copied to clipboard

Specifies the authentication mode to use.

Link copied to clipboard
sealed class AuthenticationType
Link copied to clipboard

The specified Amazon EC2 security group is already authorized for the specified cache security group.

Link copied to clipboard

The specified Amazon EC2 security group is not authorized for the specified cache security group.

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Describes an Availability Zone in which the cluster is launched.

Link copied to clipboard
sealed class AzMode
Link copied to clipboard

Contains all of the attributes of a specific cluster.

Link copied to clipboard

You already have a cluster with the given identifier.

Link copied to clipboard

The requested cluster ID does not refer to an existing cluster.

Link copied to clipboard

Provides all of the details about a particular cache engine version.

Link copied to clipboard
class CacheNode

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, Valkey or Redis OSS.

Link copied to clipboard

A parameter that has a different value for each cache node type it is applied to. For example, in a Valkey or Redis OSS cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

Link copied to clipboard

A value that applies only to a certain cache node type.

Link copied to clipboard

The status of the service update on the cache node

Link copied to clipboard

Represents the output of a CreateCacheParameterGroup operation.

Link copied to clipboard

A cache parameter group with the requested name already exists.

Link copied to clipboard

The requested cache parameter group name does not refer to an existing cache parameter group.

Link copied to clipboard

The request cannot be processed because it would exceed the maximum number of cache security groups.

Link copied to clipboard

Status of the cache parameter group.

Link copied to clipboard

Represents the output of one of the following operations:

Link copied to clipboard

A cache security group with the specified name already exists.

Link copied to clipboard

Represents a cluster's status within a particular cache security group.

Link copied to clipboard

The requested cache security group name does not refer to an existing cache security group.

Link copied to clipboard

The request cannot be processed because it would exceed the allowed number of cache security groups.

Link copied to clipboard

Represents the output of one of the following operations:

Link copied to clipboard

The requested cache subnet group name is already in use by an existing cache subnet group.

Link copied to clipboard

The requested cache subnet group is currently in use.

Link copied to clipboard

The requested cache subnet group name does not refer to an existing cache subnet group.

Link copied to clipboard

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

Link copied to clipboard

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

Link copied to clipboard

The usage limits for storage and ElastiCache Processing Units for the cache.

Link copied to clipboard
sealed class ChangeType
Link copied to clipboard

The configuration details of the CloudWatch Logs destination.

Link copied to clipboard
sealed class ClusterMode
Link copied to clipboard

The request cannot be processed because it would exceed the allowed number of clusters per customer.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

Link copied to clipboard

Represents the input of a CopySnapshotMessage operation.

Link copied to clipboard
Link copied to clipboard

Represents the input of a CreateCacheCluster operation.

Link copied to clipboard

Represents the input of a CreateCacheParameterGroup operation.

Link copied to clipboard

Represents the input of a CreateCacheSecurityGroup operation.

Link copied to clipboard

Represents the input of a CreateCacheSubnetGroup operation.

Link copied to clipboard

Represents the input of a CreateReplicationGroup operation.

Link copied to clipboard

Represents the input of a CreateSnapshot operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The endpoint from which data should be migrated.

Link copied to clipboard

The data storage limit.

Link copied to clipboard
sealed class DataStorageUnit
Link copied to clipboard
sealed class DataTieringStatus
Link copied to clipboard

The default user assigned to the user group.

Link copied to clipboard

You must add default user to a user group.

Link copied to clipboard

Represents the input of a DeleteCacheCluster operation.

Link copied to clipboard

Represents the input of a DeleteCacheParameterGroup operation.

Link copied to clipboard

Represents the input of a DeleteCacheSecurityGroup operation.

Link copied to clipboard

Represents the input of a DeleteCacheSubnetGroup operation.

Link copied to clipboard

Represents the input of a DeleteReplicationGroup operation.

Link copied to clipboard

Represents the input of a DeleteSnapshot operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Represents the input of a DescribeCacheClusters operation.

Link copied to clipboard

Represents the output of a DescribeCacheClusters operation.

Link copied to clipboard

Represents the input of a DescribeCacheEngineVersions operation.

Link copied to clipboard

Represents the output of a DescribeCacheEngineVersions operation.

Link copied to clipboard

Represents the input of a DescribeCacheParameterGroups operation.

Link copied to clipboard

Represents the output of a DescribeCacheParameterGroups operation.

Link copied to clipboard

Represents the input of a DescribeCacheParameters operation.

Link copied to clipboard

Represents the output of a DescribeCacheParameters operation.

Link copied to clipboard

Represents the input of a DescribeCacheSecurityGroups operation.

Link copied to clipboard

Represents the output of a DescribeCacheSecurityGroups operation.

Link copied to clipboard

Represents the input of a DescribeCacheSubnetGroups operation.

Link copied to clipboard

Represents the output of a DescribeCacheSubnetGroups operation.

Link copied to clipboard

Represents the input of a DescribeEngineDefaultParameters operation.

Link copied to clipboard

Represents the input of a DescribeEvents operation.

Link copied to clipboard

Represents the output of a DescribeEvents operation.

Link copied to clipboard

Represents the input of a DescribeReplicationGroups operation.

Link copied to clipboard

Represents the output of a DescribeReplicationGroups operation.

Represents the input of a DescribeReservedCacheNodesOfferings operation.

Represents the output of a DescribeReservedCacheNodesOfferings operation.

Link copied to clipboard

Represents the input of a DescribeReservedCacheNodes operation.

Link copied to clipboard

Represents the output of a DescribeReservedCacheNodes operation.

Link copied to clipboard

Represents the input of a DescribeSnapshotsMessage operation.

Link copied to clipboard

Represents the output of a DescribeSnapshots operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

Link copied to clipboard
sealed class DestinationType
Link copied to clipboard

A user with this username already exists.

Link copied to clipboard

Provides ownership and status information for an Amazon EC2 security group.

Link copied to clipboard

The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.

Link copied to clipboard

Base class for all service related exceptions thrown by the ElastiCache client

Link copied to clipboard
class Endpoint

Represents the information required for client programs to connect to a cache node. This value is read-only.

Link copied to clipboard

Represents the output of a DescribeEngineDefaultParameters operation.

Link copied to clipboard
class 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.

Link copied to clipboard
class Filter

Used to streamline results of a search based on the property being filtered.

Link copied to clipboard

Indicates the slot configuration and global identifier for a slice group.

Link copied to clipboard

Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

Link copied to clipboard

The Global datastore name already exists.

Link copied to clipboard

The name of the Global datastore and role of this replication group in the Global datastore.

Link copied to clipboard

A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.

Link copied to clipboard

The Global datastore does not exist

Link copied to clipboard
Link copied to clipboard

The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

Link copied to clipboard

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

Link copied to clipboard

The requested cluster is not in the available state.

Link copied to clipboard

The current state of the cache parameter group does not allow the requested operation to occur.

Link copied to clipboard

The current state of the cache security group does not allow deletion.

Link copied to clipboard

You must enter valid credentials.

Link copied to clipboard

The Global datastore is not available or in primary-only state.

Link copied to clipboard

The KMS key supplied is not valid.

Link copied to clipboard

Two or more incompatible parameters were specified.

Link copied to clipboard

The value for a parameter is invalid.

Link copied to clipboard

The requested replication group is not in the available state.

Link copied to clipboard

The state of the serverless cache snapshot was not received. Available for Valkey, Redis OSS and Serverless Memcached only.

Link copied to clipboard

The account for these credentials is not currently active.

Link copied to clipboard

The current state of the snapshot does not allow the requested operation to occur.

Link copied to clipboard

An invalid subnet identifier was specified.

Link copied to clipboard

The user group is not in an active state.

Link copied to clipboard

The user is not in active state.

Link copied to clipboard

The VPC network is in an invalid state.

Link copied to clipboard
sealed class IpDiscovery
Link copied to clipboard

The configuration details of the Kinesis Data Firehose destination.

Link copied to clipboard

The input parameters for the ListAllowedNodeTypeModifications operation.

Link copied to clipboard

Represents the allowed node types you can use to modify your cluster or replication group.

Link copied to clipboard

The input parameters for the ListTagsForResource operation.

Link copied to clipboard

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

Link copied to clipboard

Returns the destination, format and type of the logs.

Link copied to clipboard

Specifies the destination, format and type of the logs.

Link copied to clipboard
Link copied to clipboard
sealed class LogFormat
Link copied to clipboard
sealed class LogType
Link copied to clipboard

Represents the input of a ModifyCacheCluster operation.

Link copied to clipboard

Represents the input of a ModifyCacheParameterGroup operation.

Link copied to clipboard

Represents the output of one of the following operations:

Link copied to clipboard

Represents the input of a ModifyCacheSubnetGroup operation.

Link copied to clipboard

Represents the input of a ModifyReplicationGroups operation.

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed class MultiAzStatus
Link copied to clipboard
sealed class NetworkType
Link copied to clipboard
class NodeGroup

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.

Link copied to clipboard

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

Link copied to clipboard

Represents a single node within a node group (shard).

Link copied to clipboard

The status of the service update on the node group member

Link copied to clipboard

The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.

The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90

Link copied to clipboard

The status of the service update on the node group

Link copied to clipboard

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

Link copied to clipboard

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

Link copied to clipboard

Represents an individual cache node in a snapshot of a cluster.

Link copied to clipboard
Link copied to clipboard
sealed class NodeUpdateStatus
Link copied to clipboard

The operation was not performed because no changes were required.

Link copied to clipboard

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

Link copied to clipboard
sealed class OutpostMode
Link copied to clipboard
class Parameter

Describes an individual setting that controls some aspect of ElastiCache behavior.

Link copied to clipboard

Describes a name-value pair that is used to update the value of a parameter.

Link copied to clipboard
Link copied to clipboard

The log delivery configurations being modified

Link copied to clipboard

A group of settings that are applied to the cluster in the future, or that are currently being applied.

Link copied to clipboard

Update action that has been processed for the corresponding apply/stop request

Represents the input of a PurchaseReservedCacheNodesOffering operation.

Link copied to clipboard

Represents the input of a RebootCacheCluster operation.

Link copied to clipboard

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

Link copied to clipboard

A list of the replication groups

Link copied to clipboard

Represents the input of a RemoveTagsFromResource operation.

Link copied to clipboard

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

Link copied to clipboard

Contains all of the attributes of a specific Valkey or Redis OSS replication group.

Link copied to clipboard

The specified replication group already exists.

The targeted replication group is not available.

Link copied to clipboard

The specified replication group does not exist.

Link copied to clipboard

The designated replication group is not available for data migration.

Link copied to clipboard

The settings to be applied to the Valkey or Redis OSS replication group, either immediately or during the next maintenance window.

Link copied to clipboard

Represents the output of a PurchaseReservedCacheNodesOffering operation.

Link copied to clipboard

You already have a reservation with the given identifier.

Link copied to clipboard

The requested reserved cache node was not found.

Link copied to clipboard

The request cannot be processed because it would exceed the user's cache node quota.

Link copied to clipboard

Describes all of the attributes of a reserved cache node offering.

Link copied to clipboard

The requested cache node offering does not exist.

Link copied to clipboard

Represents the input of a ResetCacheParameterGroup operation.

Link copied to clipboard

Represents the output of one of the following operations:

Link copied to clipboard

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

Link copied to clipboard

The status of an online resharding operation.

Link copied to clipboard

Represents the input of a RevokeCacheSecurityGroupIngress operation.

Link copied to clipboard

Configuration settings for horizontal or vertical scaling operations on Memcached clusters.

Link copied to clipboard

Represents a single cache security group and its status.

Link copied to clipboard

The resource representing a serverless cache.

Link copied to clipboard

A serverless cache with this name already exists.

Link copied to clipboard

The configuration settings for a specific serverless cache.

Link copied to clipboard

The serverless cache was not found or does not exist.

The number of serverless caches exceeds the customer quota.

Link copied to clipboard

The resource representing a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.

Link copied to clipboard

This serverless cache snapshot could not be found or does not exist. Available for Valkey, Redis OSS and Serverless Memcached only.

The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Valkey, Redis OSS and Serverless Memcached only.

Link copied to clipboard

The specified service linked role (SLR) was not found.

Link copied to clipboard

An update that you can apply to your Valkey or Redis OSS clusters.

Link copied to clipboard

The service update doesn't exist

Link copied to clipboard
Link copied to clipboard
sealed class ServiceUpdateStatus
Link copied to clipboard
sealed class ServiceUpdateType
Link copied to clipboard
sealed class SlaMet
Link copied to clipboard

Represents the progress of an online resharding operation.

Link copied to clipboard
class Snapshot

Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.

Link copied to clipboard

You already have a snapshot with the given name.

Link copied to clipboard

You attempted one of the following operations:

Link copied to clipboard

The requested snapshot name does not refer to an existing snapshot.

Link copied to clipboard

The request cannot be processed because it would exceed the maximum number of snapshots.

Link copied to clipboard
sealed class SourceType
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class 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.

Link copied to clipboard

The requested subnet is being used by another cache subnet group.

Link copied to clipboard

At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.

Link copied to clipboard

The ID of the outpost subnet.

Link copied to clipboard
class Tag

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.

Link copied to clipboard

The requested tag was not found on this resource.

Link copied to clipboard

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

Link copied to clipboard

The TestFailover action is not available.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Filters update actions from the service updates that are in available status during the time range.

Link copied to clipboard
Link copied to clipboard

Update action that has failed to be processed for the corresponding apply/stop request

Link copied to clipboard

The status of the service update for a specific replication group

Link copied to clipboard
sealed class UpdateActionStatus
Link copied to clipboard
class User
Link copied to clipboard

A user with this ID already exists.

Link copied to clipboard
class UserGroup
Link copied to clipboard

The user group with this ID already exists.

Link copied to clipboard

The user group was not found or does not exist

Link copied to clipboard

Returns the updates being applied to the user group.

Link copied to clipboard

The number of users exceeds the user group limit.

Link copied to clipboard

The status of the user group update.

Link copied to clipboard

The user does not exist or could not be found.

Link copied to clipboard

The quota of users has been exceeded.