apps/docs/content/docs/en/tools/rds.mdx
import { BlockInfoCard } from "@/components/ui/block-info-card"
<BlockInfoCard type="rds" color="linear-gradient(45deg, #2E27AD 0%, #527FFF 100%)" /> Amazon RDS Aurora Serverless is a fully managed relational database that automatically starts up, shuts down, and scales capacity based on your application's needs. It allows you to run SQL databases in the cloud without managing database servers.
With RDS Aurora Serverless, you can:
In Sim, the RDS integration enables your agents to work with Amazon Aurora Serverless databases securely and programmatically. Supported operations include:
This integration allows your agents to automate a wide range of database operations without manual intervention. By connecting Sim with Amazon RDS, you can build agents that manage, update, and retrieve relational data within your workflows—all without handling database infrastructure or connections.
Integrate Amazon RDS Aurora Serverless into the workflow using the Data API. Can query, insert, update, delete, and execute raw SQL without managing database connections.
rds_queryExecute a SELECT query on Amazon RDS using the Data API
| Parameter | Type | Required | Description |
|---|---|---|---|
region | string | Yes | AWS region (e.g., us-east-1) |
accessKeyId | string | Yes | AWS access key ID |
secretAccessKey | string | Yes | AWS secret access key |
resourceArn | string | Yes | ARN of the Aurora DB cluster (e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster) |
secretArn | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
database | string | No | Database name to connect to (e.g., mydb, production_db) |
query | string | Yes | SQL SELECT query to execute (e.g., SELECT * FROM users WHERE status = :status) |
| Parameter | Type | Description |
|---|---|---|
message | string | Operation status message |
rows | array | Array of rows returned from the query |
rowCount | number | Number of rows returned |
rds_insertInsert data into an Amazon RDS table using the Data API
| Parameter | Type | Required | Description |
|---|---|---|---|
region | string | Yes | AWS region (e.g., us-east-1) |
accessKeyId | string | Yes | AWS access key ID |
secretAccessKey | string | Yes | AWS secret access key |
resourceArn | string | Yes | ARN of the Aurora DB cluster (e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster) |
secretArn | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
database | string | No | Database name to connect to (e.g., mydb, production_db) |
table | string | Yes | Table name to insert into |
data | object | Yes | Data to insert as key-value pairs |
| Parameter | Type | Description |
|---|---|---|
message | string | Operation status message |
rows | array | Array of inserted rows |
rowCount | number | Number of rows inserted |
rds_updateUpdate data in an Amazon RDS table using the Data API
| Parameter | Type | Required | Description |
|---|---|---|---|
region | string | Yes | AWS region (e.g., us-east-1) |
accessKeyId | string | Yes | AWS access key ID |
secretAccessKey | string | Yes | AWS secret access key |
resourceArn | string | Yes | ARN of the Aurora DB cluster (e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster) |
secretArn | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
database | string | No | Database name to connect to (e.g., mydb, production_db) |
table | string | Yes | Table name to update |
data | object | Yes | Data to update as key-value pairs |
conditions | object | Yes | Conditions for the update (e.g., {"id": 1}) |
| Parameter | Type | Description |
|---|---|---|
message | string | Operation status message |
rows | array | Array of updated rows |
rowCount | number | Number of rows updated |
rds_deleteDelete data from an Amazon RDS table using the Data API
| Parameter | Type | Required | Description |
|---|---|---|---|
region | string | Yes | AWS region (e.g., us-east-1) |
accessKeyId | string | Yes | AWS access key ID |
secretAccessKey | string | Yes | AWS secret access key |
resourceArn | string | Yes | ARN of the Aurora DB cluster (e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster) |
secretArn | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
database | string | No | Database name to connect to (e.g., mydb, production_db) |
table | string | Yes | Table name to delete from |
conditions | object | Yes | Conditions for the delete (e.g., {"id": 1}) |
| Parameter | Type | Description |
|---|---|---|
message | string | Operation status message |
rows | array | Array of deleted rows |
rowCount | number | Number of rows deleted |
rds_executeExecute raw SQL on Amazon RDS using the Data API
| Parameter | Type | Required | Description |
|---|---|---|---|
region | string | Yes | AWS region (e.g., us-east-1) |
accessKeyId | string | Yes | AWS access key ID |
secretAccessKey | string | Yes | AWS secret access key |
resourceArn | string | Yes | ARN of the Aurora DB cluster (e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster) |
secretArn | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
database | string | No | Database name to connect to (e.g., mydb, production_db) |
query | string | Yes | Raw SQL query to execute (e.g., CREATE TABLE users (id SERIAL PRIMARY KEY, name VARCHAR(255))) |
| Parameter | Type | Description |
|---|---|---|
message | string | Operation status message |
rows | array | Array of rows returned or affected |
rowCount | number | Number of rows affected |
rds_introspectIntrospect Amazon RDS Aurora database schema to retrieve table structures, columns, and relationships
| Parameter | Type | Required | Description |
|---|---|---|---|
region | string | Yes | AWS region (e.g., us-east-1) |
accessKeyId | string | Yes | AWS access key ID |
secretAccessKey | string | Yes | AWS secret access key |
resourceArn | string | Yes | ARN of the Aurora DB cluster (e.g., arn:aws:rds:us-east-1:123456789012:cluster:my-cluster) |
secretArn | string | Yes | ARN of the Secrets Manager secret containing DB credentials |
database | string | No | Database name to connect to (e.g., mydb, production_db) |
schema | string | No | Schema to introspect (default: public for PostgreSQL, database name for MySQL) |
engine | string | No | Database engine (aurora-postgresql or aurora-mysql). Auto-detected if not provided. |
| Parameter | Type | Description |
|---|---|---|
message | string | Operation status message |
engine | string | Detected database engine type |
tables | array | Array of table schemas with columns, keys, and indexes |
schemas | array | List of available schemas in the database |