Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DecreaseReplicaCountMessage

Hierarchy

Index

Properties

ApplyImmediately

ApplyImmediately: boolean | undefined

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

Optional NewReplicaCount

NewReplicaCount: undefined | number

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

Optional ReplicaConfiguration

ReplicaConfiguration: ConfigureShard[]

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

Optional ReplicasToRemove

ReplicasToRemove: string[]

A list of the node ids to remove from the replication group or node group (shard).

ReplicationGroupId

ReplicationGroupId: string | undefined

The id of the replication group from which you want to remove replica nodes.