Returns a list of orderable DB Instance options for the specified engine.
Access
Parameters
Parameter |
Type |
Required |
Description |
$engine
|
string
|
Required
|
The name of the engine to retrieve DB Instance options for. |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
EngineVersion - string - Optional - The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.DBInstanceClass - string - Optional - The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.LicenseModel - string - Optional - The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.Vpc - boolean - Optional - The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.MaxRecords - integer - Optional - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100Marker - string - Optional - An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .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
Examples
Get a list of orderable DB Instance options for MySQL.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_orderable_db_instance_options('MySQL');
// Success?
var_dump($response->isOK());
Result:
bool(true)
Get a list of orderable DB Instance options for Oracle SE.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_orderable_db_instance_options('oracle-se');
// Success?
var_dump($response->isOK());
Result:
bool(true)
Get a list of orderable DB Instance options for Oracle SE One.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_orderable_db_instance_options('oracle-se1');
// Success?
var_dump($response->isOK());
Result:
bool(true)
Get a list of orderable DB Instance options for Oracle EE.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_orderable_db_instance_options('oracle-ee');
// Success?
var_dump($response->isOK());
Result:
bool(true)
Source
Method defined in services/rds.class.php | Toggle source view (7 lines) | View on GitHub
public function describe_orderable_db_instance_options($engine, $opt = null)
{
if (!$opt) $opt = array();
$opt['Engine'] = $engine;
return $this->authenticate('DescribeOrderableDBInstanceOptions', $opt);
}