AWS CloudFormation
User Guide (Version )

AWS::RDS::OptionGroup

The AWS::RDS::OptionGroup resource creates an option group, to enable and configure features that are specific to a particular DB engine.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::RDS::OptionGroup", "Properties" : { "EngineName" : String, "MajorEngineVersion" : String, "OptionConfigurations" : [ OptionConfiguration, ... ], "OptionGroupDescription" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::RDS::OptionGroup Properties: EngineName: String MajorEngineVersion: String OptionConfigurations: - OptionConfiguration OptionGroupDescription: String Tags: - Tag

Properties

EngineName

Specifies the name of the engine that this option group should be associated with.

Required: Yes

Type: String

Update requires: Replacement

MajorEngineVersion

Specifies the major version of the engine that this option group should be associated with.

Required: Yes

Type: String

Update requires: Replacement

OptionConfigurations

A list of all available options

Required: Yes

Type: List of OptionConfiguration

Update requires: Replacement

OptionGroupDescription

The description of the option group.

Required: Yes

Type: String

Update requires: Replacement

Tags

Tags to assign to the option group.

Required: No

Type: List of Tag

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the option group.

For more information about using the Ref function, see Ref.

Examples

Multiple Option Configurations

The following example creates an option group with two option configurations (OEM and APEX):

JSON

{ "OracleOptionGroup": { "Type": "AWS::RDS::OptionGroup", "Properties": { "EngineName": "oracle-ee", "MajorEngineVersion": "12.1", "OptionGroupDescription": "A test option group", "OptionConfigurations": [ { "OptionName": "OEM", "DBSecurityGroupMemberships": [ "default" ], "Port": "5500" }, { "OptionName": "APEX" } ] } } }

YAML

--- OracleOptionGroup: Properties: EngineName: oracle-ee MajorEngineVersion: "12.1" OptionConfigurations: - DBSecurityGroupMemberships: - default OptionName: OEM Port: "5500" - OptionName: APEX OptionGroupDescription: "A test option group" Type: "AWS::RDS::OptionGroup"

Multiple Settings

The following snippet creates an option group that specifies two option settings for the MEMCACHED option:

JSON

{ "SQLOptionGroup": { "Type": "AWS::RDS::OptionGroup", "Properties": { "EngineName": "mysql", "MajorEngineVersion": "5.6", "OptionGroupDescription": "A test option group", "OptionConfigurations": [ { "OptionName": "MEMCACHED", "VpcSecurityGroupMemberships": [ "sg-a1238db7" ], "Port": "1234", "OptionSettings": [ { "Name": "CHUNK_SIZE", "Value": "32" }, { "Name": "BINDING_PROTOCOL", "Value": "ascii" } ] } ] } } }

YAML

--- SQLOptionGroup: Properties: EngineName: mysql MajorEngineVersion: "5.6" OptionConfigurations: - OptionName: MEMCACHED OptionSettings: - Name: CHUNK_SIZE Value: "32" - Name: BINDING_PROTOCOL Value: ascii Port: "1234" VpcSecurityGroupMemberships: - sg-a1238db7 OptionGroupDescription: "A test option group" Type: "AWS::RDS::OptionGroup"