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

# Cluster
<a name="API_elastic_Cluster"></a>

傳回特定彈性叢集的相關資訊。

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

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

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
彈性叢集管理員的名稱。  
類型：字串  
必要：是

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
彈性叢集的身分驗證類型。  
類型：字串  
有效值:`PLAIN_TEXT | SECRET_ARN`   
必要：是

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
彈性叢集的 ARN 識別符。  
類型：字串  
必要：是

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
用來連線至彈性叢集的 URL。  
類型：字串  
必要：是

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
彈性叢集的名稱。  
類型：字串  
必要：是

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
以國際標準時間 (UTC) 建立彈性叢集的時間。  
類型：字串  
必要：是

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
用來加密彈性叢集的 KMS 金鑰識別符。  
類型：字串  
必要：是

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。  
 *格式*：`ddd:hh24:mi-ddd:hh24:mi`  
類型：字串  
必要：是

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
指派給每個彈性叢集碎片vCPUs 數量。上限為 64。允許的值為 2、4、8、16、32、64。  
類型：整數  
必要：是

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
指派給彈性叢集的碎片數量。上限為 32。  
類型：整數  
必要：是

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
彈性叢集的狀態。  
類型：字串  
有效值:`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
必要：是

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
彈性叢集的 Amazon EC2 IDs。  
類型：字串陣列  
必要：是

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
與竊賊彈性叢集相關聯的 EC2 VPC 安全群組清單。  
類型：字串陣列  
必要：是

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
保留自動快照的天數。  
類型：整數  
必要：否

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
如果啟用自動備份，則建立自動備份的每日時間範圍，由 決定`backupRetentionPeriod`。  
類型：字串  
必要：否

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
套用至叢集中所有碎片的複本執行個體數目。`shardInstanceCount` 值 1 表示有一個寫入器執行個體，而任何其他執行個體都是可用於讀取和改善可用性的複本。  
類型：整數  
必要：否

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
叢集中的碎片總數。  
類型：[Shard](API_elastic_Shard.md) 物件陣列  
必要：否

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

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