         | Did this page help you? Yes No Tell us about it... |
rds-restore-db-instance-to-point-in-time
Description
Restores a DB Instance to a specified point in time, creating a new DB Instance.
Some characteristics of the new DB Instance can be modified using optional parameters; if these are omitted, the new DB Instance defaults to the characteristics of the DB Instance from which the DB Snapshot was created.
![[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-to-point-in-time
TargetDBInstanceIdentifier -s
(--source-db-instance-identifier) value [-l
(--use-latest-restorable-time) ] [-e (--engine)
value ] [-lm (--license model)
value ] [-r (--restore-time)
value ] [-z (--availability-zone)
value ] [-c (--db-instance-class)
value ] [-p (--port)
value ] [-m (--multi-az)
value] [-au
(--auto-minor-version-upgrade) value ]
[-sn (--db-subnet-group-name)
value ]
[General Options]
Options
| Name | Description | Required | |||
|---|---|---|---|---|---|
|
|
DB Instance identifier. This is the unique key that identifies a DB Instance. 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: mydbinstance |
Yes | |||
|
|
User-supplied identifier of the DB Instance from which to restore. This instance must be available and must have automated backups enabled. Type: String |
Yes | |||
|
|
Specifies that the DB Instance is restored from the latest backup time. Type: Boolean Default: Constraints: Cannot be specified if
|
Conditional | |||
|
|
License model for the new DB Instance. Type: String Default: Same as the source DB Instance. Valid values: Example: |
No | |||
|
|
The date and time from to restore from. Type: Date Default: none Valid Values: Value must be a UTC time Constraints:
Example: |
Conditional | |||
|
|
The EC2 Availability Zone that the DB Instance will be created in. Type: String Default: The Availability Zone of the source DB Instance. Example: |
No | |||
|
|
Contains the compute and memory capacity of the DB Instance. Type: String Default: The instance class of 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 | |||
|
|
Name of the database engine to use for the new DB Instance. Type: String Default: Same as the source DB Instance. Valid values: |
Yes | |||
|
|
Port number that the DB Instance uses for connections. Type: Integer Default: The port of the source DB Instance. Example: |
No | |||
|
|
Specifies if the new DB Instance is a Multi-AZ deployment. Type: Boolean Default: Valid values: Constraints: The |
No | |||
|
|
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean 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 |
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 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 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.
Backup Retention—The number of days that automated backups are retained before deletion.
PendingBackupRetention—The backup retention period which will be applied at the next maintenance window, or which is currently being applied if the
--apply-immediatelyoption was specified.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 specified.PendingCredentials—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 specified.DB Name—Name of the initial database created when the instance was created. This column appears only in the
--show-longview.Maintenance Window—The window during which patching and instance modifications will be performed. This column appears only in the
--show-longview.Backup Window—The period during which daily automated backups are created. This column appears only in the
--show-longview.Name—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. It can be either
in-syncorpending-reboot.Multi-AZ—Indicates if this is a Multi-AZ DB Instance.
EngineVersion—Database engine version number.
Examples
Restore a Database to a Specified Time with Minimal Parameters
This example restores a database to a specified time with the minimal set of parameters.
PROMPT> rds-restore-db-instance-to-point-in-time restored-db -s original-db -r 2009-07-31T13:00:00Z
Restore a Database to a Specified Time, Specifying a New Availability Zone
This example restores a database to a specified time with a new Availability Zone.
PROMPT> rds-restore-db-instance-to-point-in-time restored-db -s original-db -r 2009-07-31T13:00:00Z -z us-east-1b
