IntegrationsAwsActions
Describe RDS DB instances
Describe supported RDS DB instances and filter out Aurora, Neptune, DocumentDB, and RDS Custom. Page size is 20-100. Requires rds:DescribeDBInstances.
rds.db_instances.describe · AWS · v1
Details
Scopes
rds:DescribeDBInstances
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
region | string | No | enum us-east-1 | us-east-2 | us-west-1 | us-west-2 | af-south-1 | ap-east-1 | ap-east-2 | ap-south-1 | ap-south-2 | ap-southeast-1 | ap-southeast-2 | ap-southeast-3 | ap-southeast-4 | ap-southeast-5 | ap-southeast-6 | ap-southeast-7 | ap-northeast-1 | ap-northeast-2 | ap-northeast-3 | ca-central-1 | ca-west-1 | eu-central-1 | eu-central-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-north-1 | eu-south-1 | eu-south-2 | il-central-1 | me-central-1 | me-south-1 | mx-central-1 | sa-east-1 |
db_instance_identifier | string | No | minLength 1; maxLength 63; pattern ^[A-Za-z][A-Za-z0-9-]*$ |
page_size | integer | No | minimum 20; maximum 100 |
cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
db_instances | array<object> | Yes | maxItems 100 |
db_instances[] | object | Yes | additionalProperties false |
db_instances[].identifier | string | Yes | minLength 1; maxLength 63; pattern ^[A-Za-z][A-Za-z0-9-]*$ |
db_instances[].arn | string | Yes | minLength 20; maxLength 2048; pattern ^arn:aws:.+$ |
db_instances[].status | string | Yes | minLength 1; maxLength 64 |
db_instances[].engine | string | Yes | minLength 1; maxLength 64 |
db_instances[].engine_version | string | No | minLength 1; maxLength 64 |
db_instances[].instance_class | string | No | minLength 1; maxLength 64 |
db_instances[].endpoint_address | string | No | minLength 1; maxLength 256 |
db_instances[].endpoint_port | integer | No | minimum 0; maximum 65535 |
db_instances[].availability_zone | string | No | minLength 1; maxLength 64 |
db_instances[].multi_az | boolean | Yes | — |
db_instances[].storage_encrypted | boolean | Yes | — |
db_instances[].publicly_accessible | boolean | Yes | — |
db_instances[].cluster_identifier | string | No | minLength 1; maxLength 63 |
db_instances[].automatic_restart_time | string | No | minLength 1; maxLength 64 |
db_instances[].created_at | string | No | minLength 1; maxLength 64 |
next_cursor | string | No | minLength 1; maxLength 16384; pattern ^(?!.*://)[^\x00-\x1f\x7f]+$ |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"region": {
"type": "string",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"af-south-1",
"ap-east-1",
"ap-east-2",
"ap-south-1",
"ap-south-2",
"ap-southeast-1",
"ap-southeast-2",
"ap-southeast-3",
"ap-southeast-4",
"ap-southeast-5",
"ap-southeast-6",
"ap-southeast-7",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ca-central-1",
"ca-west-1",
"eu-central-1",
"eu-central-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-north-1",
"eu-south-1",
"eu-south-2",
"il-central-1",
"me-central-1",
"me-south-1",
"mx-central-1",
"sa-east-1"
]
},
"db_instance_identifier": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z][A-Za-z0-9-]*$"
},
"page_size": {
"type": "integer",
"minimum": 20,
"maximum": 100
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
}
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"db_instances": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"identifier": {
"type": "string",
"minLength": 1,
"maxLength": 63,
"pattern": "^[A-Za-z][A-Za-z0-9-]*$"
},
"arn": {
"type": "string",
"minLength": 20,
"maxLength": 2048,
"pattern": "^arn:aws:.+$"
},
"status": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"engine": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"engine_version": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"instance_class": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"endpoint_address": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"endpoint_port": {
"type": "integer",
"minimum": 0,
"maximum": 65535
},
"availability_zone": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"multi_az": {
"type": "boolean"
},
"storage_encrypted": {
"type": "boolean"
},
"publicly_accessible": {
"type": "boolean"
},
"cluster_identifier": {
"type": "string",
"minLength": 1,
"maxLength": 63
},
"automatic_restart_time": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"created_at": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"identifier",
"arn",
"status",
"engine",
"multi_az",
"storage_encrypted",
"publicly_accessible"
]
},
"maxItems": 100
},
"next_cursor": {
"type": "string",
"minLength": 1,
"maxLength": 16384,
"pattern": "^(?!.*://)[^\\x00-\\x1f\\x7f]+$"
}
},
"required": [
"db_instances"
]
}