ReplicationGroup

Contains all of the attributes of a specific Valkey or Redis OSS replication group.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The date the auth token was last modified

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The user supplied description of the replication group.

Link copied to clipboard

The engine used in a replication group. The options are redis, memcached or valkey.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the destination, format and type of the logs.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

Link copied to clipboard

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

Link copied to clipboard

A 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).

Link copied to clipboard

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

Link copied to clipboard

The date and time when the cluster was created.

Link copied to clipboard

The identifier for the replication group.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: ReplicationGroup.Builder.() -> Unit = {}): ReplicationGroup
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String