Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon Relational Database Service OptionGroup OptionConfiguration

Use the OptionConfigurations property to configure an option and its settings for an AWS::RDS::OptionGroup resource.

Syntax

JSON

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

YAML

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

Properties

DBSecurityGroupMemberships

A list of database security group names for this option. If the option requires access to a port, the security groups must allow access to that port. If you specify this property, don't specify the VPCSecurityGroupMemberships property.

Required: No

Type: List of String values

OptionName

The name of the option. For more information about options, see Working with Option Groups in the Amazon Relational Database Service User Guide.

Required: Yes

Type: String

OptionSettings

The settings for this option.

Required: No

Type: List of Amazon RDS OptionGroup OptionSetting

OptionVersion

The version for the option.

Required: No

Type: String

Port

The port number that this option uses.

Required: No

Type: Integer

VpcSecurityGroupMemberships

A list of VPC security group IDs for this option. If the option requires access to a port, the security groups must allow access to that port. If you specify this property, don't specify the DBSecurityGroupMemberships property.

Required: No

Type: List of String values

Examples

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

JSON

Copy
{ "AWSTemplateFormatVersion": "2010-09-09", "Description":"APEX has a dependency on XMLDB, so, there must be at least one XMLDB when there is a 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

Copy
AWSTemplateFormatVersion: 2010-09-09 Description: >- APEX has a dependency on XMLDB, so, there must be at least one XMLDB when there is a 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

See Also