本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# DBCluster
<a name="API_DBCluster"></a>

叢集的詳細資訊。

## 目錄
<a name="API_DBCluster_Contents"></a>

**注意**  
在下列清單中，會先說明必要的參數。

 ** AssociatedRoles.DBClusterRole.N **   
提供與叢集相關聯的 AWS Identity and Access Management (IAM) 角色清單。與叢集相關聯的 (IAM) 角色會授予叢集代表您存取其他 AWS 服務的許可。  
類型：[DBClusterRole](API_DBClusterRole.md) 物件陣列  
必要：否

 ** AvailabilityZones.AvailabilityZone.N **   
提供叢集中執行個體可在其中建立的 Amazon EC2 可用區域清單。  
類型：字串陣列  
必要：否

 ** BackupRetentionPeriod **   
指定保留自動快照的天數。  
類型：整數  
必要：否

 ** CloneGroupId **   
識別與資料庫叢集建立關聯的複製群組。  
類型：字串  
必要：否

 ** ClusterCreateTime **   
以國際標準時間 (UTC) 指定建立叢集的時間。  
類型：Timestamp  
必要：否

 ** DBClusterArn **   
叢集的 Amazon Resource Name (ARN)。  
類型：字串  
必要：否

 ** DBClusterIdentifier **   
包含使用者提供的叢集識別符。此識別符是識別叢集的唯一金鑰。  
類型：字串  
必要：否

 ** DBClusterMembers.DBClusterMember.N **   
提供組成叢集的執行個體清單。  
類型：[DBClusterMember](API_DBClusterMember.md) 物件陣列  
必要：否

 ** DBClusterParameterGroup **   
指定叢集的叢集參數群組名稱。  
類型：字串  
必要：否

 ** DbClusterResourceId **   
叢集 AWS 區域的唯一不可變識別符。每當存取叢集的 AWS KMS 金鑰時， AWS CloudTrail 日誌項目中都會找到此識別符。  
類型：字串  
必要：否

 ** DBSubnetGroup **   
指定與叢集相關聯的子網路群組資訊，包括子網路群組中的名稱、描述和子網路。  
類型：字串  
必要：否

 ** DeletionProtection **   
指定是否可以刪除此叢集。如果 `DeletionProtection` 已啟用，除非修改並`DeletionProtection`停用，否則無法刪除叢集。 會`DeletionProtection`保護叢集免於意外刪除。  
類型：布林值  
必要：否

 ** EarliestRestorableTime **   
可使用point-in-time還原還原資料庫的最早時間。  
類型：Timestamp  
必要：否

 ** EnabledCloudwatchLogsExports.member.N **   
此叢集設定為匯出至 Amazon CloudWatch Logs 的日誌類型清單。  
類型：字串陣列  
必要：否

 ** Endpoint **   
指定叢集主要執行個體的連線端點。  
類型：字串  
必要：否

 ** Engine **   
提供要用於此叢集的資料庫引擎名稱。  
類型：字串  
必要：否

 ** EngineVersion **   
指示資料庫引擎版本。  
類型：字串  
必要：否

 ** HostedZoneId **   
指定當您建立託管區域時，Amazon Route 53 指派的 ID。  
類型：字串  
必要：否

 ** IOOptimizedNextAllowedModificationTime **   
下次您可以修改 Amazon DocumentDB 叢集以使用 iopt1 儲存類型。  
類型：Timestamp  
必要：否

 ** KmsKeyId **   
如果 `StorageEncrypted`是 `true`，則為加密叢集的 AWS KMS 金鑰識別符。  
類型：字串  
必要：否

 ** LatestRestorableTime **   
指定可透過 point-in-time 還原還原資料庫的最新時間。  
類型：Timestamp  
必要：否

 ** MasterUsername **   
包含叢集的主要使用者名稱。  
類型：字串  
必要：否

 ** MasterUserSecret **   
由 Secrets Manager 中的 Amazon DocumentDB 管理的 AWS 秘密，用於主要使用者密碼。  
類型：[ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 物件  
必要：否

 ** MultiAZ **   
指定叢集是否在多個可用區域中具有執行個體。  
類型：布林值  
必要：否

 ** NetworkType **   
叢集的網路類型。  
網路類型是由為叢集`DBSubnetGroup`指定的 決定。只能`DBSubnetGroup`支援 IPv4 通訊協定或 IPv4 和 IPv6 通訊協定 (`DUAL`)。  
如需詳細資訊，請參閱《Amazon [DocumentDB 開發人員指南》中的 VPC 中的 DocumentDB 叢集](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 Amazon DocumentDB   
有效值: `IPV4` \$1 `DUAL`   
類型：字串  
必要：否

 ** PercentProgress **   
指定操作的進度 (百分比)。  
類型：字串  
必要：否

 ** Port **   
指定資料庫引擎接聽的連接埠。  
類型：整數  
必要：否

 ** PreferredBackupWindow **   
指定每日的時間範圍，若有啟用自動化備份 (由 `BackupRetentionPeriod` 決定)，則自動化備份會在此期間建立。  
類型：字串  
必要：否

 ** PreferredMaintenanceWindow **   
指定每週可能進行系統維護的時段，以世界協調時間 (UTC) 表示。  
類型：字串  
必要：否

 ** ReaderEndpoint **   
叢集的讀取器端點。叢集負載的讀取器端點會平衡叢集中可用 Amazon DocumentDB 複本的連線。當用戶端請求新的讀取器端點連線時，Amazon DocumentDB 會在叢集中的 Amazon DocumentDB 複本之間分配連線請求。此功能有助於平衡叢集中多個 Amazon DocumentDB 複本的讀取工作負載。  
如果發生容錯移轉，且您連線的 Amazon DocumentDB 複本提升為主要執行個體，則會捨棄您的連線。若要繼續將讀取工作負載傳送至叢集中的其他 Amazon DocumentDB 複本，您可以接著重新連線至讀取器端點。  
類型：字串  
必要：否

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
包含與此叢集相關聯的次要叢集的一或多個識別符。  
類型：字串陣列  
必要：否

 ** ReplicationSourceIdentifier **   
如果此叢集是次要叢集，則包含來源叢集的識別符。  
類型：字串  
必要：否

 ** ServerlessV2ScalingConfiguration **   
Amazon DocumentDB Serverless 叢集的擴展組態。  
類型：[ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 物件  
必要：否

 ** Status **   
指定此叢集的目前狀態。  
類型：字串  
必要：否

 ** StorageEncrypted **   
指定是否要加密叢集。  
類型：布林值  
必要：否

 ** StorageType **   
與叢集相關聯的儲存類型  
如需 Amazon DocumentDB 叢集儲存類型的資訊，請參閱《*Amazon DocumentDB 開發人員指南*》中的叢集儲存組態。  
儲存類型的有效值 - `standard | iopt1`   
預設值為 `standard `   
類型：字串  
必要：否

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
提供叢集所屬的虛擬私有雲端 (VPC) 安全群組清單。  
類型：[VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 物件陣列  
必要：否

## 另請參閱
<a name="API_DBCluster_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster)