RDS / Client / backtrack_db_cluster

backtrack_db_cluster#

RDS.Client.backtrack_db_cluster(**kwargs)#

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.

Note

This action applies only to Aurora MySQL DB clusters.

See also: AWS API Documentation

Request Syntax

response = client.backtrack_db_cluster(
    DBClusterIdentifier='string',
    BacktrackTo=datetime(2015, 1, 1),
    Force=True|False,
    UseEarliestTimeOnPointInTimeUnavailable=True|False
)
Parameters:

  • DBClusterIdentifier (string) –

    [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 (datetime) –

    [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.

    Note

    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 (boolean) – A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

  • UseEarliestTimeOnPointInTimeUnavailable (boolean) – A value that indicates 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.

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterIdentifier': 'string',
    'BacktrackIdentifier': 'string',
    'BacktrackTo': datetime(2015, 1, 1),
    'BacktrackedFrom': datetime(2015, 1, 1),
    'BacktrackRequestCreationTime': datetime(2015, 1, 1),
    'Status': 'string'
}

Response Structure

  • (dict) –

    This data type is used as a response element in the DescribeDBClusterBacktracks action.

    • DBClusterIdentifier (string) –

      Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    • BacktrackIdentifier (string) –

      Contains the backtrack identifier.

    • BacktrackTo (datetime) –

      The timestamp of the time to which the DB cluster was backtracked.

    • BacktrackedFrom (datetime) –

      The timestamp of the time from which the DB cluster was backtracked.

    • BacktrackRequestCreationTime (datetime) –

      The timestamp of the time at which the backtrack was requested.

    • Status (string) –

      The status of the backtrack. This property returns one of the following values:

      • applying - The backtrack is currently being applied to or rolled back from the DB cluster.

      • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

      • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

      • pending - The backtrack is currently pending application to or rollback from the DB cluster.

Exceptions

  • RDS.Client.exceptions.DBClusterNotFoundFault

  • RDS.Client.exceptions.InvalidDBClusterStateFault