         | Did this page help you? Yes No Tell us about it... |
rds-create-db-instance-read-replica
Description
Creates a DB Instance that acts as a Read Replica of a source DB Instance.
![[Note]](http://docs.amazonwebservices.com/docs-common/images/note.png) | Note |
|---|---|
Read Replicas are only supported with the MySQL database engine. |
All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except where specified otherwise.
Syntax
rds-create-db-instance-read-replica
DBInstanceIdentifier -s
(--source-db-instance-identifier) value [-c
(--db-instance-class) value ] value ] value ] value ]
Options
| Name | Description | Required |
|---|---|---|
|
|
DB Instance identifier of the Read Replica. This is the
unique key that identifies a DB Instance. This parameter is
stored as a lowercase string. This can also be passed as a named
parameter using Type: String Default: None Constraints:
Example: myinstance |
Yes |
|
|
The identifier of the DB Instance for which this DB Instance will act as a Read Replica. You can have up to 5 read replicas per DB Instance. Type: String Constraints:
|
Yes |
|
|
Contains the compute and memory capacity of the Read Replica. Type: String Default: Inherits from the source DB Instance. Different instance classes are available for different database engines.
For information about valid values for a particular engine, use the
Valid values: Example: |
No |
|
|
Port number that the Read Replica uses for connections. Type: Integer Default: Inherits from the source DB Instance Example: |
No |
|
|
Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window. Type: Boolean Default: Inherits from the source DB Instance Example: |
No |
|
|
The EC2 Availability Zone that the Read Replica will be created in. Type: String Default: A random, system-chosen Availability Zone in the same region as the current endpoint. Constraints: The Example: |
No |
Output
The command returns a table that contains the following information:
DBInstanceID—The user-supplied DB Instance identifier
Created—The data and time the instance was created, in 24-hour UTC
Class—The compute and memory capacity of the instance
Engine—Name of the database engine to be used for this DB Instance
Storage—Initially allocated storage size specified in gigabytes (GBs)
Master Username—The master username for the DB Instance
Status—The current status of the DB Instance. Valid values:
available|backing-up|creating|deleted|deleting|failed|modifying|rebooting|resetting-master-credentials|storage-full|incompatible-parameters|incompatible-restoreEndpoint Address—Address of the DB Instance
Port—Port used to connect to the DB Instance
AZ—The instance's Availability Zone
Backup Retention—The number of days that automated backups are retained before deletion
PendingBackupRetention—The backup retention period that will be applied at the next maintenance window, or that is currently being applied if the
--apply-immediatelyoption was specifiedPendingClass—The class to which the instance will be scaled during the next maintenance window, or to which it is currently being scaled if the
--apply-immediatelyoption was specifiedPendingCredentials—The (hidden) master user password that will be applied to the DB Instance
PendingStorage—The storage size to which the instance will be scaled during the next maintenance window, or to which it is currently being scaled if the
--apply-immediatelyoption was specifiedPendingMulti-AZ—If true, indicates that the instance will be converted to run as a Multi-AZ deployment; if false, the instance will be converted to run as a standard (Single-AZ) deployment.
PendingVersion—The engine version of the pending database instance.
DB Name—Name of the initial database created when the instance was created. This column appears only in the
--show-longviewMaintenance Window—The period during which patching and instance modifications will be performed. This column appears only in the
--show-longviewBackup Window—The period during which automated backups are created. This column appears only in the
--show-longviewLatest Restorable Time—The latest time to which a database can be restored using point-in-time restore. This column appears only in the
--show-longview.Multi-AZ—Indicates if this is a Multi-AZ DB Instance.
EngineVersion—The version number of the database engine.
Auto Minor Version Upgrade—Indicates that minor version upgrades will be applied to the DB Instance during the maintenance window. This column appears only in the
--show-longview.Name—The DB Security Group name
Status—Status of authorization. Valid values:
authorizing|authorized|revokingGroup Name—Name of DB Parameter Group applied to
Apply Status—Status of applying the parameter group. It can be either
in-syncorpending-rebootRead Replica ID—The identifier of the source DB Instance for which this DB Instance acts as a Read Replica
Examples
Create a Read Replica with Minimal Parameters
This example creates a Read Replica with the minimal set of parameters.
PROMPT>rds-create-db-instance-read-replica SimCoProd01Replica01 -s SimcoProd01DBINSTANCE simcoprod01replica01 db.m1.large mysql 10 master creating us-east-1b 0 n 5.1.50 simcoprod01 SECGROUP default active PARAMGRP default.mysql5.1 in-sync
Create a Read Replica and Specify an Availability Zone
This example creates a Read Replica, specifying an availability zone.
PROMPT>rds-create-db-instance-read-replica SimCoProd01Replica02 -s SimCoProd01-z us-east-1aDBINSTANCE simcoprod01replica02 db.m1.large mysql 10 master creating us-east-1a 0 n 5.1.50 simcoprod01 SECGROUP default active PARAMGRP default.mysql5.1 in-sync
