Create Snapshot

redshiftserverless_create_snapshot

R Documentation

Creates a snapshot of all databases in a namespace

Description

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.

Usage

redshiftserverless_create_snapshot(namespaceName, retentionPeriod,
  snapshotName, tags)

Arguments

namespaceName

[required] The namespace to create a snapshot for.

retentionPeriod

How long to retain the created snapshot.

snapshotName

[required] The name of the snapshot.

tags

An array of Tag objects to associate with the snapshot.

Value

A list with the following syntax:

list(
  snapshot = list(
    accountsWithProvisionedRestoreAccess = list(
      "string"
    ),
    accountsWithRestoreAccess = list(
      "string"
    ),
    actualIncrementalBackupSizeInMegaBytes = 123.0,
    adminPasswordSecretArn = "string",
    adminPasswordSecretKmsKeyId = "string",
    adminUsername = "string",
    backupProgressInMegaBytes = 123.0,
    currentBackupRateInMegaBytesPerSecond = 123.0,
    elapsedTimeInSeconds = 123,
    estimatedSecondsToCompletion = 123,
    kmsKeyId = "string",
    namespaceArn = "string",
    namespaceName = "string",
    ownerAccount = "string",
    snapshotArn = "string",
    snapshotCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    snapshotName = "string",
    snapshotRemainingDays = 123,
    snapshotRetentionPeriod = 123,
    snapshotRetentionStartTime = as.POSIXct(
      "2015-01-01"
    ),
    status = "AVAILABLE"|"CREATING"|"DELETED"|"CANCELLED"|"FAILED"|"COPYING",
    totalBackupSizeInMegaBytes = 123.0
  )
)

Request syntax

svc$create_snapshot(
  namespaceName = "string",
  retentionPeriod = 123,
  snapshotName = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)