         | Did this page help you? Yes No Tell us about it... |
rds-restore-db-instance-from-db-snapshot
Description
Creates a new DB Instance from a DB Snapshot of an existing DB Instance, effectively replicating the existing instance at the time the DB Snapshot was taken. Some characteristics of the new DB Instance can be modified using optional parameters; if these are omitted, the new restored DB Instance defaults to the characteristics of the DB Instance from which the snapshot was taken.
![[Note]](http://docs.amazonwebservices.com/docs-common/images/note.png) | Note |
|---|---|
This operation is not supported for Read Replica DB Instances. |
Syntax
rds-restore-db-instance-from-db-snapshot
DBInstanceIdentifier -s
(--db-snapshot-identifier) value [-e
(--engine) value ] [-lm (--license model)
value ] [-z (--availability-zone)
value ] [-c (--db-instance-class)
value ] [-m (--multi-az)
value] [-sn (--db-subnet-group-name)
value ] value ] [-p (--port)
value ] [-au
(--auto-minor-version-upgrade) value ]
[General Options]
Options
| Name | Description | Required | |||
|---|---|---|---|---|---|
|
|
DB Instance identifier. This is the unique key that identifies a DB Instance. Stored as a lowercase string. Type: String Default: None Constraints: Must contain 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myinstance |
Yes | |||
|
|
The EC2 Availability Zone that the DB Instance will be created in. Type: String Default: A random, system-chosen Availability Zone. Example: |
No | |||
|
|
The identifier for an existing DB Snapshot. Type: String Default: None Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: |
Yes | |||
|
|
Name of the database engine to use for the new DB Instance. Type: String Default: Same as the source DB Instance. Valid values: |
Yes | |||
|
|
Contains the compute and memory capacity of the DB
Instance. Different instance classes are available for different database engines.
For information about valid values for a particular engine, use the
Type: String Default: None Valid values: Example: |
No | |||
|
|
License model for the new DB Instance. Type: String Default: Same as the source DB Instance. Valid values: Example: |
No | |||
|
|
The name of the DB Subnet Group to retore into. Specifying a DB Subnet Group will restore to a DB Instance in the named VPC.
Type: String Default: none Constraints: Must be the name of an existing DB Subnet Group. Example: |
No | |||
|
|
Specifies if the new DB Instance is a Multi-AZ deployment. Type: Boolean Default: Valid values: Constraints: The |
No | |||
|
|
The meaning of this parameter differs according to the database engine you use. MySQL Name of a database to create when the DB Instance is created. If this parameter is not specified, no database is created in the instance. Constraints:
Type: String Example: Oracle The Oracle System ID (SID) of the created DB Instance. Constraints:
Type: String Example: |
No | |||
|
|
Port number that the DB Instance uses for connections. Type: Integer Default: The value used in the DB Snapshot Example: |
No | |||
|
|
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean Example: |
No |
Output
The command returns a table that contains the following information:
DBInstanceID—the user-supplied database identifier
Created—the data and time the instance was created, in UTC
Class—The compute and memory capacity of the DB Instance
Engine—Name of the database engine to be used for this DB Instance
Storage—Initially allocated storage size specified in GBs
Master Username—The master username for the DB Instance
Status—The current status of the instance. Valid values:
available|backing-up|creating|deleted|deleting|failed|modifying|rebooting|resetting-master-credentialsEndpoint Address—Address of the DB Instance
Port—Port used to connect to the DB Instance
AZ—The instance's Availability Zone
PendingClass—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 specifiedDB Name—Name of the initial database created when the instance was created (for the MySQL engine) or the Oracle System ID (SID) of the created DB Instance (for the Oracle engine). This column appears only in the
--show-longviewMaintenance Window—The window during which patching and instance modifications will be performed. This column appears only in the
--show-longviewName—Security Group name
Status—Status of authorization. Valid values:
authorizing|authorized|revokingName—DB Subnet Group name
Description—DB Subnet Group description
Group Name—Name of DB Parameter Group applied to
Apply Status—Status of applying the parameter group. Valid values:
in-sync|pending-reboot|applyingMulti-AZ—Indicates if this is a Multi-AZ DB Instance.
EngineVersion—Database engine version number.
Examples
Restore a Database from a Snapshot with Minimal Parameters
This example restores a database from a DB Snapshot with the minimal set of parameters.
PROMPT> rds-restore-db-instance-from-db-snapshot mynewrestoreddatabase -s myexistingsnapshot
Restore a Database from a Snapshot, Specifying a New Availability Zone
This example restores a database from a DB Snapshot with a new Availability Zone.
PROMPT> rds-restore-db-instance-from-db-snapshot mynewrestoreddatabase -s myexistingsnapshot -c db.m1.large -p 3501 -z us-east-1a
