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

DeleteDBCluster

Exclui um cluster provisionado anteriormente. Quando você exclui um cluster, todos os backups automatizados para esse cluster são excluídos e não podem ser recuperados. Os snapshots manuais do cluster especificado não são excluídos.

Parâmetros de Solicitação

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

DBClusterIdentifier

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

Restrições:

  • Deve corresponder a um DBClusterIdentifier existente.

Tipo: string

Obrigatório: sim

FinalDBSnapshotIdentifier

O identificador do snapshot do novo snapshot do cluster criado quando SkipFinalSnapshot é definido como false.

nota

Especificar esse parâmetro e também definir o parâmetro SkipFinalShapshot para true resultará em um erro.

Restrições:

  • Deve ter de 1 a 255 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: Não

SkipFinalSnapshot

Determina se um snapshot de cluster foi criado antes de o cluster ser excluído. Se true for especificado, nenhum snapshot de cluster será criado. Se false for especificado, um snapshot de cluster será criado antes de o cluster do banco de dados ser excluído.

nota

Você deve especificar um parâmetro SkipFinalSnapshot se false for FinalDBSnapshotIdentifier.

Padrão: false

Tipo: Booliano

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 comuns a todas ações, consulte Erros comuns.

DBClusterNotFoundFault

DBClusterIdentifier não se refere a um cluster existente.

Código de Status HTTP: 404

DBClusterSnapshotAlreadyExistsFault

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

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

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 SDKs específicos de linguagem AWS, consulte: