Skip to content

RDS Instance Data Model Documentation

Table of Contents

Top

protos/clouddb/wire/aws/rds/instance.proto

RdsDatabaseInstanceSettings

AWS mutable configuration for a RDS database instance.

Fields extracted from: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBInstance.html

Field Type Label Description
db_instance_id string User-supplied database identifier. AWS API field: DBInstanceIdentifier
arn string ARN for the DB instance. AWS API field: DBInstanceArn
engine string Database Engine used. exp mysql, postgres AWS API field: Engine
engine_version string Database engine version. AWS API field: EngineVersion
db_instance_class string Name of the compute and memory capacity class of the DB instance. AWS API field: DBInstanceClass
status string Current state of this database. AWS API field: DBInstanceStatus
resource_id string The AWS Region-unique, immutable identifier for the DB instance. AWS API field: DbiResourceId
master_username string Master username for the DB instance. AWS API field: MasterUsername
db_name string The meaning of this parameter differs according to the database engine you use. - For MySQL, MariaDB, SQL Server, PostgreSQL: name of the initial database of this instance that was provided at create time - For Oracle: Oracle System ID (SID) AWS API field: DBName
created_at google.protobuf.Timestamp Date and time the DB instance was created. AWS API field: InstanceCreateTime
availability_zone string Name of the Availability Zone the DB instance is located in. AWS API field: AvailabilityZone
endpoint RdsEndpoint Connection endpoint. AWS API field: Endpoint
listener_endpoint RdsEndpoint Listener connection endpoint for SQL Server Always On. AWS API field: ListenerEndpoint
db_cluster_id string Name of the DB cluster that the DB instance is a member of, if any. AWS API field: DBClusterIdentifier
public bool True: Internet-facing instance with a publicly resolvable DNS name (resolving to a public IP). False: internal instance with a DNS name (resolving to a private IP). AWS API field: PubliclyAccessible
deletion_protection bool Whether the DB instance has deletion protection enabled. AWS API field: DeletionProtection
charset string Name of the character set that this instance is associated with. AWS API field: CharacterSetName
timezone string The time zone of the DB instance. AWS API field: Timezone
provisioned_iops ProvisionedIops
license string License model information for this DB instance. AWS API field: LicenseModel
tde_credential_arn string ARN from the key store with which the instance is associated for TDE encryption. AWS API field: TdeCredentialArn
ca_cert_id string CA certificate identifier for this DB instance. AWS API field: CACertificateIdentifier
iam_db_auth bool Whether mapping of IAM accounts to database accounts is enabled. AWS API field: IAMDatabaseAuthenticationEnabled
cloudwatch_logs string repeated List of log types that this DB instance is configured to export to CloudWatch. AWS API field: EnabledCloudwatchLogsExports
multi_az RdsMultiAvailabilityZone Multiple Availability Zone information for a RDS instance
storage RdsStorage Storage info for this DB instance.
backup RdsBackup Backup info for this DB instance
maintenance RdsMaintenance Maintenance info for this DB instance
monitoring RdsMonitoring Monitoring info for this DB instance
read_replica RdsReadReplica Read replica info about thid DB instance.
performance_insights RdsPerformanceInsights Performance Insights info for this DB instance.
db_security_groups RdsDatabaseSecurityGroup repeated List of DB security group elements. AWS API field: DBSecurityGroups
vpc_security_groups RdsVpcSecurityGroup repeated List of VPC security group elements that the DB instance belongs to. AWS API field: VpcSecurityGroups
db_parameter_groups RdsDatabaseParameterGroup repeated List of DB parameter groups applied to this DB instance. AWS API field: DBParameterGroups
db_subnet_group RdsDatabaseSubnetGroup Subnet group associated with the DB instance. AWS API field: DBSubnetGroup
option_group_memberships RdsOptionGroupMembership repeated List of option group memberships for this DB instance. AWS API field: OptionGroupMemberships
domain_memberships RdsDomainMembership repeated Active Directory Domain membership records associated with the DB instance. AWS API field: DomainMemberships
processor_features RdsProcessorFeature repeated Number of CPU cores and threads per core for the DB instance class. AWS API field: ProcessorFeatures
roles RdsIamRole repeated IAM roles associated with the DB instance. AWS API field: AssociatedRoles

RdsDatabaseParameterGroup

Status of the DB parameter group of a RDS instance

Field Type Label Description
name string Name of the DB parameter group. AWS API field: DBParameterGroups -> DBParameterGroupName
status string Status of parameter updates. AWS API field: DBParameterGroups -> ParameterApplyStatus

RdsDatabaseSecurityGroup

Database Security Group info for RDS instance

Field Type Label Description
name string Name of the DB security group. AWS API field: DBSecurityGroups -> Name
status string Status of the DB security group. AWS API field: DBSecurityGroups -> Status

RdsDatabaseSubnetGroup

Information on the subnet group associated with a RDS instance

Field Type Label Description
name string Name of the DB subnet group AWS API field: DBSubnetGroup -> DBSubnetGroupName
description string Description of the DB subnet group. AWS API field: DBSubnetGroup -> DBSubnetGroupDescription
vpc string VpcId of the DB subnet group AWS API field: DBSubnetGroup -> VpcId
status string Status of the DB subnet group. AWS API field: DBSubnetGroup -> SubnetGroupStatus
subnets RdsSubnet repeated List of Subnet elements. AWS API field: DBSubnetGroup -> Subnets
arn string ARN for the DB subnet group. AWS API field: DBSubnetGroup -> DBSubnetGroupArn

RdsMaintenance

Maintenance information of a RDS instance

Field Type Label Description
window string Specifies the weekly time range during which system maintenance can occur in Universal Coordinated Time (UTC). AWS API field: PreferredMaintenanceWindow
auto_minor_version_upgrade bool Indicates whether minor version patches are applied automatically. AWS API field: AutoMinorVersionUpgrade

RdsMonitoring

Monitoring information of a RDS instance

Field Type Label Description
interval int32 Interval, in seconds, between points when Enhanced Monitoring metrics are collected. AWS API field: MonitoringInterval
arn string ARN of the CloudWatch log stream that receives the Enhanced Monitoring metrics data AWS API field: EnhancedMonitoringResourceArn
role_arn string ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch. AWS API field: MonitoringRoleArn

RdsMultiAvailabilityZone

Multiple Availability Zone information for a RDS instance

Field Type Label Description
multi bool Specifies if the DB instance is a Multi-AZ deployment. AWS API field: MultiAZ
secondary string Name of the secondary Availability Zone for a DB instance with multi-AZ enabled. AWS API field: SecondaryAvailabilityZone

RdsPerformanceInsights

Performance Insights info for a RDS instance.

Field Type Label Description
enabled bool Whether Performance Insights is enabled AWS API field: PerformanceInsightsEnabled
pkms_key string KMS key identifier for encryption of Performance Insights data AWS API field: PerformanceInsightsKMSKeyId
retention int32 Amount of time, in days, to retain Performance Insights data. AWS API field: PerformanceInsightsRetentionPeriod

RdsReadReplica

Read replica information about a RDS instance

Field Type Label Description
source_db_instance_id string Identifier of the source DB instance if this DB instance is a Read Replica. AWS API field: ReadReplicaSourceDBInstanceIdentifier
db_instance_ids string repeated One or more identifiers of the Read Replicas associated with this DB instance. AWS API field: ReadReplicaDBInstanceIdentifiers
db_cluster_ids string repeated One or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. AWS API field: ReadReplicaDBClusterIdentifiers
promotion_tier int32 The order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. AWS API field: PromotionTier
read_replica_statuses RdsReadReplicaStatus repeated List of read replica status information for a DB instance. AWS API field: StatusInfos

RdsReadReplicaStatus

Status of a Read Replica.

Field Type Label Description
normal bool Indicates whether the instance is operating normally or is in an error state. AWS API field: StatusInfos -> Normal
status string Status of the DB instance. AWS API field: StatusInfos -> Status
message string Details of the error if there is an error for the instance. AWS API field: StatusInfos -> Message

RdsSubnet

Subnet info for a RDS subnet group

Field Type Label Description
subnet_id string Identifier of the subnet. AWS API field: DBSubnetGroup -> Subnet -> SubnetIdentifier
availability_zone string Name of the Availability Zone. AWS API field: DBSubnetGroup -> Subnet -> SubnetAvailabilityZone -> Name
status string Status of the subnet. AWS API field: DBSubnetGroup -> Subnet -> SubnetStatus

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)