rds-create-db-snapshot

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 DBInstanceIdentifier

-s (--db-snapshot-identifier) value [General Options]

Options

Name Description Required

Name	Description	Required
`DBInstanceIdentifier`	DB Instance identifier. This is the unique key that identifies a DB Instance. This parameter is stored as a lowercase string. This parameter can also be set using --db-instance-identifier `value` 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
`-s` `value` `--db-snapshot-identifier` `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

DBInstanceIdentifier

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

This parameter can also be set using --db-instance-identifier value

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

-s value

--db-snapshot-identifier 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

Output

The command returns the following information:

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)
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
Storage—The size of the DB Snapshot's allocated storage (GB)
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