aws_sdk_rds/client/backtrack_db_cluster.rs
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`BacktrackDBCluster`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`db_cluster_identifier(impl Into<String>)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::set_db_cluster_identifier):<br>required: **true**<br><p>The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p></li> <li> <p>First character must be a letter.</p></li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p></li> </ul> <p>Example: <code>my-cluster1</code></p><br>
/// - [`backtrack_to(DateTime)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::backtrack_to) / [`set_backtrack_to(Option<DateTime>)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::set_backtrack_to):<br>required: **true**<br><p>The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p><note> <p>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.</p> </note> <p>Constraints:</p> <ul> <li> <p>Must contain a valid ISO 8601 timestamp.</p></li> <li> <p>Can't contain a timestamp set in the future.</p></li> </ul> <p>Example: <code>2017-07-08T18:00Z</code></p><br>
/// - [`force(bool)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::set_force):<br>required: **false**<br><p>Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.</p><br>
/// - [`use_earliest_time_on_point_in_time_unavailable(bool)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::use_earliest_time_on_point_in_time_unavailable) / [`set_use_earliest_time_on_point_in_time_unavailable(Option<bool>)`](crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::set_use_earliest_time_on_point_in_time_unavailable):<br>required: **false**<br><p>Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when <i>BacktrackTo</i> is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and <i>BacktrackTo</i> is set to a timestamp earlier than the earliest backtrack time, an error occurs.</p><br>
/// - On success, responds with [`BacktrackDbClusterOutput`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput) with field(s):
/// - [`db_cluster_identifier(Option<String>)`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput::db_cluster_identifier): <p>Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.</p>
/// - [`backtrack_identifier(Option<String>)`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput::backtrack_identifier): <p>Contains the backtrack identifier.</p>
/// - [`backtrack_to(Option<DateTime>)`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput::backtrack_to): <p>The timestamp of the time to which the DB cluster was backtracked.</p>
/// - [`backtracked_from(Option<DateTime>)`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput::backtracked_from): <p>The timestamp of the time from which the DB cluster was backtracked.</p>
/// - [`backtrack_request_creation_time(Option<DateTime>)`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput::backtrack_request_creation_time): <p>The timestamp of the time at which the backtrack was requested.</p>
/// - [`status(Option<String>)`](crate::operation::backtrack_db_cluster::BacktrackDbClusterOutput::status): <p>The status of the backtrack. This property returns one of the following values:</p> <ul> <li> <p><code>applying</code> - The backtrack is currently being applied to or rolled back from the DB cluster.</p></li> <li> <p><code>completed</code> - The backtrack has successfully been applied to or rolled back from the DB cluster.</p></li> <li> <p><code>failed</code> - An error occurred while the backtrack was applied to or rolled back from the DB cluster.</p></li> <li> <p><code>pending</code> - The backtrack is currently pending application to or rollback from the DB cluster.</p></li> </ul>
/// - On failure, responds with [`SdkError<BacktrackDBClusterError>`](crate::operation::backtrack_db_cluster::BacktrackDBClusterError)
pub fn backtrack_db_cluster(&self) -> crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder {
crate::operation::backtrack_db_cluster::builders::BacktrackDBClusterFluentBuilder::new(self.handle.clone())
}
}