本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
CreateDBCluster
建立新的 Amazon DocumentDB 叢集。
請求參數
如需所有動作的一般參數相關資訊，請參閱《Common Parameters》。
- DBClusterIdentifier
-
叢集的識別碼，此參數是以小寫字母字串的形式儲存。
約束:
-
必須包含 1 到 63 個字母、數字或連字號。
-
第一個字元必須是字母。
-
不能以連字號結尾或連續包含兩個連字號。
範例：
my-cluster類型：字串
必要：是
-
- Engine
-
要用於此叢集的資料庫引擎名稱。
有效值：
docdb類型：字串
必要：是
- AvailabilityZones。 AvailabilityZone.N
-
Amazon EC2 可用區域的清單，在這些可用區域中可以建立叢集中的執行個體。
類型：字串陣列
必要：否
- BackupRetentionPeriod
-
自動備份保留的天數。您必須指定一個值 (最小值為 1)。
預設：1
約束:
-
該值必須介於 1 到 35 之間。
類型：整數
必要：否
-
- DBClusterParameterGroupName
-
要與此叢集建立關聯的叢集參數群組名稱。
類型：字串
必要：否
- DBSubnetGroupName
-
要與此叢集建立關聯的子網路群組。
限制條件：必須符合現有
DBSubnetGroup的名稱。絕不能為預設值。範例：
mySubnetgroup類型：字串
必要：否
- DeletionProtection
-
指定是否可以刪除此叢集。如果啟
DeletionProtection用，除非已修改並DeletionProtection停用叢集，否則無法刪除叢集。DeletionProtection防止叢集遭到意外刪除。類型：布林值
必要：否
- EnableCloudwatchLogsExports. 成員.
-
必須啟用匯出至 Amazon CloudWatch 日誌的記錄類型清單。您可以啟用稽核日誌或分析工具日誌。如需詳細資訊，請參閱稽核 Amazon DocumentDB 事件和分析 Amazon Docu mentDB 操作。
類型：字串陣列
必要：否
- EngineVersion
-
要使用的資料庫引擎版本號碼。
--engine-version預設為最新的主要引擎版本。對於生產工作負載，我們建議使用預定的主要引擎版本明確宣告此參數。類型：字串
必要：否
- GlobalClusterIdentifier
-
新全域叢集的叢集識別碼。
類型：字串
長度限制：長度下限為 1。長度上限為 255。
模式：
[A-Za-z][0-9A-Za-z-:._]*必要：否
- KmsKeyId
-
加密叢集的 AWS KMS 金鑰識別碼。
AWS KMS 金鑰識別碼是 AWS KMS 加密金鑰的 Amazon Resource Name (ARN)。若您使用擁有用來加密新叢集 AWS 帳戶 加密金鑰的相同 AWS KMS 建立叢集，您可以改為使用 AWS KMS 金鑰別名，而非 AWS KMS 加密金鑰的 ARN。
若加密金鑰並未在
KmsKeyId中指定：-
如果
StorageEncrypted參數是true，則 Amazon DocumentDB 會使用您的預設加密金鑰。
AWS KMS 會為 AWS 帳戶 建立預設加密金鑰。您的 AWS 帳戶 在每個 AWS 區域 各有不同的預設加密金鑰。
類型：字串
必要：否
-
- MasterUsername
-
叢集主要使用者的名稱。
約束:
-
必須為 1 到 63 個字母或數字。
-
第一個字元必須是字母。
-
不能是所選擇資料庫引擎的保留字。
類型：字串
必要：否
-
- MasterUserPassword
-
主要資料庫使用者的密碼。此密碼可包含任何可印出的 ASCII 字元，但斜線 (/)、雙引號 (") 或 "at" 符號 (@) 則除外。
限制條件：必須包含 8 到 100 個字元。
類型：字串
必要：否
- Port
-
叢集中執行處理接受連線的連接埠號碼。
類型：整數
必要：否
- PreferredBackupWindow
-
每日的時間範圍，若使用
BackupRetentionPeriod參數啟用自動化備份，則會在此期間建立自動化備份。預設是從各 AWS 區域 8 小時時段內隨機選取的 30 分鐘時段。
約束:
-
格式必須為
hh24:mi-hh24:mi。 -
必須以國際標準時間 (UTC) 表示。
-
不得和慣用的維護時段衝突。
-
必須至少 30 分鐘。
類型：字串
必要：否
-
- PreferredMaintenanceWindow
-
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。
格式：
ddd:hh24:mi-ddd:hh24:mi預設是從各 AWS 區域 8 小時時段內隨機選取的 30 分鐘時段，並隨機發生在一週內的某一天。
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日
限制條件：必須至少是 30 分鐘的時段。
類型：字串
必要：否
- PreSignedUrl
-
目前不支援。
類型：字串
必要：否
- StorageEncrypted
-
指定是否要加密叢集。
類型：布林值
必要：否
- StorageType
-
和資料庫叢集相關聯的儲存類型。
如需 Amazon DocumentDB 叢集的儲存類型的相關資訊，請參閱 Amazon DocumentDB 開發人員指南中的叢集儲存組態。
儲存類型的有效值-
standard | iopt1預設值為
standard注意
當您創建一個 DocumentDB 數據庫集群與存儲類型設置為
iopt1，存儲類型在響應返回。當您將其設定為時，不會傳回儲存區類型standard。類型：字串
必要：否
- 標籤. 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
-
除非只有一個可用區域，否則子網路群組中的子網路應至少涵蓋兩個可用區域。
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 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
