Amazon RDS · Schema

Amazon RDS DB Instance

Represents an Amazon RDS database instance with its associated configuration, state, endpoint, and metadata.

AWSCloud DatabasesDatabase ServiceDBaaSManaged DatabasesRelational Databases

Properties

Name Type Description
dBInstanceIdentifier string The user-supplied unique key that identifies the DB instance
dBInstanceClass string The name of the compute and memory capacity class of the DB instance (e.g., db.m5.large, db.r5.xlarge)
engine string The database engine for this DB instance
engineVersion string The version number of the database engine
dBInstanceStatus string The current state of the DB instance
masterUsername string The master username for the DB instance
dBName string The name of the initial database created when the DB instance was created
endpoint object
allocatedStorage integer The allocated storage size in gibibytes (GiB)
instanceCreateTime string The date and time the DB instance was created
preferredBackupWindow string The daily time range during which automated backups are created
backupRetentionPeriod integer The number of days for which automatic DB snapshots are retained
vpcSecurityGroups array The VPC security groups associated with the DB instance
availabilityZone string The Availability Zone where the DB instance is located
dBSubnetGroup object
multiAZ boolean Whether the DB instance is a Multi-AZ deployment
autoMinorVersionUpgrade boolean Whether minor version patches are applied automatically
storageType string The storage type associated with the DB instance
storageEncrypted boolean Whether the DB instance is encrypted
publiclyAccessible boolean Whether the DB instance is publicly accessible
cACertificateIdentifier string The identifier of the CA certificate for this DB instance
dBInstanceArn string The Amazon Resource Name (ARN) for the DB instance
tags array Tags assigned to the DB instance
port integer The port that the DB instance listens on
dBClusterIdentifier string If the DB instance is a member of a DB cluster, the cluster identifier
licenseModel string The license model information for this DB instance
View JSON Schema on GitHub