You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
Parameters:
-
db_instance_identifier
(Optional[String], default:
None
)
–
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
force_failover
(Optional[BooleanOptional], default:
None
)
–
When true, the reboot is conducted through a Multi-AZ failover.
Constraint: You can't specify true if the instance is not configured for Multi-AZ.
Raises:
Source code in docs_src/capo_docdb/_services/doc_db.py
| def reboot_db_instance(
self,
*,
config_overrides: Optional[DocDBClientConfig] = None,
db_instance_identifier: Optional["capo_docdb.types.string.String"] = None,
force_failover: Optional[
"capo_docdb.types.boolean_optional.BooleanOptional"
] = None,
) -> "capo_docdb.types.reboot_db_instance_result.RebootDBInstanceResult":
"""<p>You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect. </p> <p>Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to <i>rebooting</i>. </p>
Args:
db_instance_identifier: <p>The instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBInstance</code>.</p> </li> </ul>
force_failover: <p> When <code>true</code>, the reboot is conducted through a Multi-AZ failover. </p> <p>Constraint: You can't specify <code>true</code> if the instance is not configured for Multi-AZ.</p>
Raises:
capo_docdb.errors.db_instance_not_found_fault.DBInstanceNotFoundFault: <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing instance. </p>
capo_docdb.errors.invalid_db_instance_state_fault.InvalidDBInstanceStateFault: <p> The specified instance isn't in the <i>available</i> state. </p>
capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_docdb.types.reboot_db_instance_message.RebootDBInstanceMessage]",
) -> OperationResponse[
"capo_docdb.types.reboot_db_instance_result.RebootDBInstanceResult"
]:
import capo_docdb._operations.amazon_rd_sv19.reboot_db_instance
output, http_response = (
capo_docdb._operations.amazon_rd_sv19.reboot_db_instance.reboot_db_instance(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("RebootDBInstance")
)
input_: capo_docdb.types.reboot_db_instance_message.RebootDBInstanceMessage = {}
if db_instance_identifier is not None:
input_["db_instance_identifier"] = db_instance_identifier
if force_failover is not None:
input_["force_failover"] = force_failover
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|