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

rds-create-db-snapshot

The Amazon RDS Command Line Interface (CLI) has been deprecated. Instead, use the AWS CLI for RDS.

For information on how to download and use the AWS CLI, go to AWS Command Line Interface User Guide. For a reference of the RDS commands available in the AWS CLI, go to AWS CLI Reference for Amazon RDS.

Note

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API. If you need to download an entire log file at once, rather than in portions using the download-db-log-file-portion command, then you can continue to use the last published version of the RDS CLI and the rds-download-db-logfile command.

Description

Creates a recoverable DB snapshot of all data associated with a DB instance.

Note

This operation is not supported for Read Replica DB instances.

Syntax

rds-create-db-snapshot db-instance-identifier

-s (--db-snapshot-identifier) value

[-tk (--tag-key) value ]

[-tv (--tag-value) value ]

[General Options]

Options

NameDescriptionRequired

--db-instance-identifier value

-i value

DB instance identifier. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

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-create-db-snapshot my-db-instance-identifier.

Type: String

Default: None

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.

Example: --db-instance-identifier mydbinstance

Yes

--db-snapshot-identifier value

-s value

The identifier for the DB snapshot.

Type: String

Default: None

Constraints: Cannot be null, empty, or blank. Cannot be a word reserved by the database engine. Must contain 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

Example: -s my-snapshot-id

Yes

--tag-key

-tk

The name of a tag to add for the new DB snapshot.

No

--tag-value

-tv

The value of the tag to add for the new DB snapshot.

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 (in 24 hour 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 engine 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 | deleting

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

  • Iops—The provisioned IOPS allocated, expressed as I/O operations per second

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

Examples

Create a Database Snapshot

This example creates a new DB snapshot.


PROMPT> rds-create-db-snapshot -i mydbinstance -s mytestsnapshot