Documentation

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

See: newReplicationGroup smart constructor.

Create a value of ReplicationGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:ReplicationGroup', replicationGroup_arn - The ARN (Amazon Resource Name) of the replication group.

$sel:atRestEncryptionEnabled:ReplicationGroup', replicationGroup_atRestEncryptionEnabled - A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

$sel:authTokenEnabled:ReplicationGroup', replicationGroup_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

$sel:authTokenLastModifiedDate:ReplicationGroup', replicationGroup_authTokenLastModifiedDate - The date the auth token was last modified

$sel:autoMinorVersionUpgrade:ReplicationGroup', replicationGroup_autoMinorVersionUpgrade - If you are running Redis engine version 6.0 or later, 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.

$sel:automaticFailover:ReplicationGroup', replicationGroup_automaticFailover - Indicates the status of automatic failover for this Redis replication group.

$sel:cacheNodeType:ReplicationGroup', replicationGroup_cacheNodeType - The name of the compute and memory capacity node type for each node in the replication group.

$sel:clusterEnabled:ReplicationGroup', replicationGroup_clusterEnabled - 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

$sel:configurationEndpoint:ReplicationGroup', replicationGroup_configurationEndpoint - The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

$sel:dataTiering:ReplicationGroup', replicationGroup_dataTiering - 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.

$sel:description:ReplicationGroup', replicationGroup_description - The user supplied description of the replication group.

$sel:globalReplicationGroupInfo:ReplicationGroup', replicationGroup_globalReplicationGroupInfo - The name of the Global datastore and role of this replication group in the Global datastore.

$sel:ipDiscovery:ReplicationGroup', replicationGroup_ipDiscovery - The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

$sel:kmsKeyId:ReplicationGroup', replicationGroup_kmsKeyId - The ID of the KMS key used to encrypt the disk in the cluster.

ReplicationGroup, replicationGroup_logDeliveryConfigurations - Returns the destination, format and type of the logs.

$sel:memberClusters:ReplicationGroup', replicationGroup_memberClusters - The names of all the cache clusters that are part of this replication group.

$sel:memberClustersOutpostArns:ReplicationGroup', replicationGroup_memberClustersOutpostArns - The outpost ARNs of the replication group's member clusters.

$sel:multiAZ:ReplicationGroup', replicationGroup_multiAZ - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

$sel:networkType:ReplicationGroup', replicationGroup_networkType - Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

$sel:nodeGroups:ReplicationGroup', replicationGroup_nodeGroups - A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

$sel:pendingModifiedValues:ReplicationGroup', replicationGroup_pendingModifiedValues - A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

$sel:replicationGroupCreateTime:ReplicationGroup', replicationGroup_replicationGroupCreateTime - The date and time when the cluster was created.

$sel:replicationGroupId:ReplicationGroup', replicationGroup_replicationGroupId - The identifier for the replication group.

$sel:snapshotRetentionLimit:ReplicationGroup', replicationGroup_snapshotRetentionLimit - The 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.

$sel:snapshotWindow:ReplicationGroup', replicationGroup_snapshotWindow - 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.

This parameter is only valid if the Engine parameter is redis.

$sel:snapshottingClusterId:ReplicationGroup', replicationGroup_snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the replication group.

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

ReplicationGroup, replicationGroup_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

ReplicationGroup, replicationGroup_transitEncryptionMode - A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

$sel:userGroupIds:ReplicationGroup', replicationGroup_userGroupIds - The ID of the user group associated to the replication group.

The ARN (Amazon Resource Name) of the replication group.

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

The date the auth token was last modified

If you are running Redis engine version 6.0 or later, 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.

Indicates the status of automatic failover for this Redis replication group.

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

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

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

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 user supplied description of the replication group.

The name of the Global datastore and role of this replication group in the Global datastore.

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

The ID of the KMS key used to encrypt the disk in the cluster.

Returns the destination, format and type of the logs.

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

The outpost ARNs of the replication group's member clusters.

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 Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

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

The date and time when the cluster was created.

The identifier for the replication group.

The 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.

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.

This parameter is only valid if the Engine parameter is redis.

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

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

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

The ID of the user group associated to the replication group.