rds-describe-option-groups - Online in the Cloud

PROGRAM:

NAME

rds-describe-option-groups - Describes a specific, engine specific, or all option groups.

SYNOPSIS

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

DESCRIPTION

Returns a description of a specific option group, of option groups for a
specific engine or engine version, or of all option groups.

SPECIFIC OPTIONS

-e, --engine-name VALUE
Filters the list of option groups to only include groups associated with
a specific database engine.

-g, --option-group-name VALUE
The name of the option group to describe. Cannot be supplied together
with EngineName or MajorEngineVersion.

-v, --major-engine-version VALUE
Filters the list of option groups to only include groups associated with
a specific database engine version. If specified, then EngineName must
also be specified.

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 option groups

$PROMPT>$ rds-describe-option-groups

OUTPUT

This command returns a table that contains the following:
* Group Name - The name of the option group.
* Engine - The DB engine that this option group is associated with.
* Major Engine Version - The required major engine version of the engine
that this option group is associated with.
* Description - The description of the option group.
* VpcSpecific - If this is N, then both VPC and non-VPC instances can
currently join this option group.
* Vpc - If VpcSpecific is N, this field is blank. If VpcSpecific is Y, and
this field is blank, only non-VPC instances can join this option group.
Otherwise, only instances in this VPC can join this option group.
* Name - The name of the option.
* Port - The port used by this option, if any.
* Description - The description of this option.
* Name - Security Group name.
* Status - Status of authorization.

Use rds-describe-option-groups online using onworks.net services