RebootDBInstance
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBInstanceIdentifier
-
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing
DBInstance
.
Type: String
Required: Yes
-
- ForceFailover
-
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.Type: Boolean
Required: No
Response Elements
The following element is returned by the service.
- DBInstance
-
Detailed information about an instance.
Type: DBInstance object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBInstanceNotFound
-
DBInstanceIdentifier
doesn't refer to an existing instance.HTTP Status Code: 404
- InvalidDBInstanceState
-
The specified instance isn't in the available state.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: