Skip to content

Returns the detailed parameter list for a particular cluster parameter group

Description

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

Usage

docdb_describe_db_cluster_parameters(DBClusterParameterGroupName,
  Source, Filters, MaxRecords, Marker)

Arguments

  • DBClusterParameterGroupName

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

    Constraints:

    • If provided, must match the name of an existing DBClusterParameterGroup.

  • Source

    A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

  • 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(
  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"
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_db_cluster_parameters(
  DBClusterParameterGroupName = "string",
  Source = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)