Builder

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

If you are running Valkey or Redis OSS 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.

A valid cache node type that you want to scale this replication group to.

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

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.

Modifies the engine listed in a replication group message. The options are redis, memcached or valkey.

The upgraded version of the cache engine to be run on the clusters in the replication group.

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 and 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 to indicate MultiAZ is enabled.

Deprecated. This parameter is not used.

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

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.

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Removes the user group associated with this replication group.

A description for the replication group. Maximum length is 255 characters.

The identifier of the replication group to modify.

Specifies the VPC Security Groups associated with the clusters in the replication group.

The number of days for which ElastiCache retains automatic node group (shard) 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 cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.

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

A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.

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

The ID of the user group you are associating with the replication group.

The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.