2023/11/28 - Amazon ElastiCache - 9 new 6 updated api methods
Changes Launching Amazon ElastiCache Serverless that enables you to create a cache in under a minute without any capacity management. ElastiCache Serverless monitors the cache's memory, CPU, and network usage and scales both vertically and horizontally to support your application's requirements.
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,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123
}
},
RemoveUserGroup=True|False,
UserGroupId='string',
SecurityGroupIds=[
'string',
],
SnapshotRetentionLimit=123,
DailySnapshotTime='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) -- [REQUIRED]
The upper 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) -- [REQUIRED]
The configuration for the maximum number of ECPUs the cache can consume per second.
boolean
The identifier of the UserGroup to be removed from association with the Redis serverless cache. Available for Redis only. Default is NULL.
string
The identifier of the UserGroup to be associated with the serverless cache. Available for Redis 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 Redis 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 Redis only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
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,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123
}
},
'KmsKeyId': 'string',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': '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.
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.
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.
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.
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.
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 Redis only. Default is NULL.
SubnetIds (list) --
If no subnet IDs are given and your VPC is in SFO, 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 current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
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 Redis only.
Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.
See also: AWS API Documentation
Request Syntax
client.copy_serverless_cache_snapshot(
SourceServerlessCacheSnapshotName='string',
TargetServerlessCacheSnapshotName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis only.
string
[REQUIRED]
The identifier for the snapshot to be created. Available for Redis only.
string
The identifier of the KMS key used to encrypt the target snapshot. Available for Redis only.
list
A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis only. Default: 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.
dict
Response Syntax
{
'ServerlessCacheSnapshot': {
'ServerlessCacheSnapshotName': 'string',
'ARN': 'string',
'KmsKeyId': 'string',
'SnapshotType': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'ExpiryTime': datetime(2015, 1, 1),
'BytesUsedForCache': 'string',
'ServerlessCacheConfiguration': {
'ServerlessCacheName': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string'
}
}
}
Response Structure
(dict) --
ServerlessCacheSnapshot (dict) --
The response for the attempt to copy the serverless cache snapshot. Available for Redis only.
ServerlessCacheSnapshotName (string) --
The identifier of a serverless cache snapshot. Available for Redis only.
ARN (string) --
The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
SnapshotType (string) --
The type of snapshot of serverless cache. Available for Redis only.
Status (string) --
The current status of the serverless cache. Available for Redis only.
CreateTime (datetime) --
The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Redis only.
ExpiryTime (datetime) --
The time that the serverless cache snapshot will expire. Available for Redis only.
BytesUsedForCache (string) --
The total size of a serverless cache snapshot, in bytes. Available for Redis only.
ServerlessCacheConfiguration (dict) --
The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
ServerlessCacheName (string) --
The identifier of a serverless cache.
Engine (string) --
The engine that the serverless cache is configured with.
MajorEngineVersion (string) --
The engine version number that the serverless cache is configured with.
Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only.
See also: AWS API Documentation
Request Syntax
client.describe_serverless_cache_snapshots(
ServerlessCacheName='string',
ServerlessCacheSnapshotName='string',
SnapshotType='string',
NextToken='string',
MaxResults=123
)
string
The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Redis only.
string
The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Redis only.
string
The type of snapshot that is being described. Available for Redis only.
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 max-results. Available for Redis only.
integer
The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Redis only.The default is 50. The Validation Constraints are a maximum of 50.
dict
Response Syntax
{
'NextToken': 'string',
'ServerlessCacheSnapshots': [
{
'ServerlessCacheSnapshotName': 'string',
'ARN': 'string',
'KmsKeyId': 'string',
'SnapshotType': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'ExpiryTime': datetime(2015, 1, 1),
'BytesUsedForCache': 'string',
'ServerlessCacheConfiguration': {
'ServerlessCacheName': 'string',
'Engine': 'string',
'MajorEngineVersion': '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 max-results. Available for Redis only.
ServerlessCacheSnapshots (list) --
The serverless caches snapshots associated with a given description request. Available for Redis only.
(dict) --
The resource representing a serverless cache snapshot. Available for Redis only.
ServerlessCacheSnapshotName (string) --
The identifier of a serverless cache snapshot. Available for Redis only.
ARN (string) --
The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
SnapshotType (string) --
The type of snapshot of serverless cache. Available for Redis only.
Status (string) --
The current status of the serverless cache. Available for Redis only.
CreateTime (datetime) --
The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Redis only.
ExpiryTime (datetime) --
The time that the serverless cache snapshot will expire. Available for Redis only.
BytesUsedForCache (string) --
The total size of a serverless cache snapshot, in bytes. Available for Redis only.
ServerlessCacheConfiguration (dict) --
The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
ServerlessCacheName (string) --
The identifier of a serverless cache.
Engine (string) --
The engine that the serverless cache is configured with.
MajorEngineVersion (string) --
The engine version number that the serverless cache is configured with.
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,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123
}
},
KmsKeyId='string',
SecurityGroupIds=[
'string',
],
SnapshotArnsToRestore=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
UserGroupId='string',
SubnetIds=[
'string',
],
SnapshotRetentionLimit=123,
DailySnapshotTime='string'
)
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) -- [REQUIRED]
The upper 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) -- [REQUIRED]
The configuration for the maximum number of ECPUs the cache can 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 Redis 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 Redis 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 snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
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 Redis only.
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,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123
}
},
'KmsKeyId': 'string',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': '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.
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.
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.
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.
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.
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 Redis only. Default is NULL.
SubnetIds (list) --
If no subnet IDs are given and your VPC is in SFO, 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 current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
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 Redis only.
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,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123
}
},
'KmsKeyId': 'string',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': '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.
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.
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.
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.
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.
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 Redis only. Default is NULL.
SubnetIds (list) --
If no subnet IDs are given and your VPC is in SFO, 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 current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
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 Redis only.
This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.
See also: AWS API Documentation
Request Syntax
client.create_serverless_cache_snapshot(
ServerlessCacheSnapshotName='string',
ServerlessCacheName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name for the snapshot being created. Must be unique for the customer account. Available for Redis only. Must be between 1 and 255 characters.
string
[REQUIRED]
The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis only.
string
The ID of the KMS key used to encrypt the snapshot. Available for Redis only. Default: NULL
list
A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis only.
(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
{
'ServerlessCacheSnapshot': {
'ServerlessCacheSnapshotName': 'string',
'ARN': 'string',
'KmsKeyId': 'string',
'SnapshotType': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'ExpiryTime': datetime(2015, 1, 1),
'BytesUsedForCache': 'string',
'ServerlessCacheConfiguration': {
'ServerlessCacheName': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string'
}
}
}
Response Structure
(dict) --
ServerlessCacheSnapshot (dict) --
The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis only.
ServerlessCacheSnapshotName (string) --
The identifier of a serverless cache snapshot. Available for Redis only.
ARN (string) --
The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
SnapshotType (string) --
The type of snapshot of serverless cache. Available for Redis only.
Status (string) --
The current status of the serverless cache. Available for Redis only.
CreateTime (datetime) --
The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Redis only.
ExpiryTime (datetime) --
The time that the serverless cache snapshot will expire. Available for Redis only.
BytesUsedForCache (string) --
The total size of a serverless cache snapshot, in bytes. Available for Redis only.
ServerlessCacheConfiguration (dict) --
The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
ServerlessCacheName (string) --
The identifier of a serverless cache.
Engine (string) --
The engine that the serverless cache is configured with.
MajorEngineVersion (string) --
The engine version number that the serverless cache is configured with.
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 Redis 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,
'Unit': 'GB'
},
'ECPUPerSecond': {
'Maximum': 123
}
},
'KmsKeyId': 'string',
'SecurityGroupIds': [
'string',
],
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ReaderEndpoint': {
'Address': 'string',
'Port': 123
},
'ARN': 'string',
'UserGroupId': 'string',
'SubnetIds': [
'string',
],
'SnapshotRetentionLimit': 123,
'DailySnapshotTime': '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.
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.
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.
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.
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.
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 Redis only. Default is NULL.
SubnetIds (list) --
If no subnet IDs are given and your VPC is in SFO, 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 current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
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 Redis only.
Deletes an existing serverless cache snapshot. Available for Redis only.
See also: AWS API Documentation
Request Syntax
client.delete_serverless_cache_snapshot(
ServerlessCacheSnapshotName='string'
)
string
[REQUIRED]
Idenfitier of the snapshot to be deleted. Available for Redis only.
dict
Response Syntax
{
'ServerlessCacheSnapshot': {
'ServerlessCacheSnapshotName': 'string',
'ARN': 'string',
'KmsKeyId': 'string',
'SnapshotType': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'ExpiryTime': datetime(2015, 1, 1),
'BytesUsedForCache': 'string',
'ServerlessCacheConfiguration': {
'ServerlessCacheName': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string'
}
}
}
Response Structure
(dict) --
ServerlessCacheSnapshot (dict) --
The snapshot to be deleted. Available for Redis only.
ServerlessCacheSnapshotName (string) --
The identifier of a serverless cache snapshot. Available for Redis only.
ARN (string) --
The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
SnapshotType (string) --
The type of snapshot of serverless cache. Available for Redis only.
Status (string) --
The current status of the serverless cache. Available for Redis only.
CreateTime (datetime) --
The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Redis only.
ExpiryTime (datetime) --
The time that the serverless cache snapshot will expire. Available for Redis only.
BytesUsedForCache (string) --
The total size of a serverless cache snapshot, in bytes. Available for Redis only.
ServerlessCacheConfiguration (dict) --
The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
ServerlessCacheName (string) --
The identifier of a serverless cache.
Engine (string) --
The engine that the serverless cache is configured with.
MajorEngineVersion (string) --
The engine version number that the serverless cache is configured with.
Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only.
See also: AWS API Documentation
Request Syntax
client.export_serverless_cache_snapshot(
ServerlessCacheSnapshotName='string',
S3BucketName='string'
)
string
[REQUIRED]
The identifier of the serverless cache snapshot to be exported to S3. Available for Redis only.
string
[REQUIRED]
Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Redis only.
dict
Response Syntax
{
'ServerlessCacheSnapshot': {
'ServerlessCacheSnapshotName': 'string',
'ARN': 'string',
'KmsKeyId': 'string',
'SnapshotType': 'string',
'Status': 'string',
'CreateTime': datetime(2015, 1, 1),
'ExpiryTime': datetime(2015, 1, 1),
'BytesUsedForCache': 'string',
'ServerlessCacheConfiguration': {
'ServerlessCacheName': 'string',
'Engine': 'string',
'MajorEngineVersion': 'string'
}
}
}
Response Structure
(dict) --
ServerlessCacheSnapshot (dict) --
The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis only.
ServerlessCacheSnapshotName (string) --
The identifier of a serverless cache snapshot. Available for Redis only.
ARN (string) --
The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
KmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
SnapshotType (string) --
The type of snapshot of serverless cache. Available for Redis only.
Status (string) --
The current status of the serverless cache. Available for Redis only.
CreateTime (datetime) --
The date and time that the source serverless cache's metadata and cache data set was obtained for the snapshot. Available for Redis only.
ExpiryTime (datetime) --
The time that the serverless cache snapshot will expire. Available for Redis only.
BytesUsedForCache (string) --
The total size of a serverless cache snapshot, in bytes. Available for Redis only.
ServerlessCacheConfiguration (dict) --
The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
ServerlessCacheName (string) --
The identifier of a serverless cache.
Engine (string) --
The engine that the serverless cache is configured with.
MajorEngineVersion (string) --
The engine version number that the serverless cache is configured with.
{'ServerlessCacheSnapshotName': 'string'}
Creates a Redis (cluster mode disabled) or a Redis (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 Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis 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 Redis 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 Redis (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 avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide .
Note
This operation is valid for Redis only.
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'
)
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 Redis (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.
Note
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters .
Default: system chosen Availability Zones.
(string) --
integer
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (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 Redis (cluster mode disabled) or a Redis (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 Redis (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 for Redis 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
Note
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro , cache.t4g.small , cache.t4g.medium T3 node types: cache.t3.micro , cache.t3.small , cache.t3.medium T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R7g node types : cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , cache.r7g.16xlarge
Note
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge R4 node types: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis 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 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 Redis 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 Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2 .
To create a Redis (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.
Warning
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups .
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 Redis 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:
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.
Note
The Amazon SNS topic owner must be the same as the cluster owner.
boolean
If you are running Redis 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 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 .
Warning
For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
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 version 3.2.6 , 4.x or later.
Default: false
Warning
For HIPAA compliance, you must specify TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .
boolean
A flag that enables encryption at rest when set to true .
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 , 4.x or later.
Default: false
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 Redis engine version 6.2 onward or Memcached engine version 1.6.6 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 Redis engine version 6.2 onward or Memcached engine version 1.6.6 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 Redis 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 Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis 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 Redis only.
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',
'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'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific Redis 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 Redis 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 Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis 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 Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (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 Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (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).
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 Redis (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 Redis (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 Redis 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.
Warning
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
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.
Note
This parameter is only valid if the Engine parameter is redis .
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 Redis 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 version 3.2.6 , 4.x or later.
Default: false
AtRestEncryptionEnabled (boolean) --
A flag that enables encryption at-rest when set to true .
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 , 4.x or later.
Default: false
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.
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 Redis 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.
NetworkType (string) --
Must be either ipv4 | ipv6 | dual_stack . IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 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 Redis engine version 6.2 onward or Memcached engine version 1.6.6 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 Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
{'ServerlessCaches': ['string']}
For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
See also: AWS API Documentation
Request Syntax
client.create_user_group(
UserGroupId='string',
Engine='string',
UserIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the user group.
string
[REQUIRED]
The current supported value is Redis.
list
The list of user IDs that belong to the user group.
(string) --
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. Available for Redis only.
(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
{
'UserGroupId': 'string',
'Status': 'string',
'Engine': 'string',
'UserIds': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserIdsToRemove': [
'string',
],
'UserIdsToAdd': [
'string',
]
},
'ReplicationGroups': [
'string',
],
'ServerlessCaches': [
'string',
],
'ARN': 'string'
}
Response Structure
(dict) --
UserGroupId (string) --
The ID of the user group.
Status (string) --
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
Engine (string) --
The current supported value is Redis.
UserIds (list) --
The list of user IDs that belong to the user group.
(string) --
MinimumEngineVersion (string) --
The minimum engine version required, which is Redis 6.0
PendingChanges (dict) --
A list of updates being applied to the user group.
UserIdsToRemove (list) --
The list of user IDs to remove.
(string) --
UserIdsToAdd (list) --
The list of user IDs to add.
(string) --
ReplicationGroups (list) --
A list of replication groups that the user group can access.
(string) --
ServerlessCaches (list) --
Indicates which serverless caches the specified user group is associated with. Available for Redis only.
(string) --
ARN (string) --
The Amazon Resource Name (ARN) of the user group.
{'ServerlessCaches': ['string']}
For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC) .
See also: AWS API Documentation
Request Syntax
client.delete_user_group(
UserGroupId='string'
)
string
[REQUIRED]
The ID of the user group.
dict
Response Syntax
{
'UserGroupId': 'string',
'Status': 'string',
'Engine': 'string',
'UserIds': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserIdsToRemove': [
'string',
],
'UserIdsToAdd': [
'string',
]
},
'ReplicationGroups': [
'string',
],
'ServerlessCaches': [
'string',
],
'ARN': 'string'
}
Response Structure
(dict) --
UserGroupId (string) --
The ID of the user group.
Status (string) --
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
Engine (string) --
The current supported value is Redis.
UserIds (list) --
The list of user IDs that belong to the user group.
(string) --
MinimumEngineVersion (string) --
The minimum engine version required, which is Redis 6.0
PendingChanges (dict) --
A list of updates being applied to the user group.
UserIdsToRemove (list) --
The list of user IDs to remove.
(string) --
UserIdsToAdd (list) --
The list of user IDs to add.
(string) --
ReplicationGroups (list) --
A list of replication groups that the user group can access.
(string) --
ServerlessCaches (list) --
Indicates which serverless caches the specified user group is associated with. Available for Redis only.
(string) --
ARN (string) --
The Amazon Resource Name (ARN) of the user group.
{'SourceType': {'serverless-cache', 'serverless-cache-snapshot'}}
Response {'Events': {'SourceType': {'serverless-cache', 'serverless-cache-snapshot'}}}
Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
See also: AWS API Documentation
Request Syntax
client.describe_events(
SourceIdentifier='string',
SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group'|'serverless-cache'|'serverless-cache-snapshot'|'user'|'user-group',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
MaxRecords=123,
Marker='string'
)
string
The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
string
The event source to retrieve events for. If no value is specified, all events are returned.
datetime
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
datetime
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
integer
The number of minutes worth of events to retrieve.
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',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group'|'serverless-cache'|'serverless-cache-snapshot'|'user'|'user-group',
'Message': 'string',
'Date': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeEvents operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
Events (list) --
A list of events. Each element in the list contains detailed information about one event.
(dict) --
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
SourceIdentifier (string) --
The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
SourceType (string) --
Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
Message (string) --
The text of the event.
Date (datetime) --
The date and time when the event occurred.
{'UserGroups': {'ServerlessCaches': ['string']}}
Returns a list of user groups.
See also: AWS API Documentation
Request Syntax
client.describe_user_groups(
UserGroupId='string',
MaxRecords=123,
Marker='string'
)
string
The ID of the user group.
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.
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
{
'UserGroups': [
{
'UserGroupId': 'string',
'Status': 'string',
'Engine': 'string',
'UserIds': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserIdsToRemove': [
'string',
],
'UserIdsToAdd': [
'string',
]
},
'ReplicationGroups': [
'string',
],
'ServerlessCaches': [
'string',
],
'ARN': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
UserGroups (list) --
Returns a list of user groups.
(dict) --
UserGroupId (string) --
The ID of the user group.
Status (string) --
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
Engine (string) --
The current supported value is Redis.
UserIds (list) --
The list of user IDs that belong to the user group.
(string) --
MinimumEngineVersion (string) --
The minimum engine version required, which is Redis 6.0
PendingChanges (dict) --
A list of updates being applied to the user group.
UserIdsToRemove (list) --
The list of user IDs to remove.
(string) --
UserIdsToAdd (list) --
The list of user IDs to add.
(string) --
ReplicationGroups (list) --
A list of replication groups that the user group can access.
(string) --
ServerlessCaches (list) --
Indicates which serverless caches the specified user group is associated with. Available for Redis only.
(string) --
ARN (string) --
The Amazon Resource Name (ARN) of the user group.
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. >
{'ServerlessCaches': ['string']}
Changes the list of users that belong to the user group.
See also: AWS API Documentation
Request Syntax
client.modify_user_group(
UserGroupId='string',
UserIdsToAdd=[
'string',
],
UserIdsToRemove=[
'string',
]
)
string
[REQUIRED]
The ID of the user group.
list
The list of user IDs to add to the user group.
(string) --
list
The list of user IDs to remove from the user group.
(string) --
dict
Response Syntax
{
'UserGroupId': 'string',
'Status': 'string',
'Engine': 'string',
'UserIds': [
'string',
],
'MinimumEngineVersion': 'string',
'PendingChanges': {
'UserIdsToRemove': [
'string',
],
'UserIdsToAdd': [
'string',
]
},
'ReplicationGroups': [
'string',
],
'ServerlessCaches': [
'string',
],
'ARN': 'string'
}
Response Structure
(dict) --
UserGroupId (string) --
The ID of the user group.
Status (string) --
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
Engine (string) --
The current supported value is Redis.
UserIds (list) --
The list of user IDs that belong to the user group.
(string) --
MinimumEngineVersion (string) --
The minimum engine version required, which is Redis 6.0
PendingChanges (dict) --
A list of updates being applied to the user group.
UserIdsToRemove (list) --
The list of user IDs to remove.
(string) --
UserIdsToAdd (list) --
The list of user IDs to add.
(string) --
ReplicationGroups (list) --
A list of replication groups that the user group can access.
(string) --
ServerlessCaches (list) --
Indicates which serverless caches the specified user group is associated with. Available for Redis only.
(string) --
ARN (string) --
The Amazon Resource Name (ARN) of the user group.