db_cluster_backtracks

Creates, updates, deletes, gets or lists a db_cluster_backtracks resource.

Overview

Name	db_cluster_backtracks
Type	Resource
Id	aws.rds.db_cluster_backtracks

Fields

The following fields are returned by SELECT queries:

describe_db_cluster_backtracks

Name	Datatype	Description
backtrack_identifier	string	Contains the backtrack identifier.
backtrack_request_creation_time	string	The timestamp of the time at which the backtrack was requested.
backtrack_to	string	The timestamp of the time to which the DB cluster was backtracked.
backtracked_from	string	The timestamp of the time from which the DB cluster was backtracked.
db_cluster_identifier	string	Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_cluster_backtracks	select	DBClusterIdentifier, region	BacktrackIdentifier, Filters, MaxRecords, Marker	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DBClusterIdentifier	string	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
region	string	AWS region (default: us-east-1)
BacktrackIdentifier	string	If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier. Example: 123e4567-e89b-12d3-a456-426655440000
Filters	array	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.
Marker	string	An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	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.

SELECT examples

describe_db_cluster_backtracks

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.

SELECT
backtrack_identifier,
backtrack_request_creation_time,
backtrack_to,
backtracked_from,
db_cluster_identifier,
status
FROM aws.rds.db_cluster_backtracks
WHERE DBClusterIdentifier = '{{ DBClusterIdentifier }}' -- required
AND region = '{{ region }}' -- required
AND BacktrackIdentifier = '{{ BacktrackIdentifier }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;