翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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>
週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。  
 *形式*: `ddd:hh24:mi-ddd:hh24:mi`   
タイプ: 文字列  
必須: はい

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 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 サブネット ID。  
型: 文字列の配列  
必須: はい

 ** 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 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。  
タイプ: 整数  
必須: いいえ

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
クラスター内のシャードの数  
タイプ: [Shard](API_elastic_Shard.md) オブジェクトの配列  
必須：いいえ

## 以下の資料も参照してください。
<a name="API_elastic_Cluster_SeeAlso"></a>

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster)