メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::RDS::OptionGroup

AWS::RDS::OptionGroup リソースを使用して、データとデータベースの管理を簡単にすることができるオプショングループを作成します。オプショングループの詳細については、Amazon Relational Database Service ユーザーガイドの「オプショングループを使用する」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

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

プロパティ

EngineName

このオプショングループが関連付けられているデータベースエンジンの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

MajorEngineVersion

このオプショングループが関連付けられているデータベースエンジンのメジャーバージョン番号。

Required: Yes

Type: String

更新に伴う要件: 置換

OptionGroupDescription

オプショングループの説明。

Required: Yes

Type: String

更新に伴う要件: 置換

OptionConfigurations

このオプショングループの設定。

Required: Yes

Amazon RDS OptionGroup OptionConfigurationType: リスト

更新に伴う要件: 置換

Tags

このオプショングループに対する任意のタグのセット (キーと値のペア)。

Required: No

Type: AWS CloudFormation Resource Tags

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref によりリソース名が返されます。 例:

Copy
{ "Ref": "myOptionGroup" }

myOptionGroup リソースの場合、Ref はオプショングループの名前を返します。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

複数のオプションの設定

次のスニペットでは、2 つのオプション設定 (OEMAPEX) を持つオプショングループを作成します。

JSON

Copy
"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

Copy
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"

複数の設定

次のスニペットでは、MEMCACHED オプションに 2 つの設定を指定するオプショングループを作成します。

JSON

Copy
"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

Copy
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

このページの内容: