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

AWS::Redshift::ClusterParameterGroup

Amazon Redshift クラスターに関連付けることができる Amazon Redshift パラメーターグループを作成します。グループ内のパラメーターはクラスターに作成したすべてのデータベースに適用されます。

構文

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

JSON

Copy
{ "Type" : "AWS::Redshift::ClusterParameterGroup", "Properties" : { "Description" : String, "ParameterGroupFamily" : String, "Parameters" : [ Parameter, ... ], "Tags" : [ Resource Tag, ... ] } }

YAML

Copy
Type: "AWS::Redshift::ClusterParameterGroup" Properties: Description: String ParameterGroupFamily: String Parameters: - Parameter Tags: - Resource Tag

プロパティ

Description

パラメーターグループの説明。

Required: Yes

Type: String

更新に伴う要件: 置換

ParameterGroupFamily

このクラスターパラメーターグループに適用する Amazon Redshift エンジンバージョン。Parameters プロパティで指定できる一連のパラメーターは、クラスターエンジンバージョンによって決まります。

Required: Yes

Type: String

更新に伴う要件: 置換

Parameters

ParameterGroupFamily プロパティに指定した Amazon Redshift エンジンバージョンで許可されるパラメーターの名前と値のリスト。詳細については、Amazon Redshift Cluster Management Guideの「Amazon Redshift パラメーターグループ」を参照してください。

Required: No

タイプ: Amazon Redshift パラメーターの型

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

Tags

このパラメーターグループに関連付ける任意のタグのセット (キーと値のペア) を指定します。タグを使ってリソースを管理します。

Required: No

Type: AWS CloudFormation Resource Tags

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

戻り値

参照番号

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

Copy
{ "Ref": "myClusterParameterGroup" }

Amazon Redshift クラスターパラメーターグループ myClusterParameterGroup について、クラスターパラメーターグループの名前が Ref から返されます。

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

単一のパラメーター

次の例は、パラメーターが 1 つ指定されたパラメーターグループを表しています。

JSON

Copy
"myClusterParameterGroup" : { "Type" : "AWS::Redshift::ClusterParameterGroup", "Properties" : { "Description" : "My parameter group", "ParameterGroupFamily" : "redshift-1.0", "Parameters" : [ { "ParameterName" : "enable_user_activity_logging", "ParameterValue" : "true" }] } }

YAML

Copy
myClusterParameterGroup: Type: "AWS::Redshift::ClusterParameterGroup" Properties: Description: "My parameter group" ParameterGroupFamily: "redshift-1.0" Parameters: - ParameterName: "enable_user_activity_logging" ParameterValue: "true"

ワークロード管理設定

次の例は、wlm_json_configuration パラメーターを使用して、ワークロード管理設定を変更します。パラメーターの値は JSON オブジェクトです。引用符 (") で囲んだ文字列として渡す必要があります。

JSON

Copy
"RedshiftClusterParameterGroup": { "Type": "AWS::Redshift::ClusterParameterGroup", "Properties": { "Description": "Cluster parameter group", "ParameterGroupFamily": "redshift-1.0", "Parameters": [{ "ParameterName": "wlm_json_configuration", "ParameterValue": "[{\"user_group\":[\"example_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concurrency\":7},{\"query_concurrency\":5}]" }], "Tags": [ { "Key": "foo", "Value": "bar" } ] } }

YAML

Copy
RedshiftClusterParameterGroup: Type: "AWS::Redshift::ClusterParameterGroup" Properties: Description: "Cluster parameter group" ParameterGroupFamily: "redshift-1.0" Parameters: - ParameterName: "wlm_json_configuration" ParameterValue: "[{\"user_group\":[\"example_user_group1\"],\"query_group\":[\"example_query_group1\"],\"query_concurrency\":7},{\"query_concurrency\":5}]" Tags: - Key: foo Value: bar

このページの内容: