backtrack_db_cluster¶
Operation¶
async
¶
backtrack_db_cluster(input: BacktrackDBClusterInput, plugins: list[Plugin] | None = None) -> BacktrackDBClusterOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BacktrackDBClusterInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
BacktrackDBClusterOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
backtrack_to: datetime | None = ...
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
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
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
class-attribute
instance-attribute
¶
force: bool | None = ...
Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.
class-attribute
instance-attribute
¶
use_earliest_time_on_point_in_time_unavailable: bool | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
This data type is used as a response element in the
DescribeDBClusterBacktracks action.
Attributes¶
class-attribute
instance-attribute
¶
backtrack_identifier: str | None = ...
Contains the backtrack identifier.
class-attribute
instance-attribute
¶
backtrack_request_creation_time: datetime | None = ...
The timestamp of the time at which the backtrack was requested.
class-attribute
instance-attribute
¶
backtrack_to: datetime | None = ...
The timestamp of the time to which the DB cluster was backtracked.
class-attribute
instance-attribute
¶
backtracked_from: datetime | None = ...
The timestamp of the time from which the DB cluster was backtracked.
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
status: str | None = ...
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.