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.

# UpdateCluster
<a name="API_elastic_UpdateCluster"></a>

Modifie un cluster élastique. Cela inclut la mise à jour du nom d'utilisateur/mot de passe administrateur, la mise à niveau de la version de l'API et la configuration d'une fenêtre de sauvegarde et d'une fenêtre de maintenance

## Syntaxe de la demande
<a name="API_elastic_UpdateCluster_RequestSyntax"></a>

```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}
```

## Paramètres de demande URI
<a name="API_elastic_UpdateCluster_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-uri-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Obligatoire : oui

## Corps de la demande
<a name="API_elastic_UpdateCluster_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-adminUserPassword"></a>
Le mot de passe associé à l'administrateur du cluster Elastic. Ce mot de passe peut contenir tout caractère ASCII imprimable à l'exception de la barre oblique (/), des guillemets doubles (") ou du symbole arobase (@).  
 *Contraintes* : Doit contenir de 8 à 100 caractères.  
Type : chaîne  
Obligatoire : non

 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-authType"></a>
Type d'authentification utilisé pour déterminer où récupérer le mot de passe utilisé pour accéder au cluster élastique. Les types valides sont `PLAIN_TEXT` ou`SECRET_ARN`.  
Type : Chaîne  
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`   
Obligatoire : non

 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-backupRetentionPeriod"></a>
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : Integer  
Obligatoire : non

 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-clientToken"></a>
Le jeton client pour le cluster élastique.  
Type : chaîne  
Obligatoire : non

 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-preferredBackupWindow"></a>
La plage horaire quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par le`backupRetentionPeriod`.  
Type : chaîne  
Obligatoire : non

 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-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`   
 *Par défaut* : une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.  
 *Jours valides* : lundi, mardi, mercredi, jeudi, vendredi, samedi, dimanche  
 *Contraintes* : fenêtre minimale de 30 minutes.  
Type : chaîne  
Obligatoire : non

 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-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 : Integer  
Obligatoire : non

 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardCount"></a>
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.  
Type : Integer  
Obligatoire : non

 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-shardInstanceCount"></a>
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. 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 : Integer  
Obligatoire : non

 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-subnetIds"></a>
Le sous-réseau Amazon EC2 IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **   <a name="documentdb-elastic_UpdateCluster-request-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité VPC EC2 à associer au cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

## Syntaxe de la réponse
<a name="API_elastic_UpdateCluster_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}
```

## Eléments de réponse
<a name="API_elastic_UpdateCluster_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **   <a name="documentdb-elastic_UpdateCluster-response-cluster"></a>
Renvoie des informations sur le cluster élastique mis à jour.  
Type : objet [Cluster](API_elastic_Cluster.md)

## Erreurs
<a name="API_elastic_UpdateCluster_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.    
 ** message **   
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403

 ** ConflictException **   
Il y a eu un conflit d'accès.    
 ** resourceId **   
L'ID de la ressource où il y a eu un conflit d'accès.  
 ** resourceType **   
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409

 ** InternalServerException **   
Une erreur interne du serveur s'est produite.  
Code d’état HTTP : 500

 ** ResourceNotFoundException **   
La ressource spécifiée n'a pas pu être localisée.    
 ** message **   
Un message d'erreur décrivant l'échec.  
 ** resourceId **   
L'ID de la ressource introuvable.  
 ** resourceType **   
Type de ressource introuvable.
Code d’état HTTP :404

 ** ThrottlingException **   
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.    
 ** retryAfterSeconds **   
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429

 ** ValidationException **   
Structure définissant une exception de validation.    
 ** fieldList **   
Liste des champs dans lesquels l'exception de validation s'est produite.  
 ** message **   
Message d'erreur décrivant l'exception de validation.  
 ** reason **   
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400

## Voir aussi
<a name="API_elastic_UpdateCluster_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 Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)