AWS::RDS::OptionGroup OptionSetting - Amazon CloudFormation
SyntaxPropertiesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::RDS::OptionGroup OptionSetting

The OptionSetting property type specifies the value for an option within an OptionSetting property.

Syntax

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

JSON

{
  "Name" : String,
  "Value" : String
}

YAML

  Name: String
  Value: String

Properties

Name

The name of the option that has settings that you can set.

Required: No

Type: String

Update requires: No interruption

Value

The current value of the option setting.

Required: No

Type: String

Update requires: No interruption

Examples

Enable ingress to a DB security group

The following example creates an option group for the Oracle Enterprise Edition engine, version 19, and configures it with the Oracle Enterprise Manager option, specifying necessary option settings and a port.

JSON

{
  "Resources": {
    "MyOptionGroup": {
      "Type": "AWS::RDS::OptionGroup",
      "Properties": {
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "19",
        "OptionGroupDescription": "My Oracle OEM Option Group",
        "Options": [
          {
            "OptionName": "OEM",
            "Port": 5500,
            "OptionSettings": [
              {
                "Name": "OEM_HOST",
                "Value": "oem.example.com"
              },
              {
                "Name": "OEM_PORT",
                "Value": "5500"
              },
              {
                "Name": "SECURITY_GROUP_IDS",
                "Value": "sg-0123456789abcdef0"
              }
            ]
          }
        ],
        "Tags": [
          {
            "Key": "Name",
            "Value": "MyOptionGroup"
          }
        ]
      }
    }
  }
}

YAML

Resources:
  MyOptionGroup:
    Type: AWS::RDS::OptionGroup
    Properties:
      EngineName: oracle-ee
      MajorEngineVersion: 19
      OptionGroupDescription: My Oracle OEM Option Group
      Options:
        - OptionName: OEM
          Port: 5500
          OptionSettings:
            - Name: OEM_HOST
              Value: oem.example.com
            - Name: OEM_PORT
              Value: 5500
            - Name: SECURITY_GROUP_IDS
              Value: sg-0123456789abcdef0
      Tags:
        - Key: Name
          Value: MyOptionGroup