Builder
Properties
A flag that enables encryption at rest when set to true
.
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
The compute and memory capacity of the nodes in the node group (shard).
The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
A list of cache security group names to associate with this replication group.
The name of the cache subnet group to be used for the replication group.
Enabled 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.
Enables 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.
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions
operation.
The name of the Global datastore
The network type you choose when creating a replication group, 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.
Specifies the destination, format and type of the logs.
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
Must 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 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system.
A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone
, ReplicaAvailabilityZones
, ReplicaCount
, and Slots
.
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The number of clusters this replication group initially has.
An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. For Valkey or Redis OSS (cluster mode disabled) either omit this parameter or set it to 1.
A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available
.
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
A user-created description for the replication group.
The replication group identifier. This parameter is stored as a lowercase string.
One or more Amazon VPC security groups associated with this replication group.
The name of the snapshot used to create a replication group. Available for Valkey, Redis OSS only.
A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring
while the new replication group is being created.
The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before being deleted.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey
, Value=myKeyValue
. You can include multiple tags as shown following: Key=myKey
, Value=myKeyValue
Key=mySecondKey
, Value=mySecondKeyValue
. Tags on replication groups will be replicated to all nodes.
A flag that enables in-transit encryption when set to true
.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
The user group to associate with the replication group.