Returns a list of DBClusterParameterGroup descriptions¶

Description¶

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

Usage¶

docdb_describe_db_cluster_parameter_groups(DBClusterParameterGroupName,
  Filters, MaxRecords, Marker)

Arguments¶

• DBClusterParameterGroupName

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

  Constraints:

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

• 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(
  Marker = "string",
  DBClusterParameterGroups = list(
    list(
      DBClusterParameterGroupName = "string",
      DBParameterGroupFamily = "string",
      Description = "string",
      DBClusterParameterGroupArn = "string"
    )
  )
)

Request syntax¶

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