Skip to content

RDS  >  Operations  >  delete_db_cluster_snapshot

delete_db_cluster_snapshot

Operation

delete_db_cluster_snapshot async

delete_db_cluster_snapshot(request: DeleteDBClusterSnapshotInput | DeleteDBClusterSnapshotInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteDBClusterSnapshotOutput
delete_db_cluster_snapshot(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDBClusterSnapshotInputDict]) -> DeleteDBClusterSnapshotOutput

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

Note

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DeleteDBClusterSnapshotOutput

An instance of DeleteDBClusterSnapshotOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DeleteDBClusterSnapshotInput dataclass

Bases: _SerdeShape

Attributes
db_cluster_snapshot_identifier class-attribute instance-attribute
db_cluster_snapshot_identifier: str | None = ...

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

Dictionaries

DeleteDBClusterSnapshotInputDict

Bases: TypedDict

Dictionary form of DeleteDBClusterSnapshotInput.

Attributes
db_cluster_snapshot_identifier instance-attribute
db_cluster_snapshot_identifier: Required[str]

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

Output

DeleteDBClusterSnapshotOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDBClusterSnapshotOutput structure.

Attributes

db_cluster_snapshot class-attribute instance-attribute
db_cluster_snapshot: DBClusterSnapshot | None = ...

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.