reboot_db_instance ( $db_instance_identifier, $opt )

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

$db_instance_identifier

string

Required

The DB Instance identifier. This parameter is stored as a lowercase string. Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • ForceFailover - boolean - Optional - When true, the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify true if the instance is not configured for MultiAZ.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

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

public function reboot_db_instance($db_instance_identifier, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['DBInstanceIdentifier'] = $db_instance_identifier;
    
    return $this->authenticate('RebootDBInstance', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback