AWS::RDS::OptionGroup OptionConfiguration

The OptionConfiguration property type specifies an individual option, and its settings, within an AWS::RDS::OptionGroup resource.

Syntax

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

JSON

{
  "DBSecurityGroupMemberships" : [ String, ... ],
  "OptionName" : String,
  "OptionSettings" : [ OptionSetting, ... ],
  "OptionVersion" : String,
  "Port" : Integer,
  "VpcSecurityGroupMemberships" : [ String, ... ]
}

YAML

  DBSecurityGroupMemberships: 
    - String
  OptionName: String
  OptionSettings: 
    - OptionSetting
  OptionVersion: String
  Port: Integer
  VpcSecurityGroupMemberships: 
    - String

Properties

DBSecurityGroupMemberships

A list of DB security groups used for this option.

Required: No

Type: Array of String

Update requires: No interruption

OptionName

The configuration of options to include in a group.

Required: Yes

Type: String

Update requires: No interruption

OptionSettings

The option settings to include in an option group.

Required: No

Type: Array of OptionSetting

Update requires: No interruption

OptionVersion

The version for the option.

Required: No

Type: String

Update requires: No interruption

Port

The optional port for the option.

Required: No

Type: Integer

Update requires: No interruption

VpcSecurityGroupMemberships

A list of VPC security group names used for this option.

Required: No

Type: Array of String

Update requires: No interruption

Examples

Specify an option configuration

The following example template uses OptionName and OptionVersion parameters when creating an AWS::RDS::OptionGroup resource.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "APEX has a dependency on XMLDB, so, there must be at least one XMLDB when there is an APEX",
    "Parameters": {
        "OptionName": {
            "Type": "String"
        },
        "OptionVersion": {
            "Type": "String"
        }
    },
    "Resources": {
        "myOptionGroup": {
            "Type": "AWS::RDS::OptionGroup",
            "Properties": {
                "EngineName": "oracle-ee",
                "MajorEngineVersion": "11.2",
                "OptionGroupDescription": "testing creating optionGroup with APEX version",
                "OptionConfigurations": [
                    {
                        "OptionName": "XMLDB"
                    },
                    {
                        "OptionName": {
                            "Ref": "OptionName"
                        },
                        "OptionVersion": {
                            "Ref": "OptionVersion"
                        }
                    }
                ]
            }
        }
    }
}

YAML

--- 
AWSTemplateFormatVersion: 2010-09-09
Description: "APEX has a dependency on XMLDB, so, there must be at least one XMLDB when there is an APEX"
Parameters: 
  OptionName: 
    Type: String
  OptionVersion: 
    Type: String
Resources: 
  myOptionGroup: 
    Properties: 
      EngineName: oracle-ee
      MajorEngineVersion: "11.2"
      OptionConfigurations: 
        - 
          OptionName: XMLDB
        - 
          OptionName: OptionName
          OptionVersion: OptionVersion
      OptionGroupDescription: "testing creating optionGroup with APEX version"
    Type: AWS::RDS::OptionGroup