2017/10/24 - Amazon ElastiCache - 10 updated api methods
Changes Amazon ElastiCache for Redis today announced support for data encryption both for data in-transit and data at-rest. The new encryption in-transit functionality enables ElastiCache for Redis customers to encrypt data for all communication between clients and Redis engine, and all intra-cluster Redis communication. The encryption at-rest functionality allows customers to encrypt their S3 based backups. Customers can begin using the new functionality by simply enabling this functionality via AWS console, and a small configuration change in their Redis clients. The ElastiCache for Redis service automatically manages life cycle of the certificates required for encryption, including the issuance, renewal and expiration of certificates. Additionally, as part of this launch, customers will gain the ability to start using the Redis AUTH command that provides an added level of authentication.
{'CacheCluster': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
See also: AWS API Documentation
Request Syntax
client.create_cache_cluster(
CacheClusterId='string',
ReplicationGroupId='string',
AZMode='single-az'|'cross-az',
PreferredAvailabilityZone='string',
PreferredAvailabilityZones=[
'string',
],
NumCacheNodes=123,
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'
)
string
[REQUIRED]
The node group (shard) identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 20 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
string
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster is added to the specified replication group as a read replica; otherwise, the cache cluster is a standalone primary that is not part of any replication group.
If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cache cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
Note
This parameter is only valid if the Engine parameter is redis .
string
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
This parameter is only supported for Memcached cache clusters.
If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
string
The EC2 Availability Zone in which the cache cluster is created.
All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones .
Default: System chosen Availability Zone.
list
A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
This option is only supported on Memcached.
Note
If you are creating your cache cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheNodes .
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
(string) --
integer
The initial number of cache nodes that the cache cluster has.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
string
The name of the cache engine to be used for this cache cluster.
Valid values for this parameter are: memcached | redis
string
The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster or replication group and create it anew with the earlier engine version.
string
The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.
string
The name of the subnet group to be used for the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (Amazon VPC).
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 security group names to associate with this cache cluster.
Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
(string) --
list
One or more VPC security groups associated with the cache cluster.
Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (Amazon VPC).
(string) --
list
A list of cost allocation tags to be added to this resource.
(dict) --
A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. 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 single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.
Note
This parameter is only valid if the Engine parameter is redis .
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
(string) --
string
The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.
Note
This parameter is only valid if the Engine parameter is redis .
string
Specifies the weekly time range during which maintenance on the cache 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 of the cache nodes 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 cache cluster owner.
boolean
This parameter is currently disabled.
integer
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.
Note
This parameter is only valid if the Engine parameter is redis .
Default: 0 (i.e., automatic backups are disabled for this cache 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.
Note
This parameter is only valid if the Engine parameter is redis .
string
Reserved parameter. The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or '@'.
For more information, see AUTH password at http://redis.io/commands/AUTH.
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
Response Structure
(dict) --
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache 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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Engine (string) --
The name of the cache engine ( memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster, one of the following values: available , creating , deleted , deleting , incompatible-network , modifying , rebooting cache cluster nodes , restore-failed , or snapshotting .
NumCacheNodes (integer) --
The number of cache nodes in the cache 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 cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache 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
PendingModifiedValues (dict) --
A group of settings that are applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster runs.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group is scaled to.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
Status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status.
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache retains automatic cache 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 cache cluster.
Example: 05:00-09:00
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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 at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Default: false
{'AtRestEncryptionEnabled': 'boolean', 'TransitEncryptionEnabled': 'boolean'}
Response {'ReplicationGroup': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
A Redis (cluster mode disabled) replication group is a collection of cache clusters, where one of the cache 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) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).
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. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing 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',
PrimaryClusterId='string',
AutomaticFailoverEnabled=True|False,
NumCacheClusters=123,
PreferredCacheClusterAZs=[
'string',
],
NumNodeGroups=123,
ReplicasPerNodeGroup=123,
NodeGroupConfiguration=[
{
'Slots': 'string',
'ReplicaCount': 123,
'PrimaryAvailabilityZone': 'string',
'ReplicaAvailabilityZones': [
'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
)
string
[REQUIRED]
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 20 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 identifier of the cache cluster that serves as the primary for this replication group. This cache 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.
If true , Multi-AZ is enabled for this replication group. If false , Multi-AZ is disabled for this replication group.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
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 (primary plus 5 replicas).
list
A list of EC2 Availability Zones in which the replication group's cache 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 cache 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: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
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.
(dict) --
node group (shard) configuration options. Each node group (shard) configuration has the following: Slots , PrimaryAvailabilityZone , ReplicaAvailabilityZones , ReplicaCount .
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) --
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
string
The name of the cache engine to be used for the cache clusters in this replication group.
string
The version number of the cache engine to be used for the cache 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 cache 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 cost allocation tags to be added to this resource. A tag is a key-value pair.
(dict) --
A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. 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 cache 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 cache cluster owner.
boolean
This parameter is currently disabled.
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 cache 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.
This parameter is valid only if:
The parameter TransitEncryptionEnabled was set to true when the cluster was created.
The line requirepass was added to the database configuration file.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
Cannot contain any of the following characters: '/', '"', or '@'.
For more information, see AUTH password at http://redis.io/commands/AUTH.
boolean
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
This parameter is valid only if the Engine parameter is redis , the EngineVersion parameter is 3.2.4 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 .
Default: false
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.
Note
This parameter is valid only if the Engine parameter is redis and the cluster is being created in an Amazon VPC.
Default: false
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
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 description of the replication group.
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 Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(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 15 node groups numbered 0001 to 0015.
Status (string) --
The current state of this replication group - creating , available , etc.
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.
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 cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
ConfigurationEndpoint (dict) --
The configuration endpoint for this replicaiton 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 cache 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
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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.
Default: false
{'CacheCluster': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.
This operation cannot be used to delete a cache cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cache cluster from a Redis (cluster mode enabled) replication group.
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
See also: AWS API Documentation
Request Syntax
client.delete_cache_cluster(
CacheClusterId='string',
FinalSnapshotIdentifier='string'
)
string
[REQUIRED]
The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
string
The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
Response Structure
(dict) --
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache 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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Engine (string) --
The name of the cache engine ( memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster, one of the following values: available , creating , deleted , deleting , incompatible-network , modifying , rebooting cache cluster nodes , restore-failed , or snapshotting .
NumCacheNodes (integer) --
The number of cache nodes in the cache 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 cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache 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
PendingModifiedValues (dict) --
A group of settings that are applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster runs.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group is scaled to.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
Status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status.
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache retains automatic cache 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 cache cluster.
Example: 05:00-09:00
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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 at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Default: false
{'ReplicationGroup': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true .
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
client.delete_replication_group(
ReplicationGroupId='string',
RetainPrimaryCluster=True|False,
FinalSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier for the cluster to be deleted. This parameter is not case sensitive.
boolean
If set to true , all of the read replicas are deleted, but the primary node is retained.
string
The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
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 description of the replication group.
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 Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(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 15 node groups numbered 0001 to 0015.
Status (string) --
The current state of this replication group - creating , available , etc.
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.
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 cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
ConfigurationEndpoint (dict) --
The configuration endpoint for this replicaiton 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 cache 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
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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.
Default: false
{'CacheClusters': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.
By default, abbreviated information about the cache clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.
If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.
See also: AWS API Documentation
Request Syntax
client.describe_cache_clusters(
CacheClusterId='string',
MaxRecords=123,
Marker='string',
ShowCacheNodeInfo=True|False,
ShowCacheClustersNotInReplicationGroups=True|False
)
string
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.
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 .
boolean
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
boolean
An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.
dict
Response Syntax
{
'Marker': 'string',
'CacheClusters': [
{
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheClusters operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
CacheClusters (list) --
A list of cache clusters. Each item in the list contains detailed information about one cache cluster.
(dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache 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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Engine (string) --
The name of the cache engine ( memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster, one of the following values: available , creating , deleted , deleting , incompatible-network , modifying , rebooting cache cluster nodes , restore-failed , or snapshotting .
NumCacheNodes (integer) --
The number of cache nodes in the cache 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 cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache 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
PendingModifiedValues (dict) --
A group of settings that are applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster runs.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group is scaled to.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
Status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status.
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache retains automatic cache 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 cache cluster.
Example: 05:00-09:00
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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 at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Default: false
{'ReplicationGroups': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
client.describe_replication_groups(
ReplicationGroupId='string',
MaxRecords=123,
Marker='string'
)
string
The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
string
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'ReplicationGroups': [
{
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeReplicationGroups operation.
Marker (string) --
Provides an identifier to allow retrieval of paginated results.
ReplicationGroups (list) --
A list of replication groups. Each item in the list contains detailed information about one replication group.
(dict) --
Contains all of the attributes of a specific Redis replication group.
ReplicationGroupId (string) --
The identifier for the replication group.
Description (string) --
The description of the replication group.
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 Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(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 15 node groups numbered 0001 to 0015.
Status (string) --
The current state of this replication group - creating , available , etc.
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.
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 cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
ConfigurationEndpoint (dict) --
The configuration endpoint for this replicaiton 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 cache 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
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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.
Default: false
{'CacheCluster': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
See also: AWS API Documentation
Request Syntax
client.modify_cache_cluster(
CacheClusterId='string',
NumCacheNodes=123,
CacheNodeIdsToRemove=[
'string',
],
AZMode='single-az'|'cross-az',
NewAvailabilityZones=[
'string',
],
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
CacheNodeType='string'
)
string
[REQUIRED]
The cache cluster identifier. This value is stored as a lowercase string.
integer
The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
Note
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately ).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.
list
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
(string) --
string
Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values: single-az | cross-az .
This option is only supported for Memcached cache clusters.
Note
You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
list
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
This option is only supported on Memcached clusters.
Scenarios:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Warning
Important: If the new create request is Apply Immediately - Yes , all creates are performed immediately. If the new create request is Apply Immediately - No , all creates are pending.
(string) --
list
A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
(string) --
list
Specifies the VPC Security Groups associated with the cache cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
(string) --
string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
Note
The Amazon SNS topic owner must be same as the cache cluster owner.
string
The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
string
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active .
Valid values: active | inactive
boolean
If true , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.
If false , changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Warning
If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.
Valid values: true | false
Default: false
string
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.
boolean
This parameter is currently disabled.
integer
The number of days for which ElastiCache retains automatic cache 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.
Note
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
string
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.
string
A valid cache node type that you want to scale this cache cluster up to.
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
Response Structure
(dict) --
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache 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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Engine (string) --
The name of the cache engine ( memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster, one of the following values: available , creating , deleted , deleting , incompatible-network , modifying , rebooting cache cluster nodes , restore-failed , or snapshotting .
NumCacheNodes (integer) --
The number of cache nodes in the cache 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 cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache 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
PendingModifiedValues (dict) --
A group of settings that are applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster runs.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group is scaled to.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
Status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status.
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache retains automatic cache 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 cache cluster.
Example: 05:00-09:00
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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 at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Default: false
{'ReplicationGroup': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Modifies the settings for a replication group.
Warning
Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.
Note
This operation is valid for Redis only.
See also: AWS API Documentation
Request Syntax
client.modify_replication_group(
ReplicationGroupId='string',
ReplicationGroupDescription='string',
PrimaryClusterId='string',
SnapshottingClusterId='string',
AutomaticFailoverEnabled=True|False,
CacheSecurityGroupNames=[
'string',
],
SecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
NotificationTopicArn='string',
CacheParameterGroupName='string',
NotificationTopicStatus='string',
ApplyImmediately=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
SnapshotRetentionLimit=123,
SnapshotWindow='string',
CacheNodeType='string',
NodeGroupId='string'
)
string
[REQUIRED]
The identifier of the replication group to modify.
string
A description for the replication group. Maximum length is 255 characters.
string
For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
string
The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
boolean
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
list
A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default .
(string) --
list
Specifies the VPC Security Groups associated with the cache clusters in the replication group.
This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
(string) --
string
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
Note
The Amazon SNS topic owner must be same as the replication group owner.
string
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
string
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active .
Valid values: active | inactive
boolean
If true , this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false , changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
string
The upgraded version of the cache engine to be run on the cache clusters in the replication group.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
boolean
This parameter is currently disabled.
integer
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
string
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId .
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
string
A valid cache node type that you want to scale this replication group to.
string
The name of the Node Group (called shard in the console).
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
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 description of the replication group.
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 Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(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 15 node groups numbered 0001 to 0015.
Status (string) --
The current state of this replication group - creating , available , etc.
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.
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 cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
ConfigurationEndpoint (dict) --
The configuration endpoint for this replicaiton 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 cache 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
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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.
Default: false
{'CacheCluster': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Reboots some, or all, of the cache nodes within a provisioned cache cluster. This operation applies any modified cache parameter groups to the cache cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cache cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
See also: AWS API Documentation
Request Syntax
client.reboot_cache_cluster(
CacheClusterId='string',
CacheNodeIdsToReboot=[
'string',
]
)
string
[REQUIRED]
The cache cluster identifier. This parameter is stored as a lowercase string.
list
[REQUIRED]
A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.
(string) --
dict
Response Syntax
{
'CacheCluster': {
'CacheClusterId': 'string',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'ClientDownloadLandingPage': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'CacheClusterStatus': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'NumCacheNodes': 123,
'CacheNodeIdsToRemove': [
'string',
],
'EngineVersion': 'string',
'CacheNodeType': 'string'
},
'NotificationConfiguration': {
'TopicArn': 'string',
'TopicStatus': 'string'
},
'CacheSecurityGroups': [
{
'CacheSecurityGroupName': 'string',
'Status': 'string'
},
],
'CacheParameterGroup': {
'CacheParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'CacheNodeIdsToReboot': [
'string',
]
},
'CacheSubnetGroupName': 'string',
'CacheNodes': [
{
'CacheNodeId': 'string',
'CacheNodeStatus': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ParameterGroupStatus': 'string',
'SourceCacheNodeId': 'string',
'CustomerAvailabilityZone': 'string'
},
],
'AutoMinorVersionUpgrade': True|False,
'SecurityGroups': [
{
'SecurityGroupId': 'string',
'Status': 'string'
},
],
'ReplicationGroupId': 'string',
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
Response Structure
(dict) --
CacheCluster (dict) --
Contains all of the attributes of a specific cache cluster.
CacheClusterId (string) --
The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.
ConfigurationEndpoint (dict) --
Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ClientDownloadLandingPage (string) --
The URL of the web page where you can download the latest ElastiCache client library.
CacheNodeType (string) --
The name of the compute and memory capacity node type for the cache 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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
Engine (string) --
The name of the cache engine ( memcached or redis ) to be used for this cache cluster.
EngineVersion (string) --
The version of the cache engine that is used in this cache cluster.
CacheClusterStatus (string) --
The current state of this cache cluster, one of the following values: available , creating , deleted , deleting , incompatible-network , modifying , rebooting cache cluster nodes , restore-failed , or snapshotting .
NumCacheNodes (integer) --
The number of cache nodes in the cache 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 cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
CacheClusterCreateTime (datetime) --
The date and time when the cache 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
PendingModifiedValues (dict) --
A group of settings that are applied to the cache cluster in the future, or that are currently being applied.
NumCacheNodes (integer) --
The new number of cache nodes for the cache cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.
CacheNodeIdsToRemove (list) --
A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
EngineVersion (string) --
The new cache engine version that the cache cluster runs.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group is scaled to.
NotificationConfiguration (dict) --
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
TopicArn (string) --
The Amazon Resource Name (ARN) that identifies the topic.
TopicStatus (string) --
The current state of the topic.
CacheSecurityGroups (list) --
A list of cache security group elements, composed of name and status sub-elements.
(dict) --
Represents a cache cluster's status within a particular cache security group.
CacheSecurityGroupName (string) --
The name of the cache security group.
Status (string) --
The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
CacheParameterGroup (dict) --
Status of the cache parameter group.
CacheParameterGroupName (string) --
The name of the cache parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
CacheNodeIdsToReboot (list) --
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
(string) --
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the cache cluster.
CacheNodes (list) --
A list of cache nodes that are members of the cache cluster.
(dict) --
Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
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: T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge
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
Compute optimized:
Previous generation: (not recommended) C1 node types: cache.c1.xlarge
Memory optimized:
Current generation: R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge
Previous generation: (not recommended) M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
Supported node types are available in all regions except as noted in the following table.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
CacheNodeId (string) --
The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.
CacheNodeStatus (string) --
The current state of this cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created.
Endpoint (dict) --
The hostname for connecting to this cache node.
Address (string) --
The DNS hostname of the cache node.
Port (integer) --
The port number that the cache engine is listening on.
ParameterGroupStatus (string) --
The status of the parameter group applied to this cache node.
SourceCacheNodeId (string) --
The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cache cluster.
CustomerAvailabilityZone (string) --
The Availability Zone where this node was created and now resides.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SecurityGroups (list) --
A list of VPC Security Groups associated with the cache cluster.
(dict) --
Represents a single cache security group and its status.
SecurityGroupId (string) --
The identifier of the cache security group.
Status (string) --
The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.
ReplicationGroupId (string) --
The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.
SnapshotRetentionLimit (integer) --
The number of days for which ElastiCache retains automatic cache 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 cache cluster.
Example: 05:00-09:00
AuthTokenEnabled (boolean) --
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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 at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Default: false
{'ReplicationGroup': {'AtRestEncryptionEnabled': 'boolean',
'AuthTokenEnabled': 'boolean',
'TransitEncryptionEnabled': 'boolean'}}
Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed
Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide .
See also: AWS API Documentation
Request Syntax
client.test_failover(
ReplicationGroupId='string',
NodeGroupId='string'
)
string
[REQUIRED]
The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
string
[REQUIRED]
The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
dict
Response Syntax
{
'ReplicationGroup': {
'ReplicationGroupId': 'string',
'Description': 'string',
'Status': 'string',
'PendingModifiedValues': {
'PrimaryClusterId': 'string',
'AutomaticFailoverStatus': 'enabled'|'disabled'
},
'MemberClusters': [
'string',
],
'NodeGroups': [
{
'NodeGroupId': 'string',
'Status': 'string',
'PrimaryEndpoint': {
'Address': 'string',
'Port': 123
},
'Slots': 'string',
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
'ConfigurationEndpoint': {
'Address': 'string',
'Port': 123
},
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'ClusterEnabled': True|False,
'CacheNodeType': 'string',
'AuthTokenEnabled': True|False,
'TransitEncryptionEnabled': True|False,
'AtRestEncryptionEnabled': True|False
}
}
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 description of the replication group.
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 Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
MemberClusters (list) --
The names of all the cache clusters that are part of this replication group.
(string) --
NodeGroups (list) --
A single element list with information about the nodes in the replication group.
(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 15 node groups numbered 0001 to 0015.
Status (string) --
The current state of this replication group - creating , available , etc.
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.
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 cache cluster to which the node belongs.
CacheNodeId (string) --
The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).
ReadEndpoint (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.
PreferredAvailabilityZone (string) --
The name of the Availability Zone in which the node is located.
CurrentRole (string) --
The role that is currently assigned to the node - primary or replica .
SnapshottingClusterId (string) --
The cache cluster ID that is used as the daily snapshot source for the replication group.
AutomaticFailover (string) --
Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
ConfigurationEndpoint (dict) --
The configuration endpoint for this replicaiton 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 cache 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
TransitEncryptionEnabled (boolean) --
A flag that enables in-transit encryption when set to true .
You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.
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.
Default: false