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

AWS::RDS::DBCluster

AWS::RDS::DBCluster リソースは、Amazon RDS (Amazon Aurora) DB クラスターの Aurora などのクラスターを作成します。Amazon Aurora は完全に管理された MySQL 互換のリレーショナルデータベースエンジンです。詳細については、Amazon Relational Database Service ユーザーガイドAurora on Amazon RDS を参照してください。

注記

現在、Amazon Aurora がサポートされるリージョンでのみこのリソースを作成できます。

AWS::RDS::DBCluster リソースのデフォルトの DeletionPolicy は Snapshot です。AWS CloudFormation によってリソースが削除される方法の詳細については、「DeletionPolicy 属性」を参照してください。

構文

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

JSON

Copy
{ "Type" : "AWS::RDS::DBCluster", "Properties" : { "AvailabilityZones" : [ String, ... ], "BackupRetentionPeriod" : Integer, "DatabaseName" : String, "DBClusterParameterGroupName" : String, "DBSubnetGroupName" : String, "Engine" : String, "EngineVersion" : String, "KmsKeyId" : String, "MasterUsername" : String, "MasterUserPassword" : String, "Port" : Integer, "PreferredBackupWindow" : String, "PreferredMaintenanceWindow" : String, "ReplicationSourceIdentifier" : String, "SnapshotIdentifier" : String, "StorageEncrypted" : Boolean, "Tags" : [ Resource Tag, ... ], "VpcSecurityGroupIds" : [ String, ... ] } }

YAML

Copy
Type: "AWS::RDS::DBCluster" Properties: AvailabilityZones: - 文字列 BackupRetentionPeriod: Integer DatabaseName: String DBClusterParameterGroupName: String DBSubnetGroupName: String Engine: String EngineVersion: String KmsKeyId: String MasterUsername: String MasterUserPassword: String Port: Integer PreferredBackupWindow: String PreferredMaintenanceWindow: String ReplicationSourceIdentifier: String SnapshotIdentifier: String StorageEncrypted: Boolean Tags: - Resource Tag VpcSecurityGroupIds: - 文字列

プロパティ

AvailabilityZones

クラスターの DB インスタンスを作成できるアベイラビリティーゾーン (AZ) のリスト。

Required: No

Type: String

更新に伴う要件: 置換

BackupRetentionPeriod

自動バックアップを維持される日数。詳細については、「CreateDBCluster」(Amazon Relational Database Service API Reference) を参照してください。

Required: No

Type: Integer

更新に伴う要件: 中断はありません。 または一時的な中断があります。詳細については、Amazon Relational Database Service API Referenceの「ModifyDBInstance」を参照してください。

DatabaseName

データベースの名前。8 つ以内の英数字での名前を指定できます。名前を入力しないと、Amazon Relational Database Service (Amazon RDS) はこの DB クラスター内でデータベースを作成しません。

Required: No

Type: String

更新に伴う要件: 置換

DBClusterParameterGroupName

このクラスターに関連付ける DB クラスターパラメーターグループの名前。デフォルト値については、DBClusterParameterGroupName パラメーター、CreateDBCluster アクション (Amazon Relational Database Service API Reference) を参照してください。

Required: No

Type: String

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

DBSubnetGroupName

この DB クラスターと関連付けたい DB サブネットグループ。

Required: No

Type: String

更新に伴う要件: 置換

Engine

この DB クラスターに使用するデータベースエンジンの名前。

有効な値については、Engine パラメーター、「CreateDBCluster」アクション (Amazon Relational Database Service API Reference) を参照してください。

Required: Yes

Type: String

更新に伴う要件: 置換

EngineVersion

使用するデータベースエンジンのバージョン番号。

Required: No

Type: String

更新に伴う要件: 置換

KmsKeyId

DB クラスターのデータベースインスタンスを暗号化するために使用される、arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef のような、AWS Key Management Service マスターキーの Amazon リソースネーム (ARN)。StorageEncrypted プロパティを有効にして、このプロパティを指定しない場合、デフォルトのマスターキーが使用されます。このプロパティを指定する場合は、StorageEncrypted プロパティを true に設定する必要があります。

SnapshotIdentifier を指定した場合、このプロパティは指定しないでください。値はスナップショット DB クラスターから継承されます。

Required: No

Type: String

更新に伴う要件: 置換

MasterUsername

DB インスタンスのマスターユーザー名。

Required: Conditional。プロパティに SnapshotIdentifier を指定しない場合は、このプロパティを指定する必要があります。その場合は、このプロパティを指定しないでください。

Type: String

更新に伴う要件: 置換

MasterUserPassword

マスターデータベースユーザーのパスワードです。

Required: Conditional。プロパティに SnapshotIdentifier を指定しない場合は、このプロパティを指定する必要があります。その場合は、このプロパティを指定しないでください。

Type: String

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

Port

クラスターの DB インスタンスが接続を受け付けることができるポート番号。

Required: No

Type: Integer

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

PreferredBackupWindow

自動バックアップが有効な場合 (BackupRetentionPeriod を参照) に、自動バックアップを作成する毎日の UTC 時間の範囲。

有効な値については、Amazon Relational Database Service API Referenceの「CreateDBInstance」の PreferredBackupWindow パラメーターを参照してください。

Required: No

Type: String

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

PreferredMaintenanceWindow

週 1 回のシステムメンテナンスを実行できる時間帯 (UTC)

有効な値については、Amazon Relational Database Service API Referenceの「CreateDBInstance」の PreferredMaintenanceWindow パラメーターを参照してください。

Required: No

Type: String

更新に伴う要件: 中断はありません。 または一時的な中断があります。詳細については、Amazon Relational Database Service API Referenceの「ModifyDBInstance」を参照してください。

ReplicationSourceIdentifier

この DB クラスターがリードレプリカとして作成されている場合の、ソース Amazon RDS MySQL DB インスタンスまたは DB クラスターの Amazon リソースネーム (ARN)。

Required: No

Type: String

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

SnapshotIdentifier

復元する DB クラスタースナップショットの識別子。

Required: No

Type: String

更新に伴う要件: 置換

StorageEncrypted

クラスターの DB インスタンスを暗号化するかどうかを指定します。

SnapshotIdentifier プロパティを指定した場合、このプロパティは指定しないでください。値はスナップショット DB クラスターから継承されます。

Required: Conditional。KmsKeyId プロパティを指定した場合、暗号化を有効にする必要があります。

Type: Boolean

更新に伴う要件: 置換

Tags

この DB クラスターにアタッチするタグ。

Required: No

: リソースタグのリスト

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

VpcSecurityGroupIds

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

Required: No

Type: List of String values

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

戻り値

参照番号

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

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

Fn::GetAtt

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

Endpoint.Address

DB クラスターの接続エンドポイント。たとえば、mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com です。

Endpoint.Port

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

ReadEndpoint.Address

DB クラスターの読み込みエンドポイント。たとえば、mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com です。

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

次のスニペットは、Amazon Aurora DB クラスターを作成し、複数の DB インスタンスを追加します。Amazon RDS は自動的にクラスターの作成側と読み取り側の DB インスタンスを割り当てるため、各 DB インスタンスのエンドポイントではなく、データの書き込みと読み取りを行うクラスターのエンドポイントを使用します。

JSON

Copy
"RDSCluster" : { "Type" : "AWS::RDS::DBCluster", "Properties" : { "MasterUsername" : { "Ref" : "username" }, "MasterUserPassword" : { "Ref" : "password" }, "Engine" : "aurora", "DBSubnetGroupName" : { "Ref" : "DBSubnetGroup" }, "DBClusterParameterGroupName" : { "Ref" : "RDSDBClusterParameterGroup" } } }, "RDSDBInstance1" : { "Type" : "AWS::RDS::DBInstance", "Properties" : { "DBSubnetGroupName" : { "Ref" : "DBSubnetGroup" }, "DBParameterGroupName" :{"Ref": "RDSDBParameterGroup"}, "Engine" : "aurora", "DBClusterIdentifier" : { "Ref" : "RDSCluster" }, "PubliclyAccessible" : "true", "AvailabilityZone" : { "Fn::GetAtt" : [ "Subnet1", "AvailabilityZone" ] }, "DBInstanceClass" : "db.r3.xlarge" } }, "RDSDBInstance2" : { "Type" : "AWS::RDS::DBInstance", "Properties" : { "DBSubnetGroupName" : { "Ref" : "DBSubnetGroup" }, "DBParameterGroupName" :{"Ref": "RDSDBParameterGroup"}, "Engine" : "aurora", "DBClusterIdentifier" : { "Ref" : "RDSCluster" }, "PubliclyAccessible" : "true", "AvailabilityZone" : { "Fn::GetAtt" : [ "Subnet2", "AvailabilityZone" ] }, "DBInstanceClass" : "db.r3.xlarge" } }, "RDSDBClusterParameterGroup" : { "Type": "AWS::RDS::DBClusterParameterGroup", "Properties" : { "Description" : "CloudFormation Sample Aurora Cluster Parameter Group", "Family" : "aurora5.6", "Parameters" : { "time_zone" : "US/Eastern" } } }, "RDSDBParameterGroup": { "Type": "AWS::RDS::DBParameterGroup", "Properties" : { "Description" : "CloudFormation Sample Aurora Parameter Group", "Family" : "aurora5.6", "Parameters" : { "sql_mode": "IGNORE_SPACE" } } }

YAML

Copy
RDSCluster: Type: AWS::RDS::DBCluster Properties: MasterUsername: Ref: username MasterUserPassword: Ref: password Engine: aurora DBSubnetGroupName: Ref: DBSubnetGroup DBClusterParameterGroupName: Ref: RDSDBClusterParameterGroup RDSDBInstance1: Type: AWS::RDS::DBInstance Properties: DBSubnetGroupName: Ref: DBSubnetGroup DBParameterGroupName: Ref: RDSDBParameterGroup Engine: aurora DBClusterIdentifier: Ref: RDSCluster PubliclyAccessible: 'true' AvailabilityZone: Fn::GetAtt: - Subnet1 - AvailabilityZone DBInstanceClass: db.r3.xlarge RDSDBInstance2: Type: AWS::RDS::DBInstance Properties: DBSubnetGroupName: Ref: DBSubnetGroup DBParameterGroupName: Ref: RDSDBParameterGroup Engine: aurora DBClusterIdentifier: Ref: RDSCluster PubliclyAccessible: 'true' AvailabilityZone: Fn::GetAtt: - Subnet2 - AvailabilityZone DBInstanceClass: db.r3.xlarge RDSDBClusterParameterGroup: Type: AWS::RDS::DBClusterParameterGroup Properties: Description: CloudFormation Sample Aurora Cluster Parameter Group Family: aurora5.6 Parameters: time_zone: US/Eastern RDSDBParameterGroup: Type: AWS::RDS::DBParameterGroup Properties: Description: CloudFormation Sample Aurora Parameter Group Family: aurora5.6 Parameters: sql_mode: IGNORE_SPACE

このページの内容: