describe_engine_default_parameters ( $cache_parameter_group_family, $opt )

Returns the default engine and system parameter information for the specified cache engine.

Access

public

Parameters

Parameter

Type

Required

Description

$cache_parameter_group_family

string

Required

The name of the Cache Parameter Group Family.

Currently, memcached1.4 is the only cache parameter group family supported by the service.

$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 marker is included in the response so that the remaining results may be retrieved.
  • Marker - string - Optional - An optional marker provided in the previous DescribeCacheClusters 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

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe all engine default parameters.

$elasticache = new AmazonElastiCache();

$response = $elasticache->describe_engine_default_parameters('memcached1.4');
$query = $response->body
                  ->query('descendant-or-self::Parameter[ParameterName="max_item_size"]')
                  ->first();

print_r($query);
Result:
CFSimpleXML Object
(
    [ParameterValue] => 1048576
    [DataType] => integer
    [Source] => system
    [IsModifiable] => true
    [Description] => The size of the largest item storable in the cache, in bytes.
    [AllowedValues] => 1024-134217728
    [ParameterName] => max_item_size
    [MinimumEngineVersion] => 1.4.5
)

Source

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

public function describe_engine_default_parameters($cache_parameter_group_family, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['CacheParameterGroupFamily'] = $cache_parameter_group_family;
    
    return $this->authenticate('DescribeEngineDefaultParameters', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback