CopyDBClusterSnapshot - Amazon DocumentDB
Parâmetros da solicitaçãoElementos de RespostaErrosConsulte também

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á.

CopyDBClusterSnapshot

Copia um snapshot de um cluster.

Para copiar um snapshot de um snapshot manual do cluster de banco de dados compartilhado, SourceDBClusterSnapshotIdentifier deve ser o nome do recurso da Amazon (ARN) do snapshot do cluster compartilhado. Só é possível copiar um snapshot de cluster de banco de dados compartilhado, criptografado ou não, na mesma Região da AWS.

Para cancelar uma operação de cópia depois que ela estiver em andamento, exclua o snapshot do cluster de banco de dados de destino identificado por TargetDBClusterSnapshotIdentifier enquanto ele estiver no status cópia.

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.

SourceDBClusterSnapshotIdentifier

O identificador do snapshot de cluster a ser copiado. Esse parâmetro não diferencia maiúsculas de minúsculas.

Restrições:

  • É necessário especificar um snapshot de sistema válido no estado disponível.

  • Se o instantâneo de origem estiver Região da AWS igual ao da cópia, especifique um identificador de instantâneo válido.

  • Se o instantâneo de origem estiver em um local Região da AWS diferente da cópia, especifique um ARN de instantâneo de cluster válido.

Exemplo: my-cluster-snapshot1

Tipo: String

Obrigatório: Sim

TargetDBClusterSnapshotIdentifier

O identificador do novo snapshot de cluster a ser criado a partir do snapshot de cluster de origem. 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-cluster-snapshot2

Tipo: String

Obrigatório: Sim

CopyTags

Defina como true para copiar todas as tags do snapshot do cluster de origem no snapshot do cluster do cluster de destino. Caso contrário, false. O padrão é false.

Tipo: booliano

Obrigatório: não

KmsKeyId

O ID da AWS KMS chave para um snapshot de cluster criptografado. O ID da AWS KMS chave é o Amazon Resource Name (ARN), o identificador da AWS KMS chave ou o alias da AWS KMS chave de criptografia. AWS KMS

Se você copiar um snapshot de cluster criptografado do seu Conta da AWS, poderá especificar um valor para KmsKeyId criptografar a cópia com uma nova chave de AWS KMS criptografia. Se você não especificar um valor paraKmsKeyId, a cópia do snapshot do cluster será criptografada com a mesma AWS KMS chave do snapshot do cluster de origem.

Se você copiar um snapshot de cluster criptografado compartilhado de outro Conta da AWS, deverá especificar um valor paraKmsKeyId.

Para copiar um snapshot de cluster criptografado para outro Região da AWS, KmsKeyId defina a ID de AWS KMS chave que você deseja usar para criptografar a cópia do snapshot de cluster na região de destino. AWS KMS as chaves de criptografia são específicas Região da AWS daquelas em que foram criadas, e você não pode usar chaves de criptografia uma Região da AWS na outra Região da AWS.

Se você copiar um snapshot de cluster não criptografado e especificar um valor para o parâmetro KmsKeyId, um erro será retornado.

Tipo: sequência

Obrigatório: não

PreSignedUrl

O URL que contém uma solicitação assinada do Signature versão 4 para a ação da CopyDBClusterSnapshot API no Região da AWS que contém o instantâneo do cluster de origem a ser copiado. Você deve usar o parâmetro PreSignedUrl ao copiar um snapshot de cluster de outro Região da AWS.

Se você estiver usando uma ferramenta AWS SDK ou a AWS CLI, poderá especificar SourceRegion (ou --source-region para a AWS CLI) em vez de especificar manualmentePreSignedUrl. A especificação SourceRegion gera automaticamente um URL pré-assinado que é uma solicitação válida para a operação que pode ser executada na Região da AWS de origem.

O URL pré-assinado deve ser uma solicitação válida para a ação da CopyDBClusterSnapshot API que pode ser executada na fonte Região da AWS que contém o instantâneo do cluster a ser copiado. A solicitação de URL pré-assinada deve conter os seguintes valores de parâmetros:

  • SourceRegion - O ID da região que contém o instantâneo a ser copiado.

  • SourceDBClusterSnapshotIdentifier - O identificador do snapshot do cluster criptografado a ser copiado. Esse identificador deve estar no formato de nome do recurso da Amazon (ARN) da Região da AWS de origem Por exemplo, se você estiver copiando um snapshot de cluster criptografado da região us-east-1 Região da AWS, seu SourceDBClusterSnapshotIdentifier se parecerá com o seguinte exemplo: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - o identificador para o novo snapshot de cluster de cluster a ser criado. Esse parâmetro não diferencia maiúsculas de minúsculas.

Tipo: sequência

Obrigatório: não

Tags.Tag.N

As tags a serem atribuídas ao snapshot do cluster.

Tipo: matriz de objetos Tag

Obrigatório: não

Elementos de Resposta

O elemento a seguir é retornado pelo serviço.

DBClusterSnapshot

Informações detalhadas sobre um snapshot de cluster.

Tipo: objeto DBClusterSnapshot

Erros

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

DBClusterSnapshotAlreadyExistsFault

O usuário já tem um snapshot de cluster com o identificador determinado.

Código de Status HTTP: 400

DBClusterSnapshotNotFoundFault

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

Código de Status HTTP: 404

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

KMSKeyNotAccessibleFault

Ocorreu um erro ao acessar uma AWS KMS chave.

Código de Status HTTP: 400

SnapshotQuotaExceeded

A solicitação faria com que você excedesse o número de snapshots permitidos.

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: