Creates a snapshot of a DB instance¶

Description¶

Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.

Usage¶

rds_create_db_snapshot(DBSnapshotIdentifier, DBInstanceIdentifier, Tags)

Arguments¶

DBSnapshotIdentifier

[required] The identifier for the DB snapshot.

Constraints:
- Can't be null, empty, or blank
- Must contain from 1 to 255 letters, numbers, or hyphens
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
DBInstanceIdentifier

[required] The identifier of the DB instance that you want to create the snapshot of.

Constraints:
- Must match the identifier of an existing DBInstance.
Tags

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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,
    StorageThroughput = 123,
    OptionGroupName = "string",
    PercentProgress = 123,
    SourceRegion = "string",
    SourceDBSnapshotIdentifier = "string",
    StorageType = "string",
    TdeCredentialArn = "string",
    Encrypted = TRUE|FALSE,
    StorageEncryptionType = "none"|"sse-kms"|"sse-rds",
    BackupRetentionPeriod = 123,
    PreferredBackupWindow = "string",
    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"
      )
    ),
    SnapshotTarget = "string",
    OriginalSnapshotCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    SnapshotDatabaseTime = as.POSIXct(
      "2015-01-01"
    ),
    DBSystemId = "string",
    MultiTenant = TRUE|FALSE,
    DedicatedLogVolume = TRUE|FALSE,
    AdditionalStorageVolumes = list(
      list(
        VolumeName = "string",
        AllocatedStorage = 123,
        IOPS = 123,
        MaxAllocatedStorage = 123,
        StorageThroughput = 123,
        StorageType = "string"
      )
    ),
    SnapshotAvailabilityZone = "string",
    FullSnapshotSizeInBytes = 123
  )
)

Request syntax¶

svc$create_db_snapshot(
  DBSnapshotIdentifier = "string",
  DBInstanceIdentifier = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples¶

# This example creates a DB snapshot.
svc$create_db_snapshot(
  DBInstanceIdentifier = "mymysqlinstance",
  DBSnapshotIdentifier = "mydbsnapshot"
)