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

rds-add-option-to-option-group

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

Adds an option to an option group.

Most options can be added and removed from option groups. Persistent options, such as the TDE option for Microsoft SQL Server, cannot be removed from an option group while DB instances are associated with the option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can never be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance.

For more information, see Working with Option Groups.

Syntax

rds-add-option-to-option-group option-group-name

--option-name value

[--apply-immediately]

[--security-groups value[,value2][,...]]

[--settings key1=value1;key2=value2;...]

[--port value]

[--vpc-security-group-ids value1,value2,...]

[General Options]

Options

Name Description Required

--option-group-name value

Name of the option group that the option will be added to.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-add-option-to-option-group my-option-group-name.

Yes

--option-name

-n

Name of the option to be added to the option group.

Yes

--apply-immediately

If supplied, the option will be applied immediately for all associated DB instances. If not supplied, the option will be applied for each DB instance during its next maintenance window.

No

--security-groups

-sg

Name of the security group or groups that will be applied to the port that the option uses for communication. Yes if the option uses a port; otherwise, no.

--settings

-s

Provides additional information for the option if the option has modifiable settings. A semi-colon separated list in the form 'key1=value1; mey2=value2; etc. If no settings are provided for an option that requires one, the default values will be used. No

--port

A non-default port that the option will use for communication.

No

--vpc-security-group-ids

-vpcsg

A comma-separated list of VPC Security Group identifiers that should be used to grant access to the port for this option. Permission is only granted if the option uses a port.

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.

  • 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.

  • Option group description—The description of the option group.

  • Option name—The name of the option that was added.

  • Port—The number of the port that the option will use.

  • Persistent—Indicates if this is a persistent option. A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.

  • Permanent—Indicates if this is a permanent option. A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.

  • Option description—A description of the option.

  • Option status—The status of authorization.

  • Security group—The security group assigned to the port.

  • Authorization—Status of ingress authorization for the security 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.

  • Setting—The setting name that the option will use.

  • Setting Description—The description of the option setting.

  • Value—The value of the option setting.

  • Modifiable—Indicates if the option setting is modifiable.

Example

This example adds the Oracle Enterprise Manager Database Control option to an option group named TestOptionGroup. The default DB security group is applied to the default port:

Copy
PROMPT> rds-add-option-to-option-group TestOptionGroup --option-name OEM --security-groups default --apply-immediately OPTIONGROUP testoptiongroup oracle-ee 11.2 Oracle Enterprise Manager Database Control OPTION OEM 1158 Oracle Enterprise Manager SECGROUP default authorized

This example adds the Oracle time zone option to an option group named TestOptionGroup:

Copy
PROMPT> rds-add-option-to-option-group TestOptionGroup --option-name Timezone --settings "TIME_ZONE=Japan"