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

AWS::RDS::DBClusterParameterGroup

The AWS::RDS::DBClusterParameterGroup リソースは、新しい Amazon Relational Database Service (Amazon RDS) データベース (DB) クラスターのパラメーターグループを作成します。DB クラスターのパラメーターグループの詳細については、付録: DB クラスターパラメーターと DB インスタンスパラメーター」(Amazon Relational Database Service ユーザーガイド) を参照してください。

注記

パラメーターグループを DB クラスターに適用すると、インスタンスの再起動が必要になる場合があり、再起動中はデータベースが停止することになります。

構文

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

JSON

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

YAML

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

プロパティ

Description

このDB クラスターパラメーターグループのわかりやすい説明。

Required: Yes

型: 文字列

更新に伴う要件: 置換

Family

aurora5.6 などの、このクラスター DB パラメーターグループのデータベースファミリー。

Required: Yes

型: 文字列

更新に伴う要件: 置換

Parameters

この DB クラスターパラメーターグループに対して設定するパラメーターです。パラメーターキーのリストについては、「付録: DB クラスターパラメーターと DB インスタンスパラメーター」(Amazon Relational Database Service ユーザーガイド) を参照してください。

動的パラメータの変更は直ちに適用されます。静的パラメーターの変更の場合、変更を有効にするには、パラメーターグループに関連付けられている DB インスタンスにフェイルオーバーせずに再起動する必要があります。

Required: Yes

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

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

更新するパラメーターによって、更新に伴う要件: 中断はありません。 または一時的な中断があります。

Tags

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

Required: No

: リソースタグ のリスト

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

戻り値

参照番号

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

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

次のスニペットは UTF32 に文字セットデータベースを設定するパラメーターグループを作成します:

JSON

Copy
"RDSDBClusterParameterGroup" : { "Type" : "AWS::RDS::DBClusterParameterGroup", "Properties" : { "Parameters" : { "character_set_database" : "utf32" }, "Family" : "aurora5.6", "Description" : "A sample parameter group" } }

YAML

Copy
RDSDBClusterParameterGroup: Type: "AWS::RDS::DBClusterParameterGroup" Properties: Parameters: character_set_database: "utf32" Family: "aurora5.6" Description: "A sample parameter group"

このページの内容: