Modifies the settings for a replication group.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
modify_replication_group_shard_configuration
in the ElastiCache API Reference
This operation is valid for Redis only.
elasticache_modify_replication_group(ReplicationGroupId,
ReplicationGroupDescription, PrimaryClusterId, SnapshottingClusterId,
AutomaticFailoverEnabled, MultiAZEnabled, NodeGroupId,
CacheSecurityGroupNames, SecurityGroupIds, PreferredMaintenanceWindow,
NotificationTopicArn, CacheParameterGroupName, NotificationTopicStatus,
ApplyImmediately, EngineVersion, AutoMinorVersionUpgrade,
SnapshotRetentionLimit, SnapshotWindow, CacheNodeType, AuthToken,
AuthTokenUpdateStrategy, UserGroupIdsToAdd, UserGroupIdsToRemove,
RemoveUserGroups)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"
)
)
),
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"
)
)
)
[required] The identifier of the replication group to modify.
A description for the replication group. Maximum length is 255 characters.
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.
The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
Deprecated. This parameter is not used.
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.
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).
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
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.
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.
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
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
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.
This parameter is currently disabled.
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.
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.
A valid cache node type that you want to scale this replication group to.
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.
Specifies the strategy to use to update the AUTH token. This parameter
must be specified with the auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
A list of user group IDs.
A list of users groups to remove, meaning the users in the group no longer can access thereplication group.
Removes the user groups that can access this replication group.
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,
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
)