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

CopyOptionGroup

Copies the specified option group.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

SourceOptionGroupIdentifier

The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

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.

Type: String

Required: Yes

Tags.Tag.N

A list of tags.

Type: Array of Tag objects

Required: No

TargetOptionGroupDescription

The description for the copied option group.

Type: String

Required: Yes

TargetOptionGroupIdentifier

The identifier for the copied option group.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-option-group

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

OptionGroup

Type: OptionGroup object

Errors

For information about the errors that are common to all actions, see Common Errors.

OptionGroupAlreadyExistsFault

The option group you are trying to create already exists.

HTTP Status Code: 400

OptionGroupNotFoundFault

The specified option group could not be found.

HTTP Status Code: 404

OptionGroupQuotaExceededFault

The quota of 20 option groups was exceeded for this AWS account.

HTTP Status Code: 400

Example

Sample Request

Copy
https://rds.us-east-1.amazonaws.com/ ?Action=CopyOptionGroup &SignatureMethod=HmacSHA256 &SignatureVersion=4 &SourceOptionGroupIdentifier=arn%3Aaws%3Ards%3Aus-west-2%3A815981987263%3og%3Amy-remote-option-group &TargetOptionGroupDescription=New%20option%20group &TargetOptionGroupIdentifier=new-local-option-group &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request &X-Amz-Date=20140429T175351Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2

Sample Response

Copy
<CopyOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <CopyOptionGroupResult> <OptionGroup> <OptionGroupName>new-local-option-group</OptionGroupName> <MajorEngineVersion>5.6</MajorEngineVersion> <AllowsVpcAndNonVpcInstanceMemberships>false</AllowsVpcAndNonVpcInstanceMemberships> <EngineName>mysql</EngineName> <OptionGroupDescription>description</OptionGroupDescription> <Options> <Option> <Port>11211</Port> <OptionName>MEMCACHED</OptionName> <OptionDescription>Innodb Memcached for MySQL</OptionDescription> <Persistent>false</Persistent> <OptionSettings> <OptionSetting> <DataType>BOOLEAN</DataType> <IsModifiable>true</IsModifiable> <IsCollection>false</IsCollection> <Description>If enabled when there is no more memory to store items, memcached will return an error rather than evicting items.</Description> <Name>ERROR_ON_MEMORY_EXHAUSTED</Name> <Value>0</Value> <ApplyType>STATIC</ApplyType> <AllowedValues>0,1</AllowedValues> <DefaultValue>0</DefaultValue> </OptionSetting> <OptionSetting> <DataType>INTEGER</DataType> <IsModifiable>true</IsModifiable> <IsCollection>false</IsCollection> <Description>The backlog queue configures how many network connections can be waiting to be processed by memcached</Description> <Name>BACKLOG_QUEUE_LIMIT</Name> <Value>1024</Value> <ApplyType>STATIC</ApplyType> <AllowedValues>1-2048</AllowedValues> <DefaultValue>1024</DefaultValue> </OptionSetting> </OptionSettings> <VpcSecurityGroupMemberships/> <Permanent>false</Permanent> <DBSecurityGroupMemberships> <DBSecurityGroup> <Status>authorized</Status> <DBSecurityGroupName>default</DBSecurityGroupName> </DBSecurityGroup> </DBSecurityGroupMemberships> </Option> </Options> </OptionGroup> </CopyOptionGroupResult> <ResponseMetadata> <RequestId>2928d60e-beb6-11d3-8e5c-3ccda5460c46</RequestId> </ResponseMetadata> </CopyOptionGroupResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: