Request Parameters Response Elements Errors Examples See Also

ModifyDBSnapshot

Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.

Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.

Request Parameters

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

DBSnapshotIdentifier

The identifier of the DB snapshot to modify.

Type: String

Required: Yes

EngineVersion

The engine version to upgrade the DB snapshot to.

The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

MySQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the Amazon RDS User Guide.

Oracle

19.0.0.0.ru-2022-01.rur-2022-01.r1 (supported for 12.2.0.1 DB snapshots)
19.0.0.0.ru-2022-07.rur-2022-07.r1 (supported for 12.1.0.2 DB snapshots)
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)
11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)
11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

PostgreSQL

For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a PostgreSQL DB snapshot engine version in the Amazon RDS User Guide.

Type: String

Required: No

OptionGroupName

The option group to identify with the upgraded DB snapshot.

You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.

Type: String

Required: No

Response Elements

The following element is returned by the service.

DBSnapshot

Contains the details of an Amazon RDS DB snapshot.

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.

DBSnapshotNotFound

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of ModifyDBSnapshot.

Sample Request


https://rds.us-west-2.amazonaws.com/
    ?Action=ModifyDBSnapshot
    &DBSnapshotIdentifier=mysnapshot1
    &EngineVersion=5.6.44
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20161228/us-west-2/rds/aws4_request
    &X-Amz-Date=20210628T220515Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=eb44f1ce3dab4e1dbf113d8d2a265d88d17ece1999ffd36be85714ed36cbdbe3

Sample Response



<ModifyDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <ModifyDBSnapshotResult>
    <DBSnapshot>
      <Port>3306</Port>
      <OptionGroupName>default:mysql-5-6</OptionGroupName>
      <Engine>mysql</Engine>
      <Status>available</Status>
      <SnapshotType>manual</SnapshotType>
      <LicenseModel>general-public-license</LicenseModel>
      <EngineVersion>5.6.44</EngineVersion>
      <DBInstanceIdentifier>mysqldb-sample</DBInstanceIdentifier>
      <DBSnapshotIdentifier>mysnapshot1</DBSnapshotIdentifier>
      <SnapshotCreateTime>2021-04-20T10:09:15.446Z</SnapshotCreateTime>
      <OriginalSnapshotCreateTime>2021-04-20T10:09:15.446Z</OriginalSnapshotCreateTime>
      <AvailabilityZone>us-west-2b</AvailabilityZone>
      <InstanceCreateTime>2016-12-28T22:24:26.573Z</InstanceCreateTime>
      <PercentProgress>100</PercentProgress>
      <AllocatedStorage>100</AllocatedStorage>
      <MasterUsername>myawsuser</MasterUsername>
    </DBSnapshot>
  </ModifyDBSnapshotResult>
  <ResponseMetadata>
    <RequestId>aa80a25a-af09-11d4-ed11-23c32f9aa7d3</RequestId>
  </ResponseMetadata>
</ModifyDBSnapshotResponse>