2026/06/02 - Amazon ElastiCache - 19 updated api methods
Changes Amazon ElastiCache for Valkey now supports durability. This new capability is enabled through a Multi-AZ transactional log, enabling fast recovery and restart during failures.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Complete the migration of data.
See also: AWS API Documentation
Request Syntax
client.complete_migration(
ReplicationGroupId='string',
Force=True|False
)
string
[REQUIRED]
The ID of the replication group to which data is being migrated.
boolean
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.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'Snapshot': {'Durability': 'default | async | sync | disabled'}}
Makes a copy of an existing snapshot.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
See also: AWS API Documentation
Request Syntax
client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string',
TargetBucket='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of an existing snapshot from which to make a copy.
string
[REQUIRED]
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.
string
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.
string
The ID of the KMS key used to encrypt the target snapshot.
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.
(dict) --
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.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
],
'KmsKeyId': 'string',
'ARN': 'string',
'DataTiering': 'enabled'|'disabled',
'Durability': 'default'|'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
ReplicationGroupId (string) --
The unique identifier of the source replication group.
ReplicationGroupDescription (string) --
A description of the source replication group.
CacheClusterId (string) --
The user-supplied identifier of the source cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated) or was created manually ( manual).
CacheNodeType (string) --
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
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
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.
Engine (string) --
The name of the cache engine ( memcached or redis) used by the source cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cluster.
NumCacheNodes (integer) --
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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cluster is located.
PreferredOutpostArn (string) --
The ARN (Amazon Resource Name) of the preferred outpost.
CacheClusterCreateTime (datetime) --
The date and time when the source cluster was created.
PreferredMaintenanceWindow (string) --
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
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
AutoMinorVersionUpgrade (boolean) --
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.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
NumNodeGroups (integer) --
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.
AutomaticFailover (string) --
Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
NodeSnapshots (list) --
A list of the cache nodes in the source cluster.
(dict) --
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId (string) --
A unique identifier for the source cluster.
NodeGroupId (string) --
A unique identifier for the source node group (shard).
CacheNodeId (string) --
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration (dict) --
The configuration for the source node group (shard).
NodeGroupId (string) --
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
Slots (string) --
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"
ReplicaCount (integer) --
The number of read replica nodes in this node group (shard).
PrimaryAvailabilityZone (string) --
The Availability Zone where the primary node of this node group (shard) is launched.
ReplicaAvailabilityZones (list) --
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.
(string) --
PrimaryOutpostArn (string) --
The outpost ARN of the primary node.
ReplicaOutpostArns (list) --
The outpost ARN of the node replicas.
(string) --
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
DataTiering (string) --
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.
Durability (string) --
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.
{'Durability': 'default | async | sync | disabled'}
Response {'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Creates a Valkey or Redis OSS (cluster mode disabled) or a Valkey or Redis OSS (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Valkey or Redis OSS (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Valkey or Redis OSS cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Valkey or Redis OSS engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Valkey or Redis OSS (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can use scaling. For more information, see Scaling self-designed clusters in the ElastiCache User Guide.
See also: AWS API Documentation
Request Syntax
client.create_replication_group(
ReplicationGroupId='string',
ReplicationGroupDescription='string',
GlobalReplicationGroupId='string',
PrimaryClusterId='string',
AutomaticFailoverEnabled=True|False,
MultiAZEnabled=True|False,
NumCacheClusters=123,
PreferredCacheClusterAZs=[
'string',
],
NumNodeGroups=123,
ReplicasPerNodeGroup=123,
NodeGroupConfiguration=[
{
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
],
CacheNodeType='string',
Engine='string',
EngineVersion='string',
CacheParameterGroupName='string',
CacheSubnetGroupName='string',
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SnapshotArns=[
'string',
],
SnapshotName='string',
PreferredMaintenanceWindow='string',
Port=123,
NotificationTopicArn='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
AuthToken='string',
TransitEncryptionEnabled=True|False,
AtRestEncryptionEnabled=True|False,
KmsKeyId='string',
UserGroupIds=[
'string',
],
LogDeliveryConfigurations=[
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Enabled': True|False
},
],
DataTieringEnabled=True|False,
NetworkType='ipv4'|'ipv6'|'dual_stack',
IpDiscovery='ipv4'|'ipv6',
TransitEncryptionMode='preferred'|'required',
ClusterMode='enabled'|'disabled'|'compatible',
ServerlessCacheSnapshotName='string',
Durability='default'|'async'|'sync'|'disabled'
)
string
[REQUIRED]
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.
string
[REQUIRED]
A user-created description for the replication group.
string
The name of the Global datastore
string
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.
boolean
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
boolean
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
integer
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).
list
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.
Default: system chosen Availability Zones.
(string) --
integer
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
integer
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
list
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.
(dict) --
Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
NodeGroupId (string) --
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
Slots (string) --
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"
ReplicaCount (integer) --
The number of read replica nodes in this node group (shard).
PrimaryAvailabilityZone (string) --
The Availability Zone where the primary node of this node group (shard) is launched.
ReplicaAvailabilityZones (list) --
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.
(string) --
PrimaryOutpostArn (string) --
The outpost ARN of the primary node.
ReplicaOutpostArns (list) --
The outpost ARN of the node replicas.
(string) --
string
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
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
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.
string
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.
string
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.
string
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.
string
The name of the cache subnet group to be used for the replication group.
list
A list of cache security group names to associate with this replication group.
(string) --
list
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).
(string) --
list
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.
(dict) --
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.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
list
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
(string) --
string
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.
string
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
integer
The port number on which each member of the replication group accepts connections.
string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
boolean
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.
integer
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).
string
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.
string
Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.
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.
boolean
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
boolean
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
string
The ID of the KMS key used to encrypt the disk in the cluster.
list
The user group to associate with the replication group.
(string) --
list
Specifies the destination, format and type of the logs.
(dict) --
Specifies the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Specify either cloudwatch-logs or kinesis-firehose as the destination type.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Specifies either JSON or TEXT
Enabled (boolean) --
Specify if log delivery is enabled. Default true.
boolean
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.
string
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.
string
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.
string
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.
string
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.
string
The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.
string
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.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ServerlessCache': {'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Creates a serverless cache.
See also: AWS API Documentation
Request Syntax
client.create_serverless_cache(
ServerlessCacheName='string',
Description='string',
Engine='string',
MajorEngineVersion='string',
CacheUsageLimits={
'DataStorage': {
'Maximum': 123,
'Minimum': 123,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123,
'Minimum': 123
}
},
KmsKeyId='string',
SecurityGroupIds=[
'string',
],
SnapshotArnsToRestore=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
UserGroupId='string',
SubnetIds=[
'string',
],
SnapshotRetentionLimit=123,
DailySnapshotTime='string',
NetworkType='ipv4'|'ipv6'|'dual_stack'
)
string
[REQUIRED]
User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
string
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.
string
[REQUIRED]
The name of the cache engine to be used for creating the serverless cache.
string
The version of the cache engine that will be used to create the serverless cache.
dict
Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
DataStorage (dict) --
The maximum data storage limit in the cache, expressed in Gigabytes.
Maximum (integer) --
The upper limit for data storage the cache is set to use.
Minimum (integer) --
The lower limit for data storage the cache is set to use.
Unit (string) -- [REQUIRED]
The unit that the storage is measured in, in GB.
ECPUPerSecond (dict) --
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Maximum (integer) --
The configuration for the maximum number of ECPUs the cache can consume per second.
Minimum (integer) --
The configuration for the minimum number of ECPUs the cache should be able consume per second.
string
ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
list
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.
(string) --
list
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Valkey, Redis OSS and Serverless Memcached only.
(string) --
list
The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
(dict) --
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.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
string
The identifier of the UserGroup to be associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
list
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.
(string) --
integer
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.
string
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.
string
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.
dict
Response Syntax
{
'ServerlessCache': {
'ServerlessCacheName': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string',
'FullEngineVersion': 'string',
'CacheUsageLimits': {
'DataStorage': {
'Maximum': 123,
'Minimum': 123,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123,
'Minimum': 123
}
},
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': 'string',
'NetworkType': 'ipv4'|'ipv6'|'dual_stack'
}
}
Response Structure
(dict) --
ServerlessCache (dict) --
The response for the attempt to create the serverless cache.
ServerlessCacheName (string) --
The unique identifier of the serverless cache.
Description (string) --
A description of the serverless cache.
CreateTime (datetime) --
When the serverless cache was created.
Status (string) --
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
Engine (string) --
The engine the serverless cache is compatible with.
MajorEngineVersion (string) --
The version number of the engine the serverless cache is compatible with.
FullEngineVersion (string) --
The name and version number of the engine the serverless cache is compatible with.
CacheUsageLimits (dict) --
The cache usage limit for the serverless cache.
DataStorage (dict) --
The maximum data storage limit in the cache, expressed in Gigabytes.
Maximum (integer) --
The upper limit for data storage the cache is set to use.
Minimum (integer) --
The lower limit for data storage the cache is set to use.
Unit (string) --
The unit that the storage is measured in, in GB.
ECPUPerSecond (dict) --
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Maximum (integer) --
The configuration for the maximum number of ECPUs the cache can consume per second.
Minimum (integer) --
The configuration for the minimum number of ECPUs the cache should be able consume per second.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
StorageEncryptionType (string) --
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.
SecurityGroupIds (list) --
The IDs of the EC2 security groups associated with the serverless cache.
(string) --
Endpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ARN (string) --
The Amazon Resource Name (ARN) of the serverless cache.
UserGroupId (string) --
The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
SubnetIds (list) --
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.
(string) --
SnapshotRetentionLimit (integer) --
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.
DailySnapshotTime (string) --
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.
NetworkType (string) --
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.
{'Snapshot': {'Durability': 'default | async | sync | disabled'}}
Creates a copy of an entire cluster or replication group at a specific moment in time.
See also: AWS API Documentation
Request Syntax
client.create_snapshot(
ReplicationGroupId='string',
CacheClusterId='string',
SnapshotName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
The identifier of an existing replication group. The snapshot is created from this replication group.
string
The identifier of an existing cluster. The snapshot is created from this cluster.
string
[REQUIRED]
A name for the snapshot being created. This value is stored as a lowercase string.
string
The ID of the KMS key used to encrypt the snapshot.
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.
(dict) --
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.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
],
'KmsKeyId': 'string',
'ARN': 'string',
'DataTiering': 'enabled'|'disabled',
'Durability': 'default'|'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
ReplicationGroupId (string) --
The unique identifier of the source replication group.
ReplicationGroupDescription (string) --
A description of the source replication group.
CacheClusterId (string) --
The user-supplied identifier of the source cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated) or was created manually ( manual).
CacheNodeType (string) --
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
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
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.
Engine (string) --
The name of the cache engine ( memcached or redis) used by the source cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cluster.
NumCacheNodes (integer) --
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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cluster is located.
PreferredOutpostArn (string) --
The ARN (Amazon Resource Name) of the preferred outpost.
CacheClusterCreateTime (datetime) --
The date and time when the source cluster was created.
PreferredMaintenanceWindow (string) --
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
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
AutoMinorVersionUpgrade (boolean) --
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.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
NumNodeGroups (integer) --
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.
AutomaticFailover (string) --
Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
NodeSnapshots (list) --
A list of the cache nodes in the source cluster.
(dict) --
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId (string) --
A unique identifier for the source cluster.
NodeGroupId (string) --
A unique identifier for the source node group (shard).
CacheNodeId (string) --
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration (dict) --
The configuration for the source node group (shard).
NodeGroupId (string) --
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
Slots (string) --
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"
ReplicaCount (integer) --
The number of read replica nodes in this node group (shard).
PrimaryAvailabilityZone (string) --
The Availability Zone where the primary node of this node group (shard) is launched.
ReplicaAvailabilityZones (list) --
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.
(string) --
PrimaryOutpostArn (string) --
The outpost ARN of the primary node.
ReplicaOutpostArns (list) --
The outpost ARN of the node replicas.
(string) --
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
DataTiering (string) --
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.
Durability (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Dynamically decreases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
See also: AWS API Documentation
Request Syntax
client.decrease_replica_count(
ReplicationGroupId='string',
NewReplicaCount=123,
ReplicaConfiguration=[
{
'NodeGroupId': 'string',
'NewReplicaCount': 123,
'PreferredAvailabilityZones': [
'string',
],
'PreferredOutpostArns': [
'string',
]
},
],
ReplicasToRemove=[
'string',
],
ApplyImmediately=True|False
)
string
[REQUIRED]
The id of the replication group from which you want to remove replica nodes.
integer
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)
list
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.
(dict) --
Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
NodeGroupId (string) -- [REQUIRED]
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.
NewReplicaCount (integer) -- [REQUIRED]
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)
PreferredAvailabilityZones (list) --
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.
(string) --
PreferredOutpostArns (list) --
The outpost ARNs in which the cache cluster is created.
(string) --
list
A list of the node ids to remove from the replication group or node group (shard).
(string) --
boolean
[REQUIRED]
If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
See also: AWS API Documentation
Request Syntax
client.delete_replication_group(
ReplicationGroupId='string',
RetainPrimaryCluster=True|False,
FinalSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier for the cluster to be deleted. This parameter is not case sensitive.
boolean
If set to true, all of the read replicas are deleted, but the primary node is retained.
string
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.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ServerlessCache': {'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Deletes a specified existing serverless cache.
See also: AWS API Documentation
Request Syntax
client.delete_serverless_cache(
ServerlessCacheName='string',
FinalSnapshotName='string'
)
string
[REQUIRED]
The identifier of the serverless cache to be deleted.
string
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.
dict
Response Syntax
{
'ServerlessCache': {
'ServerlessCacheName': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string',
'FullEngineVersion': 'string',
'CacheUsageLimits': {
'DataStorage': {
'Maximum': 123,
'Minimum': 123,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123,
'Minimum': 123
}
},
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': 'string',
'NetworkType': 'ipv4'|'ipv6'|'dual_stack'
}
}
Response Structure
(dict) --
ServerlessCache (dict) --
Provides the details of the specified serverless cache that is about to be deleted.
ServerlessCacheName (string) --
The unique identifier of the serverless cache.
Description (string) --
A description of the serverless cache.
CreateTime (datetime) --
When the serverless cache was created.
Status (string) --
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
Engine (string) --
The engine the serverless cache is compatible with.
MajorEngineVersion (string) --
The version number of the engine the serverless cache is compatible with.
FullEngineVersion (string) --
The name and version number of the engine the serverless cache is compatible with.
CacheUsageLimits (dict) --
The cache usage limit for the serverless cache.
DataStorage (dict) --
The maximum data storage limit in the cache, expressed in Gigabytes.
Maximum (integer) --
The upper limit for data storage the cache is set to use.
Minimum (integer) --
The lower limit for data storage the cache is set to use.
Unit (string) --
The unit that the storage is measured in, in GB.
ECPUPerSecond (dict) --
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Maximum (integer) --
The configuration for the maximum number of ECPUs the cache can consume per second.
Minimum (integer) --
The configuration for the minimum number of ECPUs the cache should be able consume per second.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
StorageEncryptionType (string) --
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.
SecurityGroupIds (list) --
The IDs of the EC2 security groups associated with the serverless cache.
(string) --
Endpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ARN (string) --
The Amazon Resource Name (ARN) of the serverless cache.
UserGroupId (string) --
The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
SubnetIds (list) --
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.
(string) --
SnapshotRetentionLimit (integer) --
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.
DailySnapshotTime (string) --
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.
NetworkType (string) --
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.
{'Snapshot': {'Durability': 'default | async | sync | disabled'}}
Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
See also: AWS API Documentation
Request Syntax
client.delete_snapshot(
SnapshotName='string'
)
string
[REQUIRED]
The name of the snapshot to be deleted.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
],
'KmsKeyId': 'string',
'ARN': 'string',
'DataTiering': 'enabled'|'disabled',
'Durability': 'default'|'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
ReplicationGroupId (string) --
The unique identifier of the source replication group.
ReplicationGroupDescription (string) --
A description of the source replication group.
CacheClusterId (string) --
The user-supplied identifier of the source cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated) or was created manually ( manual).
CacheNodeType (string) --
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
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
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.
Engine (string) --
The name of the cache engine ( memcached or redis) used by the source cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cluster.
NumCacheNodes (integer) --
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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cluster is located.
PreferredOutpostArn (string) --
The ARN (Amazon Resource Name) of the preferred outpost.
CacheClusterCreateTime (datetime) --
The date and time when the source cluster was created.
PreferredMaintenanceWindow (string) --
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
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
AutoMinorVersionUpgrade (boolean) --
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.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
NumNodeGroups (integer) --
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.
AutomaticFailover (string) --
Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
NodeSnapshots (list) --
A list of the cache nodes in the source cluster.
(dict) --
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId (string) --
A unique identifier for the source cluster.
NodeGroupId (string) --
A unique identifier for the source node group (shard).
CacheNodeId (string) --
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration (dict) --
The configuration for the source node group (shard).
NodeGroupId (string) --
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
Slots (string) --
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"
ReplicaCount (integer) --
The number of read replica nodes in this node group (shard).
PrimaryAvailabilityZone (string) --
The Availability Zone where the primary node of this node group (shard) is launched.
ReplicaAvailabilityZones (list) --
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.
(string) --
PrimaryOutpostArn (string) --
The outpost ARN of the primary node.
ReplicaOutpostArns (list) --
The outpost ARN of the node replicas.
(string) --
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
DataTiering (string) --
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.
Durability (string) --
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.
{'ReplicationGroups': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
See also: AWS API Documentation
Request Syntax
client.describe_replication_groups(
ReplicationGroupId='string',
MaxRecords=123,
Marker='string'
)
string
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.
integer
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.
string
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.
dict
Response Syntax
{
'Marker': 'string',
'ReplicationGroups': [
{
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeReplicationGroups operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
ReplicationGroups (list) --
A list of replication groups. Each item in the list contains detailed information about one replication group.
(dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ServerlessCaches': {'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.describe_serverless_caches(
ServerlessCacheName='string',
MaxResults=123,
NextToken='string'
)
string
The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL
integer
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.
string
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.
dict
Response Syntax
{
'NextToken': 'string',
'ServerlessCaches': [
{
'ServerlessCacheName': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string',
'FullEngineVersion': 'string',
'CacheUsageLimits': {
'DataStorage': {
'Maximum': 123,
'Minimum': 123,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123,
'Minimum': 123
}
},
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': 'string',
'NetworkType': 'ipv4'|'ipv6'|'dual_stack'
},
]
}
Response Structure
(dict) --
NextToken (string) --
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.
ServerlessCaches (list) --
The serverless caches associated with a given description request.
(dict) --
The resource representing a serverless cache.
ServerlessCacheName (string) --
The unique identifier of the serverless cache.
Description (string) --
A description of the serverless cache.
CreateTime (datetime) --
When the serverless cache was created.
Status (string) --
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
Engine (string) --
The engine the serverless cache is compatible with.
MajorEngineVersion (string) --
The version number of the engine the serverless cache is compatible with.
FullEngineVersion (string) --
The name and version number of the engine the serverless cache is compatible with.
CacheUsageLimits (dict) --
The cache usage limit for the serverless cache.
DataStorage (dict) --
The maximum data storage limit in the cache, expressed in Gigabytes.
Maximum (integer) --
The upper limit for data storage the cache is set to use.
Minimum (integer) --
The lower limit for data storage the cache is set to use.
Unit (string) --
The unit that the storage is measured in, in GB.
ECPUPerSecond (dict) --
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Maximum (integer) --
The configuration for the maximum number of ECPUs the cache can consume per second.
Minimum (integer) --
The configuration for the minimum number of ECPUs the cache should be able consume per second.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
StorageEncryptionType (string) --
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.
SecurityGroupIds (list) --
The IDs of the EC2 security groups associated with the serverless cache.
(string) --
Endpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ARN (string) --
The Amazon Resource Name (ARN) of the serverless cache.
UserGroupId (string) --
The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
SubnetIds (list) --
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.
(string) --
SnapshotRetentionLimit (integer) --
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.
DailySnapshotTime (string) --
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.
NetworkType (string) --
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.
{'Snapshots': {'Durability': 'default | async | sync | disabled'}}
Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
See also: AWS API Documentation
Request Syntax
client.describe_snapshots(
ReplicationGroupId='string',
CacheClusterId='string',
SnapshotName='string',
SnapshotSource='string',
Marker='string',
MaxRecords=123,
ShowNodeGroupConfig=True|False
)
string
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
string
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
string
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
string
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.
string
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.
integer
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.
boolean
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
dict
Response Syntax
{
'Marker': 'string',
'Snapshots': [
{
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
],
'KmsKeyId': 'string',
'ARN': 'string',
'DataTiering': 'enabled'|'disabled',
'Durability': 'default'|'async'|'sync'|'disabled'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeSnapshots operation.
Marker (string) --
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.
Snapshots (list) --
A list of snapshots. Each item in the list contains detailed information about one snapshot.
(dict) --
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
ReplicationGroupId (string) --
The unique identifier of the source replication group.
ReplicationGroupDescription (string) --
A description of the source replication group.
CacheClusterId (string) --
The user-supplied identifier of the source cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated) or was created manually ( manual).
CacheNodeType (string) --
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
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
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.
Engine (string) --
The name of the cache engine ( memcached or redis) used by the source cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cluster.
NumCacheNodes (integer) --
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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cluster is located.
PreferredOutpostArn (string) --
The ARN (Amazon Resource Name) of the preferred outpost.
CacheClusterCreateTime (datetime) --
The date and time when the source cluster was created.
PreferredMaintenanceWindow (string) --
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
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
AutoMinorVersionUpgrade (boolean) --
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.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
NumNodeGroups (integer) --
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.
AutomaticFailover (string) --
Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.
NodeSnapshots (list) --
A list of the cache nodes in the source cluster.
(dict) --
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId (string) --
A unique identifier for the source cluster.
NodeGroupId (string) --
A unique identifier for the source node group (shard).
CacheNodeId (string) --
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration (dict) --
The configuration for the source node group (shard).
NodeGroupId (string) --
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
Slots (string) --
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"
ReplicaCount (integer) --
The number of read replica nodes in this node group (shard).
PrimaryAvailabilityZone (string) --
The Availability Zone where the primary node of this node group (shard) is launched.
ReplicaAvailabilityZones (list) --
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.
(string) --
PrimaryOutpostArn (string) --
The outpost ARN of the primary node.
ReplicaOutpostArns (list) --
The outpost ARN of the node replicas.
(string) --
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
DataTiering (string) --
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.
Durability (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Dynamically increases the number of replicas in a Valkey or Redis OSS (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Valkey or Redis OSS (cluster mode enabled) replication group. This operation is performed with no cluster down time.
See also: AWS API Documentation
Request Syntax
client.increase_replica_count(
ReplicationGroupId='string',
NewReplicaCount=123,
ReplicaConfiguration=[
{
'NodeGroupId': 'string',
'NewReplicaCount': 123,
'PreferredAvailabilityZones': [
'string',
],
'PreferredOutpostArns': [
'string',
]
},
],
ApplyImmediately=True|False
)
string
[REQUIRED]
The id of the replication group to which you want to add replica nodes.
integer
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.
list
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.
(dict) --
Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
NodeGroupId (string) -- [REQUIRED]
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.
NewReplicaCount (integer) -- [REQUIRED]
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)
PreferredAvailabilityZones (list) --
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.
(string) --
PreferredOutpostArns (list) --
The outpost ARNs in which the cache cluster is created.
(string) --
boolean
[REQUIRED]
If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'Durability': 'default | async | sync | disabled'}
Response {'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.
Scaling for Valkey or Redis OSS (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
See also: AWS API Documentation
Request Syntax
client.modify_replication_group(
ReplicationGroupId='string',
ReplicationGroupDescription='string',
PrimaryClusterId='string',
SnapshottingClusterId='string',
AutomaticFailoverEnabled=True|False,
MultiAZEnabled=True|False,
NodeGroupId='string',
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
Engine='string',
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
CacheNodeType='string',
AuthToken='string',
AuthTokenUpdateStrategy='SET'|'ROTATE'|'DELETE',
UserGroupIdsToAdd=[
'string',
],
UserGroupIdsToRemove=[
'string',
],
RemoveUserGroups=True|False,
LogDeliveryConfigurations=[
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Enabled': True|False
},
],
IpDiscovery='ipv4'|'ipv6',
TransitEncryptionEnabled=True|False,
TransitEncryptionMode='preferred'|'required',
ClusterMode='enabled'|'disabled'|'compatible',
Durability='default'|'async'|'sync'|'disabled'
)
string
[REQUIRED]
The identifier of the replication group to modify.
string
A description for the replication group. Maximum length is 255 characters.
string
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.
string
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.
boolean
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
boolean
A flag to indicate MultiAZ is enabled.
string
Deprecated. This parameter is not used.
list
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.
(string) --
list
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).
(string) --
string
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
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
string
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.
string
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
boolean
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
string
Modifies the engine listed in a replication group message. The options are valkey, memcached or redis.
string
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.
boolean
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.
integer
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.
string
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.
string
A valid cache node type that you want to scale this replication group to.
string
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.
string
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
list
The ID of the user group you are associating with the replication group.
(string) --
list
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.
(string) --
boolean
Removes the user group associated with this replication group.
list
Specifies the destination, format and type of the logs.
(dict) --
Specifies the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Specify either cloudwatch-logs or kinesis-firehose as the destination type.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Specifies either JSON or TEXT
Enabled (boolean) --
Specify if log delivery is enabled. Default true.
string
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.
boolean
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.
string
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.
string
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.
string
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.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
See also: AWS API Documentation
Request Syntax
client.modify_replication_group_shard_configuration(
ReplicationGroupId='string',
NodeGroupCount=123,
ApplyImmediately=True|False,
ReshardingConfiguration=[
{
'NodeGroupId': 'string',
'PreferredAvailabilityZones': [
'string',
]
},
],
NodeGroupsToRemove=[
'string',
],
NodeGroupsToRetain=[
'string',
]
)
string
[REQUIRED]
The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
integer
[REQUIRED]
The number of node groups (shards) that results from the modification of the shard configuration.
boolean
[REQUIRED]
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
Value: true
list
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).
(dict) --
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
NodeGroupId (string) --
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
PreferredAvailabilityZones (list) --
A list of preferred availability zones for the nodes in this cluster.
(string) --
list
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 ``NodeGroupId``s to remove from the cluster.
ElastiCache will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
(string) --
list
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 ``NodeGroupId``s to retain in the cluster.
ElastiCache will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
(string) --
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ServerlessCache': {'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
This API modifies the attributes of a serverless cache.
See also: AWS API Documentation
Request Syntax
client.modify_serverless_cache(
ServerlessCacheName='string',
Description='string',
CacheUsageLimits={
'DataStorage': {
'Maximum': 123,
'Minimum': 123,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123,
'Minimum': 123
}
},
RemoveUserGroup=True|False,
UserGroupId='string',
SecurityGroupIds=[
'string',
],
SnapshotRetentionLimit=123,
DailySnapshotTime='string',
Engine='string',
MajorEngineVersion='string'
)
string
[REQUIRED]
User-provided identifier for the serverless cache to be modified.
string
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.
dict
Modify the cache usage limit for the serverless cache.
DataStorage (dict) --
The maximum data storage limit in the cache, expressed in Gigabytes.
Maximum (integer) --
The upper limit for data storage the cache is set to use.
Minimum (integer) --
The lower limit for data storage the cache is set to use.
Unit (string) -- [REQUIRED]
The unit that the storage is measured in, in GB.
ECPUPerSecond (dict) --
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Maximum (integer) --
The configuration for the maximum number of ECPUs the cache can consume per second.
Minimum (integer) --
The configuration for the minimum number of ECPUs the cache should be able consume per second.
boolean
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.
string
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.
list
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.
(string) --
integer
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.
string
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.
string
Modifies the engine listed in a serverless cache request. The options are valkey, memcached or redis.
string
Modifies the engine vesion listed in a serverless cache request.
dict
Response Syntax
{
'ServerlessCache': {
'ServerlessCacheName': 'string',
'Description': 'string',
'CreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string',
'FullEngineVersion': 'string',
'CacheUsageLimits': {
'DataStorage': {
'Maximum': 123,
'Minimum': 123,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123,
'Minimum': 123
}
},
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': 'string',
'NetworkType': 'ipv4'|'ipv6'|'dual_stack'
}
}
Response Structure
(dict) --
ServerlessCache (dict) --
The response for the attempt to modify the serverless cache.
ServerlessCacheName (string) --
The unique identifier of the serverless cache.
Description (string) --
A description of the serverless cache.
CreateTime (datetime) --
When the serverless cache was created.
Status (string) --
The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
Engine (string) --
The engine the serverless cache is compatible with.
MajorEngineVersion (string) --
The version number of the engine the serverless cache is compatible with.
FullEngineVersion (string) --
The name and version number of the engine the serverless cache is compatible with.
CacheUsageLimits (dict) --
The cache usage limit for the serverless cache.
DataStorage (dict) --
The maximum data storage limit in the cache, expressed in Gigabytes.
Maximum (integer) --
The upper limit for data storage the cache is set to use.
Minimum (integer) --
The lower limit for data storage the cache is set to use.
Unit (string) --
The unit that the storage is measured in, in GB.
ECPUPerSecond (dict) --
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
Maximum (integer) --
The configuration for the maximum number of ECPUs the cache can consume per second.
Minimum (integer) --
The configuration for the minimum number of ECPUs the cache should be able consume per second.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
StorageEncryptionType (string) --
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.
SecurityGroupIds (list) --
The IDs of the EC2 security groups associated with the serverless cache.
(string) --
Endpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
Represents the information required for client programs to connect to a cache node. This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ARN (string) --
The Amazon Resource Name (ARN) of the serverless cache.
UserGroupId (string) --
The identifier of the user group associated with the serverless cache. Available for Valkey and Redis OSS only. Default is NULL.
SubnetIds (list) --
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.
(string) --
SnapshotRetentionLimit (integer) --
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.
DailySnapshotTime (string) --
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.
NetworkType (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Start the migration of data.
See also: AWS API Documentation
Request Syntax
client.start_migration(
ReplicationGroupId='string',
CustomerNodeEndpointList=[
{
'Address': 'string',
'Port': 123
},
]
)
string
[REQUIRED]
The ID of the replication group to which data should be migrated.
list
[REQUIRED]
List of endpoints from which data should be migrated. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element.
(dict) --
The endpoint from which data should be migrated.
Address (string) --
The address of the node endpoint
Port (integer) --
The port of the node endpoint
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
See also: AWS API Documentation
Request Syntax
client.test_failover(
ReplicationGroupId='string',
NodeGroupId='string'
)
string
[REQUIRED]
The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
string
[REQUIRED]
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.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.
{'ReplicationGroup': {'Durability': 'default | async | sync | disabled',
'EffectiveDurability': 'async | sync | disabled',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms'}}
Async API to test connection between source and target replication group.
See also: AWS API Documentation
Request Syntax
client.test_migration(
ReplicationGroupId='string',
CustomerNodeEndpointList=[
{
'Address': 'string',
'Port': 123
},
]
)
string
[REQUIRED]
The ID of the replication group to which data is to be migrated.
list
[REQUIRED]
List of endpoints from which data should be migrated. List should have only one element.
(dict) --
The endpoint from which data should be migrated.
Address (string) --
The address of the node endpoint
Port (integer) --
The port of the node endpoint
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'GlobalReplicationGroupInfo': {
'GlobalReplicationGroupId': 'string',
'GlobalReplicationGroupMemberRole': 'string'
},
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled',
'Resharding': {
'SlotMigration': {
'ProgressPercentage': 123.0
}
},
'AuthTokenStatus': 'SETTING'|'ROTATING',
'UserGroups': {
'UserGroupIdsToAdd': [
'string',
],
'UserGroupIdsToRemove': [
'string',
]
},
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json'
},
],
'TransitEncryptionEnabled': True|False,
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'MultiAZ': 'enabled'|'disabled',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False,
'MemberClustersOutpostArns': [
'string',
],
'KmsKeyId': 'string',
'StorageEncryptionType': 'none'|'sse-elasticache'|'sse-kms',
'ARN': 'string',
'UserGroupIds': [
'string',
],
'LogDeliveryConfigurations': [
{
'LogType': 'slow-log'|'engine-log',
'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
'DestinationDetails': {
'CloudWatchLogsDetails': {
'LogGroup': 'string'
},
'KinesisFirehoseDetails': {
'DeliveryStream': 'string'
}
},
'LogFormat': 'text'|'json',
'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
'Message': 'string'
},
],
'ReplicationGroupCreateTime': datetime(2015, 1, 1),
'DataTiering': 'enabled'|'disabled',
'AutoMinorVersionUpgrade': True|False,
'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
'IpDiscovery': 'ipv4'|'ipv6',
'TransitEncryptionMode': 'preferred'|'required',
'ClusterMode': 'enabled'|'disabled'|'compatible',
'Engine': 'string',
'Durability': 'default'|'async'|'sync'|'disabled',
'EffectiveDurability': 'async'|'sync'|'disabled'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Valkey or Redis OSS replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The user supplied description of the replication group.
GlobalReplicationGroupInfo (dict) --
The name of the Global datastore and role of this replication group in the Global datastore.
GlobalReplicationGroupId (string) --
The name of the Global datastore
GlobalReplicationGroupMemberRole (string) --
The role of the replication group in a Global datastore. Can be primary or secondary.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
PendingModifiedValues (dict) --
A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
PrimaryClusterId (string) --
The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
Resharding (dict) --
The status of an online resharding operation.
SlotMigration (dict) --
Represents the progress of an online resharding operation.
ProgressPercentage (float) --
The percentage of the slot migration that is complete.
AuthTokenStatus (string) --
The auth token status
UserGroups (dict) --
The user group being modified.
UserGroupIdsToAdd (list) --
The ID of the user group to add.
(string) --
UserGroupIdsToRemove (list) --
The ID of the user group to remove.
(string) --
LogDeliveryConfigurations (list) --
The log delivery configurations being modified
(dict) --
The log delivery configurations being modified
LogType (string) --
Refers to slow-log or engine-log..
DestinationType (string) --
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
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).
(dict) --
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.
NodeGroupId (string) --
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.
Status (string) --
The current state of this replication group - creating, available, modifying, deleting.
PrimaryEndpoint (dict) --
The endpoint of the primary node in this node group (shard).
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ReaderEndpoint (dict) --
The endpoint of the replica nodes in this node group (shard). This value is read-only.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
Slots (string) --
The keyspace for this node group (shard).
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group (shard).
(dict) --
Represents a single node within a node group (shard).
CacheClusterId (string) --
The ID of the cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (dict) --
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.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
PreferredOutpostArn (string) --
The outpost ARN of the node group member.
CurrentRole (string) --
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.
SnapshottingClusterId (string) --
The cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of automatic failover for this Valkey or Redis OSS replication group.
MultiAZ (string) --
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
ConfigurationEndpoint (dict) --
The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
SnapshotRetentionLimit (integer) --
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.
SnapshotWindow (string) --
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.
ClusterEnabled (boolean) --
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
CacheNodeType (string) --
The name of the compute and memory capacity node type for each node in the replication group.
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.
Default: false
AuthTokenLastModifiedDate (datetime) --
The date the auth token was last modified
TransitEncryptionEnabled (boolean) --
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
AtRestEncryptionEnabled (boolean) --
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
MemberClustersOutpostArns (list) --
The outpost ARNs of the replication group's member clusters.
(string) --
KmsKeyId (string) --
The ID of the KMS key used to encrypt the disk in the cluster.
StorageEncryptionType (string) --
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.
ARN (string) --
The ARN (Amazon Resource Name) of the replication group.
UserGroupIds (list) --
The ID of the user group associated to the replication group.
(string) --
LogDeliveryConfigurations (list) --
Returns the destination, format and type of the logs.
(dict) --
Returns the destination, format and type of the logs.
LogType (string) --
Refers to slow-log or engine-log.
DestinationType (string) --
Returns the destination type, either cloudwatch-logs or kinesis-firehose.
DestinationDetails (dict) --
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
CloudWatchLogsDetails (dict) --
The configuration details of the CloudWatch Logs destination.
LogGroup (string) --
The name of the CloudWatch Logs log group.
KinesisFirehoseDetails (dict) --
The configuration details of the Kinesis Data Firehose destination.
DeliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream.
LogFormat (string) --
Returns the log format, either JSON or TEXT.
Status (string) --
Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Message (string) --
Returns an error message for the log delivery configuration.
ReplicationGroupCreateTime (datetime) --
The date and time when the cluster was created.
DataTiering (string) --
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.
AutoMinorVersionUpgrade (boolean) --
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.
NetworkType (string) --
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.
IpDiscovery (string) --
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.
TransitEncryptionMode (string) --
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
ClusterMode (string) --
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.
Engine (string) --
The engine used in a replication group. The options are valkey, memcached or redis.
Durability (string) --
The durability setting of the replication group. For more information, see Durability.
EffectiveDurability (string) --
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.