Values (p.awso.0.9.0.doc.awso.elasticache.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval xmlNamespace : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule Integer : sig ... end

Sourcemodule String_ : sig ... end

Sourcemodule NodeUpdateInitiatedBy : sig ... end

Sourcemodule NodeUpdateStatus : sig ... end

Sourcemodule TStamp : sig ... end

Sourcemodule Endpoint : sig ... end

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

Sourcemodule CloudWatchLogsDestinationDetails : sig ... end

The configuration details of the CloudWatch Logs destination.

Sourcemodule KinesisFirehoseDestinationDetails : sig ... end

The configuration details of the Kinesis Data Firehose destination.

Sourcemodule NodeGroupMemberUpdateStatus : sig ... end

The status of the service update on the node group member

Sourcemodule NodeGroupMember : sig ... end

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

Sourcemodule DestinationDetails : sig ... end

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

Sourcemodule DestinationType : sig ... end

Sourcemodule LogFormat : sig ... end

Sourcemodule LogType : sig ... end

Sourcemodule Double : sig ... end

Sourcemodule UserGroupId : sig ... end

Sourcemodule AllowedNodeGroupId : sig ... end

Sourcemodule AvailabilityZonesList : sig ... end

Sourcemodule IntegerOptional : sig ... end

Sourcemodule OutpostArnsList : sig ... end

Sourcemodule NetworkType : sig ... end

Sourcemodule NodeGroupMemberUpdateStatusList : sig ... end

Sourcemodule LogDeliveryConfigurationStatus : sig ... end

Sourcemodule NodeGroupMemberList : sig ... end

Sourcemodule PendingLogDeliveryConfiguration : sig ... end

The log delivery configurations being modified

Sourcemodule SlotMigration : sig ... end

Represents the progress of an online resharding operation.

Sourcemodule UserGroupIdList : sig ... end

Sourcemodule UserId : sig ... end

Sourcemodule NodeGroupConfiguration : sig ... end

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

Sourcemodule DataStorageUnit : sig ... end

Sourcemodule AutomaticFailoverStatus : sig ... end

Sourcemodule CacheNodeTypeSpecificValue : sig ... end

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

Sourcemodule AvailabilityZone : sig ... end

Describes an Availability Zone in which the cluster is launched.

Sourcemodule NetworkTypeList : sig ... end

Sourcemodule SubnetOutpost : sig ... end

The ID of the outpost subnet.

Sourcemodule CacheNodeUpdateStatus : sig ... end

The status of the service update on the cache node

Sourcemodule NodeGroupUpdateStatus : sig ... end

The status of the service update on the node group

Sourcemodule RecurringCharge : sig ... end

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

Sourcemodule LogDeliveryConfiguration : sig ... end

Returns the destination, format and type of the logs.

Sourcemodule NodeGroup : sig ... end

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.

Sourcemodule AuthTokenUpdateStatus : sig ... end

Sourcemodule BooleanOptional : sig ... end

Sourcemodule ClusterMode : sig ... end

Sourcemodule PendingAutomaticFailoverStatus : sig ... end

Sourcemodule PendingLogDeliveryConfigurationList : sig ... end

Sourcemodule ReshardingStatus : sig ... end

The status of an online resharding operation.

Sourcemodule TransitEncryptionMode : sig ... end

Sourcemodule UserGroupsUpdateStatus : sig ... end

The status of the user group update.

Sourcemodule ReshardingConfiguration : sig ... end

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

Sourcemodule AuthenticationType : sig ... end

Sourcemodule AwsQueryErrorMessage : sig ... end

Sourcemodule FilterValue : sig ... end

Sourcemodule UserIdList : sig ... end

Sourcemodule NodeSnapshot : sig ... end

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

Sourcemodule DataStorage : sig ... end

The data storage limit.

Sourcemodule ECPUPerSecond : sig ... end

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

Sourcemodule GlobalNodeGroup : sig ... end

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

Sourcemodule GlobalReplicationGroupMember : sig ... end

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

Sourcemodule Boolean : sig ... end

Sourcemodule CacheNodeTypeSpecificValueList : sig ... end

Sourcemodule ChangeType : sig ... end

Sourcemodule Subnet : sig ... end

Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

Sourcemodule EC2SecurityGroup : sig ... end

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

Sourcemodule CacheNode : sig ... end

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. 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: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge For region availability, see Supported Node Types M6g node types (available only for Redis OSS 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.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge Memory optimized: Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge For region availability, see Supported Node Types R6g node types (available only for Redis OSS 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.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 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. Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances. Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances. The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

Sourcemodule CacheNodeIdsList : sig ... end

Sourcemodule CacheSecurityGroupMembership : sig ... end

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

Sourcemodule ScaleConfig : sig ... end

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

Sourcemodule SecurityGroupMembership : sig ... end

Represents a single cache security group and its status.

Sourcemodule CacheNodeUpdateStatusList : sig ... end

Sourcemodule NodeGroupUpdateStatusList : sig ... end

Sourcemodule ServiceUpdateSeverity : sig ... end

Sourcemodule ServiceUpdateStatus : sig ... end

Sourcemodule ServiceUpdateType : sig ... end

Sourcemodule SlaMet : sig ... end

Sourcemodule UpdateActionStatus : sig ... end

Sourcemodule RecurringChargeList : sig ... end

Sourcemodule ClusterIdList : sig ... end

Sourcemodule DataTieringStatus : sig ... end

Sourcemodule GlobalReplicationGroupInfo : sig ... end

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

Sourcemodule IpDiscovery : sig ... end

Sourcemodule LogDeliveryConfigurationList : sig ... end

Sourcemodule MultiAZStatus : sig ... end

Sourcemodule NodeGroupList : sig ... end

Sourcemodule ReplicationGroupOutpostArnList : sig ... end

Sourcemodule ReplicationGroupPendingModifiedValues : sig ... end

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

Sourcemodule PreferredAvailabilityZoneList : sig ... end

Sourcemodule PreferredOutpostArnList : sig ... end

Sourcemodule ReshardingConfigurationList : sig ... end

Sourcemodule SourceType : sig ... end

Sourcemodule Authentication : sig ... end

Indicates whether the user requires a password to authenticate.

Sourcemodule DefaultUserAssociatedToUserGroupFault : sig ... end

The default user assigned to the user group.

Sourcemodule DuplicateUserNameFault : sig ... end

A user with this username already exists.

Sourcemodule EngineType : sig ... end

Sourcemodule InvalidParameterCombinationException : sig ... end

Two or more incompatible parameters were specified.

Sourcemodule InvalidParameterValueException : sig ... end

The value for a parameter is invalid.

Sourcemodule InvalidUserStateFault : sig ... end

The user is not in active state.

Sourcemodule ServiceLinkedRoleNotFoundFault : sig ... end

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

Sourcemodule TagQuotaPerResourceExceeded : sig ... end

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.

Sourcemodule UserAlreadyExistsFault : sig ... end

A user with this ID already exists.

Sourcemodule UserNotFoundFault : sig ... end

The user does not exist or could not be found.

Sourcemodule UserQuotaExceededFault : sig ... end

The quota of users has been exceeded.

Sourcemodule FilterName : sig ... end

Sourcemodule FilterValueList : sig ... end

Sourcemodule DefaultUserRequired : sig ... end

You must add default user to a user group.

Sourcemodule InvalidUserGroupStateFault : sig ... end

The user group is not in an active state.

Sourcemodule UGReplicationGroupIdList : sig ... end

Sourcemodule UGServerlessCacheIdList : sig ... end

Sourcemodule UserGroupAlreadyExistsFault : sig ... end

The user group with this ID already exists.

Sourcemodule UserGroupNotFoundFault : sig ... end

The user group was not found or does not exist

Sourcemodule UserGroupPendingChanges : sig ... end

Returns the updates being applied to the user group.

Sourcemodule UserGroupQuotaExceededFault : sig ... end

The number of users exceeds the user group limit.

Sourcemodule NodeSnapshotList : sig ... end

Sourcemodule CacheUsageLimits : sig ... end

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

Sourcemodule SecurityGroupIdsList : sig ... end

Sourcemodule SubnetIdsList : sig ... end

Sourcemodule ServerlessCacheConfiguration : sig ... end

The configuration settings for a specific serverless cache.

Sourcemodule GlobalNodeGroupList : sig ... end

Sourcemodule GlobalReplicationGroupMemberList : sig ... end

Sourcemodule CacheNodeTypeSpecificParameter : sig ... end

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.

Sourcemodule Parameter : sig ... end

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

Sourcemodule SubnetList : sig ... end

Sourcemodule EC2SecurityGroupList : sig ... end

Sourcemodule CacheNodeList : sig ... end

Sourcemodule CacheParameterGroupStatus : sig ... end

Status of the cache parameter group.

Sourcemodule CacheSecurityGroupMembershipList : sig ... end

Sourcemodule NotificationConfiguration : sig ... end

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

Sourcemodule PendingModifiedValues : sig ... end

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

Sourcemodule SecurityGroupMembershipList : sig ... end

Sourcemodule UpdateAction : sig ... end

The status of the service update for a specific replication group

Sourcemodule ProcessedUpdateAction : sig ... end

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

Sourcemodule UnprocessedUpdateAction : sig ... end

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

Sourcemodule CustomerNodeEndpoint : sig ... end

The endpoint from which data should be migrated.

Sourcemodule Tag : sig ... end

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.

Sourcemodule ServiceUpdate : sig ... end

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

Sourcemodule ParameterNameValue : sig ... end

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

Sourcemodule ReservedCacheNodesOffering : sig ... end

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

Sourcemodule ReservedCacheNode : sig ... end

Represents the output of a PurchaseReservedCacheNodesOffering operation.

Sourcemodule ReplicationGroup : sig ... end

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

Sourcemodule InputAuthenticationType : sig ... end

Sourcemodule PasswordListInput : sig ... end

Sourcemodule LogDeliveryConfigurationRequest : sig ... end

Specifies the destination, format and type of the logs.

Sourcemodule ConfigureShard : sig ... end

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

Sourcemodule RegionalConfiguration : sig ... end

A list of the replication groups

Sourcemodule Event : sig ... end

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.

Sourcemodule User : sig ... end

For 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).

Sourcemodule Filter : sig ... end

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

Sourcemodule UserGroup : sig ... end

For 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)

Sourcemodule Snapshot : sig ... end

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

Sourcemodule ServerlessCache : sig ... end

The resource representing a serverless cache.

Sourcemodule ServerlessCacheSnapshot : sig ... end

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

Sourcemodule GlobalReplicationGroup : sig ... end

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. The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

Sourcemodule CacheNodeTypeSpecificParametersList : sig ... end

Sourcemodule ParametersList : sig ... end

Sourcemodule CacheSubnetGroup : sig ... end

Represents the output of one of the following operations: CreateCacheSubnetGroup ModifyCacheSubnetGroup

Sourcemodule CacheSecurityGroup : sig ... end

Represents the output of one of the following operations: AuthorizeCacheSecurityGroupIngress CreateCacheSecurityGroup RevokeCacheSecurityGroupIngress

Sourcemodule CacheParameterGroup : sig ... end

Represents the output of a CreateCacheParameterGroup operation.

Sourcemodule CacheEngineVersion : sig ... end

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

Sourcemodule CacheCluster : sig ... end

Contains all of the attributes of a specific cluster.

Sourcemodule UpdateActionList : sig ... end

Sourcemodule ProcessedUpdateActionList : sig ... end

Sourcemodule ServiceUpdateNotFoundFault : sig ... end

The service update doesn't exist

Sourcemodule UnprocessedUpdateActionList : sig ... end

Sourcemodule InvalidReplicationGroupStateFault : sig ... end

The requested replication group is not in the available state.

Sourcemodule ReplicationGroupAlreadyUnderMigrationFault : sig ... end

The targeted replication group is not available.

Sourcemodule ReplicationGroupNotFoundFault : sig ... end

The specified replication group does not exist.

Sourcemodule CustomerNodeEndpointList : sig ... end

Sourcemodule APICallRateForCustomerExceededFault : sig ... end

The customer has exceeded the allowed rate of API calls.

Sourcemodule InvalidCacheClusterStateFault : sig ... end

The requested cluster is not in the available state.

Sourcemodule InvalidKMSKeyFault : sig ... end

The KMS key supplied is not valid.

Sourcemodule NodeGroupNotFoundFault : sig ... end

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.

Sourcemodule TestFailoverNotAvailableFault : sig ... end

The TestFailover action is not available.

Sourcemodule CacheClusterNotFoundFault : sig ... end

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

Sourcemodule CacheParameterGroupNotFoundFault : sig ... end

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

Sourcemodule CacheSecurityGroupNotFoundFault : sig ... end

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

Sourcemodule CacheSubnetGroupNotFoundFault : sig ... end

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

Sourcemodule InvalidARNFault : sig ... end

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

Sourcemodule InvalidServerlessCacheSnapshotStateFault : sig ... end

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

Sourcemodule InvalidServerlessCacheStateFault : sig ... end

The account for these credentials is not currently active.

Sourcemodule ReservedCacheNodeNotFoundFault : sig ... end

The requested reserved cache node was not found.

Sourcemodule ServerlessCacheNotFoundFault : sig ... end

The serverless cache was not found or does not exist.

Sourcemodule ServerlessCacheSnapshotNotFoundFault : sig ... end

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

Sourcemodule SnapshotNotFoundFault : sig ... end

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

Sourcemodule TagList : sig ... end

Sourcemodule TagNotFoundFault : sig ... end

The requested tag was not found on this resource.

Sourcemodule ServiceUpdateList : sig ... end

Sourcemodule AuthorizationNotFoundFault : sig ... end

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

Sourcemodule InvalidCacheSecurityGroupStateFault : sig ... end

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

Sourcemodule ParameterNameValueList : sig ... end

Sourcemodule ReservedCacheNodesOfferingList : sig ... end

Sourcemodule ReservedCacheNodesOfferingNotFoundFault : sig ... end

The requested cache node offering does not exist.

Sourcemodule ReservedCacheNodeList : sig ... end

Sourcemodule ReplicationGroupList : sig ... end

Sourcemodule KeyList : sig ... end

Sourcemodule GlobalReplicationGroupNotFoundFault : sig ... end

The Global datastore does not exist

Sourcemodule InvalidGlobalReplicationGroupStateFault : sig ... end

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

Sourcemodule ReservedCacheNodeAlreadyExistsFault : sig ... end

You already have a reservation with the given identifier.

Sourcemodule ReservedCacheNodeQuotaExceededFault : sig ... end

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

Sourcemodule AccessString : sig ... end

Sourcemodule AuthenticationMode : sig ... end

Specifies the authentication mode to use.

Sourcemodule UserIdListInput : sig ... end

Sourcemodule InvalidCredentialsException : sig ... end

You must enter valid credentials.

Sourcemodule InsufficientCacheClusterCapacityFault : sig ... end

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

Sourcemodule InvalidVPCNetworkStateFault : sig ... end

The VPC network is in an invalid state.

Sourcemodule NodeGroupsPerReplicationGroupQuotaExceededFault : sig ... end

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

Sourcemodule NodeQuotaForCustomerExceededFault : sig ... end

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

Sourcemodule NodeGroupsToRemoveList : sig ... end

Sourcemodule NodeGroupsToRetainList : sig ... end

Sourcemodule NodeQuotaForClusterExceededFault : sig ... end

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

Sourcemodule AuthTokenUpdateStrategyType : sig ... end

Sourcemodule CacheSecurityGroupNameList : sig ... end

Sourcemodule LogDeliveryConfigurationRequestList : sig ... end

Sourcemodule CacheSubnetQuotaExceededFault : sig ... end

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

Sourcemodule InvalidSubnet : sig ... end

An invalid subnet identifier was specified.

Sourcemodule SubnetInUse : sig ... end

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

Sourcemodule SubnetNotAllowedFault : sig ... end

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.

Sourcemodule SubnetIdentifierList : sig ... end

Sourcemodule AZMode : sig ... end

Sourcemodule ClusterQuotaForCustomerExceededFault : sig ... end

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

Sourcemodule NoOperationFault : sig ... end

The operation was not performed because no changes were required.

Sourcemodule ReplicaConfigurationList : sig ... end

Sourcemodule RegionalConfigurationList : sig ... end

Sourcemodule EventList : sig ... end

Sourcemodule UserList : sig ... end

Sourcemodule FilterList : sig ... end

Sourcemodule UserGroupList : sig ... end

Sourcemodule CacheClusterIdList : sig ... end

Sourcemodule ReplicationGroupIdList : sig ... end

Sourcemodule ServiceUpdateStatusList : sig ... end

Sourcemodule TimeRangeFilter : sig ... end

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

Sourcemodule UpdateActionStatusList : sig ... end

Sourcemodule SnapshotList : sig ... end

Sourcemodule ServerlessCacheList : sig ... end

Sourcemodule ServerlessCacheSnapshotList : sig ... end

Sourcemodule GlobalReplicationGroupList : sig ... end

Sourcemodule EngineDefaults : sig ... end

Represents the output of a DescribeEngineDefaultParameters operation.

Sourcemodule InvalidSnapshotStateFault : sig ... end

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

Sourcemodule ServerlessCacheSnapshotAlreadyExistsFault : sig ... end

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

Sourcemodule SnapshotAlreadyExistsFault : sig ... end

You already have a snapshot with the given name.

Sourcemodule SnapshotFeatureNotSupportedFault : sig ... end

You attempted one of the following operations: Creating a snapshot of a Valkey or Redis OSS cluster running on a cache.t1.micro cache node. Creating a snapshot of a cluster that is running Memcached rather than Valkey or Redis OSS. Neither of these are supported by ElastiCache.

Sourcemodule SnapshotQuotaExceededFault : sig ... end

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

Sourcemodule RemoveReplicasList : sig ... end

Sourcemodule GlobalNodeGroupIdList : sig ... end

Sourcemodule UserName : sig ... end

Sourcemodule ServerlessCacheSnapshotQuotaExceededFault : sig ... end

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

Sourcemodule ServerlessCacheAlreadyExistsFault : sig ... end

A serverless cache with this name already exists.

Sourcemodule ServerlessCacheQuotaForCustomerExceededFault : sig ... end

The number of serverless caches exceeds the customer quota.

Sourcemodule SnapshotArnsList : sig ... end

Sourcemodule ReplicationGroupAlreadyExistsFault : sig ... end

The specified replication group already exists.

Sourcemodule NodeGroupConfigurationList : sig ... end

Sourcemodule UserGroupIdListInput : sig ... end

Sourcemodule GlobalReplicationGroupAlreadyExistsFault : sig ... end

The Global datastore name already exists.

Sourcemodule CacheSubnetGroupAlreadyExistsFault : sig ... end

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

Sourcemodule CacheSubnetGroupQuotaExceededFault : sig ... end

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

Sourcemodule CacheSecurityGroupAlreadyExistsFault : sig ... end

A cache security group with the specified name already exists.

Sourcemodule CacheSecurityGroupQuotaExceededFault : sig ... end

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

Sourcemodule CacheParameterGroupAlreadyExistsFault : sig ... end

A cache parameter group with the requested name already exists.

Sourcemodule CacheParameterGroupQuotaExceededFault : sig ... end

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

Sourcemodule InvalidCacheParameterGroupStateFault : sig ... end

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

Sourcemodule CacheClusterAlreadyExistsFault : sig ... end

You already have a cluster with the given identifier.

Sourcemodule OutpostMode : sig ... end

Sourcemodule ReplicationGroupNotUnderMigrationFault : sig ... end

The designated replication group is not available for data migration.

Sourcemodule CacheSubnetGroups : sig ... end

Sourcemodule CacheSecurityGroups : sig ... end

Sourcemodule CacheParameterGroupList : sig ... end

Sourcemodule CacheEngineVersionList : sig ... end

Sourcemodule CacheClusterList : sig ... end

Sourcemodule AuthorizationAlreadyExistsFault : sig ... end

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

Sourcemodule NodeTypeList : sig ... end

Sourcemodule UpdateActionsMessage : sig ... end

Returns details of the update actions

Sourcemodule UpdateActionResultsMessage : sig ... end

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

Sourcemodule TestMigrationResponse : sig ... end

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

Sourcemodule TestMigrationMessage : sig ... end

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

Sourcemodule TestFailoverResult : sig ... end

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 Valkey or 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: Replication group message: Test Failover API called for node group <node-group-id> Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed Cache cluster message: Recovering cache nodes <node-id> 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.

Sourcemodule TestFailoverMessage : sig ... end

Sourcemodule TagListMessage : sig ... end

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

Sourcemodule StartMigrationResponse : sig ... end

Start the migration of data.

Sourcemodule StartMigrationMessage : sig ... end

Start the migration of data.

Sourcemodule ServiceUpdatesMessage : sig ... end

Returns details of the service updates

Sourcemodule RevokeCacheSecurityGroupIngressResult : sig ... end

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

Sourcemodule RevokeCacheSecurityGroupIngressMessage : sig ... end

Represents the input of a RevokeCacheSecurityGroupIngress operation.

Sourcemodule ResetCacheParameterGroupMessage : sig ... end

Represents the input of a ResetCacheParameterGroup operation.

Sourcemodule ReservedCacheNodesOfferingMessage : sig ... end

Represents the output of a DescribeReservedCacheNodesOfferings operation.

Sourcemodule ReservedCacheNodeMessage : sig ... end

Represents the output of a DescribeReservedCacheNodes operation.

Sourcemodule ReplicationGroupMessage : sig ... end

Represents the output of a DescribeReplicationGroups operation.

Sourcemodule RemoveTagsFromResourceMessage : sig ... end

Represents the input of a RemoveTagsFromResource operation.

Sourcemodule RebootCacheClusterResult : sig ... end

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, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters. If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

Sourcemodule RebootCacheClusterMessage : sig ... end

Represents the input of a RebootCacheCluster operation.

Sourcemodule RebalanceSlotsInGlobalReplicationGroupResult : sig ... end

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

Sourcemodule RebalanceSlotsInGlobalReplicationGroupMessage : sig ... end

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

Sourcemodule PurchaseReservedCacheNodesOfferingResult : sig ... end

Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes.

Sourcemodule PurchaseReservedCacheNodesOfferingMessage : sig ... end

Represents the input of a PurchaseReservedCacheNodesOffering operation.

Sourcemodule ModifyUserMessage : sig ... end

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

Sourcemodule ModifyUserGroupMessage : sig ... end

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

Sourcemodule ModifyServerlessCacheResponse : sig ... end

This API modifies the attributes of a serverless cache.

Sourcemodule ModifyServerlessCacheRequest : sig ... end

This API modifies the attributes of a serverless cache.

Sourcemodule ModifyReplicationGroupShardConfigurationResult : sig ... end

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

Sourcemodule ModifyReplicationGroupShardConfigurationMessage : sig ... end

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

Sourcemodule ModifyReplicationGroupResult : sig ... end

Modifies 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 the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Valkey or Redis OSS only.

Sourcemodule ModifyReplicationGroupMessage : sig ... end

Represents the input of a ModifyReplicationGroups operation.

Sourcemodule ModifyGlobalReplicationGroupResult : sig ... end

Modifies the settings for a Global datastore.

Sourcemodule ModifyGlobalReplicationGroupMessage : sig ... end

Modifies the settings for a Global datastore.

Sourcemodule ModifyCacheSubnetGroupResult : sig ... end

Modifies an existing cache subnet group.

Sourcemodule ModifyCacheSubnetGroupMessage : sig ... end

Represents the input of a ModifyCacheSubnetGroup operation.

Sourcemodule ModifyCacheParameterGroupMessage : sig ... end

Represents the input of a ModifyCacheParameterGroup operation.

Sourcemodule ModifyCacheClusterResult : sig ... end

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.

Sourcemodule ModifyCacheClusterMessage : sig ... end

Represents the input of a ModifyCacheCluster operation.

Sourcemodule ListTagsForResourceMessage : sig ... end

The input parameters for the ListTagsForResource operation.

Sourcemodule ListAllowedNodeTypeModificationsMessage : sig ... end

The input parameters for the ListAllowedNodeTypeModifications operation.

Sourcemodule IncreaseReplicaCountResult : sig ... end

Dynamically 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 node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Sourcemodule IncreaseReplicaCountMessage : sig ... end

Sourcemodule IncreaseNodeGroupsInGlobalReplicationGroupResult : sig ... end

Increase the number of node groups in the Global datastore

Sourcemodule IncreaseNodeGroupsInGlobalReplicationGroupMessage : sig ... end

Increase the number of node groups in the Global datastore

Sourcemodule FailoverGlobalReplicationGroupResult : sig ... end

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

Sourcemodule FailoverGlobalReplicationGroupMessage : sig ... end

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

Sourcemodule ExportServerlessCacheSnapshotResponse : sig ... end

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

Sourcemodule ExportServerlessCacheSnapshotRequest : sig ... end

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

Sourcemodule EventsMessage : sig ... end

Represents the output of a DescribeEvents operation.

Sourcemodule DisassociateGlobalReplicationGroupResult : sig ... end

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.

Sourcemodule DisassociateGlobalReplicationGroupMessage : sig ... end

Sourcemodule DescribeUsersResult : sig ... end

Returns a list of users.

Sourcemodule DescribeUsersMessage : sig ... end

Returns a list of users.

Sourcemodule DescribeUserGroupsResult : sig ... end

Returns a list of user groups.

Sourcemodule DescribeUserGroupsMessage : sig ... end

Returns a list of user groups.

Sourcemodule DescribeUpdateActionsMessage : sig ... end

Returns details of the update actions

Sourcemodule DescribeSnapshotsMessage : sig ... end

Represents the input of a DescribeSnapshotsMessage operation.

Sourcemodule DescribeSnapshotsListMessage : sig ... end

Represents the output of a DescribeSnapshots operation.

Sourcemodule DescribeServiceUpdatesMessage : sig ... end

Returns details of the service updates

Sourcemodule DescribeServerlessCachesResponse : sig ... end

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.

Sourcemodule DescribeServerlessCachesRequest : sig ... end

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.

Sourcemodule DescribeServerlessCacheSnapshotsResponse : sig ... end

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 Valkey, Redis OSS and Serverless Memcached only.

Sourcemodule DescribeServerlessCacheSnapshotsRequest : sig ... end

Sourcemodule DescribeReservedCacheNodesOfferingsMessage : sig ... end

Represents the input of a DescribeReservedCacheNodesOfferings operation.

Sourcemodule DescribeReservedCacheNodesMessage : sig ... end

Represents the input of a DescribeReservedCacheNodes operation.

Sourcemodule DescribeReplicationGroupsMessage : sig ... end

Represents the input of a DescribeReplicationGroups operation.

Sourcemodule DescribeGlobalReplicationGroupsResult : sig ... end

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

Sourcemodule DescribeGlobalReplicationGroupsMessage : sig ... end

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

Sourcemodule DescribeEventsMessage : sig ... end

Represents the input of a DescribeEvents operation.

Sourcemodule DescribeEngineDefaultParametersResult : sig ... end

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

Sourcemodule DescribeEngineDefaultParametersMessage : sig ... end

Represents the input of a DescribeEngineDefaultParameters operation.

Sourcemodule DescribeCacheSubnetGroupsMessage : sig ... end

Represents the input of a DescribeCacheSubnetGroups operation.

Sourcemodule DescribeCacheSecurityGroupsMessage : sig ... end

Represents the input of a DescribeCacheSecurityGroups operation.

Sourcemodule DescribeCacheParametersMessage : sig ... end

Represents the input of a DescribeCacheParameters operation.

Sourcemodule DescribeCacheParameterGroupsMessage : sig ... end

Represents the input of a DescribeCacheParameterGroups operation.

Sourcemodule DescribeCacheEngineVersionsMessage : sig ... end

Represents the input of a DescribeCacheEngineVersions operation.

Sourcemodule DescribeCacheClustersMessage : sig ... end

Represents the input of a DescribeCacheClusters operation.

Sourcemodule DeleteUserMessage : sig ... end

For 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 replication groups. For more information, see Using Role Based Access Control (RBAC).

Sourcemodule DeleteUserGroupMessage : sig ... end

For 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 before it can be deleted. For more information, see Using Role Based Access Control (RBAC).

Sourcemodule DeleteSnapshotResult : sig ... end

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. This operation is valid for Valkey or Redis OSS only.

Sourcemodule DeleteSnapshotMessage : sig ... end

Represents the input of a DeleteSnapshot operation.

Sourcemodule DeleteServerlessCacheSnapshotResponse : sig ... end

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

Sourcemodule DeleteServerlessCacheSnapshotRequest : sig ... end

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

Sourcemodule DeleteServerlessCacheResponse : sig ... end

Deletes a specified existing serverless cache. CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.

Sourcemodule DeleteServerlessCacheRequest : sig ... end

Sourcemodule DeleteReplicationGroupResult : sig ... end

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. 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.

Sourcemodule DeleteReplicationGroupMessage : sig ... end

Represents the input of a DeleteReplicationGroup operation.

Sourcemodule DeleteGlobalReplicationGroupResult : sig ... end

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.

Sourcemodule DeleteGlobalReplicationGroupMessage : sig ... end

Sourcemodule DeleteCacheSubnetGroupMessage : sig ... end

Represents the input of a DeleteCacheSubnetGroup operation.

Sourcemodule DeleteCacheSecurityGroupMessage : sig ... end

Represents the input of a DeleteCacheSecurityGroup operation.

Sourcemodule DeleteCacheParameterGroupMessage : sig ... end

Represents the input of a DeleteCacheParameterGroup operation.

Sourcemodule DeleteCacheClusterResult : sig ... end

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: Valkey or Redis OSS (cluster mode enabled) clusters Valkey or 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 Valkey or Redis OSS (cluster mode enabled) replication group A cluster that is not in the available state

Sourcemodule DeleteCacheClusterMessage : sig ... end

Represents the input of a DeleteCacheCluster operation.

Sourcemodule DecreaseReplicaCountResult : sig ... end

Dynamically 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 node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.

Sourcemodule DecreaseReplicaCountMessage : sig ... end

Sourcemodule DecreaseNodeGroupsInGlobalReplicationGroupResult : sig ... end

Decreases the number of node groups in a Global datastore

Sourcemodule DecreaseNodeGroupsInGlobalReplicationGroupMessage : sig ... end

Decreases the number of node groups in a Global datastore

Sourcemodule CreateUserMessage : sig ... end

For 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).

Sourcemodule CreateUserGroupMessage : sig ... end

For 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)

Sourcemodule CreateSnapshotResult : sig ... end

Creates 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.

Sourcemodule CreateSnapshotMessage : sig ... end

Represents the input of a CreateSnapshot operation.

Sourcemodule CreateServerlessCacheSnapshotResponse : sig ... end

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

Sourcemodule CreateServerlessCacheSnapshotRequest : sig ... end

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

Sourcemodule CreateServerlessCacheResponse : sig ... end

Creates a serverless cache.

Sourcemodule CreateServerlessCacheRequest : sig ... end

Creates a serverless cache.

Sourcemodule CreateReplicationGroupResult : sig ... end

Creates 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 standalone regional replication group or a secondary replication group associated with a Global datastore. A Valkey or 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 Valkey or 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 Valkey or 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 Valkey or 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 scaling. For more information, see Scaling self-designed clusters in the ElastiCache User Guide. This operation is valid for Valkey and Redis OSS only.

Sourcemodule CreateReplicationGroupMessage : sig ... end

Represents the input of a CreateReplicationGroup operation.

Sourcemodule CreateGlobalReplicationGroupResult : sig ... end

Global Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache 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.

Sourcemodule CreateGlobalReplicationGroupMessage : sig ... end

Sourcemodule CreateCacheSubnetGroupResult : sig ... end

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

Sourcemodule CreateCacheSubnetGroupMessage : sig ... end

Represents the input of a CreateCacheSubnetGroup operation.

Sourcemodule CreateCacheSecurityGroupResult : sig ... end

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.

Sourcemodule CreateCacheSecurityGroupMessage : sig ... end

Represents the input of a CreateCacheSecurityGroup operation.

Sourcemodule CreateCacheParameterGroupResult : sig ... end

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.

Sourcemodule CreateCacheParameterGroupMessage : sig ... end

Represents the input of a CreateCacheParameterGroup operation.

Sourcemodule CreateCacheClusterResult : sig ... end

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS. This operation is not supported for Valkey or Redis OSS (cluster mode enabled) clusters.

Sourcemodule CreateCacheClusterMessage : sig ... end

Represents the input of a CreateCacheCluster operation.

Sourcemodule CopySnapshotResult : sig ... end

Makes 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 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.

Sourcemodule CopySnapshotMessage : sig ... end

Represents the input of a CopySnapshotMessage operation.

Sourcemodule CopyServerlessCacheSnapshotResponse : sig ... end

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

Sourcemodule CopyServerlessCacheSnapshotRequest : sig ... end

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

Sourcemodule CompleteMigrationResponse : sig ... end

Complete the migration of data.

Sourcemodule CompleteMigrationMessage : sig ... end

Complete the migration of data.

Sourcemodule CacheSubnetGroupMessage : sig ... end

Represents the output of a DescribeCacheSubnetGroups operation.

Sourcemodule CacheSubnetGroupInUse : sig ... end

The requested cache subnet group is currently in use.

Sourcemodule CacheSecurityGroupMessage : sig ... end

Represents the output of a DescribeCacheSecurityGroups operation.

Sourcemodule CacheParameterGroupsMessage : sig ... end

Represents the output of a DescribeCacheParameterGroups operation.

Sourcemodule CacheParameterGroupNameMessage : sig ... end

Represents the output of one of the following operations: ModifyCacheParameterGroup ResetCacheParameterGroup

Sourcemodule CacheParameterGroupDetails : sig ... end

Represents the output of a DescribeCacheParameters operation.

Sourcemodule CacheEngineVersionMessage : sig ... end

Represents the output of a DescribeCacheEngineVersions operation.

Sourcemodule CacheClusterMessage : sig ... end

Represents the output of a DescribeCacheClusters operation.

Sourcemodule BatchStopUpdateActionMessage : sig ... end

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

Sourcemodule BatchApplyUpdateActionMessage : sig ... end

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

Sourcemodule AuthorizeCacheSecurityGroupIngressResult : sig ... end

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. You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

Sourcemodule AuthorizeCacheSecurityGroupIngressMessage : sig ... end

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

Sourcemodule AllowedNodeTypeModificationsMessage : sig ... end

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

Sourcemodule AddTagsToResourceMessage : sig ... end

Represents the input of an AddTagsToResource operation.