elasticache_describe_engine_default_parameters: Returns the default engine and system parameter information...

Description Usage Arguments Value Request syntax

View source: R/elasticache_operations.R

Description

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

Usage

1
2
elasticache_describe_engine_default_parameters(
  CacheParameterGroupFamily, MaxRecords, Marker)

Arguments

CacheParameterGroupFamily

[required] The name of the cache parameter group family.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
list(
  EngineDefaults = list(
    CacheParameterGroupFamily = "string",
    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

1
2
3
4
5
svc$describe_engine_default_parameters(
  CacheParameterGroupFamily = "string",
  MaxRecords = 123,
  Marker = "string"
)

paws.database documentation built on March 9, 2021, 5:11 p.m.