CopyClusterSnapshot - Amazon DocumentDB
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte Também

CopyClusterSnapshot

Copia um snapshot de um cluster elástico.

Sintaxe da Solicitação

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

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}

Parâmetros da Solicitação de URI

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

snapshotArn

O identificador de nome do recurso da Amazon (ARN) do snapshot do cluster elástico.

Obrigatório: Sim

Corpo da Solicitação

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

targetSnapshotName

O identificador do snapshot de cluster elástico novo 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: elastic-cluster-snapshot-5

Tipo: string

Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63.

Obrigatório: Sim

copyTags

Defina true para copiar todas as tags do snapshot do cluster de origem no snapshot do cluster elástico de destino. O padrão é false.

Tipo: Booliano

Obrigatório: Não

kmsKeyId

O ID da chave do AWS KMS para um snapshot do cluster elástico criptografado. O ID da chave do AWS KMS é o nome do recurso da Amazon (ARN), o identificador da chave do AWS KMS ou o alias da chave do AWS KMS para a chave de criptografia do AWS KMS.

Se você copiar um snapshot do cluster elástico criptografado da conta da AWS, especifique um valor para KmsKeyId a fim de criptografar a cópia com uma nova chave de criptografia do AWS KMS. Se você não especificar um valor para KmsKeyId, a cópia do snapshot do cluster elástico será criptografada com a mesma chave do AWS KMS que o snapshot do cluster elástico de origem.

Para copiar um snapshot de cluster elástico criptografado para outra região da AWS, defina KmsKeyId com o ID da chave do AWS KMS que você quer usar para criptografar a cópia do snapshot do cluster elástico na região de destino. AWS As chaves de criptografia do KMS são específicas da região da AWS em que são criadas, e você não pode usar chaves de criptografia de uma região da AWS em outra região da AWS.

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

Tipo: string

Obrigatório: Não

tags

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

Tipo: Mapa de string para string

Restrições de Tamanho de Chave: Tamanho mínimo de 1. O tamanho 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

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "string",
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}

Elementos de Resposta

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.

snapshot

Retorna informações sobre um snapshot de cluster elástico específico.

Tipo: objeto ClusterSnapshot

Erros

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

AccessDeniedException

Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.

Código de Status HTTP: 403

ConflictException

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.

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çada quando a solicitação for negada devido à limitação da solicitação.

Código de Status HTTP: 429

ValidationException

Uma estrutura que define uma exceção de validação.

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: