Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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

Renvoie des informations sur un cluster élastique spécifique.

## Table des matières
<a name="API_elastic_Cluster_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
Nom de l'administrateur du cluster Elastic.  
Type : String  
Obligatoire : oui

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
Type d'authentification pour le cluster élastique.  
Type : String  
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`   
Obligatoire : oui

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Type : String  
Obligatoire : oui

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
URL utilisée pour se connecter au cluster élastique.  
Type : String  
Obligatoire : oui

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
Nom du cluster élastique.  
Type : String  
Obligatoire : oui

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
Heure à laquelle le cluster élastique a été créé en temps universel coordonné (UTC).  
Type : String  
Obligatoire : oui

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
Identifiant de clé KMS à utiliser pour chiffrer le cluster élastique.  
Type : String  
Obligatoire : oui

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
Intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.  
 *Format* : `ddd:hh24:mi-ddd:hh24:mi`   
Type : String  
Obligatoire : oui

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
Le nombre de v CPUs attribué à chaque partition de cluster élastique. Le maximum est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64.  
Type : entier  
Obligatoire : oui

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.  
Type : entier  
Obligatoire : oui

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
État du cluster élastique.  
Type : String  
Valeurs valides : `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`   
Obligatoire : oui

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
Le EC2 sous-réseau Amazon IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : oui

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité EC2 VPC associés à ce cluster élastique.  
Type : tableau de chaînes  
Obligatoire : oui

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : entier  
Obligatoire : non

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
Plage de temps quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par`backupRetentionPeriod`.  
Type : chaîne  
Obligatoire : non

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster. Une `shardInstanceCount` valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.  
Type : entier  
Obligatoire : non

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
Nombre total de partitions dans le cluster.  
Type : tableau d’objets [Shard](API_elastic_Shard.md)  
Obligatoire : non

## consultez aussi
<a name="API_elastic_Cluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster)