describe_cache_parameters ( $cache_parameter_group_name, $opt )

Returns the detailed parameter list for a particular CacheParameterGroup.

Access

public

Parameters

Parameter

Type

Required

Description

$cache_parameter_group_name

string

Required

The name of a specific cache parameter group to return details for.

$opt

array

Optional

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

  • Source - string - Optional - The parameter types to return. Valid values: user | system | engine-default
  • 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 cache parameters.

$elasticache = new AmazonElastiCache();

$response = $elasticache->describe_cache_parameters('default.memcached1.4');

$query = $response->body
                  ->query('descendant-or-self::Parameter[ParameterName="max_simultaneous_connections"]')
                  ->first();

print_r($query);
Result:
CFSimpleXML Object
(
    [ParameterValue] => 65000
    [DataType] => integer
    [Source] => system
    [IsModifiable] => false
    [Description] => The maximum number of simultaneous connections.
    [AllowedValues] => 3-65000
    [ParameterName] => max_simultaneous_connections
    [MinimumEngineVersion] => 1.4.5
)

Source

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

public function describe_cache_parameters($cache_parameter_group_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['CacheParameterGroupName'] = $cache_parameter_group_name;
    
    return $this->authenticate('DescribeCacheParameters', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback