Amazon Relational Database Service
Command Line Interface Reference (API Version 2013-09-09)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.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

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 ]

[--iops value ]

[-pub (--publicly-accessible) value]

[-m (--multi-az) value ]

[-og (--option-group) value ]

[-sn (--db-subnet-group-name) value ]

[-n (--db-name) value ]

[-p (--port) value ]

[-au (--auto-minor-version-upgrade) value ]

[General Options]

Options

NameDescriptionRequired

DBInstanceIdentifier

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

-z value

--availability-zone value

The Amazon EC2 Availability Zone that the DB instance will be created in.

Type: String

Default: A random, system-chosen Availability Zone.

Example: -z us-east-1c

No

-s value

--db-snapshot-identifier value

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: -s my-snapshot-id

Yes

-e value

--engine value

Name of the database engine to use for the new DB instance.

Type: String

Default: Same as the source DB instance.

Valid values: MySQL | oracle-se1 | oracle-se | oracle-ee

Yes

-c value

--db-instance-class value

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 rds-describe-orderable-db-instance-options command.

Type: String

Default: None

Valid values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge

Example: --db-instance-class db.m1.xlarge

No

-lm

--license-model value

License model for the new DB instance.

Type: String

Default: Same as the source DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Example: --license-model bring-your-own-license

No

-sn value

--db-subnet-group value

The name of the DB subnet group to restore into. Specifying a DB subnet group will restore to a DB instance in the named VPC.

Note

You can restore a DB instance from a VPC to a DB instance in another VPC, or from a non-VPC DB instance into a DB instance in a VPC. You cannot restore from a VPC to a DB instance that is not in a VPC.

Type: String

Default: none

Constraints: Must be the name of an existing DB subnet group.

Example: --db-subnet-group-name mydbsubnetgroup

No

--iops value

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.

If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

You cannot change the provisioned IOPS for a SQL Server DB instance.

No

-pub value

--publicly-accessible value

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

 

-m value

--multi-az value

Specifies if the new DB instance is a Multi-AZ deployment.

Type: Boolean

Default: false

Valid values: true | false

Constraints: The --availability-zone parameter cannot be set if the --multi-az parameter is set to true.

No

-og value

--option-group value

Specifies the name of the option group that should be associated with this instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can never be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance.

Type: String

No

-n value

--db-name value

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:

  • Cannot be empty.

  • Must contain 1 to 64 alphanumeric characters.

  • Cannot be a word reserved by the specified database engine.

Type: String

Example: --db-name MyDatabase

Oracle

The Oracle System ID (SID) of the created DB instance.

Constraints:

  • Cannot be longer than 8 characters.

Type: String

Example: --db-name MYORACLE

No

-p value

--port value

Port number that the DB instance uses for connections.

Type: Integer

Default: The value used in the DB snapshot

Example: --port 1234

No

-au value

--auto-minor-version-upgrade value

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

Type: Boolean

Example: --au true

No

Output

The command returns a table that contains the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • 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

  • Iops—The provisioned storage IOPS, expressed as I/O operations per second.

  • 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-credentials

  • SecondaryAvailabilityZone—If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

  • Endpoint 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-immediately option 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-immediately option was specified

  • DB Name—Name of the initial database created when the instance was created or the Oracle System ID (SID) of the created DB instance (for the Oracle engine). This column appears only in the --show-long view

  • Maintenance Window—The window during which patching and instance modifications will be performed. This column appears only in the --show-long view

  • Name—security group name

  • Status—Status of authorization. Valid values: authorizing | authorized | revoking

  • Name—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 | applying

  • Multi-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