{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-rds/refs/heads/main/json-schema/amazon-rds-openapi-db-instance-schema.json", "title": "DBInstance", "description": "Describes an Amazon RDS DB instance", "type": "object", "properties": { "dBInstanceIdentifier": { "type": "string", "description": "The user-supplied unique key that identifies the DB instance" }, "dBInstanceClass": { "type": "string", "description": "The name of the compute and memory capacity class of the DB instance" }, "engine": { "type": "string", "description": "The database engine for this DB instance" }, "engineVersion": { "type": "string", "description": "The version of the database engine" }, "dBInstanceStatus": { "type": "string", "description": "The current state of the DB instance", "enum": [ "available", "backing-up", "configuring-enhanced-monitoring", "configuring-iam-database-auth", "configuring-log-exports", "creating", "delete-precheck", "deleting", "failed", "inaccessible-encryption-credentials", "incompatible-network", "incompatible-option-group", "incompatible-parameters", "incompatible-restore", "maintenance", "modifying", "moving-to-vpc", "rebooting", "renaming", "resetting-master-credentials", "restore-error", "starting", "stopped", "stopping", "storage-full", "storage-optimization", "upgrading" ] }, "masterUsername": { "type": "string", "description": "The master username for the DB instance" }, "dBName": { "type": "string", "description": "The name of the initial database provided during creation" }, "endpoint": { "type": "object", "description": "The connection endpoint for the DB instance", "properties": { "address": { "type": "string", "description": "The DNS address of the DB instance" }, "port": { "type": "integer", "description": "The port that the DB instance listens on" }, "hostedZoneId": { "type": "string", "description": "The ID of the hosted zone for the DB instance" } } }, "allocatedStorage": { "type": "integer", "description": "The allocated storage size in gibibytes (GiB)" }, "instanceCreateTime": { "type": "string", "format": "date-time", "description": "The date and time the DB instance was created" }, "preferredBackupWindow": { "type": "string", "description": "The daily time range during which automated backups are created" }, "backupRetentionPeriod": { "type": "integer", "description": "The number of days for which automatic DB snapshots are retained" }, "vpcSecurityGroups": { "type": "array", "description": "The VPC security groups associated with the DB instance", "items": { "type": "object", "properties": { "vpcSecurityGroupId": { "type": "string", "description": "The ID of the VPC security group" }, "status": { "type": "string", "description": "The membership status of the VPC security group" } } } }, "availabilityZone": { "type": "string", "description": "The Availability Zone where the DB instance is located" }, "dBSubnetGroup": { "type": "object", "description": "Information about the subnet group associated with the DB instance", "properties": { "dBSubnetGroupName": { "type": "string", "description": "The name of the DB subnet group" }, "dBSubnetGroupDescription": { "type": "string", "description": "The description of the DB subnet group" }, "vpcId": { "type": "string", "description": "The VPC ID of the DB subnet group" } } }, "multiAZ": { "type": "boolean", "description": "Whether the DB instance is a Multi-AZ deployment" }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "Whether minor version patches are applied automatically" }, "storageType": { "type": "string", "description": "The storage type associated with the DB instance" }, "storageEncrypted": { "type": "boolean", "description": "Whether the DB instance is encrypted" }, "publiclyAccessible": { "type": "boolean", "description": "Whether the DB instance is publicly accessible" }, "dBInstanceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the DB instance" }, "tags": { "type": "array", "description": "Tags assigned to the DB instance", "items": { "$ref": "#/components/schemas/Tag" } } } }