rds_describe_db_cluster_backtracks: Returns information about backtracks for a DB cluster

Description Usage Arguments Value Request syntax

View source: R/rds_operations.R

Description

Returns information about backtracks for a DB cluster.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora MySQL DB clusters.

Usage

1
2
rds_describe_db_cluster_backtracks(DBClusterIdentifier,
  BacktrackIdentifier, Filters, MaxRecords, Marker)

Arguments

DBClusterIdentifier

[required] The DB cluster identifier of the DB cluster to be described. 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

BacktrackIdentifier

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

Example: 123e4567-e89b-12d3-a456-426655440000

Filters

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

  • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

  • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    • applying

    • completed

    • failed

    • pending

    The results list includes information about only the backtracks identified by these values.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous describe_db_cluster_backtracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
list(
  Marker = "string",
  DBClusterBacktracks = list(
    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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc$describe_db_cluster_backtracks(
  DBClusterIdentifier = "string",
  BacktrackIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

paws.database documentation built on Aug. 23, 2021, 9:18 a.m.