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

ModifyOptionGroup

Modifies an existing option group.

Request Parameters

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

ApplyImmediately

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

Type: Boolean

Required: No

OptionGroupName

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot 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

Type: String

Required: Yes

OptionsToInclude.OptionConfiguration.N

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

Type: Array of OptionConfiguration objects

Required: No

OptionsToRemove.member.N

Options in this list are removed from the option group.

Type: Array of strings

Required: No

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.

InvalidOptionGroupStateFault

The option group is not in the available state.

HTTP Status Code: 400

OptionGroupNotFoundFault

The specified option group could not be found.

HTTP Status Code: 404

Examples

Example

Sample Request

Copy
https://rds.us-east-1.amazonaws.com/ ?Action=ModifyOptionGroup &ApplyImmediately=true &OptionGroupName=myawsuser-og02 &OptionsToInclude.member.1.DBSecurityGroupMemberships.member.1=default &OptionsToInclude.member.1.OptionName=MEMCACHED &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140501/us-east-1/rds/aws4_request &X-Amz-Date=20140501T230529Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=4b278baae6294738704a9948e355af0e9bd4fa0913d5b35b0a9a3c916925aced

Sample Response

Copy
<ModifyOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <ModifyOptionGroupResult> <OptionGroup> <OptionGroupName>myawsuser-og02</OptionGroupName> <MajorEngineVersion>5.6</MajorEngineVersion> <AllowsVpcAndNonVpcInstanceMemberships>false</AllowsVpcAndNonVpcInstanceMemberships> <EngineName>mysql</EngineName> <OptionGroupDescription>my second og</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> </ModifyOptionGroupResult> <ResponseMetadata> <RequestId>073cfb45-c184-11d3-a537-cef97546330c</RequestId> </ResponseMetadata> </ModifyOptionGroupResponse>

Example

Sample Request

Copy
https://rds.us-east-1.amazonaws.com/ ?Action=ModifyOptionGroup &ApplyImmediately=true &OptionGroupName=myawsuser-og02 &OptionsToRemove.OptionName=MEMCACHED &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140501/us-east-1/rds/aws4_request &X-Amz-Date=20140501T231731Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=fd7ee924d39f1014488eb3444a8fdfb028e958b97703f95845a5addc435c1399

Sample Response

Copy
<ModifyOptionGroupResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <ModifyOptionGroupResult> <OptionGroup> <OptionGroupName>myawsuser-og02</OptionGroupName> <AllowsVpcAndNonVpcInstanceMemberships>true</AllowsVpcAndNonVpcInstanceMemberships> <MajorEngineVersion>5.6</MajorEngineVersion> <EngineName>mysql</EngineName> <OptionGroupDescription>my second og</OptionGroupDescription> <Options/> </OptionGroup> </ModifyOptionGroupResult> <ResponseMetadata> <RequestId>b5f134f3-c185-11d3-f4c6-37db295f7674</RequestId> </ResponseMetadata> </ModifyOptionGroupResponse>

See Also

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