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

AWS::DAX::Cluster

AWS::DAX::Cluster リソースを使用して、Amazon DynamoDB で使用する DAX クラスターを作成します。

DAX クラスターの作成については、『Amazon DynamoDB 開発者ガイド』の「DAX クラスターの作成」と『Amazon DynamoDB 開発者ガイド』の「CreateCluster」を参照してください。

構文

JSON

Copy
{ "Type": "AWS::DAX::Cluster", "Properties": { "AvailabilityZones": [ String, ... ], "ClusterName": String, "Description": String, "IAMRoleARN": String, "NodeType": String, "NotificationTopicARN": String, "ParameterGroupName": String, "PreferredMaintenanceWindow": String, "ReplicationFactor": Integer, "SecurityGroupIds": [ String, ... ], "SubnetGroupName": String, "Tags": { 文字列: 文字列, ... } } }

YAML

Copy
Type: "AWS::DAX::Cluster" Properties: AvailabilityZones: [ String, ... ] ClusterName: String Description: String IAMRoleARN: String NodeType: String NotificationTopicARN: String ParameterGroupName: String PreferredMaintenanceWindow: String ReplicationFactor: Integer SecurityGroupIds: [ String, ... ] SubnetGroupName: String Tags: { 文字列: 文字列, ... }

プロパティ

AvailabilityZones

クラスターノードが作成されるアベイラビリティーゾーン (AZ)。クラスターに属するすべてのノードは、これらのアベイラビリティーゾーンに配置されます。複数の AZ にノードを分散させる場合は、このパラメータを使用します。

クラスター内の DAX ノードごとに 1 つ AZ を指定する必要があります。

Required: No

Type: List of String values

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

ClusterName

クラスター識別子。このパラメーターは小文字で保存されます。

Required: No

Type: String

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

Description

クラスターの説明。

Required: No

Type: String

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

IAMRoleARN

IAM ロールを識別する有効な Amazon リソースネーム (ARN)。実行時に、DAX はこのロールを引き受け、ロールのアクセス権限を使用して、お客様に代わって DynamoDB にアクセスします。

Required: Yes

Type: String

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

NodeType

クラスター内のノードのコンピューティング能力とメモリ容量。

Required: Yes

Type: String

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

NotificationTopicARN

通知が送信される先の Amazon SNS トピックの Amazon リソースネーム (ARN)。

注記

Amazon SNS トピック所有者は DAX クラスター所有者と同じであることが必要です。

Required: No

Type: String

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

ParameterGroupName

DAX クラスターに関連付けるパラメータグループ。

Required: No

Type: String

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

PreferredMaintenanceWindow

DAX クラスターの週次メンテナンスを実行する時間範囲を指定します。これは ddd:hh24:mi-ddd:hh24:mi 形式の範囲 (24 時間表記の UTC) として指定します。最短メンテナンス期間は 60 分です。ddd の有効値は、次のとおりです。

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

例: sun:05:00-sun:09:00

注記

キャッシュクラスターの作成または変更時に、必要なメンテナンス期間を指定しない場合、DAX では、ランダムに選択された曜日に対して 60 分のメンテナンス期間が割り当てられます。

Required: No

Type: String

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

ReplicationFactor

DAX クラスター内のノードの数。レプリケーション係数が 1 の場合は、リードレプリカを使用しない単一ノードクラスターが作成されます。耐障害性機能を追加するには、1 つまたは複数のリードレプリカを使用する複数ノードクラスターを作成できます。そのためには、ReplicationFactor を 2 以上に設定します。

注記

クラスターごとに 2 つ以上のリードレプリカを配置することをお勧めします。

Required: Yes

Type: Integer

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

SecurityGroupIds

DAX クラスターの各ノードに割り当てるセキュリティグループ ID のリスト (各セキュリティグループ ID はシステムによって生成されます)。

このパラメータを指定しない場合は、DAX によってデフォルトの VPC セキュリティグループが各ノードに割り当てられます。

Required: No

Type: List of String values

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

SubnetGroupName

レプリケーショングループに使用されるサブネットグループの名前。

重要

DAX クラスターは Amazon VPC 環境でのみ実行できます。サブネットグループで指定するすべてのサブネットは同じ VPC に存在する必要があります。

Required: Yes

Type: String

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

Tags

DAX クラスターに関連付けるタグのマップ。

Required: No

タイプ: 文字列から文字列へのマッピング

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

戻り値

参照番号

このリソースの論理 ID を Ref 組み込み関数に渡すと、Ref は作成された DAX クラスターの名前を返します。(例:

Copy
{ "Ref": "MyDAXCluster" }

次のような値が返されます:

Copy
MyDAXCluster

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

Fn::GetAtt

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

Arn

DAX クラスターの ARN を返します。(例:

Copy
{ "Fn::GetAtt": ["MyDAXCluster", "Arn"] }

次のような値が返されます:

Copy
arn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster
ClusterDiscoveryEndpoint

DAX クラスターの設定エンドポイントを返します。(例:

Copy
{ "Fn::GetAtt": ["MyDAXCluster", "ClusterDiscoveryEndpoint"] }

次のような値が返されます:

Copy
mydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

以下の例では、DAX クラスターを作成しています。

JSON

Copy
{ "AWSTemplateFormatVersion": "2010-09-09", "DDescription": "Create a DAX cluster", "Resources": { "daxCluster": { "Type": "AWS::DAX::Cluster", "Properties": { "ClusterName": "MyDAXCluster", "NodeType": "dax.r3.large", "ReplicationFactor": 1, "IAMRoleARN": "arn:aws:iam::111122223333:role/DaxAccess", "Description": "DAX cluster created with CloudFormation", "SubnetGroupName": "MySubnetGroup" } }, "subnetGroupClu": { "Type": "AWS::DAX::SubnetGroup", "Properties": { "SubnetGroupName": "MySubnetGroup", "Description": "Subnet group for DAX cluster", "SubnetIds": [ "subnet1", "subnet2" ] } }, "subnet1": { "Type": "AWS::EC2::Subnet", "Properties": { "VpcId": "daxVpc", "CidrBlock": "172.13.17.0/24", "AvailabilityZone": { "Fn::Select": [ 0, { "Fn::GetAZs": "" } ] } } }, "subnet2": { "Type": "AWS::EC2::Subnet", "Properties": { "VpcId": "daxVpc", "CidrBlock": "172.13.18.0/24", "AvailabilityZone": { "Fn::Select": [ 1, { "Fn::GetAZs": "" } ] } } }, "daxVpc": { "Type": "AWS::EC2::VPC", "Properties": { "CidrBlock": "172.13.0.0/16" } } }, "Outputs": { "Cluster": { "Value": "daxCluster" } } }

YAML

Copy
AWSTemplateFormatVersion: "2010-09-09" Description: "Create a DAX cluster" Resources: daxCluster: Type: AWS::DAX::Cluster Properties: ClusterName: "MyDAXCluster" NodeType: "dax.r3.large" ReplicationFactor: 1 IAMRoleARN: "arn:aws:iam::111122223333:role/DaxAccess" Description: "DAX cluster created with CloudFormation" SubnetGroupName: !Ref subnetGroupClu subnetGroupClu: Type: AWS::DAX::SubnetGroup Properties: SubnetGroupName: "CFNClusterSubnetGrp" Description: "Subnet group for DAX cluster" SubnetIds: - !Ref subnet1 - !Ref subnet2 subnet1: Type: AWS::EC2::Subnet Properties: VpcId: !Ref daxVpc CidrBlock: 172.13.17.0/24 AvailabilityZone: Fn::Select: - 0 - Fn::GetAZs: "" subnet2: Type: AWS::EC2::Subnet Properties: VpcId: !Ref daxVpc CidrBlock: 172.13.18.0/24 AvailabilityZone: Fn::Select: - 1 - Fn::GetAZs: "" daxVpc: Type: AWS::EC2::VPC Properties: CidrBlock: 172.13.0.0/16 Outputs: Cluster: Value: !Ref daxCluster

このページの内容: