ElastiCache Replication Group

An ElastiCache Replication Group in AWS is a collection of one or more Redis cache clusters that work together to provide high availability, automatic failover, and data replication. It allows you to scale read capacity with read replicas, improve fault tolerance, and maintain data consistency across nodes. This resource is commonly used for workloads requiring fast in-memory data access with resilience and scalability.

aws.elasticache_replication_group

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
arncorestringThe ARN (Amazon Resource Name) of the replication group.
at_rest_encryption_enabledcoreboolA flag that enables encryption at-rest when set to true. You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false
auth_token_enabledcoreboolA flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands. Default: false
auth_token_last_modified_datecoretimestampThe date the auth token was last modified
auto_minor_version_upgradecoreboolIf you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
automatic_failovercorestringIndicates the status of automatic failover for this Valkey or Redis OSS replication group.
cache_node_typecorestringThe name of the compute and memory capacity node type for each node in the replication group.
cluster_enabledcoreboolA 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
cluster_modecorestringEnabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
configuration_endpointcorejsonThe configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
data_tieringcorestringEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
descriptioncorestringThe user supplied description of the replication group.
enginecorestringThe engine used in a replication group. The options are redis, memcached or valkey.
global_replication_group_infocorejsonThe name of the Global datastore and role of this replication group in the Global datastore.
ip_discoverycorestringThe network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
kms_key_idcorestringThe ID of the KMS key used to encrypt the disk in the cluster.
log_delivery_configurationscorejsonReturns the destination, format and type of the logs.
member_clusterscorearray<string>The names of all the cache clusters that are part of this replication group.
member_clusters_outpost_arnscorearray<string>The outpost ARNs of the replication group's member clusters.
multi_azcorestringA flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
network_typecorestringMust be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
node_groupscorejsonA list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
pending_modified_valuescorejsonA group of settings to be applied to the replication group, either immediately or during the next maintenance window.
replication_group_create_timecoretimestampThe date and time when the cluster was created.
replication_group_idcorestringThe identifier for the replication group.
snapshot_retention_limitcoreint64The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
snapshot_windowcorestringThe 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. This parameter is only valid if the Engine parameter is redis.
snapshotting_cluster_idcorestringThe cluster ID that is used as the daily snapshot source for the replication group.
statuscorestringThe current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
tagscorehstore
transit_encryption_enabledcoreboolA flag that enables in-transit encryption when set to true. Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later. Default: false
transit_encryption_modecorestringA setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
user_group_idscorearray<string>The ID of the user group associated to the replication group.