Describe Instances
rds.describe_db_instances
ActionAmazon Web Servicesconnection required
Calls the AWS rds API (SigV4).
List RDS instances and their endpoints.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon RDS
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
db_instance_identifier One instance (optional). | string | No | — | — | — |
max_records Max instances (20-100). | number | No | — | ≥ 1 | — |
next_token Continues a previous run of this node, using that run's next_token output. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
instances One entry per instance: db_instance_identifier, db_instance_arn (what a tagging or alarm step acts on), db_cluster_identifier, status, engine, engine_version, instance_class, endpoint and port. | array | — |
count | number | — |
next_token Cursor for the next page; empty when there are no further pages. | string | — |
{
"count": 0,
"instances": [],
"next_token": ""
}Related Amazon RDS nodes
See Describe Instances run in a workflow.
In a technical demo we add the Amazon RDS connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.