翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # CreateDBCluster 新しい Amazon DocumentDB クラスターを作成します。 ## リクエストパラメーター すべてのアクションに共通のパラメータの詳細については、「[共通パラメータ](CommonParameters.md)」を参照してください。 ** DBClusterIdentifier ** クラスター識別子。このパラメータは小文字で保存されます。 制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字にする必要があります。 + ハイフンで終わることも、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 監査イベント](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)」と「[Amazon DocumentDB オペレーションのプロファイリング](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html)」を参照してください。詳細については、「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 暗号化 AWS KMS キーの ARN の代わりにキーエイリアスを使用できます。 `KmsKeyId` で暗号化キーが指定されていない場合: + `StorageEncrypted` パラメータが `true` の場合、Amazon DocumentDB はデフォルトの暗号化キーを使用します。 AWS KMS は、 のデフォルトの暗号化キーを作成します AWS アカウント。には、それぞれ異なるデフォルトの暗号化キー AWS アカウント があります AWS リージョン。 タイプ: 文字列 必須: いいえ ** ManageMasterUserPassword ** Amazon Web Services Secrets Manager でマスターユーザーパスワードを管理するかどうかを指定します。 `MasterUserPassword` が指定されている場合、Amazon Web Services Secrets Manager でマスターユーザーのパスワードを管理することはできません。 タイプ: ブール値 必須: いいえ ** MasterUsername ** クラスターのマスターユーザーの名前。 制約: + 1～63 文字の英数字である必要があります。 + 最初の文字は文字にする必要があります。 + 選択したデータベースエンジンの予約語は使用できません。 タイプ: 文字列 必須: いいえ ** MasterUserPassword ** マスターデータベースユーザーのパスワードです。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。 制約: 8 ～ 100 文字の長さの英数字である必要があります。 タイプ: 文字列 必須: いいえ ** MasterUserSecretKmsKeyId ** Amazon Web Services Secrets Manager で自動的に生成および管理されるシークレットを暗号化するための Amazon Web Services KMS キー識別子。この設定は、マスターユーザーパスワードが DB クラスターの Amazon Web Services Secrets Manager で Amazon DocumentDB によって管理されている場合にのみ有効です。 Amazon Web Services KMS キー識別子は、KMS キーのキー ARN、キー ID、エイリアス ARN、またはエイリアス名です。別の Amazon Web Services アカウントで KMS キーを使用するには、キー ARN またはエイリアス ARN を指定します。 `MasterUserSecretKmsKeyId` を指定しない場合、`aws/secretsmanager` KMS キーを使用してシークレットを暗号化します。シークレットが別の Amazon Web Services アカウントにある場合、`aws/secretsmanager` KMS キーを使用してシークレットを暗号化することはできません。カスタマー管理の KMS キーを使用する必要があります。 Amazon Web Services アカウントにはデフォルトの KMS キーがあります。Amazon Web Services アカウントには Amazon Web Services リージョンごとに異なるデフォルトの KMS キーがあります。 タイプ: 文字列 必須: いいえ ** NetworkType ** クラスターのネットワークタイプです。 ネットワークタイプは、クラスターに指定された `DBSubnetGroup` によって決まります。`DBSubnetGroup` は IPv4 プロトコルのみ、または IPv4 プロトコルと IPv6 プロトコル (`DUAL`) をサポートできます。 詳細については、「Amazon DocumentDB デベロッパーガイド」の「[VPC の DocumentDB クラスター](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)」を参照してください。 有効な値: `IPV4` \$1 `DUAL` タイプ: 文字列 必須: いいえ ** Port ** クラスターのインスタンスが接続を受け付けることができるポート番号。 タイプ: 整数 必須: いいえ ** PreferredBackupWindow ** `BackupRetentionPeriod` パラメータを使用して自動バックアップが有効になっている場合に、自動バックアップが作成される毎日の時間範囲。 デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウです AWS リージョン。 制約: + `hh24:mi-hh24:mi` の形式である必要があります。 + 時間は協定世界時 (UTC) である必要があります。 + 必要なメンテナンス期間と競合してはいけません。 + 少なくとも 30 分以上必要です。 タイプ: 文字列 必須: いいえ ** PreferredMaintenanceWindow ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 形式: `ddd:hh24:mi-ddd:hh24:mi` デフォルトは、それぞれ 8 時間の時間ブロックからランダムに選択された 30 分のウィンドウであり AWS リージョン、ランダムな曜日に発生します。 有効な曜日: 月、火、水、木、金、土、日 制約: 最小 30 分のウィンドウ。 タイプ: 文字列 必須: いいえ ** PreSignedUrl ** 現在サポートされていません。 タイプ: 文字列 必須: いいえ ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB Serverless クラスターのスケーリング構成が含まれています。 型: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) オブジェクト 必須: いいえ ** StorageEncrypted ** クラスターが暗号化されているかどうかを指定します。 タイプ: ブール値 必須: いいえ ** StorageType ** DB クラスターに関連付けるストレージタイプ。 Amazon DocumentDB クラスターのストレージタイプの詳細については、「*Amazon DocumentDB 開発者ガイド*」の「クラスターストレージ設定」を参照してください。 ストレージタイプの有効な値 - `standard | iopt1` デフォルト値は `standard ` です ストレージタイプを `iopt1` に設定して Amazon DocumentDB クラスターを作成すると、ストレージタイプが応答で返されます。この時 `standard` に設定すると、ストレージタイプは返されません。 タイプ: 文字列 必須: いいえ **Tags.Tag.N** クラスターに割り当てられるタグ。 タイプ: [Tag](API_Tag.md) オブジェクトの配列 必須: いいえ **VpcSecurityGroupIds.VpcSecurityGroupId.N** このクラスターに関連付ける EC2 VPC セキュリティグループのリスト。 型: 文字列の配列 必須: いいえ ## レスポンス要素 以下の要素がサービスによって返されます。 ** DBCluster ** クラスターに関する詳細情報。 型: [DBCluster](API_DBCluster.md) オブジェクト ## エラー すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** 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 ** NetworkTypeNotSupported ** ネットワークタイプは、`DBSubnetGroup` または DB エンジンのバージョンではサポートされていません。 HTTP ステータスコード: 400 ** StorageQuotaExceeded ** リクエストにより、すべてのインスタンスで使用可能な許容ストレージ容量を超過します。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。 言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster)