Menu
Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)

rds-delete-db-snapshot

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

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

Syntax

rds-delete-db-snapshot db-snapshot-identifier

[General Options]

Options

Name Description Required

--db-snapshot-identifier value

DB snapshot identifier.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-delete-db-snapshot my-db-snapshot-identifier.

Constraints: Must contain 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

Yes

--force value

-f value

If specified, forces the deletion to proceed without a confirmation prompt.

No

Output

The command returns the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • DBSnapshotId—Name of the DB snapshot

  • Snapshot Created—The time (UTC) when the DB snapshot was taken

  • DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB instance

  • Instance Created—The date and time when the DB instance was created

  • Engine—The name and version of the database used

  • Storage—The size of the DB snapshot's allocated storage (GB)

  • Storage Type—The storage type of the DB snapshot

  • Encrypted—Indicates whether the DB snapshot is encrypted

  • KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB snapshot

  • Status—Status of the DB snapshot. Valid values: creating | available

  • Master Username—The login name of the database's master user

  • AZ—The original Availability Zone of the database from which the DB snapshot was taken. This column appears only in the --show-long view.

  • Port—The original port of the database from which the DB snapshot was taken. This column appears only in the --show-long view.

Examples

Delete a Database Snapshot

This example deletes a DB snapshot.

Copy
PROMPT> rds-delete-db-snapshot mysnapshot Once you begin deleting this snapshot, it will no longer be available for db instance restoration. Are you sure you want to delete this snapshot [Ny]

Output Example

This example shows detailed output with column headers.

Copy
DBSNAPSHOT DBSnapshotId Snapshot Created DBInstanceId Instance Created Engine Storage Status Master Username DBSNAPSHOT mysnapshot 2009-09-03 19:08:13.710 mydbinstance 2009-08-2721:56:55.034 MySQL5.1 10GB deleted sa