Skip to content

DescribeDBClusters

Source: src/AWS/DocDB/DescribeDBClusters.ts

Runtime binding for the DescribeDBClusters operation (IAM action rds:DescribeDBClusters).

Lists the account’s DocumentDB clusters (or one cluster by identifier) — status, endpoints, members, engine versions — for health checks and cluster discovery. Provide the implementation with Effect.provide(AWS.DocDB.DescribeDBClustersHttp).

const describeDBClusters = yield* AWS.DocDB.DescribeDBClusters();
const page = yield* describeDBClusters({
DBClusterIdentifier: clusterId,
});
const status = page.DBClusters?.[0]?.Status;