DescribeEngineDefaultClusterParametersCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, DescribeEngineDefaultClusterParametersCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribeEngineDefaultClusterParametersCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribeEngineDefaultClusterParametersMessage
  DBParameterGroupFamily: "STRING_VALUE", // required
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeEngineDefaultClusterParametersCommand(input);
const response = await client.send(command);
// { // DescribeEngineDefaultClusterParametersResult
//   EngineDefaults: { // EngineDefaults
//     DBParameterGroupFamily: "STRING_VALUE",
//     Marker: "STRING_VALUE",
//     Parameters: [ // ParametersList
//       { // Parameter
//         ParameterName: "STRING_VALUE",
//         ParameterValue: "STRING_VALUE",
//         Description: "STRING_VALUE",
//         Source: "STRING_VALUE",
//         ApplyType: "STRING_VALUE",
//         DataType: "STRING_VALUE",
//         AllowedValues: "STRING_VALUE",
//         IsModifiable: true || false,
//         MinimumEngineVersion: "STRING_VALUE",
//         ApplyMethod: "immediate" || "pending-reboot",
//       },
//     ],
//   },
// };

DescribeEngineDefaultClusterParametersCommand Input

See DescribeEngineDefaultClusterParametersCommandInput for more details

Parameter
Type
Description
DBParameterGroupFamily
Required
string | undefined

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

Filters
Filter[] | undefined

This parameter is not currently supported.

Marker
string | undefined

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.

MaxRecords
number | undefined

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.

DescribeEngineDefaultClusterParametersCommand Output

See DescribeEngineDefaultClusterParametersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EngineDefaults
EngineDefaults | undefined

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

Throws

Name
Fault
Details
DocDBServiceException
Base exception class for all service exceptions from DocDB service.