DescribeDBInstances

Source: src/AWS/DocDB/DescribeDBInstances.ts

Runtime binding for the DescribeDBInstances operation (IAM action rds:DescribeDBInstances — DocumentDB shares the RDS control plane).

Lists the account’s DocumentDB instances (optionally filtered by identifier or cluster) with status, endpoint, and class embedded — the building block of instance-health monitoring and reboot automation. Provide the implementation with Effect.provide(AWS.DocDB.DescribeDBInstancesHttp).

Monitoring Instances

const describeDBInstances = yield* DocDB.DescribeDBInstances();

const page = yield* describeDBInstances({
  Filters: [{ Name: "db-cluster-id", Values: [clusterId] }],
});
const available = page.DBInstances?.filter(
  (instance) => instance.DBInstanceStatus === "available",
);