describe_db_engine_versions ( $opt )

Returns a list of the available DB engines.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • Engine - string - Optional - The database engine to return.
  • EngineVersion - string - Optional - The database engine version to return. Example: 5.1.49
  • DBParameterGroupFamily - string - Optional - The name of a specific DB Parameter Group family to return details for. Constraints:
    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
  • MaxRecords - integer - Optional - The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100
  • Marker - string - Optional - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • DefaultOnly - boolean - Optional - Indicates that only the default version of the specified engine or engine and major version combination is returned.
  • ListSupportedCharacterSets - boolean - Optional - If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
  • 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

Describe the MySQL database engine versions.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->describe_db_engine_versions(array(
	'Engine' => 'MySQL',
	'DBParameterGroupFamily' => 'mysql5.1',
	'DefaultOnly' => true
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Describe the Oracle database engine versions.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->describe_db_engine_versions(array(
	'Engine' => 'oracle-se'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Describe the Oracle database engine versions.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->describe_db_engine_versions(array(
	'Engine' => 'oracle-se1'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Describe the Oracle database engine versions.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->describe_db_engine_versions(array(
	'Engine' => 'oracle-ee'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

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

public function describe_db_engine_versions($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('DescribeDBEngineVersions', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback