Skip to content

RDS  >  Operations  >  reboot_db_instance

reboot_db_instance

Operation

reboot_db_instance async 

reboot_db_instance(input: RebootDBInstanceInput, plugins: list[Plugin] | None = None) -> RebootDBInstanceOutput

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.

For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom.

If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.

Parameters:

Name Type Description Default
input RebootDBInstanceInput

An instance of RebootDBInstanceInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
RebootDBInstanceOutput

An instance of RebootDBInstanceOutput.

Input

RebootDBInstanceInput dataclass

Bases: _SerdeShape

Attributes

db_instance_identifier class-attribute instance-attribute 
db_instance_identifier: str | None = ...

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.
force_failover class-attribute instance-attribute 
force_failover: bool | None = ...

Specifies whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

Output

RebootDBInstanceOutput dataclass

Bases: _SerdeShape

Dataclass for RebootDBInstanceOutput structure.

Attributes

db_instance class-attribute instance-attribute 
db_instance: DBInstance | None = ...

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.