Modify Replication Group
GET {{aws_elasticache_base_url}}/?ReplicationGroupId&ApplyImmediately&AuthToken&AuthTokenUpdateStrategy&AutomaticFailoverEnabled&AutoMinorVersionUpgrade&CacheNodeType&CacheParameterGroupName&CacheSecurityGroupNames.CacheSecurityGroupName.N&EngineVersion&NodeGroupId&NotificationTopicArn&NotificationTopicStatus&PreferredMaintenanceWindow&PrimaryClusterId&ReplicationGroupDescription&SecurityGroupIds.SecurityGroupId.N&SnapshotRetentionLimit&SnapshottingClusterId&SnapshotWindow&Version=2015-02-02
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ReplicationGroupId | null | The identifier of the replication group to modify. | |
ApplyImmediately | null | 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. | |
AuthToken | null | 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: | |
AuthTokenUpdateStrategy | null | Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values: | |
AutomaticFailoverEnabled | null | Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. | |
AutoMinorVersionUpgrade | null | This parameter is currently disabled. | |
CacheNodeType | null | A valid cache node type that you want to scale this replication group to. | |
CacheParameterGroupName | null | 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. | |
CacheSecurityGroupNames.CacheSecurityGroupName.N | null | 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. | |
EngineVersion | null | The upgraded version of the cache engine to be run on the clusters in the replication group. | |
NodeGroupId | null | Deprecated. This parameter is not used. | |
NotificationTopicArn | null | The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent. | |
NotificationTopicStatus | null | The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active. | |
PreferredMaintenanceWindow | null | 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. | |
PrimaryClusterId | null | 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. | |
ReplicationGroupDescription | null | A description for the replication group. Maximum length is 255 characters. | |
SecurityGroupIds.SecurityGroupId.N | null | Specifies the VPC Security Groups associated with the clusters in the replication group. | |
SnapshotRetentionLimit | null | 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. | |
SnapshottingClusterId | null | 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. | |
SnapshotWindow | null | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId. | |
Version | string | The version of the API. |