ybm cluster read-replica
Manage cluster read replicas
Use the cluster read-replica resource to perform operations on a YugabyteDB Managed cluster read replica, including the following:
- create, update, and delete read replicas
- get information about read replicas
Syntax
Usage: ybm cluster read-replica [command] [flags]
Example
Create a read-replica cluster:
ybm cluster read-replica create \
--replica num-cores=2,\
memory-mb=4096,\
disk-size-gb=200,\
cloud-provider=AWS,\
region=us-west-3,\
num-nodes=3,\
vpc=my-vpc,\
num-replicas=2,\
multi-zone=true
Commands
create
Create a read replica for a specified cluster.
| Flag | Description |
|---|---|
| --cluster-name | Required. Name of the cluster to which you want to add read replicas. |
| --replica | Specifications for the read replica provided as key-value pairs. Arguments:
|
delete
Delete read replicas of a specified cluster.
| Flag | Description |
|---|---|
| --cluster-name | Required. Name of the cluster whose read replicas you want to delete. |
list
List the read replicas of a specified cluster.
| Flag | Description |
|---|---|
| --cluster-name | Required. Name of the cluster whose read replicas you want to fetch. |
update
Update a read replica for a specified cluster.
| Flag | Description |
|---|---|
| --cluster-name | Required. Name of the cluster with read replicas you want to update. |
| --replica | Specifications for the read replica provided as key-value pairs. Arguments:
|