Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Required |
The DB Instance identifier. This parameter is stored as a lowercase string. Constraints:
|
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Reboot a database instance.
// Instantiate the class $rds = new AmazonRDS(); $response = $rds->reboot_db_instance('myInstance'); // Success? var_dump($response->isOK());
Related Methods
Source
Method defined in services/rds.class.php | Toggle source view (7 lines) | View on GitHub