2026/10/20 - Amazon ElastiCache - 2 new6 updated api methods
Changes LiveMigration enables customers to migrate from self-hosted EC2 Redis and Valkey clusters to ElastiCache Serverless with near-zero downtime. Customers control the migration through three API-driven phases (prepare, start, complete) that handle traffic proxying, data replication, and cutover.
Prepares the serverless cache for data migration by validating the configuration and setting up the migration resources.
See also: AWS API Documentation
Request Syntax
client.prepare_migration(
ServerlessCacheName='string',
CustomerNodeEndpointList=[
{
'Address': 'string',
'Port': 123
},
],
SourceAuthenticationConfiguration={
'SecretManagerConfig': {
'SecretArn': 'string'
}
},
SourceTlsConfiguration={
'SourceTlsMode': 'none'|'verify-ca',
'SourceTlsCertificate': 'string'
}
)
string
[REQUIRED]
The name of the serverless cache to prepare for migration.
list
[REQUIRED]
The list of endpoints from which to migrate data. For serverless cache migrations, 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
The authentication configuration for connecting to the source during migration.
SecretManagerConfig (dict) --
The Secrets Manager configuration used for authenticating with the source during migration.
SecretArn (string) --
The ARN of the secret in AWS Secrets Manager that contains the credentials for authenticating with the source.
dict
The TLS configuration for connecting to the source during migration.
SourceTlsMode (string) --
The TLS mode to use when connecting to the source. Valid values are none and verify-ca.
SourceTlsCertificate (string) --
The TLS certificate used to verify the identity of the source during migration.
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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
Response Structure
(dict) --
ServerlessCache (dict) --
Provides the details of the serverless cache prepared for migration.
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
Stops an ongoing data sync between the source and the serverless cache. The migration remains open and the data sync can be restarted. This operation is valid only while the migration is syncing; during cutover it returns InvalidServerlessCacheStateFault.
See also: AWS API Documentation
Request Syntax
client.stop_migration(
ServerlessCacheName='string'
)
string
[REQUIRED]
The name of the serverless cache for which to stop the data sync.
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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
Response Structure
(dict) --
ServerlessCache (dict) --
Provides the details of the serverless cache for which the data sync stopped.
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
{'ServerlessCacheName': 'string'}
Response {'ServerlessCache': {'ARN': 'string',
'CacheUsageLimits': {'DataStorage': {'Maximum': 'integer',
'Minimum': 'integer',
'Unit': 'GB'},
'ECPUPerSecond': {'Maximum': 'integer',
'Minimum': 'integer'}},
'ConnectionType': 'vpc | public',
'CreateTime': 'timestamp',
'DailySnapshotTime': 'string',
'Description': 'string',
'Endpoint': {'Address': 'string', 'Port': 'integer'},
'Engine': 'string',
'FullEngineVersion': 'string',
'KmsKeyId': 'string',
'MajorEngineVersion': 'string',
'Migration': {'CutoverMode': 'string',
'MigrationEndpoint': {'Address': 'string',
'Port': 'integer'},
'Status': 'string'},
'NetworkType': 'ipv4 | ipv6 | dual_stack',
'ReaderEndpoint': {'Address': 'string', 'Port': 'integer'},
'SecurityGroupIds': ['string'],
'ServerlessCacheName': 'string',
'SnapshotRetentionLimit': 'integer',
'Status': 'string',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms',
'SubnetIds': ['string'],
'UserGroupId': 'string'}}
Completes the migration of data.
See also: AWS API Documentation
Request Syntax
client.complete_migration(
ReplicationGroupId='string',
ServerlessCacheName='string',
Force=True|False
)
string
The ID of the replication group to which data is being migrated.
string
The name of the serverless cache 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'
},
'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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
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 (dict) --
Provides the details of the serverless cache for which the migration completed.
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
{'ServerlessCache': {'Migration': {'CutoverMode': 'string',
'MigrationEndpoint': {'Address': 'string',
'Port': 'integer'},
'Status': 'string'}}}
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',
ConnectionType='vpc'|'public'
)
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. 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.
string
The connection type for the serverless cache. Must be either vpc | public. Use vpc to access the cache through a VPC endpoint, or public to access the cache over the internet. If not specified, defaults to vpc. This value cannot be changed after the serverless cache is created. Setting this to public requires Valkey 9 or above.
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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
{'ServerlessCache': {'Migration': {'CutoverMode': 'string',
'MigrationEndpoint': {'Address': 'string',
'Port': 'integer'},
'Status': 'string'}}}
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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
{'ServerlessCaches': {'Migration': {'CutoverMode': 'string',
'MigrationEndpoint': {'Address': 'string',
'Port': 'integer'},
'Status': 'string'}}}
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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
},
]
}
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
{'ServerlessCache': {'Migration': {'CutoverMode': 'string',
'MigrationEndpoint': {'Address': 'string',
'Port': 'integer'},
'Status': 'string'}}}
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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.
{'AutoCutover': 'boolean',
'ClearTargetCacheData': 'boolean',
'ServerlessCacheName': 'string'}
Response {'ServerlessCache': {'ARN': 'string',
'CacheUsageLimits': {'DataStorage': {'Maximum': 'integer',
'Minimum': 'integer',
'Unit': 'GB'},
'ECPUPerSecond': {'Maximum': 'integer',
'Minimum': 'integer'}},
'ConnectionType': 'vpc | public',
'CreateTime': 'timestamp',
'DailySnapshotTime': 'string',
'Description': 'string',
'Endpoint': {'Address': 'string', 'Port': 'integer'},
'Engine': 'string',
'FullEngineVersion': 'string',
'KmsKeyId': 'string',
'MajorEngineVersion': 'string',
'Migration': {'CutoverMode': 'string',
'MigrationEndpoint': {'Address': 'string',
'Port': 'integer'},
'Status': 'string'},
'NetworkType': 'ipv4 | ipv6 | dual_stack',
'ReaderEndpoint': {'Address': 'string', 'Port': 'integer'},
'SecurityGroupIds': ['string'],
'ServerlessCacheName': 'string',
'SnapshotRetentionLimit': 'integer',
'Status': 'string',
'StorageEncryptionType': 'none | sse-elasticache | '
'sse-kms',
'SubnetIds': ['string'],
'UserGroupId': 'string'}}
Starts the migration of data.
See also: AWS API Documentation
Request Syntax
client.start_migration(
ServerlessCacheName='string',
ReplicationGroupId='string',
CustomerNodeEndpointList=[
{
'Address': 'string',
'Port': 123
},
],
AutoCutover=True|False,
ClearTargetCacheData=True|False
)
string
The name of the serverless cache to which data is being migrated.
string
The ID of the replication group to which data should be migrated.
list
The list of endpoints from which to migrate data. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element. For serverless cache migrations, ElastiCache uses the endpoint that you provided in PrepareMigration.
(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
boolean
Specifies whether ElastiCache automatically attempts to complete the migration after data sync is established.
boolean
Specifies whether ElastiCache deletes existing data in the serverless cache before migration begins. After StopMigration, StartMigration requires this option to restart the data sync.
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'
},
'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',
'ConnectionType': 'vpc'|'public',
'Migration': {
'Status': 'string',
'MigrationEndpoint': {
'Address': 'string',
'Port': 123
},
'CutoverMode': 'string'
}
}
}
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 (dict) --
Provides the details of the serverless cache to which ElastiCache is migrating data.
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.
ConnectionType (string) --
The connection type for the serverless cache. Must be either vpc | public. If not specified, defaults to vpc.
Migration (dict) --
Provides a summary of the migration status for the serverless cache.
Status (string) --
The current status of the migration.
MigrationEndpoint (dict) --
The migration endpoint, which is the standard endpoint of the serverless cache. Point your application at this endpoint during the migration. Until cutover, ElastiCache routes requests on this endpoint to your source.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
CutoverMode (string) --
The cutover configuration for the migration.