AWS Documentation » Amazon ElastiCache » Amazon ElastiCache API Reference » Actions » DescribeEngineDefaultParameters	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

DescribeEngineDefaultParameters

Description

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

Request Parameters

For information about the common parameters that all actions use, see Common Parameters.

CacheParameterGroupFamily

The name of the Cache Parameter Group Family.

Note

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

Type: String

Required: Yes

Marker

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.

Type: String

Required: No

MaxRecords

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.

Type: Integer

Required: No

Response Elements

The following elements are returned in a EngineDefaults structure.

CacheNodeTypeSpecificParameters

A list of CacheNodeTypeSpecificParameter instances.

Type: CacheNodeTypeSpecificParameter list

CacheParameterGroupFamily

Specifies the name of the Cache Parameter Group Family which the engine default parameters apply to.

Type: String

Marker

Provides an identifier to allow retrieval of paginated results.

Type: String

Parameters

Contains a list of engine default parameters.

Type: Parameter list

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombination: HTTP Status Code: 400
InvalidParameterValue: HTTP Status Code: 400

Examples

Sample Request

https://elasticache.us-east-1.amazonaws.com/
   ?Action=DescribeEngineDefaultParameters
   &CacheParameterGroupFamily=memcached1.4
   &MaxRecords=100
   &Version=2012-11-15
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2011-07-27T01%3A34%3A31.045Z
   &AWSAccessKeyId=YOUR-ACCESS-KEY
   &Signature=YOUR-SIGNATURE

Sample Response

<DescribeEngineDefaultParametersResponse xmlns="http://elasticache.amazonaws.com/doc/2012-11-15/">
  <DescribeEngineDefaultParametersResult>
    <EngineDefaults>
      <CacheParameterGroupFamily>memcached1.4</CacheParameterGroupFamily>
      <Parameters>
        <Parameter>
          <ParameterValue>1024</ParameterValue>
          <DataType>integer</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>The backlog queue limit.</Description>
          <AllowedValues>1-10000</AllowedValues>
          <ParameterName>backlog_queue_limit</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
        </Parameter>
        <Parameter>
          <ParameterValue>auto</ParameterValue>
          <DataType>string</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>Binding protocol.</Description>
          <AllowedValues>auto,binary,ascii</AllowedValues>
          <ParameterName>binding_protocol</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
        </Parameter>
        <Parameter>
          <ParameterValue>0</ParameterValue>
          <DataType>boolean</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>Try to use large memory pages.</Description>
          <AllowedValues>0,1</AllowedValues>
          <ParameterName>large_memory_pages</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>

          ... EXAMPLE TRUNCATED FOR SPACE ...

        </Parameter>
      </Parameters>
      <CacheNodeTypeSpecificParameters>
        <CacheNodeTypeSpecificParameter>
          <CacheNodeTypeSpecificValues>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.c1.xlarge</CacheNodeType>
              <Value>6000</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m1.large</CacheNodeType>
              <Value>7100</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m1.small</CacheNodeType>
              <Value>1300</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m1.xlarge</CacheNodeType>
              <Value>14600</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m2.2xlarge</CacheNodeType>
              <Value>33800</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m2.4xlarge</CacheNodeType>
              <Value>68000</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m2.xlarge</CacheNodeType>
              <Value>16600</Value>
            </CacheNodeTypeSpecificValue>
          </CacheNodeTypeSpecificValues>
          <DataType>integer</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>The maximum configurable amount of memory to use to store
 items, in megabytes.</Description>
          <AllowedValues>1-100000</AllowedValues>
          <ParameterName>max_cache_memory</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
        </CacheNodeTypeSpecificParameter>
        <CacheNodeTypeSpecificParameter>
          <CacheNodeTypeSpecificValues>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.c1.xlarge</CacheNodeType>
              <Value>8</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m1.large</CacheNodeType>
              <Value>2</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m1.small</CacheNodeType>
              <Value>1</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m1.xlarge</CacheNodeType>
              <Value>4</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m2.2xlarge</CacheNodeType>
              <Value>4</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m2.4xlarge</CacheNodeType>
              <Value>8</Value>
            </CacheNodeTypeSpecificValue>
            <CacheNodeTypeSpecificValue>
              <CacheNodeType>cache.m2.xlarge</CacheNodeType>
              <Value>2</Value>
            </CacheNodeTypeSpecificValue>
          </CacheNodeTypeSpecificValues>
          <DataType>integer</DataType>
          <Source>system</Source>
          <IsModifiable>false</IsModifiable>
          <Description>The number of memcached threads to use.</Description>
          <AllowedValues>1-8</AllowedValues>
          <ParameterName>num_threads</ParameterName>
          <MinimumEngineVersion>1.4.5</MinimumEngineVersion>
        </CacheNodeTypeSpecificParameter>
      </CacheNodeTypeSpecificParameters>
    </EngineDefaults>
  </DescribeEngineDefaultParametersResult>
  <ResponseMetadata>
    <RequestId>061282fe-b7fd-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</DescribeEngineDefaultParametersResponse>

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...