本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
ModifyDBCluster
修改 Amazon DocumentDB 叢集的設定。您可以透過在請求中指定這些參數及新的值，來變更一或多個資料庫組態參數。
請求參數
如需所有動作的一般參數資訊，請參閱《Common Parameters》。
- DBClusterIdentifier
-
要修改之叢集的叢集識別碼。此參數不區分大小寫。
約束:
-
必須符合現有
DBCluster的識別碼。
類型：字串
必要：是
-
- AllowMajorVersionUpgrade
-
指示是否允許升級主要版本的值。
限制：當指定與資料庫叢集目前版本不同之主要版本的
EngineVersion參數值時，您必須允許主要版本升級。類型：布林值
必要：否
- ApplyImmediately
-
指定是否會儘快非同步套用此要求中的變更和任何暫止變更的值，而不論叢集的
PreferredMaintenanceWindow設定為何。如果將此參數設定為false，則會在下一個維護時段套用對叢集的變更。ApplyImmediately參數只會影響NewDBClusterIdentifier和MasterUserPassword值。如果將此參數值設定為false，則會在下一個維護時段套用對NewDBClusterIdentifier和MasterUserPassword值的變更。所有其他的變更都會立即套用，無論ApplyImmediately參數的值為何。預設：
false類型：布林值
必要：否
- BackupRetentionPeriod
-
自動備份保留的天數。您必須指定一個值 (最小值為 1)。
預設：1
約束:
-
該值必須介於 1 到 35 之間。
類型：整數
必要：否
-
- CloudwatchLogsExportConfiguration
-
針對特定執行個體或叢集啟用匯出至 Amazon CloudWatch Logs 的日誌類型的組態設定。
EnableLogTypes和DisableLogTypes陣列會決定哪些記錄要匯出 (或不匯出) 至 CloudWatch 記錄。類型：CloudwatchLogsExportConfiguration 物件
必要：否
- DBClusterParameterGroupName
-
要用於叢集的叢集參數群組名稱。
類型：字串
必要：否
- DeletionProtection
-
指定是否可以刪除此叢集。如果啟
DeletionProtection用，除非已修改並DeletionProtection停用叢集，否則無法刪除叢集。DeletionProtection防止叢集遭到意外刪除。類型：布林值
必要：否
- EngineVersion
-
您要升級的資料庫引擎版本號碼。變更此參數會造成中斷。變更會在下一次維護時段期間套用，除非已啟用
ApplyImmediately。若要列出 Amazon DocumentDB 的所有可用引擎版本，請使用下列命令：
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"類型：字串
必要：否
- MasterUserPassword
-
主要資料庫使用者的密碼。此密碼可包含任何可印出的 ASCII 字元，但斜線 (/)、雙引號 (") 或 "at" 符號 (@) 則除外。
限制條件：必須包含 8 到 100 個字元。
類型：字串
必要：否
- NewDBClusterIdentifier
-
重新命名叢集時，叢集的新叢集識別碼。此值會以小寫字母字串的形式儲存。
約束:
-
必須包含 1 到 63 個字母、數字或連字號。
-
第一個字元必須是字母。
-
不能以連字號結尾或連續包含兩個連字號。
範例：
my-cluster2類型：字串
必要：否
-
- Port
-
叢集接受連線的連接埠號碼。
限制：必須是從
1150到的值65535。預設值：與原始叢集相同的連接埠。
類型：整數
必要：否
- PreferredBackupWindow
-
每日的時間範圍，若使用
BackupRetentionPeriod參數啟用自動化備份，則會在此期間建立自動化備份。預設值為 30 分鐘的視窗，每 AWS 區域個視窗從 8 小時的時間段中隨機選取。
約束:
-
格式必須為
hh24:mi-hh24:mi。 -
必須以國際標準時間 (UTC) 表示。
-
不得和慣用的維護時段衝突。
-
必須至少 30 分鐘。
類型：字串
必要：否
-
- PreferredMaintenanceWindow
-
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。
格式：
ddd:hh24:mi-ddd:hh24:mi預設值是從 8 小時的時間段中隨機選取 30 分鐘的時段 AWS 區域，每個視窗出現在一週的隨機日期。
有效日：星期一、星期二、星期三、星期四、星期五、星期六、星期日
限制條件：必須至少是 30 分鐘的時段。
類型：字串
必要：否
- StorageType
-
和資料庫叢集相關聯的儲存類型。
如需 Amazon DocumentDB 叢集的儲存類型的相關資訊，請參閱 Amazon DocumentDB 開發人員指南中的叢集儲存組態。
儲存類型的有效值-
standard | iopt1預設值為
standard類型：字串
必要：否
- VpcSecurityGroupIds。 VpcSecurityGroupId.N
-
叢集將屬於的虛擬私人雲端 (VPC) 安全性群組清單。
類型：字串陣列
必要：否
回應元素
服務會傳回下列元素。
- DBCluster
-
叢集的詳細資訊。
類型：DBCluster 物件
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- DBClusterAlreadyExistsFault
-
您已經擁有具有指定識別碼的叢集。
HTTP 狀態碼：400
- DBClusterNotFoundFault
-
DBClusterIdentifier不參考現有叢集。HTTP 狀態碼：404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupName不參考現有的叢集參數群組。HTTP 狀態碼：404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName不參照現有的子網路群組。HTTP 狀態碼：404
- InvalidDBClusterStateFault
-
叢集不是有效的狀態。
HTTP 狀態碼：400
- InvalidDBInstanceState
-
指定的執行個體不處於可用狀態。
HTTP 狀態碼：400
- InvalidDBSecurityGroupState
-
安全性群組的狀態不允許刪除。
HTTP 狀態碼：400
- InvalidDBSubnetGroupStateFault
-
子網路群組無法刪除，因為它正在使用中。
HTTP 狀態碼：400
- InvalidSubnet
-
要求的子網路無效，或要求多個子網路並非全部位於一般虛擬私人雲端 (VPC) 中。
HTTP 狀態碼：400
- InvalidVPCNetworkStateFault
-
子網路群組在建立之後，並不會涵蓋所有可用區域，因為已進行變更。
HTTP 狀態碼：400
- StorageQuotaExceeded
-
該請求會導致您超過所有執行個體允許的可用儲存空間量。
HTTP 狀態碼：400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：
