CreateDBCluster - Amazon DocumentDB

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

CreateDBCluster

新しい Amazon DocumentDB クラスターを作成します。

リクエストパラメータ

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

DBClusterIdentifier

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

制約:

  • 1 ~ 63 の文字、数字またはハイフンを使用する必要があります。

  • 1 字目は文字である必要があります。

  • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

例:my-cluster

型: 文字列

必須: はい

Engine

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

有効な値: docdb

型: 文字列

必須: はい

AvailabilityZones.AvailabilityZone.N

クラスター内のインスタンスを作成できる Amazon EC2 アベイラビリティーゾーンのリスト。

型: 文字列の配列

必須:いいえ

BackupRetentionPeriod

自動バックアップを保管する日数。最小値 1 を指定しなければなりません。

デフォルト: 1

制約:

  • 1 ~ 35 の値にする必要があります。

型: 整数

必須:いいえ

DBClusterParameterGroupName

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

型: 文字列

必須: いいえ

DBSubnetGroupName

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

制約: 既存の DBSubnetGroup の名前と一致する必要があります。デフォルト値を使用することはできません。

例:mySubnetgroup

型: 文字列

必須: いいえ

DeletionProtection

このクラスターを削除できるかどうかを指定します。DeletionProtection を有効にすると、クラスターが変更され DeletionProtection が無効にならない限り、クラスターを削除することができません。DeletionProtection はクラスターが誤って削除されるのを防ぎます。

型: ブール値

必須:いいえ

EnableCloudwatchLogsExports.member.N

Amazon CloudWatch Logs にエクスポートするために有効にする必要があるログタイプのリスト。監査ログまたはプロファイラーログを有効にすることができます。詳細については、「Amazon DocumentDB 監査イベント」と「Amazon DocumentDB オペレーションのプロファイリング」を参照してください。詳細については、「Amazon DocumentDB イベント監査」と「Amazon DocumentDB 操作プロファイリング」を参照してください。

型: 文字列の配列

必須:いいえ

EngineVersion

使用するデータベースエンジンのバージョン番号。--engine-version は、デフォルトで最新のメジャーエンジンバージョンになります。本稼働ワークロードの場合、目的のメジャーエンジンのバージョンで、このパラメータを明示的に宣言することを推奨します。

型: 文字列

必須: いいえ

GlobalClusterIdentifier

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

型: 文字列

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

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

必須: いいえ

KmsKeyId

暗号化されたクラスターの AWS KMS キー識別子。

AWS KMS キー識別子は、AWS KMS 暗号化キーの Amazon リソースネーム (ARN) です。新しいクラスターの暗号化に使用する AWS KMS 暗号化キーを所有する AWS アカウント と同じアカウントを使用してクラスターを作成する場合、AWS KMS 暗号化キーの ARN の代わりに AWS KMS キーのエイリアスを使用できます。

KmsKeyId で暗号化キーが指定されていない場合:

  • StorageEncrypted パラメータが true の場合、Amazon DocumentDB はデフォルトの暗号化キーを使用します。

AWS KMS は AWS アカウント 用にデフォルトの暗号化キーを作成します。AWS アカウントには AWS リージョン ごとにデフォルトの暗号化キーがあります。

型: 文字列

必須: いいえ

MasterUsername

クラスターのマスターユーザーの名前。

制約:

  • 1~63 文字の英数字である必要があります。

  • 1 字目は文字である必要があります。

  • 選択したデータベースエンジンの予約語は使用できません。

型: 文字列

必須: いいえ

MasterUserPassword

マスターデータベースユーザーのパスワードです。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。

制約: 8 ~ 100 文字の長さの英数字である必要があります。

型: 文字列

必須: いいえ

Port

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

型: 整数

必須:いいえ

PreferredBackupWindow

BackupRetentionPeriod パラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。

デフォルトは、AWS リージョンごとに 8 時間の範囲からランダムに選択された、30 分の時間枠です。

制約:

  • hh24:mi-hh24:mi の形式である必要があります。

  • 時間は協定世界時 (UTC) である必要があります。

  • 必要なメンテナンス期間と競合してはいけません。

  • 少なくとも 30 分以上必要です。

型: 文字列

必須: いいえ

PreferredMaintenanceWindow

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

形式: ddd:hh24:mi-ddd:hh24:mi

デフォルトは、1 週間のうちのランダムな日に起こる、AWS リージョン あたり 8 時間の範囲からランダムに選択された、30 分の時間枠です。

有効な日: 月、火、水、木、金、土、日

制約: 最小限の 30 分単位のウィンドウ。

型: 文字列

必須: いいえ

PreSignedUrl

現在サポートされていません。

型: 文字列

必須: いいえ

StorageEncrypted

クラスターが暗号化されているかどうかを指定します。

型: ブール値

必須:いいえ

StorageType

DB クラスターに関連付けるストレージタイプ。

Amazon DocumentDB クラスターのストレージタイプの詳細については、「Amazon DocumentDB 開発者ガイド」の「クラスターストレージ設定」を参照してください。

ストレージタイプの有効な値 - standard | iopt1

デフォルト値は standard です

注記

ストレージタイプを iopt1 に設定して DocumentDB DB クラスターを作成すると、ストレージタイプが応答で返されます。この時 standard に設定すると、ストレージタイプは返されません。

型: 文字列

必須: いいえ

Tags.Tag.N

クラスターに割り当てられるタグ。

型: Tag オブジェクトの配列

必須:いいえ

VpcSecurityGroupIds.VpcSecurityGroupId.N

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

型: 文字列の配列

必須:いいえ

レスポンス要素

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

DBCluster

クラスターに関する詳細情報。

型: DBCluster オブジェクト

エラー

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

DBClusterAlreadyExistsFault

指定された識別子を持つクラスターをすでに持っています。

HTTP ステータスコード:400

DBClusterNotFoundFault

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

HTTP ステータスコード: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupName は既存のパラメータグループを参照していません。

HTTP ステータスコード: 404

DBClusterQuotaExceededFault

クラスターの最大許容クォータに達したため、クラスターを作成できません。

HTTP ステータスコード: 403

DBInstanceNotFound

DBInstanceIdentifier は既存のインスタンスを参照していません。

HTTP ステータスコード: 404

DBSubnetGroupDoesNotCoverEnoughAZs

アベイラビリティーゾーンが 1 つしかない場合を除き、サブネットグループ内のサブネットは 2 つ以上のアベイラビリティゾーンをカバーする必要があります。

HTTP ステータスコード:400

DBSubnetGroupNotFoundFault

DBSubnetGroupName は既存のサブネットグループを参照していません。

HTTP ステータスコード: 404

GlobalClusterNotFoundFault

GlobalClusterIdentifier は既存のグローバルクラスターを参照していません。

HTTP ステータスコード: 404

InsufficientStorageClusterCapacity

現在のアクションに使用可能なストレージが不十分です。使用できるストレージがより多い別のアベイラビリティーゾーンを使用するようにサブネットグループを更新することで、このエラーを解決できる場合があります。

HTTP ステータスコード:400

InvalidDBClusterStateFault

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

HTTP ステータスコード:400

InvalidDBInstanceState

指定されたインスタンスは 利用可能な 状態ではありません。

HTTP ステータスコード:400

InvalidDBSubnetGroupStateFault

サブネットグループは使用中のため削除できません。

HTTP ステータスコード:400

InvalidGlobalClusterStateFault

要求された操作は、クラスターがこの状態にある間は実行できません。

HTTP ステータスコード:400

InvalidSubnet

要求されたサブネットが無効であるか、共通の仮想プライベートクラウド (VPC) 内に存在しない複数のサブネットが要求されました。

HTTP ステータスコード:400

InvalidVPCNetworkStateFault

サブネットグループは、作成後に変更されたため、すべてのアベイラビリティーゾーンがカバーされません。

HTTP ステータスコード:400

KMSKeyNotAccessibleFault

AWS KMS キーへのアクセス時にエラーが発生しました。

HTTP ステータスコード:400

StorageQuotaExceeded

リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。

HTTP ステータスコード:400

以下の資料も参照してください。

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