Module Smaws_Client_ElastiCache.Types

type nonrec exception_message = string
type nonrec user_quota_exceeded_fault = {
  1. message : exception_message option;
}

The quota of users has been exceeded.

type nonrec user_not_found_fault = {
  1. message : exception_message option;
}

The user does not exist or could not be found.

type nonrec user_name = string
type nonrec string_ = string
type nonrec engine_type = string
type nonrec user_group_id = string
type nonrec user_group_id_list = user_group_id list
type nonrec authentication_type =
  1. | IAM
  2. | NO_PASSWORD
  3. | PASSWORD
type nonrec integer_optional = int
type nonrec authentication = {
  1. password_count : integer_optional option;
    (*

    The number of passwords belonging to the user. The maximum is two.

    *)
  2. type_ : authentication_type option;
    (*

    Indicates whether the user requires a password to authenticate.

    *)
}

Indicates whether the user requires a password to authenticate.

type nonrec user = {
  1. ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) of the user.

    *)
  2. authentication : authentication option;
    (*

    Denotes whether the user requires a password to authenticate.

    *)
  3. user_group_ids : user_group_id_list option;
    (*

    Returns a list of the user group IDs the user belongs to.

    *)
  4. access_string : string_ option;
    (*

    Access permissions string used for this user.

    *)
  5. minimum_engine_version : string_ option;
    (*

    The minimum engine version required, which is Redis OSS 6.0

    *)
  6. engine : engine_type option;
    (*

    The options are valkey or redis.

    *)
  7. status : string_ option;
    (*

    Indicates the user status. Can be "active", "modifying" or "deleting".

    *)
  8. user_name : string_ option;
    (*

    The username of the user.

    *)
  9. user_id : string_ option;
    (*

    The ID of the user.

    *)
}
type nonrec user_list = user list
type nonrec user_id = string
type nonrec user_id_list_input = user_id list
type nonrec user_id_list = user_id list
type nonrec user_groups_update_status = {
  1. user_group_ids_to_remove : user_group_id_list option;
    (*

    The ID of the user group to remove.

    *)
  2. user_group_ids_to_add : user_group_id_list option;
    (*

    The ID of the user group to add.

    *)
}

The status of the user group update.

type nonrec user_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

The number of users exceeds the user group limit.

type nonrec user_group_pending_changes = {
  1. user_ids_to_add : user_id_list option;
    (*

    The list of user IDs to add.

    *)
  2. user_ids_to_remove : user_id_list option;
    (*

    The list of user IDs to remove.

    *)
}

Returns the updates being applied to the user group.

type nonrec user_group_not_found_fault = {
  1. message : exception_message option;
}

The user group was not found or does not exist

type nonrec ug_replication_group_id_list = string_ list
type nonrec ug_serverless_cache_id_list = string_ list
type nonrec user_group = {
  1. ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) of the user group.

    *)
  2. serverless_caches : ug_serverless_cache_id_list option;
    (*

    Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  3. replication_groups : ug_replication_group_id_list option;
    (*

    A list of replication groups that the user group can access.

    *)
  4. pending_changes : user_group_pending_changes option;
    (*

    A list of updates being applied to the user group.

    *)
  5. minimum_engine_version : string_ option;
    (*

    The minimum engine version required, which is Redis OSS 6.0

    *)
  6. user_ids : user_id_list option;
    (*

    The list of user IDs that belong to the user group.

    *)
  7. engine : engine_type option;
    (*

    The options are valkey or redis.

    *)
  8. status : string_ option;
    (*

    Indicates user group status. Can be "creating", "active", "modifying", "deleting".

    *)
  9. user_group_id : string_ option;
    (*

    The ID of the user group.

    *)
}
type nonrec user_group_list = user_group list
type nonrec user_group_id_list_input = user_group_id list
type nonrec user_group_already_exists_fault = {
  1. message : exception_message option;
}

The user group with this ID already exists.

type nonrec user_already_exists_fault = {
  1. message : exception_message option;
}

A user with this ID already exists.

type nonrec t_stamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec service_update_severity =
  1. | LOW
  2. | MEDIUM
  3. | IMPORTANT
  4. | CRITICAL
type nonrec service_update_status =
  1. | EXPIRED
  2. | CANCELLED
  3. | AVAILABLE
type nonrec service_update_type =
  1. | SECURITY_UPDATE
type nonrec update_action_status =
  1. | NOT_APPLICABLE
  2. | SCHEDULED
  3. | SCHEDULING
  4. | COMPLETE
  5. | STOPPED
  6. | STOPPING
  7. | IN_PROGRESS
  8. | WAITING_TO_START
  9. | NOT_APPLIED
type nonrec sla_met =
  1. | NA
  2. | NO
  3. | YES
type nonrec node_update_status =
  1. | COMPLETE
  2. | STOPPED
  3. | STOPPING
  4. | IN_PROGRESS
  5. | WAITING_TO_START
  6. | NOT_APPLIED
type nonrec node_update_initiated_by =
  1. | CUSTOMER
  2. | SYSTEM
type nonrec node_group_member_update_status = {
  1. node_update_status_modified_date : t_stamp option;
    (*

    The date when the NodeUpdateStatus was last modified

    *)
  2. node_update_initiated_date : t_stamp option;
    (*

    The date when the update is triggered

    *)
  3. node_update_initiated_by : node_update_initiated_by option;
    (*

    Reflects whether the update was initiated by the customer or automatically applied

    *)
  4. node_update_end_date : t_stamp option;
    (*

    The end date of the update for a node

    *)
  5. node_update_start_date : t_stamp option;
    (*

    The start date of the update for a node

    *)
  6. node_deletion_date : t_stamp option;
    (*

    The deletion date of the node

    *)
  7. node_update_status : node_update_status option;
    (*

    The update status of the node

    *)
  8. cache_node_id : string_ option;
    (*

    The node ID of the cache cluster

    *)
  9. cache_cluster_id : string_ option;
    (*

    The cache cluster ID

    *)
}

The status of the service update on the node group member

type nonrec node_group_member_update_status_list = node_group_member_update_status list
type nonrec node_group_update_status = {
  1. node_group_member_update_status : node_group_member_update_status_list option;
    (*

    The status of the service update on the node group member

    *)
  2. node_group_id : string_ option;
    (*

    The ID of the node group

    *)
}

The status of the service update on the node group

type nonrec node_group_update_status_list = node_group_update_status list
type nonrec cache_node_update_status = {
  1. node_update_status_modified_date : t_stamp option;
    (*

    The date when the NodeUpdateStatus was last modified>

    *)
  2. node_update_initiated_date : t_stamp option;
    (*

    The date when the update is triggered

    *)
  3. node_update_initiated_by : node_update_initiated_by option;
    (*

    Reflects whether the update was initiated by the customer or automatically applied

    *)
  4. node_update_end_date : t_stamp option;
    (*

    The end date of the update for a node

    *)
  5. node_update_start_date : t_stamp option;
    (*

    The start date of the update for a node

    *)
  6. node_deletion_date : t_stamp option;
    (*

    The deletion date of the node

    *)
  7. node_update_status : node_update_status option;
    (*

    The update status of the node

    *)
  8. cache_node_id : string_ option;
    (*

    The node ID of the cache cluster

    *)
}

The status of the service update on the cache node

type nonrec cache_node_update_status_list = cache_node_update_status list
type nonrec update_action = {
  1. engine : string_ option;
    (*

    The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

    *)
  2. estimated_update_time : string_ option;
    (*

    The estimated length of time for the update to complete

    *)
  3. cache_node_update_status : cache_node_update_status_list option;
    (*

    The status of the service update on the cache node

    *)
  4. node_group_update_status : node_group_update_status_list option;
    (*

    The status of the service update on the node group

    *)
  5. sla_met : sla_met option;
    (*

    If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

    *)
  6. update_action_status_modified_date : t_stamp option;
    (*

    The date when the UpdateActionStatus was last modified

    *)
  7. nodes_updated : string_ option;
    (*

    The progress of the service update on the replication group

    *)
  8. update_action_status : update_action_status option;
    (*

    The status of the update action

    *)
  9. update_action_available_date : t_stamp option;
    (*

    The date that the service update is available to a replication group

    *)
  10. service_update_type : service_update_type option;
    (*

    Reflects the nature of the service update

    *)
  11. service_update_status : service_update_status option;
    (*

    The status of the service update

    *)
  12. service_update_severity : service_update_severity option;
    (*

    The severity of the service update

    *)
  13. service_update_release_date : t_stamp option;
    (*

    The date the update is first available

    *)
  14. service_update_name : string_ option;
    (*

    The unique ID of the service update

    *)
  15. cache_cluster_id : string_ option;
    (*

    The ID of the cache cluster

    *)
  16. replication_group_id : string_ option;
    (*

    The ID of the replication group

    *)
}

The status of the service update for a specific replication group

type nonrec update_action_list = update_action list
type nonrec update_actions_message = {
  1. update_actions : update_action_list option;
    (*

    Returns a list of update actions

    *)
  2. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
}
type nonrec update_action_status_list = update_action_status list
type nonrec processed_update_action = {
  1. update_action_status : update_action_status option;
    (*

    The status of the update action on the Valkey or Redis OSS cluster

    *)
  2. service_update_name : string_ option;
    (*

    The unique ID of the service update

    *)
  3. cache_cluster_id : string_ option;
    (*

    The ID of the cache cluster

    *)
  4. replication_group_id : string_ option;
    (*

    The ID of the replication group

    *)
}

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

type nonrec processed_update_action_list = processed_update_action list
type nonrec unprocessed_update_action = {
  1. error_message : string_ option;
    (*

    The error message that describes the reason the request was not processed

    *)
  2. error_type : string_ option;
    (*

    The error type for requests that are not processed

    *)
  3. service_update_name : string_ option;
    (*

    The unique ID of the service update

    *)
  4. cache_cluster_id : string_ option;
    (*

    The ID of the cache cluster

    *)
  5. replication_group_id : string_ option;
    (*

    The replication group ID

    *)
}

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

type nonrec unprocessed_update_action_list = unprocessed_update_action list
type nonrec update_action_results_message = {
  1. unprocessed_update_actions : unprocessed_update_action_list option;
    (*

    Update actions that haven't been processed successfully

    *)
  2. processed_update_actions : processed_update_action_list option;
    (*

    Update actions that have been processed successfully

    *)
}
type nonrec transit_encryption_mode =
  1. | REQUIRED
  2. | PREFERRED
type nonrec time_range_filter = {
  1. end_time : t_stamp option;
    (*

    The end time of the time range filter

    *)
  2. start_time : t_stamp option;
    (*

    The start time of the time range filter

    *)
}

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

type nonrec global_replication_group_info = {
  1. global_replication_group_member_role : string_ option;
    (*

    The role of the replication group in a Global datastore. Can be primary or secondary.

    *)
  2. global_replication_group_id : string_ option;
    (*

    The name of the Global datastore

    *)
}

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

type nonrec pending_automatic_failover_status =
  1. | DISABLED
  2. | ENABLED
type nonrec double = float
type nonrec slot_migration = {
  1. progress_percentage : double option;
    (*

    The percentage of the slot migration that is complete.

    *)
}

Represents the progress of an online resharding operation.

type nonrec resharding_status = {
  1. slot_migration : slot_migration option;
    (*

    Represents the progress of an online resharding operation.

    *)
}

The status of an online resharding operation.

type nonrec auth_token_update_status =
  1. | ROTATING
  2. | SETTING
type nonrec log_type =
  1. | ENGINE_LOG
  2. | SLOW_LOG
type nonrec destination_type =
  1. | KinesisFirehose
  2. | CloudWatchLogs
type nonrec cloud_watch_logs_destination_details = {
  1. log_group : string_ option;
    (*

    The name of the CloudWatch Logs log group.

    *)
}

The configuration details of the CloudWatch Logs destination.

type nonrec kinesis_firehose_destination_details = {
  1. delivery_stream : string_ option;
    (*

    The name of the Kinesis Data Firehose delivery stream.

    *)
}

The configuration details of the Kinesis Data Firehose destination.

type nonrec destination_details = {
  1. kinesis_firehose_details : kinesis_firehose_destination_details option;
    (*

    The configuration details of the Kinesis Data Firehose destination.

    *)
  2. cloud_watch_logs_details : cloud_watch_logs_destination_details option;
    (*

    The configuration details of the CloudWatch Logs destination.

    *)
}

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

type nonrec log_format =
  1. | JSON
  2. | TEXT
type nonrec pending_log_delivery_configuration = {
  1. log_format : log_format option;
    (*

    Returns the log format, either JSON or TEXT

    *)
  2. destination_details : destination_details option;
    (*

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

    *)
  3. destination_type : destination_type option;
    (*

    Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

    *)
  4. log_type : log_type option;
    (*

    Refers to slow-log or engine-log..

    *)
}

The log delivery configurations being modified

type nonrec pending_log_delivery_configuration_list = pending_log_delivery_configuration list
type nonrec boolean_optional = bool
type nonrec cluster_mode =
  1. | COMPATIBLE
  2. | DISABLED
  3. | ENABLED
type nonrec replication_group_pending_modified_values = {
  1. cluster_mode : cluster_mode option;
    (*

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    *)
  2. transit_encryption_mode : transit_encryption_mode option;
    (*

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    *)
  3. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    *)
  4. log_delivery_configurations : pending_log_delivery_configuration_list option;
    (*

    The log delivery configurations being modified

    *)
  5. user_groups : user_groups_update_status option;
    (*

    The user group being modified.

    *)
  6. auth_token_status : auth_token_update_status option;
    (*

    The auth token status

    *)
  7. resharding : resharding_status option;
    (*

    The status of an online resharding operation.

    *)
  8. automatic_failover_status : pending_automatic_failover_status option;
    (*

    Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

    *)
  9. primary_cluster_id : string_ option;
    (*

    The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

    *)
}

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

type nonrec cluster_id_list = string_ list
type nonrec integer = int
type nonrec endpoint = {
  1. port : integer option;
    (*

    The port number that the cache engine is listening on.

    *)
  2. address : string_ option;
    (*

    The DNS hostname of the cache node.

    *)
}

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

type nonrec node_group_member = {
  1. current_role : string_ option;
    (*

    The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.

    *)
  2. preferred_outpost_arn : string_ option;
    (*

    The outpost ARN of the node group member.

    *)
  3. preferred_availability_zone : string_ option;
    (*

    The name of the Availability Zone in which the node is located.

    *)
  4. read_endpoint : endpoint option;
    (*

    The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.

    *)
  5. cache_node_id : string_ option;
    (*

    The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

    *)
  6. cache_cluster_id : string_ option;
    (*

    The ID of the cluster to which the node belongs.

    *)
}

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

type nonrec node_group_member_list = node_group_member list
type nonrec node_group = {
  1. node_group_members : node_group_member_list option;
    (*

    A list containing information about individual nodes within the node group (shard).

    *)
  2. slots : string_ option;
    (*

    The keyspace for this node group (shard).

    *)
  3. reader_endpoint : endpoint option;
    (*

    The endpoint of the replica nodes in this node group (shard). This value is read-only.

    *)
  4. primary_endpoint : endpoint option;
    (*

    The endpoint of the primary node in this node group (shard).

    *)
  5. status : string_ option;
    (*

    The current state of this replication group - creating, available, modifying, deleting.

    *)
  6. node_group_id : string_ option;
    (*

    The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

    *)
}

Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

type nonrec node_group_list = node_group list
type nonrec automatic_failover_status =
  1. | DISABLING
  2. | ENABLING
  3. | DISABLED
  4. | ENABLED
type nonrec multi_az_status =
  1. | DISABLED
  2. | ENABLED
type nonrec replication_group_outpost_arn_list = string_ list
type nonrec storage_encryption_type =
  1. | SSE_KMS
  2. | SSE_ELASTICACHE
  3. | NONE
type nonrec log_delivery_configuration_status =
  1. | ERROR
  2. | DISABLING
  3. | MODIFYING
  4. | ENABLING
  5. | ACTIVE
type nonrec log_delivery_configuration = {
  1. message : string_ option;
    (*

    Returns an error message for the log delivery configuration.

    *)
  2. status : log_delivery_configuration_status option;
    (*

    Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

    *)
  3. log_format : log_format option;
    (*

    Returns the log format, either JSON or TEXT.

    *)
  4. destination_details : destination_details option;
    (*

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

    *)
  5. destination_type : destination_type option;
    (*

    Returns the destination type, either cloudwatch-logs or kinesis-firehose.

    *)
  6. log_type : log_type option;
    (*

    Refers to slow-log or engine-log.

    *)
}

Returns the destination, format and type of the logs.

type nonrec log_delivery_configuration_list = log_delivery_configuration list
type nonrec data_tiering_status =
  1. | DISABLED
  2. | ENABLED
type nonrec boolean_ = bool
type nonrec network_type =
  1. | DUAL_STACK
  2. | IPV6
  3. | IPV4
type nonrec ip_discovery =
  1. | IPV6
  2. | IPV4
type nonrec durability =
  1. | DISABLED
  2. | SYNC
  3. | ASYNC
  4. | DEFAULT
type nonrec effective_durability =
  1. | DISABLED
  2. | SYNC
  3. | ASYNC
type nonrec replication_group = {
  1. effective_durability : effective_durability option;
    (*

    The effective durability of the replication group. When Durability is set to default, the service resolves the actual durability based on the engine version, cluster mode, and other parameters. This field reflects the resolved value. For more information, see Configuring Durability.

    *)
  2. durability : durability option;
    (*

    The durability setting of the replication group. For more information, see Durability.

    *)
  3. engine : string_ option;
    (*

    The engine used in a replication group. The options are valkey, memcached or redis.

    *)
  4. cluster_mode : cluster_mode option;
    (*

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    *)
  5. transit_encryption_mode : transit_encryption_mode option;
    (*

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    *)
  6. ip_discovery : ip_discovery option;
    (*

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  7. network_type : network_type option;
    (*

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  8. auto_minor_version_upgrade : boolean_ option;
    (*

    If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

    *)
  9. data_tiering : data_tiering_status option;
    (*

    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

    *)
  10. replication_group_create_time : t_stamp option;
    (*

    The date and time when the cluster was created.

    *)
  11. log_delivery_configurations : log_delivery_configuration_list option;
    (*

    Returns the destination, format and type of the logs.

    *)
  12. user_group_ids : user_group_id_list option;
    (*

    The ID of the user group associated to the replication group.

    *)
  13. ar_n : string_ option;
    (*

    The ARN (Amazon Resource Name) of the replication group.

    *)
  14. storage_encryption_type : storage_encryption_type option;
    (*

    Indicates the type of encryption for data stored at rest in the replication group. The value is none if at-rest encryption is not enabled, sse-elasticache if an ElastiCache service-managed key is used, or sse-kms if a customer-managed KMS key is used.

    *)
  15. kms_key_id : string_ option;
    (*

    The ID of the KMS key used to encrypt the disk in the cluster.

    *)
  16. member_clusters_outpost_arns : replication_group_outpost_arn_list option;
    (*

    The outpost ARNs of the replication group's member clusters.

    *)
  17. at_rest_encryption_enabled : boolean_optional option;
    (*

    A flag that enables encryption at-rest on the cluster when set to true. In some cases, encryption at-rest may be enabled even when this value is false. Use StorageEncryptionType to view the effective encryption state of a cluster.

    You cannot modify the value of AtRestEncryptionEnabled after the cluster is created.

    Default: true when using Valkey, false when using Redis OSS

    *)
  18. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

    Default: false

    *)
  19. auth_token_last_modified_date : t_stamp option;
    (*

    The date the auth token was last modified

    *)
  20. auth_token_enabled : boolean_optional option;
    (*

    A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

    Default: false

    *)
  21. cache_node_type : string_ option;
    (*

    The name of the compute and memory capacity node type for each node in the replication group.

    *)
  22. cluster_enabled : boolean_optional option;
    (*

    A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

    Valid values: true | false

    *)
  23. snapshot_window : string_ option;
    (*

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    This parameter is only valid if the Engine parameter is redis.

    *)
  24. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    *)
  25. configuration_endpoint : endpoint option;
    (*

    The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

    *)
  26. multi_a_z : multi_az_status option;
    (*

    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

    *)
  27. automatic_failover : automatic_failover_status option;
    (*

    Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

    *)
  28. snapshotting_cluster_id : string_ option;
    (*

    The cluster ID that is used as the daily snapshot source for the replication group.

    *)
  29. node_groups : node_group_list option;
    (*

    A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

    *)
  30. member_clusters : cluster_id_list option;
    (*

    The names of all the cache clusters that are part of this replication group.

    *)
  31. pending_modified_values : replication_group_pending_modified_values option;
    (*

    A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

    *)
  32. status : string_ option;
    (*

    The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

    *)
  33. global_replication_group_info : global_replication_group_info option;
    (*

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

    *)
  34. description : string_ option;
    (*

    The user supplied description of the replication group.

    *)
  35. replication_group_id : string_ option;
    (*

    The identifier for the replication group.

    *)
}

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

type nonrec test_migration_response = {
  1. replication_group : replication_group option;
}
type nonrec customer_node_endpoint = {
  1. port : integer_optional option;
    (*

    The port of the node endpoint

    *)
  2. address : string_ option;
    (*

    The address of the node endpoint

    *)
}

The endpoint from which data should be migrated.

type nonrec customer_node_endpoint_list = customer_node_endpoint list
type nonrec test_migration_message = {
  1. customer_node_endpoint_list : customer_node_endpoint_list;
    (*

    List of endpoints from which data should be migrated. List should have only one element.

    *)
  2. replication_group_id : string_;
    (*

    The ID of the replication group to which data is to be migrated.

    *)
}
type nonrec replication_group_not_found_fault = {
  1. message : exception_message option;
}

The specified replication group does not exist.

type nonrec replication_group_already_under_migration_fault = {
  1. message : exception_message option;
}

The targeted replication group is not available.

type nonrec invalid_replication_group_state_fault = {
  1. message : exception_message option;
}

The requested replication group is not in the available state.

type nonrec aws_query_error_message = string
type nonrec invalid_parameter_value_exception = {
  1. message : aws_query_error_message option;
    (*

    A parameter value is invalid.

    *)
}

The value for a parameter is invalid.

type nonrec test_failover_result = {
  1. replication_group : replication_group option;
}
type nonrec test_failover_not_available_fault = {
  1. message : exception_message option;
}

The TestFailover action is not available.

type nonrec allowed_node_group_id = string
type nonrec test_failover_message = {
  1. node_group_id : allowed_node_group_id;
    (*

    The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 15 node groups in any rolling 24-hour period.

    *)
  2. replication_group_id : string_;
    (*

    The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

    *)
}
type nonrec node_group_not_found_fault = {
  1. message : exception_message option;
}

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.

type nonrec invalid_parameter_combination_exception = {
  1. message : aws_query_error_message option;
    (*

    Two or more parameters that must not be used together were used together.

    *)
}

Two or more incompatible parameters were specified.

type nonrec invalid_kms_key_fault = {
  1. message : exception_message option;
}

The KMS key supplied is not valid.

type nonrec invalid_cache_cluster_state_fault = {
  1. message : exception_message option;
}

The requested cluster is not in the available state.

type nonrec api_call_rate_for_customer_exceeded_fault = {
  1. message : exception_message option;
}

The customer has exceeded the allowed rate of API calls.

type nonrec tag_quota_per_resource_exceeded = {
  1. message : exception_message option;
}

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.

type nonrec tag_not_found_fault = {
  1. message : exception_message option;
}

The requested tag was not found on this resource.

type nonrec tag = {
  1. value : string_ option;
    (*

    The tag's value. May be null.

    *)
  2. key : string_ option;
    (*

    The key for the tag. May not be null.

    *)
}

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.

type nonrec tag_list = tag list
type nonrec tag_list_message = {
  1. tag_list : tag_list option;
    (*

    A list of tags as key-value pairs.

    *)
}

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

type nonrec subnet_outpost = {
  1. subnet_outpost_arn : string_ option;
    (*

    The outpost ARN of the subnet.

    *)
}

The ID of the outpost subnet.

type nonrec subnet_not_allowed_fault = {
  1. message : exception_message option;
}

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.

type nonrec availability_zone = {
  1. name : string_ option;
    (*

    The name of the Availability Zone.

    *)
}

Describes an Availability Zone in which the cluster is launched.

type nonrec network_type_list = network_type list
type nonrec subnet = {
  1. supported_network_types : network_type_list option;
    (*

    Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  2. subnet_outpost : subnet_outpost option;
    (*

    The outpost ARN of the subnet.

    *)
  3. subnet_availability_zone : availability_zone option;
    (*

    The Availability Zone associated with the subnet.

    *)
  4. subnet_identifier : string_ option;
    (*

    The unique identifier for the 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.

type nonrec subnet_list = subnet list
type nonrec subnet_in_use = {
  1. message : exception_message option;
}

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

type nonrec subnet_ids_list = string_ list
type nonrec subnet_identifier_list = string_ list
type nonrec start_migration_response = {
  1. replication_group : replication_group option;
}
type nonrec start_migration_message = {
  1. customer_node_endpoint_list : customer_node_endpoint_list;
    (*

    List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element.

    *)
  2. replication_group_id : string_;
    (*

    The ID of the replication group to which data should be migrated.

    *)
}
type nonrec source_type =
  1. | User_group
  2. | User
  3. | Serverless_cache_snapshot
  4. | Serverless_cache
  5. | Replication_group
  6. | Cache_subnet_group
  7. | Cache_security_group
  8. | Cache_parameter_group
  9. | Cache_cluster
type nonrec snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec snapshot_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec availability_zones_list = string_ list
type nonrec outpost_arns_list = string_ list
type nonrec node_group_configuration = {
  1. replica_outpost_arns : outpost_arns_list option;
    (*

    The outpost ARN of the node replicas.

    *)
  2. primary_outpost_arn : string_ option;
    (*

    The outpost ARN of the primary node.

    *)
  3. replica_availability_zones : availability_zones_list option;
    (*

    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

    *)
  4. primary_availability_zone : string_ option;
    (*

    The Availability Zone where the primary node of this node group (shard) is launched.

    *)
  5. replica_count : integer_optional option;
    (*

    The number of read replica nodes in this node group (shard).

    *)
  6. slots : string_ option;
    (*

    A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

    Example: "0-3999"

    *)
  7. node_group_id : allowed_node_group_id option;
    (*

    Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

    *)
}

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

type nonrec node_snapshot = {
  1. snapshot_create_time : t_stamp option;
    (*

    The date and time when the source node's metadata and cache data set was obtained for the snapshot.

    *)
  2. cache_node_create_time : t_stamp option;
    (*

    The date and time when the cache node was created in the source cluster.

    *)
  3. cache_size : string_ option;
    (*

    The size of the cache on the source cache node.

    *)
  4. node_group_configuration : node_group_configuration option;
    (*

    The configuration for the source node group (shard).

    *)
  5. cache_node_id : string_ option;
    (*

    The cache node identifier for the node in the source cluster.

    *)
  6. node_group_id : string_ option;
    (*

    A unique identifier for the source node group (shard).

    *)
  7. cache_cluster_id : string_ option;
    (*

    A unique identifier for the source cluster.

    *)
}

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

type nonrec node_snapshot_list = node_snapshot list
type nonrec snapshot = {
  1. durability : durability option;
    (*

    The durability setting of the cluster when the snapshot was taken. When restoring from this snapshot, the cluster uses this durability setting unless overridden in the restore request. For more information, see Durability.

    *)
  2. data_tiering : data_tiering_status option;
    (*

    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

    *)
  3. ar_n : string_ option;
    (*

    The ARN (Amazon Resource Name) of the snapshot.

    *)
  4. kms_key_id : string_ option;
    (*

    The ID of the KMS key used to encrypt the snapshot.

    *)
  5. node_snapshots : node_snapshot_list option;
    (*

    A list of the cache nodes in the source cluster.

    *)
  6. automatic_failover : automatic_failover_status option;
    (*

    Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.

    *)
  7. num_node_groups : integer_optional option;
    (*

    The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

    *)
  8. snapshot_window : string_ option;
    (*

    The daily time range during which ElastiCache takes daily snapshots of the source cluster.

    *)
  9. snapshot_retention_limit : integer_optional option;
    (*

    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

    For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

    Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    *)
  10. auto_minor_version_upgrade : boolean_ option;
    (*

     If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  11. vpc_id : string_ option;
    (*

    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

    *)
  12. cache_subnet_group_name : string_ option;
    (*

    The name of the cache subnet group associated with the source cluster.

    *)
  13. cache_parameter_group_name : string_ option;
    (*

    The cache parameter group that is associated with the source cluster.

    *)
  14. port : integer_optional option;
    (*

    The port number used by each cache nodes in the source cluster.

    *)
  15. topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

    *)
  16. preferred_maintenance_window : string_ option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat

    Example: sun:23:00-mon:01:30

    *)
  17. cache_cluster_create_time : t_stamp option;
    (*

    The date and time when the source cluster was created.

    *)
  18. preferred_outpost_arn : string_ option;
    (*

    The ARN (Amazon Resource Name) of the preferred outpost.

    *)
  19. preferred_availability_zone : string_ option;
    (*

    The name of the Availability Zone in which the source cluster is located.

    *)
  20. num_cache_nodes : integer_optional option;
    (*

    The number of cache nodes in the source cluster.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    *)
  21. engine_version : string_ option;
    (*

    The version of the cache engine version that is used by the source cluster.

    *)
  22. engine : string_ option;
    (*

    The name of the cache engine (memcached or redis) used by the source cluster.

    *)
  23. cache_node_type : string_ option;
    (*

    The name of the compute and memory capacity node type for the source cluster.

    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.
    *)
  24. snapshot_source : string_ option;
    (*

    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

    *)
  25. snapshot_status : string_ option;
    (*

    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

    *)
  26. cache_cluster_id : string_ option;
    (*

    The user-supplied identifier of the source cluster.

    *)
  27. replication_group_description : string_ option;
    (*

    A description of the source replication group.

    *)
  28. replication_group_id : string_ option;
    (*

    The unique identifier of the source replication group.

    *)
  29. snapshot_name : string_ option;
    (*

    The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

    *)
}

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

type nonrec snapshot_list = snapshot list
type nonrec snapshot_feature_not_supported_fault = {
  1. message : exception_message option;
}

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.

type nonrec snapshot_arns_list = string_ list
type nonrec snapshot_already_exists_fault = {
  1. message : exception_message option;
}

You already have a snapshot with the given name.

type nonrec service_update = {
  1. estimated_update_time : string_ option;
    (*

    The estimated length of time the service update will take

    *)
  2. engine_version : string_ option;
    (*

    The Elasticache engine version to which the update applies. Either Valkey, Redis OSS or Memcached engine version.

    *)
  3. engine : string_ option;
    (*

    The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

    *)
  4. service_update_type : service_update_type option;
    (*

    Reflects the nature of the service update

    *)
  5. service_update_description : string_ option;
    (*

    Provides details of the service update

    *)
  6. service_update_status : service_update_status option;
    (*

    The status of the service update

    *)
  7. service_update_severity : service_update_severity option;
    (*

    The severity of the service update

    *)
  8. service_update_end_date : t_stamp option;
    (*

    The date after which the service update is no longer available

    *)
  9. service_update_release_date : t_stamp option;
    (*

    The date when the service update is initially available

    *)
  10. service_update_name : string_ option;
    (*

    The unique ID of the service update

    *)
}

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

type nonrec service_update_list = service_update list
type nonrec service_updates_message = {
  1. service_updates : service_update_list option;
    (*

    A list of service updates

    *)
  2. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
}
type nonrec service_update_status_list = service_update_status list
type nonrec service_update_not_found_fault = {
  1. message : exception_message option;
}

The service update doesn't exist

type nonrec service_linked_role_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec serverless_cache_snapshot_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec serverless_cache_snapshot_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec serverless_cache_configuration = {
  1. major_engine_version : string_ option;
    (*

    The engine version number that the serverless cache is configured with.

    *)
  2. engine : string_ option;
    (*

    The engine that the serverless cache is configured with.

    *)
  3. serverless_cache_name : string_ option;
    (*

    The identifier of a serverless cache.

    *)
}

The configuration settings for a specific serverless cache.

type nonrec serverless_cache_snapshot = {
  1. serverless_cache_configuration : serverless_cache_configuration option;
    (*

    The configuration of the serverless cache, at the time the snapshot was taken. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  2. bytes_used_for_cache : string_ option;
    (*

    The total size of a serverless cache snapshot, in bytes. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  3. expiry_time : t_stamp option;
    (*

    The time that the serverless cache snapshot will expire. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  4. create_time : t_stamp option;
    (*

    The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  5. status : string_ option;
    (*

    The current status of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  6. snapshot_type : string_ option;
    (*

    The type of snapshot of serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  7. kms_key_id : string_ option;
    (*

    The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  8. ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  9. serverless_cache_snapshot_name : string_ option;
    (*

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

    *)
}

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

type nonrec serverless_cache_snapshot_list = serverless_cache_snapshot list
type nonrec serverless_cache_snapshot_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec serverless_cache_quota_for_customer_exceeded_fault = {
  1. message : exception_message option;
}

The number of serverless caches exceeds the customer quota.

type nonrec serverless_cache_not_found_fault = {
  1. message : exception_message option;
}

The serverless cache was not found or does not exist.

type nonrec data_storage_unit =
  1. | GB
type nonrec data_storage = {
  1. unit_ : data_storage_unit;
    (*

    The unit that the storage is measured in, in GB.

    *)
  2. minimum : integer_optional option;
    (*

    The lower limit for data storage the cache is set to use.

    *)
  3. maximum : integer_optional option;
    (*

    The upper limit for data storage the cache is set to use.

    *)
}

The data storage limit.

type nonrec ecpu_per_second = {
  1. minimum : integer_optional option;
    (*

    The configuration for the minimum number of ECPUs the cache should be able consume per second.

    *)
  2. maximum : integer_optional option;
    (*

    The configuration for the maximum number of ECPUs the cache can consume per second.

    *)
}

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

type nonrec cache_usage_limits = {
  1. ecpu_per_second : ecpu_per_second option;
  2. data_storage : data_storage option;
    (*

    The maximum data storage limit in the cache, expressed in Gigabytes.

    *)
}

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

type nonrec security_group_ids_list = string_ list
type nonrec serverless_cache = {
  1. network_type : network_type option;
    (*

    The type of IP address protocol used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.

    *)
  2. daily_snapshot_time : string_ option;
    (*

    The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  3. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days.

    *)
  4. subnet_ids : subnet_ids_list option;
    (*

    If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.

    *)
  5. user_group_id : string_ option;
    (*

    The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

    *)
  6. ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) of the serverless cache.

    *)
  7. reader_endpoint : endpoint option;
  8. endpoint : endpoint option;
  9. security_group_ids : security_group_ids_list option;
    (*

    The IDs of the EC2 security groups associated with the serverless cache.

    *)
  10. storage_encryption_type : storage_encryption_type option;
    (*

    Indicates the type of encryption for data stored at rest in the serverless cache. Serverless caches are always encrypted at rest. The value is sse-elasticache if an ElastiCache service-managed key is used, or sse-kms if a customer-managed KMS key is used.

    *)
  11. kms_key_id : string_ option;
    (*

    The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

    *)
  12. cache_usage_limits : cache_usage_limits option;
    (*

    The cache usage limit for the serverless cache.

    *)
  13. full_engine_version : string_ option;
    (*

    The name and version number of the engine the serverless cache is compatible with.

    *)
  14. major_engine_version : string_ option;
    (*

    The version number of the engine the serverless cache is compatible with.

    *)
  15. engine : string_ option;
    (*

    The engine the serverless cache is compatible with.

    *)
  16. status : string_ option;
    (*

    The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

    *)
  17. create_time : t_stamp option;
    (*

    When the serverless cache was created.

    *)
  18. description : string_ option;
    (*

    A description of the serverless cache.

    *)
  19. serverless_cache_name : string_ option;
    (*

    The unique identifier of the serverless cache.

    *)
}

The resource representing a serverless cache.

type nonrec serverless_cache_list = serverless_cache list
type nonrec serverless_cache_already_exists_fault = {
  1. message : exception_message option;
}

A serverless cache with this name already exists.

type nonrec security_group_membership = {
  1. status : string_ option;
    (*

    The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

    *)
  2. security_group_id : string_ option;
    (*

    The identifier of the cache security group.

    *)
}

Represents a single cache security group and its status.

type nonrec security_group_membership_list = security_group_membership list
type nonrec scale_config = {
  1. scale_interval_minutes : integer_optional option;
    (*

    The time interval in seconds between scaling operations when performing gradual scaling for a Memcached cluster.

    *)
  2. scale_percentage : integer_optional option;
    (*

    The percentage by which to scale the Memcached cluster, either horizontally by adding nodes or vertically by increasing resources.

    *)
}

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

type nonrec ec2_security_group = {
  1. ec2_security_group_owner_id : string_ option;
    (*

    The Amazon account ID of the Amazon EC2 security group owner.

    *)
  2. ec2_security_group_name : string_ option;
    (*

    The name of the Amazon EC2 security group.

    *)
  3. status : string_ option;
    (*

    The status of the Amazon EC2 security group.

    *)
}

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

type nonrec ec2_security_group_list = ec2_security_group list
type nonrec cache_security_group = {
  1. ar_n : string_ option;
    (*

    The ARN of the cache security group,

    *)
  2. ec2_security_groups : ec2_security_group_list option;
    (*

    A list of Amazon EC2 security groups that are associated with this cache security group.

    *)
  3. description : string_ option;
    (*

    The description of the cache security group.

    *)
  4. cache_security_group_name : string_ option;
    (*

    The name of the cache security group.

    *)
  5. owner_id : string_ option;
    (*

    The Amazon account ID of the cache security group owner.

    *)
}

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
type nonrec revoke_cache_security_group_ingress_result = {
  1. cache_security_group : cache_security_group option;
}
type nonrec revoke_cache_security_group_ingress_message = {
  1. ec2_security_group_owner_id : string_;
    (*

    The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

    *)
  2. ec2_security_group_name : string_;
    (*

    The name of the Amazon EC2 security group to revoke access from.

    *)
  3. cache_security_group_name : string_;
    (*

    The name of the cache security group to revoke ingress from.

    *)
}

Represents the input of a RevokeCacheSecurityGroupIngress operation.

type nonrec invalid_cache_security_group_state_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_security_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec authorization_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec resharding_configuration = {
  1. preferred_availability_zones : availability_zones_list option;
    (*

    A list of preferred availability zones for the nodes in this cluster.

    *)
  2. node_group_id : allowed_node_group_id option;
    (*

    Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

    *)
}

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

type nonrec resharding_configuration_list = resharding_configuration list
type nonrec parameter_name_value = {
  1. parameter_value : string_ option;
    (*

    The value of the parameter.

    *)
  2. parameter_name : string_ option;
    (*

    The name of the parameter.

    *)
}

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

type nonrec parameter_name_value_list = parameter_name_value list
type nonrec reset_cache_parameter_group_message = {
  1. parameter_name_values : parameter_name_value_list option;
    (*

    An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.

    *)
  2. reset_all_parameters : boolean_ option;
    (*

    If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.

    Valid values: true | false

    *)
  3. cache_parameter_group_name : string_;
    (*

    The name of the cache parameter group to reset.

    *)
}

Represents the input of a ResetCacheParameterGroup operation.

type nonrec invalid_global_replication_group_state_fault = {
  1. message : exception_message option;
}

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

type nonrec invalid_cache_parameter_group_state_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_parameter_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_parameter_group_name_message = {
  1. cache_parameter_group_name : string_ option;
    (*

    The name of the cache parameter group.

    *)
}

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
type nonrec reserved_cache_nodes_offering_not_found_fault = {
  1. message : exception_message option;
}

The requested cache node offering does not exist.

type nonrec recurring_charge = {
  1. recurring_charge_frequency : string_ option;
    (*

    The frequency of the recurring charge.

    *)
  2. recurring_charge_amount : double option;
    (*

    The monetary amount of the recurring charge.

    *)
}

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

type nonrec recurring_charge_list = recurring_charge list
type nonrec reserved_cache_nodes_offering = {
  1. recurring_charges : recurring_charge_list option;
    (*

    The recurring price charged to run this reserved cache node.

    *)
  2. offering_type : string_ option;
    (*

    The offering type.

    *)
  3. product_description : string_ option;
    (*

    The cache engine used by the offering.

    *)
  4. usage_price : double option;
    (*

    The hourly price charged for this offering.

    *)
  5. fixed_price : double option;
    (*

    The fixed price charged for this offering.

    *)
  6. duration : integer option;
    (*

    The duration of the offering. in seconds.

    *)
  7. cache_node_type : string_ option;
    (*

    The cache node type for the reserved cache node.

    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.
    *)
  8. reserved_cache_nodes_offering_id : string_ option;
    (*

    A unique identifier for the reserved cache node offering.

    *)
}

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

type nonrec reserved_cache_nodes_offering_list = reserved_cache_nodes_offering list
type nonrec reserved_cache_nodes_offering_message = {
  1. reserved_cache_nodes_offerings : reserved_cache_nodes_offering_list option;
    (*

    A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeReservedCacheNodesOfferings operation.

type nonrec reserved_cache_node_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec reserved_cache_node_not_found_fault = {
  1. message : exception_message option;
}

The requested reserved cache node was not found.

type nonrec reserved_cache_node = {
  1. reservation_ar_n : string_ option;
    (*

    The Amazon Resource Name (ARN) of the reserved cache node.

    Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

    *)
  2. recurring_charges : recurring_charge_list option;
    (*

    The recurring price charged to run this reserved cache node.

    *)
  3. state : string_ option;
    (*

    The state of the reserved cache node.

    *)
  4. offering_type : string_ option;
    (*

    The offering type of this reserved cache node.

    *)
  5. product_description : string_ option;
    (*

    The description of the reserved cache node.

    *)
  6. cache_node_count : integer option;
    (*

    The number of cache nodes that have been reserved.

    *)
  7. usage_price : double option;
    (*

    The hourly price charged for this reserved cache node.

    *)
  8. fixed_price : double option;
    (*

    The fixed price charged for this reserved cache node.

    *)
  9. duration : integer option;
    (*

    The duration of the reservation in seconds.

    *)
  10. start_time : t_stamp option;
    (*

    The time the reservation started.

    *)
  11. cache_node_type : string_ option;
    (*

    The cache node type for the reserved cache nodes.

    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.
    *)
  12. reserved_cache_nodes_offering_id : string_ option;
    (*

    The offering identifier.

    *)
  13. reserved_cache_node_id : string_ option;
    (*

    The unique identifier for the reservation.

    *)
}

Represents the output of a PurchaseReservedCacheNodesOffering operation.

type nonrec reserved_cache_node_list = reserved_cache_node list
type nonrec reserved_cache_node_message = {
  1. reserved_cache_nodes : reserved_cache_node_list option;
    (*

    A list of reserved cache nodes. Each element in the list contains detailed information about one node.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeReservedCacheNodes operation.

type nonrec reserved_cache_node_already_exists_fault = {
  1. message : exception_message option;
}

You already have a reservation with the given identifier.

type nonrec replication_group_not_under_migration_fault = {
  1. message : exception_message option;
}

The designated replication group is not available for data migration.

type nonrec replication_group_list = replication_group list
type nonrec replication_group_message = {
  1. replication_groups : replication_group_list option;
    (*

    A list of replication groups. Each item in the list contains detailed information about one replication group.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeReplicationGroups operation.

type nonrec replication_group_id_list = string_ list
type nonrec replication_group_already_exists_fault = {
  1. message : exception_message option;
}

The specified replication group already exists.

type nonrec preferred_availability_zone_list = string_ list
type nonrec preferred_outpost_arn_list = string_ list
type nonrec configure_shard = {
  1. preferred_outpost_arns : preferred_outpost_arn_list option;
    (*

    The outpost ARNs in which the cache cluster is created.

    *)
  2. preferred_availability_zones : preferred_availability_zone_list option;
    (*

    A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache selects the availability zone for each of the replicas.

    *)
  3. new_replica_count : integer;
    (*

    The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Valkey or Redis OSS replication group you are working with.

    The minimum number of replicas in a shard or replication group is:

    • Valkey or Redis OSS (cluster mode disabled)

      • If Multi-AZ: 1
      • If Multi-AZ: 0
    • Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
    *)
  4. node_group_id : allowed_node_group_id;
    (*

    The 4-digit id for the node group you are configuring. For Valkey or Redis OSS (cluster mode disabled) replication groups, the node group id is always 0001. To find a Valkey or Redis OSS (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

    *)
}

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

type nonrec replica_configuration_list = configure_shard list
type nonrec key_list = string_ list
type nonrec remove_tags_from_resource_message = {
  1. tag_keys : key_list;
    (*

    A list of TagKeys identifying the tags you want removed from the named resource.

    *)
  2. resource_name : string_;
    (*

    The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

    For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

    *)
}

Represents the input of a RemoveTagsFromResource operation.

type nonrec invalid_serverless_cache_state_fault = {
  1. message : exception_message option;
}

The account for these credentials is not currently active.

type nonrec invalid_serverless_cache_snapshot_state_fault = {
  1. message : exception_message option;
}

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

type nonrec invalid_arn_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_subnet_group_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_cluster_not_found_fault = {
  1. message : exception_message option;
}

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

type nonrec remove_replicas_list = string_ list
type nonrec regional_configuration = {
  1. resharding_configuration : resharding_configuration_list;
    (*

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

    *)
  2. replication_group_region : string_;
    (*

    The Amazon region where the cluster is stored

    *)
  3. replication_group_id : string_;
    (*

    The name of the secondary cluster

    *)
}

A list of the replication groups

type nonrec regional_configuration_list = regional_configuration list
type nonrec cache_node_ids_list = string_ list
type nonrec pending_modified_values = {
  1. scale_config : scale_config option;
    (*

    The scaling configuration changes that are pending for the Memcached cluster.

    *)
  2. transit_encryption_mode : transit_encryption_mode option;
    (*

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    *)
  3. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    *)
  4. log_delivery_configurations : pending_log_delivery_configuration_list option;
    (*

    The log delivery configurations being modified

    *)
  5. auth_token_status : auth_token_update_status option;
    (*

    The auth token status

    *)
  6. cache_node_type : string_ option;
    (*

    The cache node type that this cluster or replication group is scaled to.

    *)
  7. engine_version : string_ option;
    (*

    The new cache engine version that the cluster runs.

    *)
  8. cache_node_ids_to_remove : cache_node_ids_list option;
    (*

    A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

    *)
  9. num_cache_nodes : integer_optional option;
    (*

    The new number of cache nodes for the cluster.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    *)
}

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

type nonrec notification_configuration = {
  1. topic_status : string_ option;
    (*

    The current state of the topic.

    *)
  2. topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) that identifies the topic.

    *)
}

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

type nonrec cache_security_group_membership = {
  1. status : string_ option;
    (*

    The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

    *)
  2. cache_security_group_name : string_ option;
    (*

    The name of the cache security group.

    *)
}

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

type nonrec cache_security_group_membership_list = cache_security_group_membership list
type nonrec cache_parameter_group_status = {
  1. cache_node_ids_to_reboot : cache_node_ids_list option;
    (*

    A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

    *)
  2. parameter_apply_status : string_ option;
    (*

    The status of parameter updates.

    *)
  3. cache_parameter_group_name : string_ option;
    (*

    The name of the cache parameter group.

    *)
}

Status of the cache parameter group.

type nonrec cache_node = {
  1. customer_outpost_arn : string_ option;
    (*

    The customer outpost ARN of the cache node.

    *)
  2. customer_availability_zone : string_ option;
    (*

    The Availability Zone where this node was created and now resides.

    *)
  3. source_cache_node_id : string_ option;
    (*

    The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

    *)
  4. parameter_group_status : string_ option;
    (*

    The status of the parameter group applied to this cache node.

    *)
  5. endpoint : endpoint option;
    (*

    The hostname for connecting to this cache node.

    *)
  6. cache_node_create_time : t_stamp option;
    (*

    The date and time when the cache node was created.

    *)
  7. cache_node_status : string_ option;
    (*

    The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

    *)
  8. cache_node_id : string_ option;
    (*

    The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's Amazon account.

    *)
}

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.
type nonrec cache_node_list = cache_node list
type nonrec cache_cluster = {
  1. transit_encryption_mode : transit_encryption_mode option;
    (*

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    *)
  2. ip_discovery : ip_discovery option;
    (*

    The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  3. network_type : network_type option;
    (*

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  4. log_delivery_configurations : log_delivery_configuration_list option;
    (*

    Returns the destination, format and type of the logs.

    *)
  5. replication_group_log_delivery_enabled : boolean_ option;
    (*

    A boolean value indicating whether log delivery is enabled for the replication group.

    *)
  6. ar_n : string_ option;
    (*

    The ARN (Amazon Resource Name) of the cache cluster.

    *)
  7. at_rest_encryption_enabled : boolean_optional option;
    (*

    A flag that enables encryption at-rest when set to true.

    You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

    Default: false

    *)
  8. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

    Default: false

    *)
  9. auth_token_last_modified_date : t_stamp option;
    (*

    The date the auth token was last modified

    *)
  10. auth_token_enabled : boolean_optional option;
    (*

    A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

    Default: false

    *)
  11. snapshot_window : string_ option;
    (*

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

    Example: 05:00-09:00

    *)
  12. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    *)
  13. replication_group_id : string_ option;
    (*

    The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

    *)
  14. security_groups : security_group_membership_list option;
    (*

    A list of VPC Security Groups associated with the cluster.

    *)
  15. auto_minor_version_upgrade : boolean_ option;
    (*

     If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  16. cache_nodes : cache_node_list option;
    (*

    A list of cache nodes that are members of the cluster.

    *)
  17. cache_subnet_group_name : string_ option;
    (*

    The name of the cache subnet group associated with the cluster.

    *)
  18. cache_parameter_group : cache_parameter_group_status option;
    (*

    Status of the cache parameter group.

    *)
  19. cache_security_groups : cache_security_group_membership_list option;
    (*

    A list of cache security group elements, composed of name and status sub-elements.

    *)
  20. notification_configuration : notification_configuration option;
    (*

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

    *)
  21. pending_modified_values : pending_modified_values option;
  22. preferred_maintenance_window : string_ option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat

    Example: sun:23:00-mon:01:30

    *)
  23. cache_cluster_create_time : t_stamp option;
    (*

    The date and time when the cluster was created.

    *)
  24. preferred_outpost_arn : string_ option;
    (*

    The outpost ARN in which the cache cluster is created.

    *)
  25. preferred_availability_zone : string_ option;
    (*

    The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

    *)
  26. num_cache_nodes : integer_optional option;
    (*

    The number of cache nodes in the cluster.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    *)
  27. cache_cluster_status : string_ option;
    (*

    The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

    *)
  28. engine_version : string_ option;
    (*

    The version of the cache engine that is used in this cluster.

    *)
  29. engine : string_ option;
    (*

    The name of the cache engine (memcached or redis) to be used for this cluster.

    *)
  30. cache_node_type : string_ option;
    (*

    The name of the compute and memory capacity node type for the cluster.

    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.
    *)
  31. client_download_landing_page : string_ option;
    (*

    The URL of the web page where you can download the latest ElastiCache client library.

    *)
  32. configuration_endpoint : endpoint option;
    (*

    Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

    Example:

    mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
    *)
  33. cache_cluster_id : string_ option;
    (*

    The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

    *)
}

Contains all of the attributes of a specific cluster.

type nonrec reboot_cache_cluster_result = {
  1. cache_cluster : cache_cluster option;
}
type nonrec reboot_cache_cluster_message = {
  1. cache_node_ids_to_reboot : cache_node_ids_list;
    (*

    A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

    *)
  2. cache_cluster_id : string_;
    (*

    The cluster identifier. This parameter is stored as a lowercase string.

    *)
}

Represents the input of a RebootCacheCluster operation.

type nonrec global_replication_group_member = {
  1. status : string_ option;
    (*

    The status of the membership of the replication group.

    *)
  2. automatic_failover : automatic_failover_status option;
    (*

    Indicates whether automatic failover is enabled for the replication group.

    *)
  3. role : string_ option;
    (*

    Indicates the role of the replication group, primary or secondary.

    *)
  4. replication_group_region : string_ option;
    (*

    The Amazon region of the Global datastore member.

    *)
  5. replication_group_id : string_ option;
    (*

    The replication group id of the Global datastore member.

    *)
}

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

type nonrec global_replication_group_member_list = global_replication_group_member list
type nonrec global_node_group = {
  1. slots : string_ option;
    (*

    The keyspace for this node group

    *)
  2. global_node_group_id : string_ option;
    (*

    The name of the global node group

    *)
}

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

type nonrec global_node_group_list = global_node_group list
type nonrec global_replication_group = {
  1. ar_n : string_ option;
    (*

    The ARN (Amazon Resource Name) of the global replication group.

    *)
  2. at_rest_encryption_enabled : boolean_optional option;
    (*

    A flag that enables encryption at rest when set to true.

    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

    *)
  3. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

    *)
  4. auth_token_enabled : boolean_optional option;
    (*

    A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

    Default: false

    *)
  5. global_node_groups : global_node_group_list option;
    (*

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

    *)
  6. cluster_enabled : boolean_optional option;
    (*

    A flag that indicates whether the Global datastore is cluster enabled.

    *)
  7. members : global_replication_group_member_list option;
    (*

    The replication groups that comprise the Global datastore.

    *)
  8. engine_version : string_ option;
    (*

    The ElastiCache engine version.

    *)
  9. engine : string_ option;
    (*

    The ElastiCache engine. For Valkey or Redis OSS only.

    *)
  10. cache_node_type : string_ option;
    (*

    The cache node type of the Global datastore

    *)
  11. status : string_ option;
    (*

    The status of the Global datastore

    *)
  12. global_replication_group_description : string_ option;
    (*

    The optional description of the Global datastore

    *)
  13. global_replication_group_id : string_ option;
    (*

    The name of the Global datastore

    *)
}

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.
type nonrec rebalance_slots_in_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec rebalance_slots_in_global_replication_group_message = {
  1. apply_immediately : boolean_;
    (*

    If True, redistribution is applied immediately.

    *)
  2. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec global_replication_group_not_found_fault = {
  1. message : exception_message option;
}

The Global datastore does not exist

type nonrec purchase_reserved_cache_nodes_offering_result = {
  1. reserved_cache_node : reserved_cache_node option;
}
type nonrec purchase_reserved_cache_nodes_offering_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. cache_node_count : integer_optional option;
    (*

    The number of cache node instances to reserve.

    Default: 1

    *)
  3. reserved_cache_node_id : string_ option;
    (*

    A customer-specified identifier to track this reservation.

    The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

    Example: myreservationID

    *)
  4. reserved_cache_nodes_offering_id : string_;
    (*

    The ID of the reserved cache node offering to purchase.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    *)
}

Represents the input of a PurchaseReservedCacheNodesOffering operation.

type nonrec password_list_input = string_ list
type nonrec change_type =
  1. | Requires_reboot
  2. | Immediate
type nonrec parameter = {
  1. change_type : change_type option;
    (*

    Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

    *)
  2. minimum_engine_version : string_ option;
    (*

    The earliest cache engine version to which the parameter can apply.

    *)
  3. is_modifiable : boolean_ option;
    (*

    Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    *)
  4. allowed_values : string_ option;
    (*

    The valid range of values for the parameter.

    *)
  5. data_type : string_ option;
    (*

    The valid data type for the parameter.

    *)
  6. source : string_ option;
    (*

    The source of the parameter.

    *)
  7. description : string_ option;
    (*

    A description of the parameter.

    *)
  8. parameter_value : string_ option;
    (*

    The value of the parameter.

    *)
  9. parameter_name : string_ option;
    (*

    The name of the parameter.

    *)
}

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

type nonrec parameters_list = parameter list
type nonrec outpost_mode =
  1. | CROSS_OUTPOST
  2. | SINGLE_OUTPOST
type nonrec node_type_list = string_ list
type nonrec node_quota_for_customer_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec node_quota_for_cluster_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec node_groups_to_retain_list = allowed_node_group_id list
type nonrec node_groups_to_remove_list = allowed_node_group_id list
type nonrec node_groups_per_replication_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec node_group_configuration_list = node_group_configuration list
type nonrec no_operation_fault = {
  1. message : exception_message option;
}

The operation was not performed because no changes were required.

type nonrec access_string = string
type nonrec input_authentication_type =
  1. | IAM
  2. | NO_PASSWORD
  3. | PASSWORD
type nonrec authentication_mode = {
  1. passwords : password_list_input option;
    (*

    Specifies the passwords to use for authentication if Type is set to password.

    *)
  2. type_ : input_authentication_type option;
    (*

    Specifies the authentication type. Possible options are IAM authentication, password and no password.

    *)
}

Specifies the authentication mode to use.

type nonrec modify_user_message = {
  1. engine : engine_type option;
    (*

    Modifies the engine listed for a user. The options are valkey or redis.

    *)
  2. authentication_mode : authentication_mode option;
    (*

    Specifies how to authenticate the user.

    *)
  3. no_password_required : boolean_optional option;
    (*

    Indicates no password is required for the user.

    *)
  4. passwords : password_list_input option;
    (*

    The passwords belonging to the user. You are allowed up to two.

    *)
  5. append_access_string : access_string option;
    (*

    Adds additional user permissions to the access string.

    *)
  6. access_string : access_string option;
    (*

    Access permissions string used for this user.

    *)
  7. user_id : user_id;
    (*

    The ID of the user.

    *)
}
type nonrec modify_user_group_message = {
  1. engine : engine_type option;
    (*

    Modifies the engine listed in a user group. The options are valkey or redis.

    *)
  2. user_ids_to_remove : user_id_list_input option;
    (*

    The list of user IDs to remove from the user group.

    *)
  3. user_ids_to_add : user_id_list_input option;
    (*

    The list of user IDs to add to the user group.

    *)
  4. user_group_id : string_;
    (*

    The ID of the user group.

    *)
}
type nonrec invalid_user_group_state_fault = {
  1. message : exception_message option;
}

The user group is not in an active state.

type nonrec duplicate_user_name_fault = {
  1. message : exception_message option;
}

A user with this username already exists.

type nonrec default_user_required = {
  1. message : exception_message option;
}

You must add default user to a user group.

type nonrec invalid_user_state_fault = {
  1. message : exception_message option;
}

The user is not in active state.

type nonrec modify_serverless_cache_response = {
  1. serverless_cache : serverless_cache option;
    (*

    The response for the attempt to modify the serverless cache.

    *)
}
type nonrec modify_serverless_cache_request = {
  1. major_engine_version : string_ option;
    (*

    Modifies the engine vesion listed in a serverless cache request.

    *)
  2. engine : string_ option;
    (*

    Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.

    *)
  3. daily_snapshot_time : string_ option;
    (*

    The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

    *)
  4. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

    *)
  5. security_group_ids : security_group_ids_list option;
    (*

    The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.

    *)
  6. user_group_id : string_ option;
    (*

    The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL - the existing UserGroup is not removed.

    *)
  7. remove_user_group : boolean_optional option;
    (*

    The identifier of the UserGroup to be removed from association with the Valkey and Redis OSS serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

    *)
  8. cache_usage_limits : cache_usage_limits option;
    (*

    Modify the cache usage limit for the serverless cache.

    *)
  9. description : string_ option;
    (*

    User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.

    *)
  10. serverless_cache_name : string_;
    (*

    User-provided identifier for the serverless cache to be modified.

    *)
}
type nonrec invalid_credentials_exception = {
  1. message : exception_message option;
}

You must enter valid credentials.

type nonrec modify_replication_group_shard_configuration_result = {
  1. replication_group : replication_group option;
}
type nonrec modify_replication_group_shard_configuration_message = {
  1. node_groups_to_retain : node_groups_to_retain_list option;
    (*

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

    ElastiCache will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

    *)
  2. node_groups_to_remove : node_groups_to_remove_list option;
    (*

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

    ElastiCache will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

    *)
  3. resharding_configuration : resharding_configuration_list option;
    (*

    Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

    You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

    *)
  4. apply_immediately : boolean_;
    (*

    Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

    Value: true

    *)
  5. node_group_count : integer;
    (*

    The number of node groups (shards) that results from the modification of the shard configuration.

    *)
  6. replication_group_id : string_;
    (*

    The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

    *)
}

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

type nonrec invalid_vpc_network_state_fault = {
  1. message : exception_message option;
}

The VPC network is in an invalid state.

type nonrec insufficient_cache_cluster_capacity_fault = {
  1. message : exception_message option;
}

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

type nonrec modify_replication_group_result = {
  1. replication_group : replication_group option;
}
type nonrec cache_security_group_name_list = string_ list
type nonrec auth_token_update_strategy_type =
  1. | DELETE
  2. | ROTATE
  3. | SET
type nonrec log_delivery_configuration_request = {
  1. enabled : boolean_optional option;
    (*

    Specify if log delivery is enabled. Default true.

    *)
  2. log_format : log_format option;
    (*

    Specifies either JSON or TEXT

    *)
  3. destination_details : destination_details option;
    (*

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

    *)
  4. destination_type : destination_type option;
    (*

    Specify either cloudwatch-logs or kinesis-firehose as the destination type.

    *)
  5. log_type : log_type option;
    (*

    Refers to slow-log or engine-log..

    *)
}

Specifies the destination, format and type of the logs.

type nonrec log_delivery_configuration_request_list = log_delivery_configuration_request list
type nonrec modify_replication_group_message = {
  1. durability : durability option;
    (*

    Specifies the durability setting for the replication group. Use this parameter to change the durability mode of an existing replication group, for example from sync to async or vice versa. For more information, see Durability.

    *)
  2. cluster_mode : cluster_mode option;
    (*

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    *)
  3. transit_encryption_mode : transit_encryption_mode option;
    (*

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set the value to required to allow encrypted connections only.

    Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.

    *)
  4. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.

    *)
  5. ip_discovery : ip_discovery option;
    (*

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  6. log_delivery_configurations : log_delivery_configuration_request_list option;
    (*

    Specifies the destination, format and type of the logs.

    *)
  7. remove_user_groups : boolean_optional option;
    (*

    Removes the user group associated with this replication group.

    *)
  8. user_group_ids_to_remove : user_group_id_list option;
    (*

    The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.

    *)
  9. user_group_ids_to_add : user_group_id_list option;
    (*

    The ID of the user group you are associating with the replication group.

    *)
  10. auth_token_update_strategy : auth_token_update_strategy_type option;
    (*

    Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

    • ROTATE - default, if no update strategy is provided
    • SET - allowed only after ROTATE
    • DELETE - allowed only when transitioning to RBAC

    For more information, see Authenticating Users with AUTH

    *)
  11. auth_token : string_ option;
    (*

    Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

    • Must be only printable ASCII characters
    • Must be at least 16 characters and no more than 128 characters in length
    • Cannot contain any of the following characters: '/', '"', or '@', '%'

    For more information, see AUTH password at AUTH.

    *)
  12. cache_node_type : string_ option;
    (*

    A valid cache node type that you want to scale this replication group to.

    *)
  13. snapshot_window : string_ option;
    (*

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    *)
  14. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    *)
  15. auto_minor_version_upgrade : boolean_optional option;
    (*

     If you are running Valkey or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  16. engine_version : string_ option;
    (*

    The upgraded version of the cache engine to be run on the clusters in the replication group.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

    *)
  17. engine : string_ option;
    (*

    Modifies the engine listed in a replication group message. The options are valkey, memcached or redis.

    *)
  18. apply_immediately : boolean_ option;
    (*

    If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

    If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

    Valid values: true | false

    Default: false

    *)
  19. notification_topic_status : string_ option;
    (*

    The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

    Valid values: active | inactive

    *)
  20. cache_parameter_group_name : string_ option;
    (*

    The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    *)
  21. notification_topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

    The Amazon SNS topic owner must be same as the replication group owner.

    *)
  22. preferred_maintenance_window : string_ option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat

    Example: sun:23:00-mon:01:30

    *)
  23. security_group_ids : security_group_ids_list option;
    (*

    Specifies the VPC Security Groups associated with the clusters in the replication group.

    This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

    *)
  24. cache_security_group_names : cache_security_group_name_list option;
    (*

    A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

    This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

    Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

    *)
  25. node_group_id : string_ option;
    (*

    Deprecated. This parameter is not used.

    *)
  26. multi_az_enabled : boolean_optional option;
    (*

    A flag to indicate MultiAZ is enabled.

    *)
  27. automatic_failover_enabled : boolean_optional option;
    (*

    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

    Valid values: true | false

    *)
  28. snapshotting_cluster_id : string_ option;
    (*

    The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

    *)
  29. primary_cluster_id : string_ option;
    (*

    For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

    *)
  30. replication_group_description : string_ option;
    (*

    A description for the replication group. Maximum length is 255 characters.

    *)
  31. replication_group_id : string_;
    (*

    The identifier of the replication group to modify.

    *)
}

Represents the input of a ModifyReplicationGroups operation.

type nonrec modify_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec modify_global_replication_group_message = {
  1. automatic_failover_enabled : boolean_optional option;
    (*

    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

    *)
  2. global_replication_group_description : string_ option;
    (*

    A description of the Global datastore

    *)
  3. cache_parameter_group_name : string_ option;
    (*

    The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

    *)
  4. engine_version : string_ option;
    (*

    The upgraded version of the cache engine to be run on the clusters in the Global datastore.

    *)
  5. engine : string_ option;
    (*

    Modifies the engine listed in a global replication group message. The options are valkey, memcached or redis.

    *)
  6. cache_node_type : string_ option;
    (*

    A valid cache node type that you want to scale this Global datastore to.

    *)
  7. apply_immediately : boolean_;
    (*

    This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

    *)
  8. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec cache_subnet_group = {
  1. supported_network_types : network_type_list option;
    (*

    Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  2. ar_n : string_ option;
    (*

    The ARN (Amazon Resource Name) of the cache subnet group.

    *)
  3. subnets : subnet_list option;
    (*

    A list of subnets associated with the cache subnet group.

    *)
  4. vpc_id : string_ option;
    (*

    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

    *)
  5. cache_subnet_group_description : string_ option;
    (*

    The description of the cache subnet group.

    *)
  6. cache_subnet_group_name : string_ option;
    (*

    The name of the cache subnet group.

    *)
}

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
type nonrec modify_cache_subnet_group_result = {
  1. cache_subnet_group : cache_subnet_group option;
}
type nonrec modify_cache_subnet_group_message = {
  1. subnet_ids : subnet_identifier_list option;
    (*

    The EC2 subnet IDs for the cache subnet group.

    *)
  2. cache_subnet_group_description : string_ option;
    (*

    A description of the cache subnet group.

    *)
  3. cache_subnet_group_name : string_;
    (*

    The name for the cache subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    Example: mysubnetgroup

    *)
}

Represents the input of a ModifyCacheSubnetGroup operation.

type nonrec invalid_subnet = {
  1. message : exception_message option;
}

An invalid subnet identifier was specified.

type nonrec cache_subnet_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec modify_cache_parameter_group_message = {
  1. parameter_name_values : parameter_name_value_list;
    (*

    An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

    *)
  2. cache_parameter_group_name : string_;
    (*

    The name of the cache parameter group to modify.

    *)
}

Represents the input of a ModifyCacheParameterGroup operation.

type nonrec modify_cache_cluster_result = {
  1. cache_cluster : cache_cluster option;
}
type nonrec az_mode =
  1. | CROSS_AZ
  2. | SINGLE_AZ
type nonrec modify_cache_cluster_message = {
  1. scale_config : scale_config option;
    (*

    Configures horizontal or vertical scaling for Memcached clusters, specifying the scaling percentage and interval.

    *)
  2. ip_discovery : ip_discovery option;
    (*

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  3. log_delivery_configurations : log_delivery_configuration_request_list option;
    (*

    Specifies the destination, format and type of the logs.

    *)
  4. auth_token_update_strategy : auth_token_update_strategy_type option;
    (*

    Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

    • ROTATE - default, if no update strategy is provided
    • SET - allowed only after ROTATE
    • DELETE - allowed only when transitioning to RBAC

    For more information, see Authenticating Users with AUTH

    *)
  5. auth_token : string_ option;
    (*

    Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

    • Must be only printable ASCII characters
    • Must be at least 16 characters and no more than 128 characters in length
    • Cannot contain any of the following characters: '/', '"', or '@', '%'

    For more information, see AUTH password at AUTH.

    *)
  6. cache_node_type : string_ option;
    (*

    A valid cache node type that you want to scale this cluster up to.

    *)
  7. snapshot_window : string_ option;
    (*

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

    *)
  8. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    *)
  9. auto_minor_version_upgrade : boolean_optional option;
    (*

     If you are running Valkey 7.2 or Redis OSS engine version 6.0 or later, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  10. engine_version : string_ option;
    (*

    The upgraded version of the cache engine to be run on the cache nodes.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

    *)
  11. engine : string_ option;
    (*

    The engine type used by the cache cluster. The options are valkey, memcached or redis.

    *)
  12. apply_immediately : boolean_ option;
    (*

    If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.

    If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

    If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification. However, a pending node-count increase on Memcached clusters cannot be superseded by a request to add fewer nodes. To change a pending node addition, first cancel it by setting NumCacheNodes equal to the current number of nodes in the cluster, then submit the new request. See the NumCacheNodes parameter for details on node scaling behavior.

    Valid values: true | false

    Default: false

    *)
  13. notification_topic_status : string_ option;
    (*

    The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

    Valid values: active | inactive

    *)
  14. cache_parameter_group_name : string_ option;
    (*

    The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    *)
  15. notification_topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

    The Amazon SNS topic owner must be same as the cluster owner.

    *)
  16. preferred_maintenance_window : string_ option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat

    Example: sun:23:00-mon:01:30

    *)
  17. security_group_ids : security_group_ids_list option;
    (*

    Specifies the VPC Security Groups associated with the cluster.

    This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

    *)
  18. cache_security_group_names : cache_security_group_name_list option;
    (*

    A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

    You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

    Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

    *)
  19. new_availability_zones : preferred_availability_zone_list option;
    (*

    This option is only supported on Memcached clusters.

    The list of Availability Zones where the new Memcached cache nodes are created.

    This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

    Scenarios:

    • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
    • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.
    • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

    The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

    If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

    Impact of new add/remove requests upon pending requests

    • Scenario-1

      • Pending Action: Delete
      • New Request: Delete
      • Result: The new delete, pending or immediate, replaces the pending delete.

    • Scenario-2

      • Pending Action: Delete
      • New Request: Create
      • Result: The new create, pending or immediate, replaces the pending delete.

    • Scenario-3

      • Pending Action: Create
      • New Request: Delete
      • Result: The new delete, pending or immediate, replaces the pending create.

    • Scenario-4

      • Pending Action: Create
      • New Request: Create

      • Result: The new create is added to the pending create.

        Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

    *)
  20. az_mode : az_mode option;
    (*

    Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

    Valid values: single-az | cross-az.

    This option is only supported for Memcached clusters.

    You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

    Only newly created nodes are located in different Availability Zones.

    *)
  21. cache_node_ids_to_remove : cache_node_ids_list option;
    (*

    A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

    For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

    *)
  22. num_cache_nodes : integer_optional option;
    (*

    The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

    If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

    A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

    *)
  23. cache_cluster_id : string_;
    (*

    The cluster identifier. This value is stored as a lowercase string.

    *)
}

Represents the input of a ModifyCacheCluster operation.

type nonrec list_tags_for_resource_message = {
  1. resource_name : string_;
    (*

    The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

    For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    *)
}

The input parameters for the ListTagsForResource operation.

type nonrec list_allowed_node_type_modifications_message = {
  1. replication_group_id : string_ option;
    (*

    The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

    You must provide a value for either the CacheClusterId or the ReplicationGroupId.

    *)
  2. cache_cluster_id : string_ option;
    (*

    The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

    You must provide a value for either the CacheClusterId or the ReplicationGroupId.

    *)
}

The input parameters for the ListAllowedNodeTypeModifications operation.

type nonrec allowed_node_type_modifications_message = {
  1. scale_down_modifications : node_type_list option;
    (*

    A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

    *)
  2. scale_up_modifications : node_type_list option;
    (*

    A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

    When scaling up a Valkey or Redis OSS cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

    *)
}

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

type nonrec invalid_snapshot_state_fault = {
  1. message : exception_message option;
}

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

type nonrec increase_replica_count_result = {
  1. replication_group : replication_group option;
}
type nonrec increase_replica_count_message = {
  1. apply_immediately : boolean_;
    (*

    If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

    *)
  2. replica_configuration : replica_configuration_list option;
    (*

    A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

    *)
  3. new_replica_count : integer_optional option;
    (*

    The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

    *)
  4. replication_group_id : string_;
    (*

    The id of the replication group to which you want to add replica nodes.

    *)
}
type nonrec cluster_quota_for_customer_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec increase_node_groups_in_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec increase_node_groups_in_global_replication_group_message = {
  1. apply_immediately : boolean_;
    (*

    Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

    *)
  2. regional_configurations : regional_configuration_list option;
    (*

    Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

    *)
  3. node_group_count : integer;
    (*

    Total number of node groups you want

    *)
  4. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec global_replication_group_list = global_replication_group list
type nonrec global_replication_group_already_exists_fault = {
  1. message : exception_message option;
}

The Global datastore name already exists.

type nonrec global_node_group_id_list = string_ list
type nonrec filter_value = string
type nonrec filter_value_list = filter_value list
type nonrec filter_name = string
type nonrec filter = {
  1. values : filter_value_list;
    (*

    The property values to filter on. For example, "user-123".

    *)
  2. name : filter_name;
    (*

    The property being filtered. For example, UserId.

    *)
}

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

type nonrec filter_list = filter list
type nonrec failover_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec failover_global_replication_group_message = {
  1. primary_replication_group_id : string_;
    (*

    The name of the primary replication group

    *)
  2. primary_region : string_;
    (*

    The Amazon region of the primary cluster of the Global datastore

    *)
  3. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec export_serverless_cache_snapshot_response = {
  1. serverless_cache_snapshot : serverless_cache_snapshot option;
    (*

    The state of a serverless cache at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec export_serverless_cache_snapshot_request = {
  1. s3_bucket_name : string_;
    (*

    Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Valkey and Redis OSS only.

    *)
  2. serverless_cache_snapshot_name : string_;
    (*

    The identifier of the serverless cache snapshot to be exported to S3. Available for Valkey and Redis OSS only.

    *)
}
type nonrec event = {
  1. date : t_stamp option;
    (*

    The date and time when the event occurred.

    *)
  2. message : string_ option;
    (*

    The text of the event.

    *)
  3. source_type : source_type option;
    (*

    Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

    *)
  4. source_identifier : string_ option;
    (*

    The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

    *)
}

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.

type nonrec event_list = event list
type nonrec events_message = {
  1. events : event_list option;
    (*

    A list of events. Each element in the list contains detailed information about one event.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeEvents operation.

type nonrec cache_node_type_specific_value = {
  1. value : string_ option;
    (*

    The value for the cache node type.

    *)
  2. cache_node_type : string_ option;
    (*

    The cache node type for which this value applies.

    *)
}

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

type nonrec cache_node_type_specific_value_list = cache_node_type_specific_value list
type nonrec cache_node_type_specific_parameter = {
  1. change_type : change_type option;
    (*

    Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

    *)
  2. cache_node_type_specific_values : cache_node_type_specific_value_list option;
    (*

    A list of cache node types and their corresponding values for this parameter.

    *)
  3. minimum_engine_version : string_ option;
    (*

    The earliest cache engine version to which the parameter can apply.

    *)
  4. is_modifiable : boolean_ option;
    (*

    Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    *)
  5. allowed_values : string_ option;
    (*

    The valid range of values for the parameter.

    *)
  6. data_type : string_ option;
    (*

    The valid data type for the parameter.

    *)
  7. source : string_ option;
    (*

    The source of the parameter value.

    *)
  8. description : string_ option;
    (*

    A description of the parameter.

    *)
  9. parameter_name : string_ option;
    (*

    The name of the parameter.

    *)
}

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.

type nonrec cache_node_type_specific_parameters_list = cache_node_type_specific_parameter list
type nonrec engine_defaults = {
  1. cache_node_type_specific_parameters : cache_node_type_specific_parameters_list option;
    (*

    A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

    *)
  2. parameters : parameters_list option;
    (*

    Contains a list of engine default parameters.

    *)
  3. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
  4. cache_parameter_group_family : string_ option;
    (*

    Specifies the name of the cache parameter group family to which the engine default parameters apply.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 | redis6.x | redis7

    *)
}

Represents the output of a DescribeEngineDefaultParameters operation.

type nonrec disassociate_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec disassociate_global_replication_group_message = {
  1. replication_group_region : string_;
    (*

    The Amazon region of secondary cluster you wish to remove from the Global datastore

    *)
  2. replication_group_id : string_;
    (*

    The name of the secondary cluster you wish to remove from the Global datastore

    *)
  3. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec describe_users_result = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

    *)
  2. users : user_list option;
    (*

    A list of users.

    *)
}
type nonrec describe_users_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    *)
  3. filters : filter_list option;
    (*

    Filter to determine the list of User IDs to return.

    *)
  4. user_id : user_id option;
    (*

    The ID of the user.

    *)
  5. engine : engine_type option;
    (*

    The engine.

    *)
}
type nonrec describe_user_groups_result = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.>

    *)
  2. user_groups : user_group_list option;
    (*

    Returns a list of user groups.

    *)
}
type nonrec describe_user_groups_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    *)
  3. user_group_id : string_ option;
    (*

    The ID of the user group.

    *)
}
type nonrec cache_cluster_id_list = string_ list
type nonrec describe_update_actions_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response

    *)
  3. show_node_level_update_status : boolean_optional option;
    (*

    Dictates whether to include node level update status in the response

    *)
  4. update_action_status : update_action_status_list option;
    (*

    The status of the update action.

    *)
  5. service_update_time_range : time_range_filter option;
    (*

    The range of time specified to search for service updates that are in available status

    *)
  6. service_update_status : service_update_status_list option;
    (*

    The status of the service update

    *)
  7. engine : string_ option;
    (*

    The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

    *)
  8. cache_cluster_ids : cache_cluster_id_list option;
    (*

    The cache cluster IDs

    *)
  9. replication_group_ids : replication_group_id_list option;
    (*

    The replication group IDs

    *)
  10. service_update_name : string_ option;
    (*

    The unique ID of the service update

    *)
}
type nonrec describe_snapshots_message = {
  1. show_node_group_config : boolean_optional option;
    (*

    A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 50

    Constraints: minimum 20; maximum 50.

    *)
  3. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  4. snapshot_source : string_ option;
    (*

    If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

    *)
  5. snapshot_name : string_ option;
    (*

    A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

    *)
  6. cache_cluster_id : string_ option;
    (*

    A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

    *)
  7. replication_group_id : string_ option;
    (*

    A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

    *)
}

Represents the input of a DescribeSnapshotsMessage operation.

type nonrec describe_snapshots_list_message = {
  1. snapshots : snapshot_list option;
    (*

    A list of snapshots. Each item in the list contains detailed information about one snapshot.

    *)
  2. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
}

Represents the output of a DescribeSnapshots operation.

type nonrec describe_service_updates_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response

    *)
  3. service_update_status : service_update_status_list option;
    (*

    The status of the service update

    *)
  4. service_update_name : string_ option;
    (*

    The unique ID of the service update

    *)
}
type nonrec describe_serverless_caches_response = {
  1. serverless_caches : serverless_cache_list option;
    (*

    The serverless caches associated with a given description request.

    *)
  2. next_token : string_ option;
    (*

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.

    *)
}
type nonrec describe_serverless_caches_request = {
  1. next_token : string_ option;
    (*

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.

    *)
  2. max_results : integer_optional option;
    (*

    The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.

    *)
  3. serverless_cache_name : string_ option;
    (*

    The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL

    *)
}
type nonrec describe_serverless_cache_snapshots_response = {
  1. serverless_cache_snapshots : serverless_cache_snapshot_list option;
    (*

    The serverless caches snapshots associated with a given description request. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  2. next_token : string_ option;
    (*

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec describe_serverless_cache_snapshots_request = {
  1. max_results : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Valkey, Redis OSS and Serverless Memcached only.The default is 50. The Validation Constraints are a maximum of 50.

    *)
  2. next_token : string_ option;
    (*

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  3. snapshot_type : string_ option;
    (*

    The type of snapshot that is being described. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  4. serverless_cache_snapshot_name : string_ option;
    (*

    The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  5. serverless_cache_name : string_ option;
    (*

    The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec describe_reserved_cache_nodes_offerings_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. offering_type : string_ option;
    (*

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

    Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"

    *)
  4. product_description : string_ option;
    (*

    The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

    *)
  5. duration : string_ option;
    (*

    Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    *)
  6. cache_node_type : string_ option;
    (*

    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

    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.
    *)
  7. reserved_cache_nodes_offering_id : string_ option;
    (*

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    *)
}

Represents the input of a DescribeReservedCacheNodesOfferings operation.

type nonrec describe_reserved_cache_nodes_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. offering_type : string_ option;
    (*

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

    Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"

    *)
  4. product_description : string_ option;
    (*

    The product description filter value. Use this parameter to show only those reservations matching the specified product description.

    *)
  5. duration : string_ option;
    (*

    The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    *)
  6. cache_node_type : string_ option;
    (*

    The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

    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.
    *)
  7. reserved_cache_nodes_offering_id : string_ option;
    (*

    The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

    *)
  8. reserved_cache_node_id : string_ option;
    (*

    The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

    *)
}

Represents the input of a DescribeReservedCacheNodes operation.

type nonrec describe_replication_groups_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. replication_group_id : string_ option;
    (*

    The identifier for the replication group to be described. This parameter is not case sensitive.

    If you do not specify this parameter, information about all replication groups is returned.

    *)
}

Represents the input of a DescribeReplicationGroups operation.

type nonrec describe_global_replication_groups_result = {
  1. global_replication_groups : global_replication_group_list option;
    (*

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

    *)
  2. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

    *)
}
type nonrec describe_global_replication_groups_message = {
  1. show_member_info : boolean_optional option;
    (*

    Returns the list of members that comprise the Global datastore.

    *)
  2. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  3. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    *)
  4. global_replication_group_id : string_ option;
    (*

    The name of the Global datastore

    *)
}
type nonrec describe_events_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. duration : integer_optional option;
    (*

    The number of minutes worth of events to retrieve.

    *)
  4. end_time : t_stamp option;
    (*

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

    Example: 2017-03-30T07:03:49.555Z

    *)
  5. start_time : t_stamp option;
    (*

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

    Example: 2017-03-30T07:03:49.555Z

    *)
  6. source_type : source_type option;
    (*

    The event source to retrieve events for. If no value is specified, all events are returned.

    *)
  7. source_identifier : string_ option;
    (*

    The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

    *)
}

Represents the input of a DescribeEvents operation.

type nonrec describe_engine_default_parameters_result = {
  1. engine_defaults : engine_defaults option;
}
type nonrec describe_engine_default_parameters_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. cache_parameter_group_family : string_;
    (*

    The name of the cache parameter group family.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7

    *)
}

Represents the input of a DescribeEngineDefaultParameters operation.

type nonrec describe_cache_subnet_groups_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. cache_subnet_group_name : string_ option;
    (*

    The name of the cache subnet group to return details for.

    *)
}

Represents the input of a DescribeCacheSubnetGroups operation.

type nonrec cache_subnet_groups = cache_subnet_group list
type nonrec cache_subnet_group_message = {
  1. cache_subnet_groups : cache_subnet_groups option;
    (*

    A list of cache subnet groups. Each element in the list contains detailed information about one group.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeCacheSubnetGroups operation.

type nonrec describe_cache_security_groups_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. cache_security_group_name : string_ option;
    (*

    The name of the cache security group to return details for.

    *)
}

Represents the input of a DescribeCacheSecurityGroups operation.

type nonrec cache_security_groups = cache_security_group list
type nonrec cache_security_group_message = {
  1. cache_security_groups : cache_security_groups option;
    (*

    A list of cache security groups. Each element in the list contains detailed information about one group.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeCacheSecurityGroups operation.

type nonrec describe_cache_parameters_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. source : string_ option;
    (*

    The parameter types to return.

    Valid values: user | system | engine-default

    *)
  4. cache_parameter_group_name : string_;
    (*

    The name of a specific cache parameter group to return details for.

    *)
}

Represents the input of a DescribeCacheParameters operation.

type nonrec cache_parameter_group_details = {
  1. cache_node_type_specific_parameters : cache_node_type_specific_parameters_list option;
    (*

    A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

    *)
  2. parameters : parameters_list option;
    (*

    A list of Parameter instances.

    *)
  3. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeCacheParameters operation.

type nonrec describe_cache_parameter_groups_message = {
  1. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  2. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  3. cache_parameter_group_name : string_ option;
    (*

    The name of a specific cache parameter group to return details for.

    *)
}

Represents the input of a DescribeCacheParameterGroups operation.

type nonrec cache_parameter_group = {
  1. ar_n : string_ option;
    (*

    The ARN (Amazon Resource Name) of the cache parameter group.

    *)
  2. is_global : boolean_ option;
    (*

    Indicates whether the parameter group is associated with a Global datastore

    *)
  3. description : string_ option;
    (*

    The description for this cache parameter group.

    *)
  4. cache_parameter_group_family : string_ option;
    (*

    The name of the cache parameter group family that this cache parameter group is compatible with.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7

    *)
  5. cache_parameter_group_name : string_ option;
    (*

    The name of the cache parameter group.

    *)
}

Represents the output of a CreateCacheParameterGroup operation.

type nonrec cache_parameter_group_list = cache_parameter_group list
type nonrec cache_parameter_groups_message = {
  1. cache_parameter_groups : cache_parameter_group_list option;
    (*

    A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeCacheParameterGroups operation.

type nonrec describe_cache_engine_versions_message = {
  1. default_only : boolean_ option;
    (*

    If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

    *)
  2. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  3. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  4. cache_parameter_group_family : string_ option;
    (*

    The name of a specific cache parameter group family to return details for.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7 | valkey7

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    *)
  5. engine_version : string_ option;
    (*

    The cache engine version to return.

    Example: 1.4.14

    *)
  6. engine : string_ option;
    (*

    The cache engine to return. Valid values: memcached | redis

    *)
}

Represents the input of a DescribeCacheEngineVersions operation.

type nonrec cache_engine_version = {
  1. cache_engine_version_description : string_ option;
    (*

    The description of the cache engine version.

    *)
  2. cache_engine_description : string_ option;
    (*

    The description of the cache engine.

    *)
  3. cache_parameter_group_family : string_ option;
    (*

    The name of the cache parameter group family associated with this cache engine.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7

    *)
  4. engine_version : string_ option;
    (*

    The version number of the cache engine.

    *)
  5. engine : string_ option;
    (*

    The name of the cache engine.

    *)
}

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

type nonrec cache_engine_version_list = cache_engine_version list
type nonrec cache_engine_version_message = {
  1. cache_engine_versions : cache_engine_version_list option;
    (*

    A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeCacheEngineVersions operation.

type nonrec describe_cache_clusters_message = {
  1. show_cache_clusters_not_in_replication_groups : boolean_optional option;
    (*

    An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this means Memcached and single node Valkey or Redis OSS clusters.

    *)
  2. show_cache_node_info : boolean_optional option;
    (*

    An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

    *)
  3. marker : string_ option;
    (*

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    *)
  4. max_records : integer_optional option;
    (*

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    *)
  5. cache_cluster_id : string_ option;
    (*

    The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

    *)
}

Represents the input of a DescribeCacheClusters operation.

type nonrec cache_cluster_list = cache_cluster list
type nonrec cache_cluster_message = {
  1. cache_clusters : cache_cluster_list option;
    (*

    A list of clusters. Each item in the list contains detailed information about one cluster.

    *)
  2. marker : string_ option;
    (*

    Provides an identifier to allow retrieval of paginated results.

    *)
}

Represents the output of a DescribeCacheClusters operation.

type nonrec delete_user_message = {
  1. user_id : user_id;
    (*

    The ID of the user.

    *)
}
type nonrec delete_user_group_message = {
  1. user_group_id : string_;
    (*

    The ID of the user group.

    *)
}
type nonrec default_user_associated_to_user_group_fault = {
  1. message : exception_message option;
}

The default user assigned to the user group.

type nonrec delete_snapshot_result = {
  1. snapshot : snapshot option;
}
type nonrec delete_snapshot_message = {
  1. snapshot_name : string_;
    (*

    The name of the snapshot to be deleted.

    *)
}

Represents the input of a DeleteSnapshot operation.

type nonrec delete_serverless_cache_snapshot_response = {
  1. serverless_cache_snapshot : serverless_cache_snapshot option;
    (*

    The snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec delete_serverless_cache_snapshot_request = {
  1. serverless_cache_snapshot_name : string_;
    (*

    Idenfitier of the snapshot to be deleted. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec delete_serverless_cache_response = {
  1. serverless_cache : serverless_cache option;
    (*

    Provides the details of the specified serverless cache that is about to be deleted.

    *)
}
type nonrec delete_serverless_cache_request = {
  1. final_snapshot_name : string_ option;
    (*

    Name of the final snapshot to be taken before the serverless cache is deleted. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL, i.e. a final snapshot is not taken.

    *)
  2. serverless_cache_name : string_;
    (*

    The identifier of the serverless cache to be deleted.

    *)
}
type nonrec delete_replication_group_result = {
  1. replication_group : replication_group option;
}
type nonrec delete_replication_group_message = {
  1. final_snapshot_identifier : string_ option;
    (*

    The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

    *)
  2. retain_primary_cluster : boolean_optional option;
    (*

    If set to true, all of the read replicas are deleted, but the primary node is retained.

    *)
  3. replication_group_id : string_;
    (*

    The identifier for the cluster to be deleted. This parameter is not case sensitive.

    *)
}

Represents the input of a DeleteReplicationGroup operation.

type nonrec delete_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec delete_global_replication_group_message = {
  1. retain_primary_replication_group : boolean_;
    (*

    The primary replication group is retained as a standalone replication group.

    *)
  2. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec delete_cache_subnet_group_message = {
  1. cache_subnet_group_name : string_;
    (*

    The name of the cache subnet group to delete.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    *)
}

Represents the input of a DeleteCacheSubnetGroup operation.

type nonrec cache_subnet_group_in_use = {
  1. message : exception_message option;
}

The requested cache subnet group is currently in use.

type nonrec delete_cache_security_group_message = {
  1. cache_security_group_name : string_;
    (*

    The name of the cache security group to delete.

    You cannot delete the default security group.

    *)
}

Represents the input of a DeleteCacheSecurityGroup operation.

type nonrec delete_cache_parameter_group_message = {
  1. cache_parameter_group_name : string_;
    (*

    The name of the cache parameter group to delete.

    The specified cache security group must not be associated with any clusters.

    *)
}

Represents the input of a DeleteCacheParameterGroup operation.

type nonrec delete_cache_cluster_result = {
  1. cache_cluster : cache_cluster option;
}
type nonrec delete_cache_cluster_message = {
  1. final_snapshot_identifier : string_ option;
    (*

    The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

    *)
  2. cache_cluster_id : string_;
    (*

    The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

    *)
}

Represents the input of a DeleteCacheCluster operation.

type nonrec decrease_replica_count_result = {
  1. replication_group : replication_group option;
}
type nonrec decrease_replica_count_message = {
  1. apply_immediately : boolean_;
    (*

    If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

    *)
  2. replicas_to_remove : remove_replicas_list option;
    (*

    A list of the node ids to remove from the replication group or node group (shard).

    *)
  3. replica_configuration : replica_configuration_list option;
    (*

    A list of ConfigureShard objects that can be used to configure each shard in a Valkey or Redis OSS replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

    *)
  4. new_replica_count : integer_optional option;
    (*

    The number of read replica nodes you want at the completion of this operation. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Valkey or Redis OSS (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

    The minimum number of replicas in a shard or replication group is:

    • Valkey or Redis OSS (cluster mode disabled)

      • If Multi-AZ is enabled: 1
      • If Multi-AZ is not enabled: 0
    • Valkey or Redis OSS (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
    *)
  5. replication_group_id : string_;
    (*

    The id of the replication group from which you want to remove replica nodes.

    *)
}
type nonrec decrease_node_groups_in_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec decrease_node_groups_in_global_replication_group_message = {
  1. apply_immediately : boolean_;
    (*

    Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

    *)
  2. global_node_groups_to_retain : global_node_group_id_list option;
    (*

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

    *)
  3. global_node_groups_to_remove : global_node_group_id_list option;
    (*

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.

    *)
  4. node_group_count : integer;
    (*

    The number of node groups (shards) that results from the modification of the shard configuration

    *)
  5. global_replication_group_id : string_;
    (*

    The name of the Global datastore

    *)
}
type nonrec create_user_message = {
  1. authentication_mode : authentication_mode option;
    (*

    Specifies how to authenticate the user.

    *)
  2. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  3. no_password_required : boolean_optional option;
    (*

    Indicates a password is not required for this user.

    *)
  4. access_string : access_string;
    (*

    Access permissions string used for this user.

    *)
  5. passwords : password_list_input option;
    (*

    Passwords used for this user. You can create up to two passwords for each user.

    *)
  6. engine : engine_type;
    (*

    The options are valkey or redis.

    *)
  7. user_name : user_name;
    (*

    The username of the user.

    *)
  8. user_id : user_id;
    (*

    The ID of the user. This value is stored as a lowercase string.

    *)
}
type nonrec create_user_group_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Valkey and Redis OSS only.

    *)
  2. user_ids : user_id_list_input option;
    (*

    The list of user IDs that belong to the user group.

    *)
  3. engine : engine_type;
    (*

    Sets the engine listed in a user group. The options are valkey or redis.

    *)
  4. user_group_id : string_;
    (*

    The ID of the user group. This value is stored as a lowercase string.

    *)
}
type nonrec create_snapshot_result = {
  1. snapshot : snapshot option;
}
type nonrec create_snapshot_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. kms_key_id : string_ option;
    (*

    The ID of the KMS key used to encrypt the snapshot.

    *)
  3. snapshot_name : string_;
    (*

    A name for the snapshot being created. This value is stored as a lowercase string.

    *)
  4. cache_cluster_id : string_ option;
    (*

    The identifier of an existing cluster. The snapshot is created from this cluster.

    *)
  5. replication_group_id : string_ option;
    (*

    The identifier of an existing replication group. The snapshot is created from this replication group.

    *)
}

Represents the input of a CreateSnapshot operation.

type nonrec create_serverless_cache_snapshot_response = {
  1. serverless_cache_snapshot : serverless_cache_snapshot option;
    (*

    The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec create_serverless_cache_snapshot_request = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  2. kms_key_id : string_ option;
    (*

    The ID of the KMS key used to encrypt the snapshot. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

    *)
  3. serverless_cache_name : string_;
    (*

    The name of an existing serverless cache. The snapshot is created from this cache. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  4. serverless_cache_snapshot_name : string_;
    (*

    The name for the snapshot being created. Must be unique for the customer account. Available for Valkey, Redis OSS and Serverless Memcached only. Must be between 1 and 255 characters. This value is stored as a lowercase string.

    *)
}
type nonrec create_serverless_cache_response = {
  1. serverless_cache : serverless_cache option;
    (*

    The response for the attempt to create the serverless cache.

    *)
}
type nonrec create_serverless_cache_request = {
  1. network_type : network_type option;
    (*

    The IP protocol version used by the serverless cache. Must be either ipv4 | ipv6 | dual_stack. ipv6 is only supported with IPv6-only subnets. If not specified, defaults to ipv4, unless all provided subnets are IPv6-only, in which case it defaults to ipv6.

    *)
  2. daily_snapshot_time : string_ option;
    (*

    The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  3. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic snapshots before deleting them. Available for Valkey, Redis OSS and Serverless Memcached only. The maximum value allowed is 35 days.

    *)
  4. subnet_ids : subnet_ids_list option;
    (*

    A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.

    *)
  5. user_group_id : string_ option;
    (*

    The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.

    *)
  6. tags : tag_list option;
    (*

    The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.

    *)
  7. snapshot_arns_to_restore : snapshot_arns_list option;
    (*

    The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  8. security_group_ids : security_group_ids_list option;
    (*

    A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.

    *)
  9. kms_key_id : string_ option;
    (*

    ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.

    *)
  10. cache_usage_limits : cache_usage_limits option;
    (*

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

    *)
  11. major_engine_version : string_ option;
    (*

    The version of the cache engine that will be used to create the serverless cache.

    *)
  12. engine : string_;
    (*

    The name of the cache engine to be used for creating the serverless cache.

    *)
  13. description : string_ option;
    (*

    User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.

    *)
  14. serverless_cache_name : string_;
    (*

    User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.

    *)
}
type nonrec create_replication_group_result = {
  1. replication_group : replication_group option;
}
type nonrec create_replication_group_message = {
  1. durability : durability option;
    (*

    Specifies the durability setting for the replication group. When set to default, the service determines the effective durability based on the engine version, cluster mode, and other parameters. The resolved setting is reflected in the EffectiveDurability property of the replication group. For more information, see Durability.

    *)
  2. serverless_cache_snapshot_name : string_ option;
    (*

    The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.

    *)
  3. cluster_mode : cluster_mode option;
    (*

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    *)
  4. transit_encryption_mode : transit_encryption_mode option;
    (*

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to required to allow encrypted connections only.

    Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.

    This process will not trigger the replacement of the replication group.

    *)
  5. ip_discovery : ip_discovery option;
    (*

    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  6. network_type : network_type option;
    (*

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  7. data_tiering_enabled : boolean_optional option;
    (*

    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

    *)
  8. log_delivery_configurations : log_delivery_configuration_request_list option;
    (*

    Specifies the destination, format and type of the logs.

    *)
  9. user_group_ids : user_group_id_list_input option;
    (*

    The user group to associate with the replication group.

    *)
  10. kms_key_id : string_ option;
    (*

    The ID of the KMS key used to encrypt the disk in the cluster.

    *)
  11. at_rest_encryption_enabled : boolean_optional option;
    (*

    A flag that enables encryption at-rest on the replication group when set to true. In some cases, encryption at-rest may be enabled even when this value is false. Use StorageEncryptionType to view the effective encryption state of a cluster.

    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created.

    Default: true when using Valkey, false when using Redis OSS

    *)
  12. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

    If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

    Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

    Default: false

    For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

    *)
  13. auth_token : string_ option;
    (*

    Reserved parameter. The password used to access a password protected server.

    AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

    For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

    Password constraints:

    • Must be only printable ASCII characters.
    • Must be at least 16 characters and no more than 128 characters in length.
    • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

    *)
  14. snapshot_window : string_ option;
    (*

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    *)
  15. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    Default: 0 (i.e., automatic backups are disabled for this cluster).

    *)
  16. auto_minor_version_upgrade : boolean_optional option;
    (*

     If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  17. notification_topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    The Amazon SNS topic owner must be the same as the cluster owner.

    *)
  18. port : integer_optional option;
    (*

    The port number on which each member of the replication group accepts connections.

    *)
  19. preferred_maintenance_window : string_ option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun
    • mon
    • tue
    • wed
    • thu
    • fri
    • sat

    Example: sun:23:00-mon:01:30

    *)
  20. snapshot_name : string_ option;
    (*

    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

    *)
  21. snapshot_arns : snapshot_arns_list option;
    (*

    A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

    Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    *)
  22. tags : tag_list option;
    (*

    A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.

    *)
  23. security_group_ids : security_group_ids_list option;
    (*

    One or more Amazon VPC security groups associated with this replication group.

    Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

    *)
  24. cache_security_group_names : cache_security_group_name_list option;
    (*

    A list of cache security group names to associate with this replication group.

    *)
  25. cache_subnet_group_name : string_ option;
    (*

    The name of the cache subnet group to be used for the replication group.

    If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

    *)
  26. cache_parameter_group_name : string_ option;
    (*

    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

    If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

    • To create a Valkey or Redis OSS (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
    • To create a Valkey or Redis OSS (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
    *)
  27. engine_version : string_ option;
    (*

    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    *)
  28. engine : string_ option;
    (*

    The name of the cache engine to be used for the clusters in this replication group. The value must be set to valkey or redis.

    *)
  29. cache_node_type : string_ option;
    (*

    The compute and memory capacity of the nodes in the node group (shard).

    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.
    *)
  30. node_group_configuration : node_group_configuration_list option;
    (*

    A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

    If you're creating a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Valkey or Redis OSS (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

    *)
  31. replicas_per_node_group : integer_optional option;
    (*

    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

    *)
  32. num_node_groups : integer_optional option;
    (*

    An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.

    Default: 1

    *)
  33. preferred_cache_cluster_a_zs : availability_zones_list option;
    (*

    A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

    This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

    If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of NumCacheClusters.

    Default: system chosen Availability Zones.

    *)
  34. num_cache_clusters : integer_optional option;
    (*

    The number of clusters this replication group initially has.

    This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

    If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

    The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

    *)
  35. multi_az_enabled : boolean_optional option;
    (*

    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

    *)
  36. automatic_failover_enabled : boolean_optional option;
    (*

    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

    AutomaticFailoverEnabled must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.

    Default: false

    *)
  37. primary_cluster_id : string_ option;
    (*

    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

    This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

    *)
  38. global_replication_group_id : string_ option;
    (*

    The name of the Global datastore

    *)
  39. replication_group_description : string_;
    (*

    A user-created description for the replication group.

    *)
  40. replication_group_id : string_;
    (*

    The replication group identifier. This parameter is stored as a lowercase string.

    Constraints:

    • A name must contain from 1 to 40 alphanumeric characters or hyphens.
    • The first character must be a letter.
    • A name cannot end with a hyphen or contain two consecutive hyphens.
    *)
}

Represents the input of a CreateReplicationGroup operation.

type nonrec create_global_replication_group_result = {
  1. global_replication_group : global_replication_group option;
}
type nonrec create_global_replication_group_message = {
  1. primary_replication_group_id : string_;
    (*

    The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster. This value is stored as a lowercase string.

    *)
  2. global_replication_group_description : string_ option;
    (*

    Provides details of the Global datastore

    *)
  3. global_replication_group_id_suffix : string_;
    (*

    The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.

    For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores.

    *)
}
type nonrec create_cache_subnet_group_result = {
  1. cache_subnet_group : cache_subnet_group option;
}
type nonrec create_cache_subnet_group_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. subnet_ids : subnet_identifier_list;
    (*

    A list of VPC subnet IDs for the cache subnet group.

    *)
  3. cache_subnet_group_description : string_;
    (*

    A description for the cache subnet group.

    *)
  4. cache_subnet_group_name : string_;
    (*

    A name for the cache subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    Example: mysubnetgroup

    *)
}

Represents the input of a CreateCacheSubnetGroup operation.

type nonrec cache_subnet_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_subnet_group_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec create_cache_security_group_result = {
  1. cache_security_group : cache_security_group option;
}
type nonrec create_cache_security_group_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. description : string_;
    (*

    A description for the cache security group.

    *)
  3. cache_security_group_name : string_;
    (*

    A name for the cache security group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".

    Example: mysecuritygroup

    *)
}

Represents the input of a CreateCacheSecurityGroup operation.

type nonrec cache_security_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_security_group_already_exists_fault = {
  1. message : exception_message option;
}

A cache security group with the specified name already exists.

type nonrec create_cache_parameter_group_result = {
  1. cache_parameter_group : cache_parameter_group option;
}
type nonrec create_cache_parameter_group_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. description : string_;
    (*

    A user-specified description for the cache parameter group.

    *)
  3. cache_parameter_group_family : string_;
    (*

    The name of the cache parameter group family that the cache parameter group can be used with.

    Valid values are: valkey8 | valkey7 | memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7

    *)
  4. cache_parameter_group_name : string_;
    (*

    A user-specified name for the cache parameter group. This value is stored as a lowercase string.

    *)
}

Represents the input of a CreateCacheParameterGroup operation.

type nonrec cache_parameter_group_quota_exceeded_fault = {
  1. message : exception_message option;
}

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

type nonrec cache_parameter_group_already_exists_fault = {
  1. message : exception_message option;
}

A cache parameter group with the requested name already exists.

type nonrec create_cache_cluster_result = {
  1. cache_cluster : cache_cluster option;
}
type nonrec create_cache_cluster_message = {
  1. ip_discovery : ip_discovery option;
    (*

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  2. network_type : network_type option;
    (*

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    *)
  3. transit_encryption_enabled : boolean_optional option;
    (*

    A flag that enables in-transit encryption when set to true.

    *)
  4. log_delivery_configurations : log_delivery_configuration_request_list option;
    (*

    Specifies the destination, format and type of the logs.

    *)
  5. preferred_outpost_arns : preferred_outpost_arn_list option;
    (*

    The outpost ARNs in which the cache cluster is created.

    *)
  6. preferred_outpost_arn : string_ option;
    (*

    The outpost ARN in which the cache cluster is created.

    *)
  7. outpost_mode : outpost_mode option;
    (*

    Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

    *)
  8. auth_token : string_ option;
    (*

    Reserved parameter. The password used to access a password protected server.

    Password constraints:

    • Must be only printable ASCII characters.
    • Must be at least 16 characters and no more than 128 characters in length.
    • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

    *)
  9. snapshot_window : string_ option;
    (*

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    This parameter is only valid if the Engine parameter is redis.

    *)
  10. snapshot_retention_limit : integer_optional option;
    (*

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

    This parameter is only valid if the Engine parameter is redis.

    Default: 0 (i.e., automatic backups are disabled for this cache cluster).

    *)
  11. auto_minor_version_upgrade : boolean_optional option;
    (*

     If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    *)
  12. notification_topic_arn : string_ option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    The Amazon SNS topic owner must be the same as the cluster owner.

    *)
  13. port : integer_optional option;
    (*

    The port number on which each of the cache nodes accepts connections.

    *)
  14. preferred_maintenance_window : string_ option;
    (*

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    *)
  15. snapshot_name : string_ option;
    (*

    The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

    This parameter is only valid if the Engine parameter is redis.

    *)
  16. snapshot_arns : snapshot_arns_list option;
    (*

    A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

    This parameter is only valid if the Engine parameter is redis.

    Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    *)
  17. tags : tag_list option;
    (*

    A list of tags to be added to this resource.

    *)
  18. security_group_ids : security_group_ids_list option;
    (*

    One or more VPC security groups associated with the cluster.

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

    *)
  19. cache_security_group_names : cache_security_group_name_list option;
    (*

    A list of security group names to associate with this cluster.

    Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

    *)
  20. cache_subnet_group_name : string_ option;
    (*

    The name of the subnet group to be used for the cluster.

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

    If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

    *)
  21. cache_parameter_group_name : string_ option;
    (*

    The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

    *)
  22. engine_version : string_ option;
    (*

    The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    *)
  23. engine : string_ option;
    (*

    The name of the cache engine to be used for this cluster.

    Valid values for this parameter are: memcached | redis

    *)
  24. cache_node_type : string_ option;
    (*

    The compute and memory capacity of the nodes in the node group (shard).

    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.
    *)
  25. num_cache_nodes : integer_optional option;
    (*

    The initial number of cache nodes that the cluster has.

    For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

    *)
  26. preferred_availability_zones : preferred_availability_zone_list option;
    (*

    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

    This option is only supported on Memcached.

    If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of NumCacheNodes.

    If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

    Default: System chosen Availability Zones.

    *)
  27. preferred_availability_zone : string_ option;
    (*

    The EC2 Availability Zone in which the cluster is created.

    All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

    Default: System chosen Availability Zone.

    *)
  28. az_mode : az_mode option;
    (*

    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

    This parameter is only supported for Memcached clusters.

    If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

    *)
  29. replication_group_id : string_ option;
    (*

    The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

    If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

    This parameter is only valid if the Engine parameter is redis.

    *)
  30. cache_cluster_id : string_;
    (*

    The node group (shard) identifier. This parameter is stored as a lowercase string.

    Constraints:

    • A name must contain from 1 to 50 alphanumeric characters or hyphens.
    • The first character must be a letter.
    • A name cannot end with a hyphen or contain two consecutive hyphens.
    *)
}

Represents the input of a CreateCacheCluster operation.

type nonrec cache_cluster_already_exists_fault = {
  1. message : exception_message option;
}

You already have a cluster with the given identifier.

type nonrec copy_snapshot_result = {
  1. snapshot : snapshot option;
}
type nonrec copy_snapshot_message = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. kms_key_id : string_ option;
    (*

    The ID of the KMS key used to encrypt the target snapshot.

    *)
  3. target_bucket : string_ option;
    (*

    The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

    When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

    For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

    *)
  4. target_snapshot_name : string_;
    (*

    A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting. This value is stored as a lowercase string.

    *)
  5. source_snapshot_name : string_;
    (*

    The name of an existing snapshot from which to make a copy.

    *)
}

Represents the input of a CopySnapshotMessage operation.

type nonrec copy_serverless_cache_snapshot_response = {
  1. serverless_cache_snapshot : serverless_cache_snapshot option;
    (*

    The response for the attempt to copy the serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec copy_serverless_cache_snapshot_request = {
  1. tags : tag_list option;
    (*

    A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Valkey, Redis OSS and Serverless Memcached only. Default: NULL

    *)
  2. kms_key_id : string_ option;
    (*

    The identifier of the KMS key used to encrypt the target snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
  3. target_serverless_cache_snapshot_name : string_;
    (*

    The identifier for the snapshot to be created. Available for Valkey, Redis OSS and Serverless Memcached only. This value is stored as a lowercase string.

    *)
  4. source_serverless_cache_snapshot_name : string_;
    (*

    The identifier of the existing serverless cache’s snapshot to be copied. Available for Valkey, Redis OSS and Serverless Memcached only.

    *)
}
type nonrec complete_migration_response = {
  1. replication_group : replication_group option;
}
type nonrec complete_migration_message = {
  1. force : boolean_ option;
    (*

    Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

    *)
  2. replication_group_id : string_;
    (*

    The ID of the replication group to which data is being migrated.

    *)
}
type nonrec batch_stop_update_action_message = {
  1. service_update_name : string_;
    (*

    The unique ID of the service update

    *)
  2. cache_cluster_ids : cache_cluster_id_list option;
    (*

    The cache cluster IDs

    *)
  3. replication_group_ids : replication_group_id_list option;
    (*

    The replication group IDs

    *)
}
type nonrec batch_apply_update_action_message = {
  1. service_update_name : string_;
    (*

    The unique ID of the service update

    *)
  2. cache_cluster_ids : cache_cluster_id_list option;
    (*

    The cache cluster IDs

    *)
  3. replication_group_ids : replication_group_id_list option;
    (*

    The replication group IDs

    *)
}
type nonrec authorize_cache_security_group_ingress_result = {
  1. cache_security_group : cache_security_group option;
}
type nonrec authorize_cache_security_group_ingress_message = {
  1. ec2_security_group_owner_id : string_;
    (*

    The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

    *)
  2. ec2_security_group_name : string_;
    (*

    The Amazon EC2 security group to be authorized for ingress to the cache security group.

    *)
  3. cache_security_group_name : string_;
    (*

    The cache security group that allows network ingress.

    *)
}

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

type nonrec authorization_already_exists_fault = {
  1. message : exception_message option;
}

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

type nonrec add_tags_to_resource_message = {
  1. tags : tag_list;
    (*

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    *)
  2. resource_name : string_;
    (*

    The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

    For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

    *)
}

Represents the input of an AddTagsToResource operation.