2016/03/24 - Amazon ElastiCache - 1 new7 updated api methods
The ListAllowedNodeTypeModifications action lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.
When you use the ModifyCacheCluster or ModifyReplicationGroup APIs to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this action.
Request Syntax
client.list_allowed_node_type_modifications(
CacheClusterId='string',
ReplicationGroupId='string'
)
string
The name of the cache cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to to create a list of node types you can scale up to.
Important: You must provide a value for either the CacheClusterId or the ReplicationGroupId.
string
The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.
Important: You must provide a value for either the CacheClusterId or the ReplicationGroupId.
dict
Response Syntax
{
'ScaleUpModifications': [
'string',
]
}
Response Structure
(dict) --
Represents the allowed node types you can use to modify your cache cluster or replication group.
ScaleUpModifications (list) --
A string list, each element of which specifies a cache node type which you can use to scale your cache cluster or replication group.
When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
(string) --
{'TargetBucket': 'string'}
The CopySnapshot action makes a copy of an existing snapshot.
Request Syntax
client.copy_snapshot(
SourceSnapshotName='string',
TargetSnapshotName='string',
TargetBucket='string'
)
string
[REQUIRED]
The name of an existing snapshot from which to copy.
string
[REQUIRED]
A name for the copied snapshot.
string
dict
Response Syntax
{
'Snapshot': {
'SnapshotName': 'string',
'CacheClusterId': 'string',
'SnapshotStatus': 'string',
'SnapshotSource': 'string',
'CacheNodeType': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'NumCacheNodes': 123,
'PreferredAvailabilityZone': 'string',
'CacheClusterCreateTime': datetime(2015, 1, 1),
'PreferredMaintenanceWindow': 'string',
'TopicArn': 'string',
'Port': 123,
'CacheParameterGroupName': 'string',
'CacheSubnetGroupName': 'string',
'VpcId': 'string',
'AutoMinorVersionUpgrade': True|False,
'SnapshotRetentionLimit': 123,
'SnapshotWindow': 'string',
'NodeSnapshots': [
{
'CacheNodeId': 'string',
'CacheSize': 'string',
'CacheNodeCreateTime': datetime(2015, 1, 1),
'SnapshotCreateTime': datetime(2015, 1, 1)
},
]
}
}
Response Structure
(dict) --
Snapshot (dict) --
Represents a copy of an entire cache cluster as of the time when the snapshot was taken.
SnapshotName (string) --
The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
CacheClusterId (string) --
The user-supplied identifier of the source cache cluster.
SnapshotStatus (string) --
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
SnapshotSource (string) --
Indicates whether the snapshot is from an automatic backup ( automated) or was created manually ( manual).
CacheNodeType (string) --
The name of the compute and memory capacity node type for the source cache cluster.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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) used by the source cache cluster.
EngineVersion (string) --
The version of the cache engine version that is used by the source cache cluster.
NumCacheNodes (integer) --
The number of cache nodes in the source 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 source cache cluster is located.
CacheClusterCreateTime (datetime) --
The date and time when the source cache cluster was created.
PreferredMaintenanceWindow (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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
TopicArn (string) --
The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.
Port (integer) --
The port number used by each cache nodes in the source cache cluster.
CacheParameterGroupName (string) --
The cache parameter group that is associated with the source cache cluster.
CacheSubnetGroupName (string) --
The name of the cache subnet group associated with the source cache cluster.
VpcId (string) --
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.
AutoMinorVersionUpgrade (boolean) --
This parameter is currently disabled.
SnapshotRetentionLimit (integer) --
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.
**Important**If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
SnapshotWindow (string) --
The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.
NodeSnapshots (list) --
A list of the cache nodes in the source cache cluster.
(dict) --
Represents an individual cache node in a snapshot of a cache cluster.
CacheNodeId (string) --
The cache node identifier for the node in the source cache cluster.
CacheSize (string) --
The size of the cache on the source cache node.
CacheNodeCreateTime (datetime) --
The date and time when the cache node was created in the source cache cluster.
SnapshotCreateTime (datetime) --
The date and time when the source node's metadata and cache data set was obtained for the snapshot.
{'CacheCluster': {'PendingModifiedValues': {'CacheNodeType': 'string'}}}
The CreateCacheCluster action creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
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'
)
string
[REQUIRED]
The node 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
The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be 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 will be 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 node group 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 will be 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 will be created. The order of the zones in the list is not important.
This option is only supported on Memcached.
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.
Example: One Memcached node in each of three different Availability Zones:
Example: All three Memcached nodes in one Availability Zone:
(string) --
integer
The initial number of cache nodes that the cache cluster will have.
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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 action.
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.
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 (VPC).
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 (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 (VPC).
(string) --
list
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.
(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.
Value (string) --
The tag's value. May not 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 will be used to populate the node group. 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 snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
integer
The port number on which each of the cache nodes will accept connections.
string
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.
boolean
This parameter is currently disabled.
integer
The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be 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 will begin taking a daily snapshot of your node group.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
Note: This parameter is only valid if the Engine parameter is redis.
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'
}
}
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 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.
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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
PendingModifiedValues (dict) --
A group of settings that will be 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 will run.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group will be 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) --
The 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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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, then 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
**Important**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 will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
{'CacheCluster': {'PendingModifiedValues': {'CacheNodeType': 'string'}}}
The DeleteCacheCluster action 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 action, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this action.
This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has Multi-AZ mode enabled.
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'
}
}
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 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.
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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
PendingModifiedValues (dict) --
A group of settings that will be 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 will run.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group will be 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) --
The 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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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, then 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
**Important**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 will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
{'CacheClusters': {'PendingModifiedValues': {'CacheNodeType': 'string'}}}
The DescribeCacheClusters action 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(s) will be returned. You can use the optional ShowDetails 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 will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be 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.
Request Syntax
client.describe_cache_clusters(
CacheClusterId='string',
MaxRecords=123,
Marker='string',
ShowCacheNodeInfo=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 action. 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.
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'
},
]
}
Response Structure
(dict) --
Represents the output of a DescribeCacheClusters action.
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 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.
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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
PendingModifiedValues (dict) --
A group of settings that will be 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 will run.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group will be 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) --
The 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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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, then 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
**Important**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 will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
{'CacheNodeType': 'string'}
Response {'CacheCluster': {'PendingModifiedValues': {'CacheNodeType': 'string'}}}
The ModifyCacheCluster action modifies the settings for a cache cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
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), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then 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 action. See ApplyImmediately. A pending action 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 actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action 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 action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions 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 ModifyCacheCluser 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.
list
The list of Availability Zones where the new Memcached cache nodes will be 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 actions. Specify NumCacheNodes=3 to cancel all pending actions.
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. 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.
Example:
(string) --
list
A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.
This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (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 (VPC).
(string) --
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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
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, then changes to the cache cluster 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 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be 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 will begin taking a daily snapshot of your cache cluster.
string
A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.
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'
}
}
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 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.
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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
PendingModifiedValues (dict) --
A group of settings that will be 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 will run.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group will be 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) --
The 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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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, then 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
**Important**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 will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00
{'CacheNodeType': 'string'}
The ModifyReplicationGroup action modifies the settings for a replication group.
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'
)
string
[REQUIRED]
The identifier of the replication group to modify.
string
A description for the replication group. Maximum length is 255 characters.
string
If this parameter is specified, ElastiCache will promote the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group will be read replicas.
string
The cache cluster ID that will be used as the daily snapshot source for the replication group.
boolean
Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
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 (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 (VPC).
(string) --
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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
string
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
string
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
string
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values: active | inactive
boolean
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false, then 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 will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be 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 will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
string
A valid cache node type that you want to scale this replication group to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.
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
},
'NodeGroupMembers': [
{
'CacheClusterId': 'string',
'CacheNodeId': 'string',
'ReadEndpoint': {
'Address': 'string',
'Port': 123
},
'PreferredAvailabilityZone': 'string',
'CurrentRole': 'string'
},
]
},
],
'SnapshottingClusterId': 'string',
'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling'
}
}
Response Structure
(dict) --
ReplicationGroup (dict) --
Contains all of the attributes of a specific 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, etc.
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 which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.
AutomaticFailoverStatus (string) --
Indicates the status of Multi-AZ for this replication group.
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.
NodeGroupId (string) --
The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.
Status (string) --
The current state of this replication group - creating, available, etc.
PrimaryEndpoint (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.
NodeGroupMembers (list) --
A list containing information about individual nodes within the node group.
(dict) --
Represents a single node within a node group.
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 for this replication group.
{'CacheCluster': {'PendingModifiedValues': {'CacheNodeType': 'string'}}}
The RebootCacheCluster action reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action 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.
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'
}
}
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 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.
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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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 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:
sun
mon
tue
wed
thu
fri
sat
Example: sun:05:00-sun:09:00
PendingModifiedValues (dict) --
A group of settings that will be 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 will run.
CacheNodeType (string) --
The cache node type that this cache cluster or replication group will be 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) --
The 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.
Valid node types are as follows:
General purpose:
Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
Compute optimized: cache.c1.xlarge
Memory optimized
Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
Notes:
All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
Redis backup/restore is not supported for t2 instances.
Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.
For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and 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, then 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 will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.
**Important**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 will begin taking a daily snapshot of your cache cluster.
Example: 05:00-09:00