aws_sdk_rds/client/reboot_db_instance.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`RebootDBInstance`](crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`db_instance_identifier(impl Into<String>)`](crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder::db_instance_identifier) / [`set_db_instance_identifier(Option<String>)`](crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder::set_db_instance_identifier):<br>required: **true**<br><p>The DB instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing DBInstance.</p></li> </ul><br>
7 /// - [`force_failover(bool)`](crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder::force_failover) / [`set_force_failover(Option<bool>)`](crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder::set_force_failover):<br>required: **false**<br><p>Specifies whether the reboot is conducted through a Multi-AZ failover.</p> <p>Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.</p><br>
8 /// - On success, responds with [`RebootDbInstanceOutput`](crate::operation::reboot_db_instance::RebootDbInstanceOutput) with field(s):
9 /// - [`db_instance(Option<DbInstance>)`](crate::operation::reboot_db_instance::RebootDbInstanceOutput::db_instance): <p>Contains the details of an Amazon RDS DB instance.</p> <p>This data type is used as a response element in the operations <code>CreateDBInstance</code>, <code>CreateDBInstanceReadReplica</code>, <code>DeleteDBInstance</code>, <code>DescribeDBInstances</code>, <code>ModifyDBInstance</code>, <code>PromoteReadReplica</code>, <code>RebootDBInstance</code>, <code>RestoreDBInstanceFromDBSnapshot</code>, <code>RestoreDBInstanceFromS3</code>, <code>RestoreDBInstanceToPointInTime</code>, <code>StartDBInstance</code>, and <code>StopDBInstance</code>.</p>
10 /// - On failure, responds with [`SdkError<RebootDBInstanceError>`](crate::operation::reboot_db_instance::RebootDBInstanceError)
11 pub fn reboot_db_instance(&self) -> crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder {
12 crate::operation::reboot_db_instance::builders::RebootDBInstanceFluentBuilder::new(self.handle.clone())
13 }
14}