Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DescribeDBClusterParametersCommand

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

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Example Syntax

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

import { RDSClient, DescribeDBClusterParametersCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, DescribeDBClusterParametersCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // DescribeDBClusterParametersMessage
  DBClusterParameterGroupName: "STRING_VALUE", // required
  Source: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeDBClusterParametersCommand(input);
const response = await client.send(command);
// { // DBClusterParameterGroupDetails
//   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",
//       SupportedEngineModes: [ // EngineModeList
//         "STRING_VALUE",
//       ],
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

Example Usage

There was an error loading the code editor. Retry

DescribeDBClusterParametersCommand Input

See DescribeDBClusterParametersCommandInput for more details

Parameter	Type	Description
`DBClusterParameterGroupName` Required	`string \| undefined`	The name of a specific DB cluster parameter group to return parameter details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
`Filters`	`Filter[] \| undefined`	A filter that specifies one or more DB cluster parameters to describe. The only supported filter is `parameter-name`. The results list only includes information about the DB cluster parameters with these names.
`Marker`	`string \| undefined`	An optional pagination token provided by a previous `DescribeDBClusterParameters` 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 called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
`Source`	`string \| undefined`	A specific source to return parameters for. Valid Values: `engine-default` `system` `user`

DescribeDBClusterParametersCommand Output

See DescribeDBClusterParametersCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`Marker`	`string \| undefined`	An optional pagination token provided by a previous `DescribeDBClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`.
`Parameters`	`Parameter[] \| undefined`	Provides a list of parameters for the DB cluster parameter group.

Throws

Name	Fault	Details
DBParameterGroupNotFoundFault	client	`DBParameterGroupName` doesn't refer to an existing DB parameter group.
RDSServiceException		Base exception class for all service exceptions from RDS service.

Getting Started