rds-describe-option-group-options - Online in the Cloud

PROGRAM:

NAME

rds-describe-option-group-options - Returns a list of options that can be added to option
groups associated with the specified engine

SYNOPSIS

rds-describe-option-group-options
--engine-name value [--major-engine-version value ] [--marker value ]
[--max-records value ] [General Options]

DESCRIPTION

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

SPECIFIC OPTIONS

-e, --engine-name VALUE
Required. Filters the list of options to those that can be added to an
option group associated with this engine.

-v, --major-engine-version VALUE
Further filters the list of options to only include options available for
the specified major version of the engine specified by EngineName.

GENERAL OPTIONS

--aws-credential-file VALUE
Location of the file with your AWS credentials. Must not be specified in
conjunction with --ec2-cert-file-path or --ec2-private-key-file-path.
This value can be set by using the environment variable
'AWS_CREDENTIAL_FILE'.

-C, --ec2-cert-file-path VALUE
Path to AWS X.509 certificate file. Must be specified in conjunction with
--ec2-private-key-file-path and must not be specified in conjunction with
--aws-credential-file. This value can be set by using the environment
variable 'EC2_CERT'.

--connection-timeout VALUE
Specify a connection timeout VALUE (in seconds) for API calls. The
default value is '30'.

--debug
If an error occurs while --debug is used, it will display information
useful for debugging the problem. The default value is 'false'.

--delimiter VALUE
What delimiter to use when displaying delimited (long) results.

--headers
If you are displaying tabular or delimited results, it includes the
column headers. If you are showing xml results, it returns the HTTP
headers from the service request, if applicable. This is off by default.

-I, --access-key-id VALUE
Specify the AWS Access ID to use.

-K, --ec2-private-key-file-path VALUE
Path to AWS X.509 private key file. Must be specified in conjunction with
--ec2-cert-file-path and must not be specified in conjunction with
--aws-credential-file. This value can be set by using the environment
variable 'EC2_PRIVATE_KEY'.

--marker VALUE
The marker provided in the previous request. If this parameter is
specified the response includes only records beyond the marker, up to
MaxRecords.

--max-records VALUE
Maximum number of records to return per page.

--region VALUE
Specify region VALUE as the web service region to use. This value can be
set by using the environment variable 'EC2_REGION'.

-S, --secret-key VALUE
Specify the AWS Secret Key to use.

--service-sig-name VALUE
Specify the service name to use when signing requests. The default is
"rds". This value can be set by using the environment variable
'SERVICE_SIG_NAME'.

--show-empty-fields
Show empty fields and rows, using a "(nil)" value. The default is to not
show empty fields or columns.

--show-request
Displays the URL used by the tools to call the AWS Service. The default
value is 'false'.

--show-table, --show-long, --show-xml, --quiet
Specify how the results are displayed: tabular, delimited (long), xml, or
no output (quiet). Tabular shows a subset of the data in fixed
column-width form, while long shows all of the returned values delimited
by a character. The xml is the raw return from the service, while quiet
suppresses all standard output. The default is tabular, or 'show-table'.

-U, --url VALUE
This option will override the URL for the service call with VALUE. This
value can be set by using the environment variable 'RDS_URL'.

INPUT EXAMPLES

This shows how to get a list of all options available for a specific engine

$PROMPT>$ rds-describe-option-group-options -e oracle-ee --headers

OUTPUT

This command returns a table that contains the following:
* Option Name - Option Name.
* Engine - The engine this option is available for.
* Minimum Required Engine Version - The minimum engine version required by
the option.
* Port Required - Indicates whether this option requires a port.
* Default Port - If a port is required but not specified when adding an
option to an option group, this default port is used.
* Description - Option Description.
* Name - The name of the associated option group.
* Status - The status of the option group membership (e.g. in-sync,
applying, pending, pending-maintenance).

Use rds-describe-option-group-options online using onworks.net services