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.

# RestoreClusterFromSnapshot
<a name="API_elastic_RestoreClusterFromSnapshot"></a>

Restaure un cluster élastique à partir d'un instantané.

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

```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}
```

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

La demande utilise les paramètres URI suivants.

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
Identifiant ARN de l'instantané du cluster élastique.  
Obligatoire : oui

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

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

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
Nom du cluster élastique.  
Type : Chaîne  
Obligatoire : oui

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
Identifiant de clé KMS à utiliser pour chiffrer le nouveau cluster de clusters élastiques Amazon DocumentDB.  
L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster en utilisant le même compte Amazon qui possède cette clé de chiffrement KMS, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN comme clé de chiffrement KMS.  
Si aucune clé de chiffrement n'est spécifiée ici, Amazon DocumentDB utilise la clé de chiffrement par défaut créée par KMS pour votre compte. Votre compte possède une clé de chiffrement par défaut différente pour chaque région Amazon.  
Type : chaîne  
Obligatoire : non

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
Capacité de chaque partition du nouveau cluster élastique restauré.  
Type : Integer  
Obligatoire : non

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-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_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
Le sous-réseau Amazon EC2 IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : non

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Une liste des noms de balises à attribuer au cluster élastique restauré, sous la forme d'un tableau de paires clé-valeur dans lequel la clé est le nom de balise et la valeur est la valeur clé.  
Type : mappage chaîne/chaîne  
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.  
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`   
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.  
Obligatoire : non

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-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_RestoreClusterFromSnapshot_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_RestoreClusterFromSnapshot_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_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Renvoie des informations sur le cluster élastique restauré.  
Type : objet [Cluster](API_elastic_Cluster.md)

## Erreurs
<a name="API_elastic_RestoreClusterFromSnapshot_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

 ** ServiceQuotaExceededException **   
Le quota de service pour l'action a été dépassé.  
Code d'état HTTP : 402

 ** 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 recommencer 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_RestoreClusterFromSnapshot_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/RestoreClusterFromSnapshot) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)