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

rds-copy-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

Creates a copy of the specified option group.

Syntax

rds-copy-option-group source-option-group-identifier

-t (--target-option-group-identifier) value

-td (--target-option-group-description) value

[-tk (--tag-key) value ]

[-tv (--tag-value) value ]

[General Options]

Options

Name Description Required

--source-option-group-identifier value

-s value

Source option group identifier. This unique name or ARN identifies an existing option group to copy.

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-copy-option-group my-source-option-group-identifier.

Type: String

Default: None

Constraints:

  • Must specify a valid option group.

  • If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

  • If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

Yes

--target-option-group-identifier value

-t value

The identifier for the option group to create.

Type: String

Default: None

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: -t my-copied-option-group-id

Yes

--target-option-group-description value

-td value

The description of the option group to create.

Type: String

Default: None

Yes

--tag-key

-tk

The name of a tag to add for the new option group.

No

--tag-value

-tv

The value of the tag to add for the new option group.

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 new option group.

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

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

  • Description—The description of the new option group.

Examples

Copy an Option Group

The following example copies an option group and creates a new option group in the same region.

Copy
PROMPT> rds-copy-option-group my-source-option-group -t my-new-option-group -td "My new option group"