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

rds-describe-option-groups

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 information about a specific option group or about all option groups that are described with the command. By default, all option groups are described.

Syntax

rds-describe-option-groups

[--option-group-name value]

[--engine-name value]

[--major-engine-version value]

[General Options]

Options

Name Description Required

--option-group-name

-g

Name of the option group to be described. Default is all option groups.

No

--engine-name

-e

A filter that limits option groups described to those associated with the specified DB engine. Default is all DB engines.

No

--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 major 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:

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.

  • Group name—The name of the option group.

  • Engine—The name of the DB engine that the option group is associated with.

  • Major engine version—The major version ID of the DB engine.

  • Description—The description of the option group.

  • VPC Specific—Indicates if both VPC and non-VPC instances can join this option group.

  • VPC—Indicates if only instances in this VPC can join this option group.

  • Name—The name of the option.

  • Port—The port used by this option, if applicable.

  • Description—The description of the option.

  • Name—The security group name.

  • Status—The status of authorization.

Example

This example describes all option groups that are associated with Oracle Enterprise Edition version 11.2:

Copy
PROMPT> rds-describe-option-groups --engine-name oracle-ee --major-engine-version 11.2 OPTIONGROUP default:oracle-ee-11-2 oracle-ee 11.2 Default option group for oracle-ee 11.2 OPTIONGROUP testoptiongroup oracle-ee 11.2 Oracle Database Manager Database Control