As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Para restaurar um cluster a partir de um snapshot

## Sintaxe da Solicitação
<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" ]
}
```

## Parâmetros da Solicitação de URI
<a name="API_elastic_RestoreClusterFromSnapshot_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-uri-snapshotArn"></a>
O identificador ARN do snapshot do cluster elástico.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_elastic_RestoreClusterFromSnapshot_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-clusterName"></a>
O nome do cluster.  
Tipo: String  
Obrigatório: Sim

 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-kmsKeyId"></a>
O identificador de chave KMS a ser usado para criptografar o novo cluster de clusters elásticos Amazon DocumentDB.  
O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando um cluster usando a mesma conta da Amazon que possui essa chave de criptografia KMS, poderá usar o alias da chave KMS em vez do ARN como chave de criptografia KMS.  
Se uma chave de criptografia não for especificada aqui, o Amazon DocumentDB usará a chave de criptografia padrão que o KMS cria para sua conta. Sua conta tem uma chave de criptografia padrão diferente para cada região da Amazon.  
Tipo: String  
Obrigatório: não

 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardCapacity"></a>
A capacidade de cada fragmento no novo cluster elástico restaurado.  
Tipo: inteiro  
Obrigatório: não

 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-shardInstanceCount"></a>
O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.  
Tipo: inteiro  
Obrigatório: não

 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-subnetIds"></a>
A sub-rede Amazon EC2 IDs para o cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Não

 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-tags"></a>
Uma lista dos nomes de tags a serem atribuídos ao cluster elástico restaurado, na forma de uma matriz de pares de valores-chave em que a chave é o nome da tag e o valor é o valor da chave.  
Tipo: mapa de strings para string  
Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128.  
Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+`   
Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256.  
Obrigatório: Não

 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-request-vpcSecurityGroupIds"></a>
Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse cluster elástico.  
Tipo: Matriz de strings  
Obrigatório: Não

## Sintaxe da resposta
<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" ]
   }
}
```

## Elementos de resposta
<a name="API_elastic_RestoreClusterFromSnapshot_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **   <a name="documentdb-elastic_RestoreClusterFromSnapshot-response-cluster"></a>
Retorna informações sobre um cluster elástico restaurado.  
Tipo: objeto [Cluster](API_elastic_Cluster.md)

## Erros
<a name="API_elastic_RestoreClusterFromSnapshot_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** AccessDeniedException **   
Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.    
 ** message **   
Uma mensagem de erro explicando por que o acesso foi negado.
Código de Status HTTP: 403

 ** ConflictException **   
Houve um conflito de acesso.    
 ** resourceId **   
O ID do recurso em que houve um conflito de acesso.  
 ** resourceType **   
O tipo do recurso em que houve um conflito de acesso.
Código de Status HTTP: 409

 ** InternalServerException **   
Ocorreu um erro interno no servidor.  
Código de Status HTTP: 500

 ** ResourceNotFoundException **   
O recurso especificado não foi localizado.    
 ** message **   
Uma mensagem de erro descrevendo a falha.  
 ** resourceId **   
O ID do recurso que não pôde ser localizado.  
 ** resourceType **   
O tipo do recurso que não pôde ser localizado.
Código de status HTTP: 404

 ** ServiceQuotaExceededException **   
O Service Quotas para a ação foi excedida.  
Código de status HTTP: 402

 ** ThrottlingException **   
ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação.    
 ** retryAfterSeconds **   
O número de segundos a esperar antes de repetir a operação.
Código de Status HTTP: 429

 ** ValidationException **   
Uma estrutura que define uma exceção de validação.    
 ** fieldList **   
Uma lista dos campos onde ocorreu a exceção de validação.  
 ** message **   
Uma mensagem de erro descrevendo a exceção de validação.  
 ** reason **   
O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`).
Código de Status HTTP: 400

## Consulte também
<a name="API_elastic_RestoreClusterFromSnapshot_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)