Amazon Relational Database Service
API Reference (API Version 2013-09-09)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

CreateDBSnapshot

Description

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

Request Parameters

For information about the common parameters that all actions use, 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.member.N

A list of tags.

Type: Tag list

Required: No

Response Elements

The following elements are returned in a structure named DBSnapshot.

AllocatedStorage

Specifies the allocated storage size in gigabytes (GB).

Type: Integer

AvailabilityZone

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Type: String

DBInstanceIdentifier

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Type: String

DBSnapshotIdentifier

Specifies the identifier for the DB snapshot.

Type: String

Engine

Specifies the name of the database engine.

Type: String

EngineVersion

Specifies the version of the database engine.

Type: String

InstanceCreateTime

Specifies the time (UTC) when the snapshot was taken.

Type: DateTime

Iops

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Type: Integer

LicenseModel

License model information for the restored DB instance.

Type: String

MasterUsername

Provides the master username for the DB snapshot.

Type: String

OptionGroupName

Provides the option group name for the DB snapshot.

Type: String

PercentProgress

The percentage of the estimated data that has been transferred.

Type: Integer

Port

Specifies the port that the database engine was listening on at the time of the snapshot.

Type: Integer

SnapshotCreateTime

Provides the time (UTC) when the snapshot was taken.

Type: DateTime

SnapshotType

Provides the type of the DB snapshot.

Type: String

SourceRegion

The region that the DB snapshot was created in or copied from.

Type: String

Status

Specifies the status of this DB snapshot.

Type: String

VpcId

Provides the Vpc Id associated with the DB snapshot.

Type: String

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

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=CreateDBSnapshot
    &DBInstanceIdentifier=simcoprod01
    &DBSnapshotIdentifier=mydbsnapshot
    &Version=2013-05-15
    &SignatureVersion=2&SignatureMethod=HmacSHA256
    &Timestamp=2011-05-23T06%3A27%3A42.551Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<CreateDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2013-05-15/">
  <CreateDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <Engine>mysql</Engine>
      <Status>creating</Status>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <LicenseModel>general-public-license</LicenseModel>
      <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>
      <AllocatedStorage>10</AllocatedStorage>
      <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>
      <EngineVersion>5.1.50</EngineVersion>
      <DBSnapshotIdentifier>mydbsnapshot</DBSnapshotIdentifier>
      <SnapshotType>manual</SnapshotType>
      <MasterUsername>master</MasterUsername>
    </DBSnapshot>
  </CreateDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>c4181d1d-8505-11e0-90aa-eb648410240d</RequestId>
  </ResponseMetadata>
</CreateDBSnapshotResponse>