describe_cache_parameter_groups ( $opt )

Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • CacheParameterGroupName - string - Optional - The name of a specific cache parameter group to return details for.
  • 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 DescribeCacheParameterGroups 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 parameter groups.

$elasticache = new AmazonElastiCache();

$response = $elasticache->describe_cache_parameter_groups();

print_r($response->body->CacheParameterGroup()->first());
Result:
CFSimpleXML Object
(
    [CacheParameterGroupName] => default.memcached1.4
    [CacheParameterGroupFamily] => memcached1.4
    [Description] => Default parameter group for memcached1.4
)

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback