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

CreateDBSnapshot

Creates a DBSnapshot. The source DBInstance must be in "available" state.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBInstanceIdentifier

The DB instance identifier. This is the unique key that identifies a DB instance.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Type: String

Required: Yes

DBSnapshotIdentifier

The identifier for the DB snapshot.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Type: String

Required: Yes

Tags.Tag.N

A list of tags.

Type: array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

DBSnapshot

Contains the result of a successful invocation of the following actions:

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

Type: DBSnapshot object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBInstanceNotFound

DBInstanceIdentifier does not refer to an existing DB instance.

HTTP Status Code: 404

DBSnapshotAlreadyExists

DBSnapshotIdentifier is already used by an existing snapshot.

HTTP Status Code: 400

InvalidDBInstanceState

The specified DB instance is not in the available state.

HTTP Status Code: 400

SnapshotQuotaExceeded

Request would result in user exceeding the allowed number of DB snapshots.

HTTP Status Code: 400

Example

Sample Request


https://rds.us-east-1.amazonaws.com/
   ?Action=CreateDBSnapshot
   &DBInstanceIdentifier=mysqldb-02
   &DBSnapshotIdentifier=mySQLdb-snap-1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-09-01
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140423/us-east-1/rds/aws4_request
   &X-Amz-Date=20140423T161105Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=e9649af6edcfbab4016f04d72e1b7fc16d8734c37477afcf25b3def625484ed2

Sample Response


<CreateDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/">
  <CreateDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Engine>mysql</Engine>
      <Status>creating</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.13</EngineVersion>
      <DBInstanceIdentifier>mysqldb-02</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mysqldb-snap-1</DBSnapshotIdentifier>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <InstanceCreateTime>2014-04-21T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>0</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBSnapshot>
  </CreateDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>bd80a25a-af09-11c3-ed11-23c32f9aa7d3</RequestId>
  </ResponseMetadata>
</CreateDBSnapshotResponse>