DeleteDBCluster - Amazon DocumentDB

DeleteDBCluster

以前にプロビジョニングされたクラスターを削除します。クラスターを削除すると、そのクラスターの自動バックアップはすべて削除され、復旧できません。指定したクラスターの手動 DB クラスタースナップショットは削除されません。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

DBClusterIdentifier

削除するクラスターのクラスター識別子。このパラメータでは大文字と小文字は区別されません。

制約:

  • 既存の DBClusterIdentifier と一致する必要があります。

型: 文字列

必須: はい

FinalDBSnapshotIdentifier

SkipFinalSnapshotfalse に設定された場合の、作成された新しいクラスタースナップショットのクラスタースナップショット識別子。

注記

このパラメータを指定して SkipFinalShapshot パラメータを true に設定すると、エラーが発生します。

制約:

  • 1 ~ 255 の英字、数字、ハイフンである必要があります。

  • 1 字目は文字である必要があります。

  • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

型: 文字列

必須: いいえ

SkipFinalSnapshot

クラスターの削除前に最終のクラスタースナップショットを作成するかどうかを指定します。true を指定した場合、クラスタースナップショットが作成されます。false を指定した場合、DB クラスターの削除前にクラスタースナップショットが作成されます。

注記

SkipFinalSnapshotfalse の場合は、FinalDBSnapshotIdentifier パラメータを指定する必要があります。

デフォルト: false

タイプ: ブール値

必須:いいえ

レスポンス要素

以下の要素がサービスによって返されます。

DBCluster

クラスターに関する詳細情報。

型: DBCluster オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

DBClusterNotFoundFault

DBClusterIdentifier は既存のクラスターを参照していません。

HTTP ステータスコード: 404

DBClusterSnapshotAlreadyExistsFault

指定された識別子を持つクラスタースナップショットをすでに持っています。

HTTP ステータスコード:400

InvalidDBClusterSnapshotStateFault

指定された値は有効なクラスタースナップショット状態ではありません。

HTTP ステータスコード:400

InvalidDBClusterStateFault

クラスターは有効な状態ではありません。

HTTP ステータスコード:400

SnapshotQuotaExceeded

リクエストにより、スナップショットの許容数を超過します。

HTTP ステータスコード:400

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。