Skip to content

Backtrack Db Cluster

rds_backtrack_db_cluster R Documentation

Backtracks a DB cluster to a specific time, without creating a new DB cluster

Description

Backtracks a DB cluster to a specific time, without creating a new DB cluster.

For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

This action applies only to Aurora MySQL DB clusters.

Usage

rds_backtrack_db_cluster(DBClusterIdentifier, BacktrackTo, Force,
  UseEarliestTimeOnPointInTimeUnavailable)

Arguments

DBClusterIdentifier

[required] The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

BacktrackTo

[required] The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

  • Must contain a valid ISO 8601 timestamp.

  • Can't contain a timestamp set in the future.

Example: ⁠2017-07-08T18:00Z⁠

Force

Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

UseEarliestTimeOnPointInTimeUnavailable

Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

Value

A list with the following syntax: 

list(
  DBClusterIdentifier = "string",
  BacktrackIdentifier = "string",
  BacktrackTo = as.POSIXct(
    "2015-01-01"
  ),
  BacktrackedFrom = as.POSIXct(
    "2015-01-01"
  ),
  BacktrackRequestCreationTime = as.POSIXct(
    "2015-01-01"
  ),
  Status = "string"
)

Request syntax

svc$backtrack_db_cluster(
  DBClusterIdentifier = "string",
  BacktrackTo = as.POSIXct(
    "2015-01-01"
  ),
  Force = TRUE|FALSE,
  UseEarliestTimeOnPointInTimeUnavailable = TRUE|FALSE
)