Amazon ElastiCache
API Reference (API Version 2015-02-02)


Contains all of the attributes of a specific Redis replication group.



In the following list, the required parameters are described first.


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.

Type: String

Valid Values: enabled | disabled | enabling | disabling

Required: No


The name of the compute and memory capacity node type for each node in the replication group.

Type: String

Required: No


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

Type: Boolean

Required: No


The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

Type: Endpoint object

Required: No


The description of the replication group.

Type: String

Required: No


The names of all the cache clusters that are part of this replication group.

Type: Array of strings

Required: No


A single element list with information about the nodes in the replication group.

Type: Array of NodeGroup objects

Required: No


A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

Type: ReplicationGroupPendingModifiedValues object

Required: No


The identifier for the replication group.

Type: String

Required: No


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.


If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Type: Integer

Required: No


The cache cluster ID that is used as the daily snapshot source for the replication group.

Type: String

Required: No


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.

Type: String

Required: No


The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: