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

AWS::RDS::DBParameterGroup

RDS データベースファミリーのカスタムパラメーターグループを作成します。RDS パラメーターグループの詳細については、Amazon Relational Database Service ユーザーガイドの「DB パラメーターグループの操作」を参照してください。

この型はテンプレートで宣言され、AWS::RDS::DBInstanceDBParameterGroupName パラメーターで参照できます。

注記

DBInstance に ParameterGroup を適用すると、インスタンスの再起動が必要になる場合があり、再起動中はデータベースが停止することになります。

構文

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

JSON

Copy
{ "Type" : "AWS::RDS::DBParameterGroup", "Properties" : { "Description" : String, "Family" : String, "Parameters" : DBParameters, "Tags" : [ Resource Tag, ... ] } }

YAML

Copy
Type: "AWS::RDS::DBParameterGroup" Properties: Description: String Family: String Parameters: DBParameters Tags: - Resource Tag

プロパティ

Description

RDS パラメーターグループのわかりやすい説明です。たとえば、"My Parameter Group" と指定します。

Required: Yes

型: 文字列

[Update requires]: アップデートはサポートされていません。

Family

この RDS パラメーターグループのデータベースファミリーです。たとえば、"MySQL5.1" と指定します。

Required: Yes

型: 文字列

[Update requires]: アップデートはサポートされていません。

Parameters

この RDS パラメーターグループに対して設定するパラメーターです。

Required: No

タイプ: 次の例に示すように、文字列とキー値ペアで構成される JSON オブジェクト:

Copy
"Parameters" : { "Key1" : "Value1", "Key2" : "Value2", "Key3" : "Value3" }

更新に伴う要件: 中断はありません。 または一時的な中断があります。動的パラメーターの変更は直ちに適用されます。更新の際、静的パラメーター (変更されたかどうかに関わらず) がある場合、AWS CloudFormation はフェイルオーバーなしで関連する DB インスタンスを再起動するようトリガーします。

Tags

RDS パラメーターグループにアタッチするタグです。

Required: No

: リソースタグのリスト。

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

戻り値

参照番号

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

Copy
{ "Ref": "MyDBParameterGroup" }

論理 ID が "MyDBParameterGroup" の RDS::DBParameterGroup に対し、Ref はリソース名を返します。

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

以下のスニペットは、IGNORE_SPACE SQL モードを適用する Aurora DB クラスターのパラメーターグループを作成します。

JSON

Copy
"RDSDBParameterGroup": { "Type": "AWS::RDS::DBParameterGroup", "Properties" : { "Description" : "CloudFormation Sample Parameter Group", "Family" : "aurora5.6", "Parameters" : { "sql_mode": "IGNORE_SPACE" } } }

YAML

Copy
RDSDBParameterGroup: Type: AWS::RDS::DBParameterGroup Properties: Description: CloudFormation Sample Parameter Group Family: aurora5.6 Parameters: sql_mode: IGNORE_SPACE

このページの内容: