Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Relational Database Service Resource Types Reference » AWS::RDS::OptionGroup

AWS::RDS::OptionGroup

Use the AWS::RDS::OptionGroup resource to create an option group that can make managing data and databases easier. For more information about option groups, see Working with Option Groups in the Amazon Relational Database Service User Guide.

Syntax

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

JSON

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

YAML

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

Properties

EngineName

The name of the database engine that this option group is associated with.

Required: Yes

Type: String

Update requires: Replacement

MajorEngineVersion

The major version number of the database engine that this option group is associated with.

Required: Yes

Type: String

Update requires: Replacement

OptionGroupDescription

A description of the option group.

Required: Yes

Type: String

Update requires: Replacement

OptionConfigurations

The configurations for this option group.

Required: Yes

Type: List of OptionConfiguration

Update requires: Replacement

Tags

An arbitrary set of tags (key–value pairs) for this option group.

Required: No

Type: Resource Tag

Update requires: No interruption

Return Values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name. For example: 

{ "Ref": "myOptionGroup" }

For the myOptionGroup resource, Ref returns the name of the option group.

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

Examples

Multiple Option Configurations

The following snippet 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: 
  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"

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:
  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