Skip to content

Returns the detailed parameter list for a particular cache parameter group

Description

Returns the detailed parameter list for a particular cache parameter group.

Usage

elasticache_describe_cache_parameters(CacheParameterGroupName, Source,
  MaxRecords, Marker)

Arguments

  • CacheParameterGroupName

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

  • Source

    The parameter types to return.

    Valid values: user | system | engine-default

  • 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 can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • Marker

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

list(
  Marker = "string",
  Parameters = list(
    list(
      ParameterName = "string",
      ParameterValue = "string",
      Description = "string",
      Source = "string",
      DataType = "string",
      AllowedValues = "string",
      IsModifiable = TRUE|FALSE,
      MinimumEngineVersion = "string",
      ChangeType = "immediate"|"requires-reboot"
    )
  ),
  CacheNodeTypeSpecificParameters = list(
    list(
      ParameterName = "string",
      Description = "string",
      Source = "string",
      DataType = "string",
      AllowedValues = "string",
      IsModifiable = TRUE|FALSE,
      MinimumEngineVersion = "string",
      CacheNodeTypeSpecificValues = list(
        list(
          CacheNodeType = "string",
          Value = "string"
        )
      ),
      ChangeType = "immediate"|"requires-reboot"
    )
  )
)

Request syntax

svc$describe_cache_parameters(
  CacheParameterGroupName = "string",
  Source = "string",
  MaxRecords = 123,
  Marker = "string"
)

Examples

# Lists up to 100 user parameter values for the parameter group
# custom.redis2.8.
svc$describe_cache_parameters(
  CacheParameterGroupName = "custom-redis2-8",
  MaxRecords = 100L,
  Source = "user"
)