Skip to content

Modify Db Snapshot

rds_modify_db_snapshot R Documentation

Updates a manual DB snapshot with a new engine version

Description

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.

Usage

rds_modify_db_snapshot(DBSnapshotIdentifier, EngineVersion,
  OptionGroupName)

Arguments

DBSnapshotIdentifier

[required] The identifier of the DB snapshot to modify.

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.

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.

Value

A list with the following syntax: 

list(
  DBSnapshot = list(
    DBSnapshotIdentifier = "string",
    DBInstanceIdentifier = "string",
    SnapshotCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    Engine = "string",
    AllocatedStorage = 123,
    Status = "string",
    Port = 123,
    AvailabilityZone = "string",
    VpcId = "string",
    InstanceCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    MasterUsername = "string",
    EngineVersion = "string",
    LicenseModel = "string",
    SnapshotType = "string",
    Iops = 123,
    OptionGroupName = "string",
    PercentProgress = 123,
    SourceRegion = "string",
    SourceDBSnapshotIdentifier = "string",
    StorageType = "string",
    TdeCredentialArn = "string",
    Encrypted = TRUE|FALSE,
    KmsKeyId = "string",
    DBSnapshotArn = "string",
    Timezone = "string",
    IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
    ProcessorFeatures = list(
      list(
        Name = "string",
        Value = "string"
      )
    ),
    DbiResourceId = "string",
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    OriginalSnapshotCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    SnapshotDatabaseTime = as.POSIXct(
      "2015-01-01"
    ),
    SnapshotTarget = "string",
    StorageThroughput = 123,
    DBSystemId = "string",
    DedicatedLogVolume = TRUE|FALSE,
    MultiTenant = TRUE|FALSE
  )
)

Request syntax

svc$modify_db_snapshot(
  DBSnapshotIdentifier = "string",
  EngineVersion = "string",
  OptionGroupName = "string"
)