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

AWS::Redshift::Cluster

AWS::Redshift::Clusterリソースを使用して、Amazon Redshift クラスターを作成します。クラスター とはコンピューティングノードの組み合わせで構成されるフルマネージド型データウェアハウスです。デフォルト値および有効な値の詳細については、Amazon Redshift API ReferenceCreateCluster を参照してください。

構文

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

JSON

Copy
{ "Type" : "AWS::Redshift::Cluster", "Properties" : { "AllowVersionUpgrade" : Boolean, "AutomatedSnapshotRetentionPeriod" : Integer, "AvailabilityZone" : String, "ClusterParameterGroupName" : String, "ClusterSecurityGroups" : [ String, ... ], "ClusterSubnetGroupName" : String, "ClusterType" : String, "ClusterVersion" : String, "DBName" : String, "ElasticIp" : String, "Encrypted" : Boolean, "HsmClientCertificateIdentifier" : String, "HsmConfigurationIdentifier" : String, "IamRoles" : [ String, ... ], "KmsKeyId" : String, "LoggingProperties" : LoggingProperties, "MasterUsername" : String, "MasterUserPassword" : String, "NodeType" : String, "NumberOfNodes" : Integer, "OwnerAccount" : String, "Port" : Integer, "PreferredMaintenanceWindow" : String, "PubliclyAccessible" : Boolean, "SnapshotClusterIdentifier" : String, "SnapshotIdentifier" : String, "Tags" : [ リソースタグ, ... ], "VpcSecurityGroupIds" : [ String, ... ] } }

YAML

Copy
Type: "AWS::Redshift::Cluster" Properties: AllowVersionUpgrade: Boolean AutomatedSnapshotRetentionPeriod: Integer AvailabilityZone: String ClusterParameterGroupName: String ClusterSecurityGroups: - 文字列 ClusterSubnetGroupName: String ClusterType: String ClusterVersion: String DBName: String ElasticIp: String Encrypted: Boolean HsmClientCertificateIdentifier: String HsmConfigurationIdentifier: String IamRoles: - 文字列 KmsKeyId: String LoggingProperties: LoggingProperties MasterUsername: String MasterUserPassword: String NodeType: String NumberOfNodes: Integer OwnerAccount: String Port: Integer PreferredMaintenanceWindow: String PubliclyAccessible: Boolean SnapshotClusterIdentifier: String SnapshotIdentifier: String Tags: - リソースタグ VpcSecurityGroupIds: - 文字列

プロパティ

Amazon Redshift API Reference の 各プロパティの制約や有効な値などの詳細については、 CreateCluster

AllowVersionUpgrade

新しいバージョンの Amazon Redshift がリリースされたときに、クラスターで実行されているエンジンにアップグレードを適用できるかどうかを示します。アップグレードはメンテナンスの時間帯に適用されます。デフォルト値は true です。

Required: No

Type: Boolean

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

AutomatedSnapshotRetentionPeriod

自動スナップショットが保持される日数。デフォルト値は 1 です。自動スナップショットを無効にするには、値を 0 に設定します。

Required: No

Type: Integer

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

AvailabilityZone

Amazon Redshift クラスターのプロビジョニング先となる Amazon Elastic Compute Cloud (Amazon EC2) のアベイラビリティーゾーン。たとえば、特定のアベイラビリティーゾーンで実行されている EC2 インスタンスが複数存在する場合、同じゾーンにクラスターをプロビジョニングすることでネットワークのレイテンシーを低く抑えることができます。

Required: No

Type: String

更新に伴う要件: 置換

ClusterParameterGroupName

このクラスターに関連付けるパラメーターグループの名前。

Required: No

Type: String

更新に伴う要件: 一時的な中断。

ClusterSecurityGroups

このクラスターに関連付けるセキュリティグループのリスト。EC2-Classic に適用されます。

Required: No

Type: List of String values

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

ClusterSubnetGroupName

このクラスターに関連付けるクラスターサブネットグループの名前。

Required: No

Type: String

更新に伴う要件: 置換

ClusterType

クラスターのタイプ。single-node または multi-node (デフォルト) を指定します。

Required: Yes

Type: String

更新に伴う要件: 一時的な中断。

ClusterVersion

クラスターにデプロイする Amazon Redshift エンジンのバージョン。

Required: No

Type: String

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

DBName

クラスターの作成時に作成される最初のデータベースの名前。

Required: Yes

Type: String

更新に伴う要件: 置換

ElasticIp

クラスターのElastic IP (EIP) アドレス。

Required: No

Type: String

更新に伴う要件: 置換

Encrypted

クラスター内のデータを暗号化して保存するかどうかを示します。デフォルト値は false です。

Required: No

Type: Boolean

更新に伴う要件: 置換

HsmClientCertificateIdentifier

Amazon Redshift クラスターが使用するハードウェアセキュリティモジュール (HSM) クライアント証明書の名前を指定して、HSM に格納されているデータの暗号化キーを取得します。

Required: No

Type: String

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

HsmConfigurationIdentifier

Amazon Redshift クラスターが HSM 内のキーを取得したり保存したりするときに使用する情報を含む HSM 設定の名前。

Required: No

Type: String

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

IamRoles

クラスターが他の AWS サービスにアクセスするために使用する AWS Identity and Access Management (IAM) ロールのリスト。Amazon リソースネーム (ARN) で IAM ロールを指定します。1 回のリクエストで、最大 10 の IAM ロールを指定できます。クラスターには、一度に最大 10 個の IAM ロールを関連付けることができます。

Required: No

Type: String

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

KmsKeyId

クラスターでのデータの暗号化に使用する AWS Key Management Service (AWS KMS) キー ID。

Required: No

Type: String

更新に伴う要件: 置換

LoggingProperties

Amazon Redshift を設定して、このクラスターのクエリ、接続試行などのログ情報を含む監査ログファイルを作成します。

Required: No

Type: Amazon Redshift LoggingProperties

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

MasterUsername

このクラスターのマスターユーザーアカウントに関連付けるユーザー名。

Required: Yes

Type: String

更新に伴う要件: 置換

MasterUserPassword

このクラスターのマスターユーザーアカウントに関連付けるパスワード。

Required: Yes

Type: String

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

NodeType

このクラスターのためにプロビジョニングするノードタイプ。

Required: Yes

Type: String

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

NumberOfNodes

クラスターのコンピューティングノードの数。ClusterType パラメーターに multi-node を指定した場合、1 より大きな数を指定する必要があります。

重要

単一ノードクラスターにこのパラメーターを指定することはできません。

Required: Conditional

Type: Integer

更新に伴う要件: 一時的な中断。

OwnerAccount

別の AWS アカウントのスナップショットから復元するとき、そのスナップショットが存在する AWS アカウントの 12 桁の ID。

Required: No

Type: String

更新に伴う要件: 置換

Port

クラスターが着信接続を受け付けるポート番号。デフォルト値は 5439 です。

Required: No

Type: Integer

更新に伴う要件: 置換

PreferredMaintenanceWindow

週 1 回の自動化されたクラスターのメンテナンスを実行できる時間範囲 (UTC)。時間範囲は ddd:hh24:mi-ddd:hh24:mi 形式で指定します。

Required: No

Type: String

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

PubliclyAccessible

パブリックネットワークからクラスターにアクセスできるかどうかを示します。

Required: No

Type: Boolean

更新に伴う要件: 置換

SnapshotClusterIdentifier

スナップショットの作成元となったクラスターの名前。スナップショットからの復元の詳細については、Amazon Redshift API ReferenceRestoreFromClusterSnapshot アクションを参照してください。

Required: No

Required: Conditional。クラスター名に対する制限が IAM ポリシーに含まれる場合、このプロパティは必須です。また、このリソースの要素には、ワイルドカード文字 (*) を除く、任意のクラスター名を指定します。

更新に伴う要件: 置換

SnapshotIdentifier

新しいクラスターの作成元となるスナップショットの名前。

Required: Conditional。SnapshotClusterIdentifier プロパティを指定した場合は、このプロパティを指定する必要があります。

Type: String

更新に伴う要件: 置換

Tags

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

Required: No

Type: AWS CloudFormation Resource Tags

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

VpcSecurityGroupIds

このクラスターに関連付けられている VPC セキュリティグループのリスト。

Required: No

Type: List of String values

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

戻り値

参照番号

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

Copy
{ "Ref": "myCluster" }

Amazon Redshift クラスター myCluster について、そのクラスターの名前が Ref から返されます。

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

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Endpoint.Address

Amazon Redshift クラスターの接続エンドポイント。例: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com

Endpoint.Port

Amazon Redshift クラスターが接続を受け付けるポート番号。例: 5439

次の例は、単一ノードの Amazon Redshift クラスターを表しています。マスターユーザーパスワードは、同じテンプレートの入力パラメーターから参照されます。

JSON

Copy
"myCluster": { "Type": "AWS::Redshift::Cluster", "Properties": { "DBName": "mydb", "MasterUsername": "master", "MasterUserPassword": { "Ref" : "MasterUserPassword" }, "NodeType": "ds2.xlarge", "ClusterType": "single-node", "Tags": [ { "Key": "foo", "Value": "bar" } ] } }

YAML

Copy
myCluster: Type: "AWS::Redshift::Cluster" Properties: DBName: "mydb" MasterUsername: "master" MasterUserPassword: Ref: "MasterUserPassword" NodeType: "ds2.xlarge" ClusterType: "single-node" Tags: - Key: foo Value: bar

詳細

完全なサンプルテンプレートについては、「Amazon Redshift テンプレートスニペット」を参照してください。

このページの内容: