You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
Parameters:
-
db_instance_identifier
(Optional[String], default:
None
)
–
The DB 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 MultiAZ failover.
Constraint: You can't specify true if the instance is not configured for MultiAZ.
Raises:
Source code in docs_src/capo_neptune/_services/neptune.py
| def reboot_db_instance(
self,
*,
config_overrides: Optional[NeptuneClientConfig] = None,
db_instance_identifier: Optional["capo_neptune.types.string.String"] = None,
force_failover: Optional[
"capo_neptune.types.boolean_optional.BooleanOptional"
] = None,
) -> "capo_neptune.types.reboot_db_instance_result.RebootDBInstanceResult":
"""<p>You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.</p> <p>Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.</p>
Args:
db_instance_identifier: <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>
force_failover: <p> When <code>true</code>, the reboot is conducted through a MultiAZ failover.</p> <p>Constraint: You can't specify <code>true</code> if the instance is not configured for MultiAZ.</p>
Raises:
capo_neptune.errors.db_instance_not_found_fault.DBInstanceNotFoundFault: <p> <i>DBInstanceIdentifier</i> does not refer to an existing DB instance.</p>
capo_neptune.errors.invalid_db_instance_state_fault.InvalidDBInstanceStateFault: <p>The specified DB instance is not in the <i>available</i> state.</p>
capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_neptune.types.reboot_db_instance_message.RebootDBInstanceMessage]",
) -> OperationResponse[
"capo_neptune.types.reboot_db_instance_result.RebootDBInstanceResult"
]:
import capo_neptune._operations.amazon_rd_sv19.reboot_db_instance
output, http_response = (
capo_neptune._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_neptune.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
|