Modify Replication Group

elasticache_modify_replication_group

R Documentation

Modifies the settings for a replication group¶

Description¶

Modifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above.

Scaling for Valkey or Redis OSS (cluster mode enabled) in the ElastiCache User Guide
modify_replication_group_shard_configuration in the ElastiCache API Reference

This operation is valid for Valkey or Redis OSS only.

Usage¶

elasticache_modify_replication_group(ReplicationGroupId,
  ReplicationGroupDescription, PrimaryClusterId, SnapshottingClusterId,
  AutomaticFailoverEnabled, MultiAZEnabled, NodeGroupId,
  CacheSecurityGroupNames, SecurityGroupIds, PreferredMaintenanceWindow,
  NotificationTopicArn, CacheParameterGroupName, NotificationTopicStatus,
  ApplyImmediately, Engine, EngineVersion, AutoMinorVersionUpgrade,
  SnapshotRetentionLimit, SnapshotWindow, CacheNodeType, AuthToken,
  AuthTokenUpdateStrategy, UserGroupIdsToAdd, UserGroupIdsToRemove,
  RemoveUserGroups, LogDeliveryConfigurations, IpDiscovery,
  TransitEncryptionEnabled, TransitEncryptionMode, ClusterMode)

Arguments¶

ReplicationGroupId

[required] The identifier of the replication group to modify.

ReplicationGroupDescription

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

PrimaryClusterId

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.

SnapshottingClusterId

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.

AutomaticFailoverEnabled

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

Valid values: true | false

MultiAZEnabled

A flag to indicate MultiAZ is enabled.

NodeGroupId

Deprecated. This parameter is not used.

CacheSecurityGroupNames

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.

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

SecurityGroupIds

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

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

PreferredMaintenanceWindow

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.

Valid values for ddd are:

sun
mon
tue
wed
thu
fri
sat

Example: sun:23:00-mon:01:30

NotificationTopicArn

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

The Amazon SNS topic owner must be same as the replication group owner.

CacheParameterGroupName

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.

NotificationTopicStatus

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

Valid values: active | inactive

ApplyImmediately

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.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

Engine

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

EngineVersion

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

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

AutoMinorVersionUpgrade

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.

SnapshotRetentionLimit

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.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

SnapshotWindow

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

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

CacheNodeType

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

AuthToken

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:

Must be only printable ASCII characters
Must be at least 16 characters and no more than 128 characters in length
Cannot contain any of the following characters: '/', '"', or '@', '%'

For more information, see AUTH password at AUTH.

AuthTokenUpdateStrategy

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

ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC

For more information, see Authenticating Users with AUTH

UserGroupIdsToAdd

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

UserGroupIdsToRemove

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.

RemoveUserGroups

Removes the user group associated with this replication group.

LogDeliveryConfigurations

Specifies the destination, format and type of the logs.

IpDiscovery

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

TransitEncryptionEnabled

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.

TransitEncryptionMode

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

You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can set the value to required to allow encrypted connections only.

Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.

ClusterMode

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.

Value¶

A list with the following syntax:

list(
  ReplicationGroup = list(
    ReplicationGroupId = "string",
    Description = "string",
    GlobalReplicationGroupInfo = list(
      GlobalReplicationGroupId = "string",
      GlobalReplicationGroupMemberRole = "string"
    ),
    Status = "string",
    PendingModifiedValues = list(
      PrimaryClusterId = "string",
      AutomaticFailoverStatus = "enabled"|"disabled",
      Resharding = list(
        SlotMigration = list(
          ProgressPercentage = 123.0
        )
      ),
      AuthTokenStatus = "SETTING"|"ROTATING",
      UserGroups = list(
        UserGroupIdsToAdd = list(
          "string"
        ),
        UserGroupIdsToRemove = list(
          "string"
        )
      ),
      LogDeliveryConfigurations = list(
        list(
          LogType = "slow-log"|"engine-log",
          DestinationType = "cloudwatch-logs"|"kinesis-firehose",
          DestinationDetails = list(
            CloudWatchLogsDetails = list(
              LogGroup = "string"
            ),
            KinesisFirehoseDetails = list(
              DeliveryStream = "string"
            )
          ),
          LogFormat = "text"|"json"
        )
      ),
      TransitEncryptionEnabled = TRUE|FALSE,
      TransitEncryptionMode = "preferred"|"required",
      ClusterMode = "enabled"|"disabled"|"compatible"
    ),
    MemberClusters = list(
      "string"
    ),
    NodeGroups = list(
      list(
        NodeGroupId = "string",
        Status = "string",
        PrimaryEndpoint = list(
          Address = "string",
          Port = 123
        ),
        ReaderEndpoint = list(
          Address = "string",
          Port = 123
        ),
        Slots = "string",
        NodeGroupMembers = list(
          list(
            CacheClusterId = "string",
            CacheNodeId = "string",
            ReadEndpoint = list(
              Address = "string",
              Port = 123
            ),
            PreferredAvailabilityZone = "string",
            PreferredOutpostArn = "string",
            CurrentRole = "string"
          )
        )
      )
    ),
    SnapshottingClusterId = "string",
    AutomaticFailover = "enabled"|"disabled"|"enabling"|"disabling",
    MultiAZ = "enabled"|"disabled",
    ConfigurationEndpoint = list(
      Address = "string",
      Port = 123
    ),
    SnapshotRetentionLimit = 123,
    SnapshotWindow = "string",
    ClusterEnabled = TRUE|FALSE,
    CacheNodeType = "string",
    AuthTokenEnabled = TRUE|FALSE,
    AuthTokenLastModifiedDate = as.POSIXct(
      "2015-01-01"
    ),
    TransitEncryptionEnabled = TRUE|FALSE,
    AtRestEncryptionEnabled = TRUE|FALSE,
    MemberClustersOutpostArns = list(
      "string"
    ),
    KmsKeyId = "string",
    ARN = "string",
    UserGroupIds = list(
      "string"
    ),
    LogDeliveryConfigurations = list(
      list(
        LogType = "slow-log"|"engine-log",
        DestinationType = "cloudwatch-logs"|"kinesis-firehose",
        DestinationDetails = list(
          CloudWatchLogsDetails = list(
            LogGroup = "string"
          ),
          KinesisFirehoseDetails = list(
            DeliveryStream = "string"
          )
        ),
        LogFormat = "text"|"json",
        Status = "active"|"enabling"|"modifying"|"disabling"|"error",
        Message = "string"
      )
    ),
    ReplicationGroupCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    DataTiering = "enabled"|"disabled",
    AutoMinorVersionUpgrade = TRUE|FALSE,
    NetworkType = "ipv4"|"ipv6"|"dual_stack",
    IpDiscovery = "ipv4"|"ipv6",
    TransitEncryptionMode = "preferred"|"required",
    ClusterMode = "enabled"|"disabled"|"compatible",
    Engine = "string"
  )
)

Request syntax¶

svc$modify_replication_group(
  ReplicationGroupId = "string",
  ReplicationGroupDescription = "string",
  PrimaryClusterId = "string",
  SnapshottingClusterId = "string",
  AutomaticFailoverEnabled = TRUE|FALSE,
  MultiAZEnabled = TRUE|FALSE,
  NodeGroupId = "string",
  CacheSecurityGroupNames = list(
    "string"
  ),
  SecurityGroupIds = list(
    "string"
  ),
  PreferredMaintenanceWindow = "string",
  NotificationTopicArn = "string",
  CacheParameterGroupName = "string",
  NotificationTopicStatus = "string",
  ApplyImmediately = TRUE|FALSE,
  Engine = "string",
  EngineVersion = "string",
  AutoMinorVersionUpgrade = TRUE|FALSE,
  SnapshotRetentionLimit = 123,
  SnapshotWindow = "string",
  CacheNodeType = "string",
  AuthToken = "string",
  AuthTokenUpdateStrategy = "SET"|"ROTATE"|"DELETE",
  UserGroupIdsToAdd = list(
    "string"
  ),
  UserGroupIdsToRemove = list(
    "string"
  ),
  RemoveUserGroups = TRUE|FALSE,
  LogDeliveryConfigurations = list(
    list(
      LogType = "slow-log"|"engine-log",
      DestinationType = "cloudwatch-logs"|"kinesis-firehose",
      DestinationDetails = list(
        CloudWatchLogsDetails = list(
          LogGroup = "string"
        ),
        KinesisFirehoseDetails = list(
          DeliveryStream = "string"
        )
      ),
      LogFormat = "text"|"json",
      Enabled = TRUE|FALSE
    )
  ),
  IpDiscovery = "ipv4"|"ipv6",
  TransitEncryptionEnabled = TRUE|FALSE,
  TransitEncryptionMode = "preferred"|"required",
  ClusterMode = "enabled"|"disabled"|"compatible"
)

Examples¶

## Not run: 
# 
svc$modify_replication_group(
  ApplyImmediately = TRUE,
  ReplicationGroupDescription = "Modified replication group",
  ReplicationGroupId = "my-redis-rg",
  SnapshotRetentionLimit = 30L,
  SnapshottingClusterId = "my-redis-rg-001"
)

## End(Not run)