promote_read_replica ( $db_instance_identifier, $opt )

Promotes a Read Replica DB Instance to a standalone DB Instance.

Access

public

Parameters

Parameter

Type

Required

Description

$db_instance_identifier

string

Required

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

  • Must be the identifier for an existing Read Replica DB Instance
  • 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

Example:mydbinstance

$opt

array

Optional

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

  • BackupRetentionPeriod - integer - Optional - The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints:
    • Must be a value from 0 to 8
  • PreferredBackupWindow - string - Optional - The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned.
    • US-East (Northern Virginia) Region: 03:00-11:00 UTC
    • US-West (Northern California) Region: 06:00-14:00 UTC
    • EU (Ireland) Region: 22:00-06:00 UTC
    • Asia Pacific (Singapore) Region: 14:00-22:00 UTC
    • Asia Pacific (Tokyo) Region: 17:00-03:00 UTC
    Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
  • 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.

Source

Method defined in services/rds.class.php | Toggle source view (7 lines) | View on GitHub

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback