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á.
RestoreDBClusterToPointInTime
Restaura um cluster para um momento arbitrário. Os usuários podem restaurar para qualquer point-in-time antes de LatestRestorableTime por até BackupRetentionPeriod dias. O cluster de banco de destino é criado a partir do cluster de de origem com a mesma configuração do cluster original, exceto pelo fato de que o novo cluster será criado com o grupo de segurança padrão.
Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte Parâmetros comuns.
- DBClusterIdentifier
-
O nome do novo cluster a ser criado.
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.
Tipo: string
Obrigatório: Sim
-
- SourceDBClusterIdentifier
-
O identificador do cluster de origem do qual restaurar.
Restrições:
-
Deve corresponder ao identificador de um
DBClusterexistente.
Tipo: String
Obrigatório: Sim
-
- DBSubnetGroupName
-
O nome do grupo de sub-redes de a ser usado para o novo cluster.
Restrições: se fornecidas, devem corresponder ao nome de um
DBSubnetGroupexistente.Exemplo:
mySubnetgroupTipo: String
Obrigatório: não
- DeletionProtection
-
Especifica se esse cluster pode ser excluído. Se
DeletionProtectionestiver ativado, o cluster não pode ser excluído, a menos que seja modificado eDeletionProtectionesteja desabilitado.DeletionProtectionprotege clusters contra exclusão acidental.Tipo: booliano
Obrigatório: não
- EnableCloudwatchLogsExports.Membro.
-
Uma lista de tipos de log que devem ser habilitados para exportação para o Amazon CloudWatch Logs.
Tipo: matriz de strings
Obrigatório: não
- KmsKeyId
-
O identificador de AWS KMS chave a ser usado ao restaurar um cluster criptografado a partir de um cluster criptografado.
O identificador da AWS KMS chave é o Amazon Resource Name (ARN) da chave de AWS KMS criptografia. Se você estiver restaurando um cluster com o mesmo Conta da AWS proprietário da chave de AWS KMS criptografia usada para criptografar o novo cluster, poderá usar o alias da AWS KMS chave em vez do ARN da chave de criptografia. AWS KMS
Você pode restaurar em um novo cluster e criptografar o novo cluster com uma AWS KMS chave diferente da AWS KMS chave usada para criptografar o cluster de origem. O novo cluster de banco de dados é criptografado com a AWS KMS chave identificada pelo
KmsKeyIdparâmetro.Se você não especificar um valor para o parâmetro
KmsKeyId, ocorrerá o seguinte:-
Se o cluster for criptografado, o cluster restaurado será criptografado usando a AWS KMS chave usada para criptografar o cluster de origem.
-
Se o cluster não estiver criptografado, o cluster restaurado não será criptografado.
Se
DBClusterIdentifierreferir-se a um cluster não criptografado, a solicitação de restauração será rejeitada.Tipo: sequência
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
1150e65535.Padrão: A porta padrão do mecanismo.
Tipo: inteiro
Obrigatório: não
- RestoreToTime
-
A data e a hora para as quais restaurar o cluster.
Valores válidos: um horário no formato Universal Coordinated Time (UTC).
Restrições:
-
Devem ser anteriores ao último horário restaurável da instância.
-
Devem ser especificadas se o parâmetro
UseLatestRestorableTimenão for especificado. -
Não podem ser especificadas se o parâmetro
UseLatestRestorableTimefortrue. -
Não podem ser especificadas se o parâmetro
RestoreTypeforcopy-on-write.
Exemplo:
2015-03-07T23:45:00ZTipo: carimbo de hora
Obrigatório: não
-
- RestoreType
-
O tipo de restauração a ser realizada. Você pode especificar um dos seguintes valores:
-
full-copy- o novo cluster de banco de dados é restaurado como uma cópia completa do cluster de banco de dados de origem. -
copy-on-write- o novo cluster de banco de dados é restaurado como um clone do cluster de banco de dados de origem.
Restrições: você não pode especificar
copy-on-writese a versão do mecanismo do cluster de banco de dados de origem for anterior à 1.11.Se você não especificar um valor
RestoreType, o novo cluster de banco de dados será restaurado como uma cópia completa do cluster de banco de dados de origem.Tipo: sequência
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 em cluster no Guia do desenvolvedor do Amazon DocumentDB.
Valores válidos para o tipo de armazenamento -
standard | iopt1O valor padrão é
standard.Tipo: sequência
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
- UseLatestRestorableTime
-
Um valor que é definido como
truepara restaurar o cluster para o horário do backup restaurável mais recente. Caso contrário,false.Padrão:
falseRestrições: não poderão ser especificadas se o parâmetro
RestoreToTimefor fornecido.Tipo: booliano
Obrigatório: não
- VpcSecurityGroupIds. VpcSecurityGroupIdN.
-
Uma lista de grupos de segurança da VPC à qual o novo cluster pertence.
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
- DBClusterNotFoundFault
-
DBClusterIdentifiernão se refere a um cluster existente.Código de Status HTTP: 404
- 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
-
DBClusterSnapshotIdentifiernão se refere a um snapshot de cluster existente.Código de Status HTTP: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupNamenã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
- InvalidDBClusterStateFault
-
O cluster não está em um estado 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 AWS KMS chave.
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 AWS SDKs específicos da linguagem, consulte o seguinte:
