Returns the default engine and system parameter information for the specified database engine.
Access
Parameters
Parameter |
Type |
Required |
Description |
$db_parameter_group_family
|
string
|
Required
|
The name of the DB Parameter Group Family. |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
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 may be retrieved. Default: 100 Constraints: minimum 20, maximum 100Marker - string - Optional - An optional pagination token provided by a previous DescribeEngineDefaultParameters 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
Describe the database engine default parameters.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_engine_default_parameters('MySQL5.1');
// Success?
var_dump($response->isOK());
Result:
bool(true)
Related Methods
Source
Method defined in services/rds.class.php | Toggle source view (7 lines) | View on GitHub
public function describe_engine_default_parameters($db_parameter_group_family, $opt = null)
{
if (!$opt) $opt = array();
$opt['DBParameterGroupFamily'] = $db_parameter_group_family;
return $this->authenticate('DescribeEngineDefaultParameters', $opt);
}