RestoreDBClusterFromSnapshot - Amazon DocumentDB
Parâmetros de SolicitaçãoElementos de RespostaErrosConsulte Também

RestoreDBClusterFromSnapshot

Cria um novo cluster a partir de um snapshot ou de um snapshot de cluster.

Se um snapshot for especificado, o cluster de destino será criado a partir do DB snapshot de origem com uma configuração e um grupo de segurança padrão.

Se um snapshot do cluster for especificado, o cluster de destino será criado a partir do ponto de restauração do cluster de origem com a mesma configuração do cluster de banco de dados original, exceto pelo fato de que o novo cluster será criado com o grupo de segurança padrão.

Parâmetros de Solicitação

Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.

DBClusterIdentifier

O nome do cluster a ser criado a partir do snapshot ou do snapshot do cluster. Esse parâmetro não diferencia maiúsculas de minúsculas.

Restrições:

  • Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens.

  • O primeiro caractere deve ser uma letra.

  • Não podem terminar com um hífen ou conter dois hífens consecutivos.

Exemplo: my-snapshot-id

Tipo: String

Exigido: Sim

Engine

O mecanismo de banco de dados a utilizar para o novo cluster.

Padrão: o mesmo que a origem

Restrição: deve ser compatível com o mecanismo da origem

Tipo: String

Exigido: Sim

SnapshotIdentifier

O identificador do qual restaurar o snapshot ou o snapshot do cluster.

É possível usar o nome ou o nome de recurso da Amazon (ARN) para especificar um snapshot de cluster. No entanto, para especificar um snapshot você só pode usar o ARN.

Restrições:

  • Deve corresponder ao identificador de um snapshot existente.

Tipo: String

Exigido: Sim

AvailabilityZones.AvailabilityZone.N

Fornece a lista de zonas de disponibilidade do Amazon EC2 nas quais as instâncias no snapshot de cluster de banco de dados restaurado podem ser criadas.

Tipo: Matriz de strings

Obrigatório: Não

DBClusterParameterGroupName

O nome do grupo de parâmetros de cluster de banco de dados para associar a este cluster de banco de dados.

Tipo: string       Obrigatório: não

Se esse argumento for omitido, o grupo de parâmetros de cluster de banco de dados padrão será usado. Se fornecido, deverá corresponder ao nome de um grupo de parâmetros de cluster de banco de dados padrão. A string deve consistir de 1 a 255 letras, números ou hifens. Seu primeiro caractere deve ser uma letra e não pode terminar com hífen ou conter dois hífens consecutivos.

Tipo: String

Obrigatório: Não

DBSubnetGroupName

O nome do grupo de sub-redes a ser usado no novo cluster.

Restrições: se fornecidas, devem corresponder ao nome de um DBSubnetGroup existente.

Exemplo: mySubnetgroup

Tipo: string

Obrigatório: Não

DeletionProtection

Especifica se esse cluster pode ser excluído. Se DeletionProtection estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e DeletionProtection esteja desabilitado. DeletionProtection protege clusters contra exclusão acidental.

Tipo: booleano

Obrigatório: Não

EnableCloudwatchLogsExports.member.N

Uma lista de tipos de log que precisam estar habilitados para exportação para o Amazon CloudWatch Logs.

Tipo: Matriz de strings

Obrigatório: Não

EngineVersion

A versão do mecanismo de banco de dados a ser usada para o novo cluster.

Tipo: string

Obrigatório: Não

KmsKeyId

O identificador da chave do AWS KMS a ser usada ao restaurar um cluster de banco de dados criptografado a partir de um DB snapshot ou um snapshot do cluster.

O identificador da chave do AWS KMS é o nome do recurso da Amazon (ARN) para a chave de criptografia do AWS KMS. Se você estiver restaurando um cluster com a mesma Conta da AWS que tem a chave de criptografia do AWS KMS usada para criptografar o novo cluster, use o alias da chave do AWS KMS em vez de o ARN da chave de criptografia do AWS KMS.

Se você não especificar um valor para o parâmetro KmsKeyId, ocorrerá o seguinte:

  • Se o snapshot ou o snapshot do cluster em SnapshotIdentifier for criptografado, o cluster restaurado será criptografado usando a chave do AWS KMS que foi utilizada para criptografar o snapshot ou o snapshot do cluster.

  • Se o snapshot ou o snapshot do cluster em SnapshotIdentifier não estiver criptografado, o cluster de banco de dados restaurado não será criptografado.

Tipo: string

Obrigatório: Não

Port

O número da porta na qual o novo cluster aceita conexões.

Restrições: deve ser um valor entre 1150 e 65535.

Padrão: a mesma porta que a do cluster original.

Tipo: Inteiro

Obrigatório: Não

StorageType

O tipo de armazenamento a ser associado ao cluster de banco de dados.

Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento do cluster no Guia do desenvolvedor do Amazon DocumentDB.

Valores válidos para o tipo de armazenamento - standard | iopt1

O valor padrão é standard .

Tipo: string

Obrigatório: Não

Tags.Tag.N

As tags a serem atribuídas ao cluster restaurado.

Tipo: matriz de objetos Tag

Obrigatório: Não

VpcSecurityGroupIds.VpcSecurityGroupId.N

Uma lista de grupos de segurança da nuvem privada virtual (VPC) à qual o novo cluster pertencerá.

Tipo: Matriz de strings

Obrigatório: Não

Elementos de Resposta

O elemento a seguir é retornado pelo serviço.

DBCluster

Informações detalhadas sobre um cluster.

Tipo: objeto DBCluster

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulte Erros comuns.

DBClusterAlreadyExistsFault

Você já tem um cluster com o identificador determinado.

Código de Status HTTP: 400

DBClusterQuotaExceededFault

O cluster não pode ser criado porque você atingiu a cota máxima permitida de clusters.

Código de Status HTTP: 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier não se refere a um snapshot de cluster existente.

Código de Status HTTP: 404

DBSnapshotNotFound

DBSnapshotIdentifier não se refere a um snapshot existente.

Código de Status HTTP: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName não se refere a um grupo de sub-redes existente.

Código de Status HTTP: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName não se refere a um grupo de sub-redes existente.

Código de Status HTTP: 404

InsufficientDBClusterCapacityFault

O cluster não tem capacidade suficiente para a operação atual.

Código de Status HTTP: 403

InsufficientStorageClusterCapacity

Não há armazenamento suficiente disponível para a ação atual. Você pode resolver esse erro atualizando seu grupo de sub-redes para usar outras zonas de disponibilidade que tenham mais espaço de armazenamento disponível.

Código de Status HTTP: 400

InvalidDBClusterSnapshotStateFault

O valor fornecido não é um estado de snapshot de cluster válido.

Código de Status HTTP: 400

InvalidDBSnapshotState

O estado do snapshot não permite a exclusão.

Código de Status HTTP: 400

InvalidRestoreFault

Não é possível restaurar de um backup de nuvem privada virtual (VPC) para uma instância de banco de dados que não seja da VPC.

Código de Status HTTP: 400

InvalidSubnet

A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.

Código de status HTTP: 400

InvalidVPCNetworkStateFault

O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.

Código de status HTTP: 400

KMSKeyNotAccessibleFault

Ocorreu um erro ao acessar uma chave do AWS KMS.

Código de status HTTP: 400

StorageQuotaExceeded

A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.

Código de status HTTP: 400

StorageQuotaExceeded

A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.

Código de status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: