@aws-sdk/client-docdb

DescribeDBClustersCommandInput Interface

The input for DescribeDBClustersCommand.

Members

Name
Type
Details
DBClusterIdentifier string | undefined

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Filters Filter[] | undefined

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

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.

Full Signature

export interface DescribeDBClustersCommandInput extends DescribeDBClustersMessage