2021/04/07 - Amazon ElastiCache - 8 updated api methods
Changes This release adds tagging support for all AWS ElastiCache resources except Global Replication Groups.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Makes a copy of an existing snapshot.
Note
This operation is valid for Redis only.
Warning
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user. Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity. Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s. Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName .
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket. Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket. Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket. Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
See also: AWS API Documentation
Request Syntax
client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string',
TargetBucket='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of an existing snapshot from which to make a copy.
string
[REQUIRED]
A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
string
The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide .
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide .
string
The ID of the KMS key used to encrypt the target snapshot.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
],
'KmsKeyId': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
ReplicationGroupId (string) --
The unique identifier of the source replication group.
ReplicationGroupDescription (string) --
A description of the source replication group.
CacheClusterId (string) --
The user-supplied identifier of the source cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting .
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated ) or was created manually ( manual ).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation: 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
Note
For region availability, see Supported Node Types
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 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) 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) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: 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
Note
For region availability, see Supported Node Types
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) 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.
Engine (string) --
The name of the cache engine ( memcached or redis ) used by the source cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cluster is located.
PreferredOutpostArn (string) --
The ARN (Amazon Resource Name) of the preferred outpost.
CacheClusterCreateTime (datetime) --
The date and time when the source cluster was created.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
NumNodeGroups (integer) --
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
AutomaticFailover (string) --
Indicates the status of automatic failover for the source Redis replication group.
NodeSnapshots (list) --
A list of the cache nodes in the source cluster.
(dict) --
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId (string) --
A unique identifier for the source cluster.
NodeGroupId (string) --
A unique identifier for the source node group (shard).
CacheNodeId (string) --
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration (dict) --
The configuration for the source node group (shard).
NodeGroupId (string) --
Either the ElastiCache 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) --
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
ModifyCacheParameterGroup in the ElastiCache API Reference.
Parameters and Parameter Groups in the ElastiCache User Guide.
See also: AWS API Documentation
Request Syntax
client.create_cache_parameter_group(
CacheParameterGroupName='string',
CacheParameterGroupFamily='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A user-specified name for the cache parameter group.
string
[REQUIRED]
The name of the cache parameter group family that the cache parameter group can be used with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |
string
[REQUIRED]
A user-specified description for the cache parameter group.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'CacheParameterGroupFamily': 'string',
'Description': 'string',
'IsGlobal': True|False,
'ARN': 'string'
}
}
Response Structure
(dict) --
CacheParameterGroup (dict) --
Represents the output of a CreateCacheParameterGroup operation.
CacheParameterGroupName (string) --
The name of the cache parameter group.
CacheParameterGroupFamily (string) --
The name of the cache parameter group family that this cache parameter group is compatible with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |
Description (string) --
The description for this cache parameter group.
IsGlobal (boolean) --
Indicates whether the parameter group is associated with a Global datastore
ARN (string) --
The ARN (Amazon Resource Name) of the cache parameter group.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
See also: AWS API Documentation
Request Syntax
client.create_cache_security_group(
CacheSecurityGroupName='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A name for the cache security group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example: mysecuritygroup
string
[REQUIRED]
A description for the cache security group.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'CacheSecurityGroup': {
'OwnerId': 'string',
'CacheSecurityGroupName': 'string',
'Description': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'ARN': 'string'
}
}
Response Structure
(dict) --
CacheSecurityGroup (dict) --
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
OwnerId (string) --
The AWS account ID of the cache security group owner.
CacheSecurityGroupName (string) --
The name of the cache security group.
Description (string) --
The description of the cache security group.
EC2SecurityGroups (list) --
A list of Amazon EC2 security groups that are associated with this cache security group.
(dict) --
Provides ownership and status information for an Amazon EC2 security group.
Status (string) --
The status of the Amazon EC2 security group.
EC2SecurityGroupName (string) --
The name of the Amazon EC2 security group.
EC2SecurityGroupOwnerId (string) --
The AWS account ID of the Amazon EC2 security group owner.
ARN (string) --
The ARN of the cache security group,
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
See also: AWS API Documentation
Request Syntax
client.create_cache_subnet_group(
CacheSubnetGroupName='string',
CacheSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
string
[REQUIRED]
A description for the cache subnet group.
list
[REQUIRED]
A list of VPC subnet IDs for the cache subnet 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.
(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
{
'CacheSubnetGroup': {
'CacheSubnetGroupName': 'string',
'CacheSubnetGroupDescription': 'string',
'VpcId': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'SubnetOutpostArn': 'string'
}
},
],
'ARN': 'string'
}
}
Response Structure
(dict) --
CacheSubnetGroup (dict) --
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
CacheSubnetGroupName (string) --
The name of the cache subnet group.
CacheSubnetGroupDescription (string) --
The description of the cache subnet group.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
Subnets (list) --
A list of subnets associated with the cache subnet group.
(dict) --
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
SubnetIdentifier (string) --
The unique identifier for the subnet.
SubnetAvailabilityZone (dict) --
The Availability Zone associated with the subnet.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
The outpost ARN of the subnet.
SubnetOutpostArn (string) --
The outpost ARN of the subnet.
ARN (string) --
The ARN (Amazon Resource Name) of the cache subnet group.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Creates a copy of an entire cluster or replication group at a specific moment in time.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
client.create_snapshot(
ReplicationGroupId='string',
CacheClusterId='string',
SnapshotName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
The identifier of an existing replication group. The snapshot is created from this replication group.
string
The identifier of an existing cluster. The snapshot is created from this cluster.
string
[REQUIRED]
A name for the snapshot being created.
string
The ID of the KMS key used to encrypt the snapshot.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'ReplicationGroupId': 'string',
'ReplicationGroupDescription': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'PreferredOutpostArn': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NumNodeGroups': 123,
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'NodeSnapshots': [
{
'CacheClusterId': 'string',
'NodeGroupId': 'string',
'CacheNodeId': 'string',
'NodeGroupConfiguration': {
'NodeGroupId': 'string',
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'string',
],
'PrimaryOutpostArn': 'string',
'ReplicaOutpostArns': [
'string',
]
},
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
],
'KmsKeyId': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
ReplicationGroupId (string) --
The unique identifier of the source replication group.
ReplicationGroupDescription (string) --
A description of the source replication group.
CacheClusterId (string) --
The user-supplied identifier of the source cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting .
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated ) or was created manually ( manual ).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation: 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
Note
For region availability, see Supported Node Types
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 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) 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) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: 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
Note
For region availability, see Supported Node Types
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) 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.
Engine (string) --
The name of the cache engine ( memcached or redis ) used by the source cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the source cluster is located.
PreferredOutpostArn (string) --
The ARN (Amazon Resource Name) of the preferred outpost.
CacheClusterCreateTime (datetime) --
The date and time when the source cluster was created.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
NumNodeGroups (integer) --
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
AutomaticFailover (string) --
Indicates the status of automatic failover for the source Redis replication group.
NodeSnapshots (list) --
A list of the cache nodes in the source cluster.
(dict) --
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId (string) --
A unique identifier for the source cluster.
NodeGroupId (string) --
A unique identifier for the source node group (shard).
CacheNodeId (string) --
The cache node identifier for the node in the source cluster.
NodeGroupConfiguration (dict) --
The configuration for the source node group (shard).
NodeGroupId (string) --
Either the ElastiCache 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) --
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
KmsKeyId (string) --
The ID of the KMS key used to encrypt the snapshot.
ARN (string) --
The ARN (Amazon Resource Name) of the snapshot.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
For Redis engine version 6.x onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
See also: AWS API Documentation
Request Syntax
client.create_user(
UserId='string',
UserName='string',
Engine='string',
Passwords=[
'string',
],
AccessString='string',
NoPasswordRequired=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the user.
string
[REQUIRED]
The username of the user.
string
[REQUIRED]
The current supported value is Redis.
list
Passwords used for this user. You can create up to two passwords for each user.
(string) --
string
[REQUIRED]
Access permissions string used for this user.
boolean
Indicates a password is not required for this user.
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'UserId': 'string',
'UserName': 'string',
'Status': 'string',
'Engine': 'string',
'AccessString': 'string',
'UserGroupIds': [
'string',
],
'Authentication': {
'Type': 'password'|'no-password',
'PasswordCount': 123
},
'ARN': 'string'
}
Response Structure
(dict) --
UserId (string) --
The ID of the user.
UserName (string) --
The username of the user.
Status (string) --
Indicates the user status. Can be "active", "modifying" or "deleting".
Engine (string) --
The current supported value is Redis.
AccessString (string) --
Access permissions string used for this user.
UserGroupIds (list) --
Returns a list of the user group IDs the user belongs to.
(string) --
Authentication (dict) --
Denotes whether the user requires a password to authenticate.
Type (string) --
Indicates whether the user requires a password to authenticate.
PasswordCount (integer) --
The number of passwords belonging to the user. The maximum is two.
ARN (string) --
The Amazon Resource Name (ARN) of the user.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
For Redis engine version 6.x 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.
(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',
],
'PendingChanges': {
'UserIdsToRemove': [
'string',
],
'UserIdsToAdd': [
'string',
]
},
'ReplicationGroups': [
'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) --
PendingChanges (dict) --
A list of updates being applied to the user groups.
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) --
ARN (string) --
The Amazon Resource Name (ARN) of the user group.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
See also: AWS API Documentation
Request Syntax
client.purchase_reserved_cache_nodes_offering(
ReservedCacheNodesOfferingId='string',
ReservedCacheNodeId='string',
CacheNodeCount=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
string
A customer-specified identifier to track this reservation.
Note
The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
Example: myreservationID
integer
The number of cache node instances to reserve.
Default: 1
list
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(dict) --
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
Key (string) --
The key for the tag. May not be null.
Value (string) --
The tag's value. May be null.
dict
Response Syntax
{
'ReservedCacheNode': {
'ReservedCacheNodeId': 'string',
'ReservedCacheNodesOfferingId': 'string',
'CacheNodeType': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CacheNodeCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ReservationARN': 'string'
}
}
Response Structure
(dict) --
ReservedCacheNode (dict) --
Represents the output of a PurchaseReservedCacheNodesOffering operation.
ReservedCacheNodeId (string) --
The unique identifier for the reservation.
ReservedCacheNodesOfferingId (string) --
The offering identifier.
CacheNodeType (string) --
The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation: 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
Note
For region availability, see Supported Node Types
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 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) 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) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: 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
Note
For region availability, see Supported Node Types
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) 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.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved cache node.
UsagePrice (float) --
The hourly price charged for this reserved cache node.
CacheNodeCount (integer) --
The number of cache nodes that have been reserved.
ProductDescription (string) --
The description of the reserved cache node.
OfferingType (string) --
The offering type of this reserved cache node.
State (string) --
The state of the reserved cache node.
RecurringCharges (list) --
The recurring price charged to run this reserved cache node.
(dict) --
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
ReservationARN (string) --
The Amazon Resource Name (ARN) of the reserved cache node.
Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582