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

rds-describe-option-group-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

Provides a list of options that can be added to option groups that are associated with the specified DB engine.

Syntax

rds-describe-option-group-options

--engine-name value

[--major-engine-version value]

[General Options]

Options

Name Description Required

--engine-name

-e

Name of the DB engine.

Yes

--major-engine-version

-v

A filter that limits option groups described to those associated with the specified major version of the DB engine. Default is all versions.

Valid values: For a list of valid values, see the --engine-version parameter in the rds-create-db-instance

No

Output

The command returns the following information for each available option:

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.

  • Option—The name of the option.

  • Engine—The name of the DB engine that the option requires.

  • Minimum required engine version—The minimum major version ID of the DB engine that the option requires.

  • Port required—If y, the option requires a port.

  • Default port—The default port that is used by the option.

  • Description—A description of the option.

  • Name—The name of the associated option group.

  • Status—The status of the option group membership. For example, the status could be in-sync, applying, pending, or pending-maintenance.

Example

This example describes options that require Oracle Enterprise Edition:

Copy
PROMPT> rds-describe-option-group-options --engine-name oracle-ee OPTION Option Name Engine Minimum Required Engine Version Port Required Default Port Description OPTION OEM oracle-ee 11.2.0.2v3 y 1158 Oracle Enterprise Manager

This example describes options that require Oracle Enterprise Edition 11.2:

Copy
PROMPT> rds-describe-option-group-options --engine-name oracle-ee --major-engine-version 11.2 OPTION Option Name Engine Minimum Required Engine Version Port Required Default Port Description OPTION OEM oracle-ee 11.2.0.2v3 y 1158 Oracle Enterprise Manager