Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-purchase-reserved-db-instances-offering

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Purchases a reserved DB instance offering. Note that you can move Reserved Instances from an EC2-Classic (non-VPC) instance into a VPC without additional charge.

Syntax

rds-purchase-reserved-db-instance-offering reserved-db-instances-offering-id

[-c (--instance-count) value ]

[-i (--reserved-db-instance-id) value ]

[-tk (--tag-key) value ]

[-tv (--tag-value) value ]

[General Options]

Options

Name Description Required

--reserved-db-instances-offering-id value

The ID of the Reserved DB instance offering to purchase.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-purchase-reserved-db-instances-offering my-reserved-db-instances-offering-id.

Type: String

Default: None

Example: --reserved-db-instances-offering-id myreserveddbinstance

Yes

-c

--instance-count value

The number of DB instances to reserve.

Type: Integer

Default: 1

Example: -c 3

No

-i

--reserved-db-instance-id value

Optional unique identifier for the purchased reservation. If this parameter is not specified, an identifier is automatically generated for the reservation.

Type: String

Default: None

Example: -i myreservationID

No

--tag-key

-tk

The name of a tag to add for the purchased reservation.

No

--tag-value

-tv

The value of the tag to add for the purchased reservation.

No

Output

The command returns a table with 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.

  • ReservationId—the unique identifier for the reservation.

  • OfferingID—the offering identifier (only appears when the --show-long parameter is specified).

  • Class—the DB instance class for the reservation.

  • Multi-AZ—indicates if the reservation applies to Multi-AZ deployments.

  • Start Time—the time the reservation started

  • Duration—the length of the duration in years.

  • Fixed Price—the fixed price charged for each DB instance in this reservation (only appears when the --show-long parameter is specified).

  • Usage Price—the hourly price to run each reserved DB instance (only appears when the --show-long parameter is specified).

  • Count—the number of database instances reserved.

  • State—the payment status of the reservation.

  • Description—the database engine used by the reservation.

Examples

Reserve a Database Instance

This example reserves a single database instance from offering 438012d3-4052-4cc7-b2e3-8d3372e0e706.

Copy
PROMPT> rds-purchase-reserved-db-instances-offering 438012d3-4052-4cc7-b2e3-8d3372e0e706 -i myreservationID

Reserve Multiple Database Instances

This example reserves five database instances from offering 438012d3-4052-4cc7-b2e3-8d3372e0e706.

Copy
PROMPT> rds-purchase-reserved-db-instances-offering 438012d3-4052-4cc7-b2e3-8d3372e0e706 -i myreservationID -c 5