Stop Instance
rds.stop_db_instance
ActionAmazon Web Servicesconnection required
Calls the AWS rds API (SigV4).
Stop a running RDS instance.
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
2 fields, 1 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 Instance identifier. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok | boolean | — |
db_instance_identifier | string | — |
db_instance_arn Full ARN — what AddTagsToResource, IAM conditions and CloudWatch alarms take. | string | — |
db_cluster_identifier The cluster this instance belongs to; null for a standalone instance. An Aurora member is started and stopped through its cluster, not on its own. | string | — |
status | string | — |
engine | string | — |
engine_version | string | — |
instance_class | string | — |
endpoint Endpoint address. | string | — |
port Endpoint port, as a real number. | number | — |
{
"db_cluster_identifier": "",
"db_instance_arn": "",
"db_instance_identifier": "",
"endpoint": "",
"engine": "",
"engine_version": "",
"instance_class": "",
"ok": false,
"port": 0,
"status": ""
}Related Amazon RDS nodes
See Stop Instance 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.