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

rds-describe-orderable-db-instance-options

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

Returns information about available orderable DB instance options.

Syntax

rds-describe-orderable-db-instance-options -e (--engine)

[-c (--db-instance-class) value ]

[-lm (--license-model) value ]

[-v (--engine-version) value ]

[--vpc ] value

[General Options]

Options

Name Description Required

-e value

--engine value

The name of the engine to retrieve DB instance options for.

Type: String

Default: None

Example: -e mysql

Yes

-c

--db-instance-class value

The DB instance class filter value. Specify this parameter to show only the available offerings that match the specified DB instance class.

Type: String

Default: None

Example: -c db.m1.xlarge

No

-lm

--license-model value

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

Type: String

Default: None

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

No

-v

--engine-version value

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

Type: String

Default: None

Example: -v 5.1.50

No

--vpc value

The VPC filter value. Specify this parameter to filter by VPC or non-VPC orderable database instance options.

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.

  • Engine—the database engine name.

  • Version—the database engine version.

  • Class—the DB instance class.

  • Storage Type—The type of storage specified.

  • License—the license model.

  • Multi-AZ—indicates if the configuration is Multi-AZ capable.

  • ReadReplica—indicates if the configuration is Read Replica capable.

  • Name—the name of the availability zone.

  • Vpc—indicates if the configuration has VPC offered.

Examples

Describing All Orderable DB instance Options

This example returns descriptions of all orderable database instance options.

Copy
PROMPT> rds-describe-orderable-db-instance-options

Describing Orderable DB instance Options for MySQL

This example returns descriptions of all orderable database instance options for the MySQL database engine.

Copy
PROMPT> rds-describe-orderable-db-instance-options --engine mysql