Skip to content

Describe Engine Default Cluster Parameters

docdb_describe_engine_default_cluster_parameters R Documentation

Returns the default engine and system parameter information for the cluster database engine

Description

Returns the default engine and system parameter information for the cluster database engine.

Usage

docdb_describe_engine_default_cluster_parameters(DBParameterGroupFamily,
  Filters, MaxRecords, Marker)

Arguments

DBParameterGroupFamily

[required] The name of the cluster parameter group family to return the engine parameter information for.

Filters

This parameter is not currently supported.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous request. 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(
  EngineDefaults = list(
    DBParameterGroupFamily = "string",
    Marker = "string",
    Parameters = list(
      list(
        ParameterName = "string",
        ParameterValue = "string",
        Description = "string",
        Source = "string",
        ApplyType = "string",
        DataType = "string",
        AllowedValues = "string",
        IsModifiable = TRUE|FALSE,
        MinimumEngineVersion = "string",
        ApplyMethod = "immediate"|"pending-reboot"
      )
    )
  )
)

Request syntax

svc$describe_engine_default_cluster_parameters(
  DBParameterGroupFamily = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)