CreateGlobalCluster - Amazon DocumentDB

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateGlobalCluster

複数の AWS リージョンにまたがることができる Amazon DocumentDB グローバルクラスターを作成します。グローバルクラスターには、読み取り・書き込み機能を備えたプライマリクラスターが 1 つと、読み取り専用のセカンダリクラスターが含まれます。グローバルクラスターは、ワークロードのパフォーマンスに影響を与えることなく、専用のインフラストラクチャを使用して、1 秒未満のレイテンシーでリージョンにわたってストレージベースの高速レプリケーションを使用します。

最初は空のグローバルクラスターを作成し、そこにプライマリとセカンダリを追加できます。または、作成操作中に既存のクラスターを指定し、そのクラスターをグローバルクラスターのプライマリにすることもできます。

注記

このアクションは Amazon DocumentDB クラスターにのみ適用されます。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

GlobalClusterIdentifier

新しいグローバルクラスターのクラスター識別子。

型: 文字列

長さの制限:最小長は 1 です。最大長は 255 です。

パターン: [A-Za-z][0-9A-Za-z-:._]*

必須:はい

DatabaseName

データベースの名前を、英数字 64 文字以内で入力します。名前を入力しない場合は、Amazon DocumentDB は作成するグローバルクラスター上にデータベースを作成しません。

タイプ: 文字列

必須: いいえ

DeletionProtection

新しいグローバルクラスターの削除保護設定。削除保護が有効な場合、グローバルクラスターは削除できません。

型: ブール値

必須: いいえ

Engine

このクラスターに使用されるデータベースエンジン名。

タイプ: 文字列

必須: いいえ

EngineVersion

グローバルクラスターのエンジンバージョン。

タイプ: 文字列

必須: いいえ

SourceDBClusterIdentifier

グローバルクラスターのプライマリクラスターとして使用する Amazon リソースネーム (ARN)。このパラメータはオプションです。

タイプ: 文字列

必須: いいえ

StorageEncrypted

新しいグローバルクラスターのストレージ暗号化設定。

型: ブール値

必須: いいえ

レスポンス要素

以下の要素がサービスによって返されます。

GlobalCluster

Amazon DocumentDB グローバルクラスターを表すデータ型。

型: GlobalCluster オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

DBClusterNotFoundFault

DBClusterIdentifier は既存のクラスターを参照していません。

HTTP ステータスコード: 404

GlobalClusterAlreadyExistsFault

GlobalClusterIdentifier は既に存在します。新しいグローバルクラスター識別子 (一意の名前) を選択して、新しいグローバルクラスターを作成します。

HTTP ステータスコード:400

GlobalClusterQuotaExceededFault

このアカウントのグローバルクラスター数は、すでに許容最大数に達しています。

HTTP ステータスコード:400

InvalidDBClusterStateFault

クラスターは有効な状態ではありません。

HTTP ステータスコード:400

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。