Skip to content

RDS Cluster Data Model Documentation

Table of Contents

Top

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

ClusterMember

Cluster member info

Field Type Label Description
db_instance_identifier string Contains information about an instance that is part of a DB cluster. AWS API field: DBInstanceIdentifier
is_cluster_writer bool Whether the cluster member is the primary instance for the DB cluster. AWS API field: IsClusterWriter
db_cluster_parameter_group_status string Status of the DB cluster parameter group for this member of the DB cluster. AWS API field: DBClusterParameterGroupStatus
promotion_tier int32 Order in which this Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. AWS API field: PromotionTier

DbOptionGroupMembership

https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBClusterOptionGroupStatus.html

Field Type Label Description
db_cluster_option_group_name string Name of the option group that the instance belongs to.
status string Status of the membership

DomainMembership

Active Directory Domain membership record associated with the RDS instance/cluster.

Field Type Label Description
domain string Identifier of the Active Directory Domain. AWS API field: DomainMemberships -> Domain
status string Status of the Active Directory Domain membership. AWS API field: DomainMemberships -> Status
fqdn string Fully qualified domain name of the Active Directory Domain. AWS API field: DomainMemberships -> FQDN
iam_role_name string Name of the IAM role to be used when making API calls to the Directory Service. AWS API field: DomainMemberships -> IAMRoleName

IamRole

Describes an IAM role that is associated with a RDS instance/cluster.

Field Type Label Description
role_arn string ARN of the IAM role that is associated with the DB instance/cluster. AWS API field: AssociatedRoles -> RoleArn
feature_name string Feature associated with the IAM role. AWS API field: AssociatedRoles -> FeatureName
status string State of association between the IAM role and the DB instance/cluster AWS API field: AssociatedRoles -> Status

RdsClusterScalingConfiguration

Scaling configuration for an Aurora DB cluster in serverless DB engine mode.

Field Type Label Description
min_capacity int32 Minimum capacity for the Aurora DB cluster. AWS API field: MinCapacity
max_capacity int32 Maximum capacity for the Aurora DB cluster. AWS API field: MinCapacity
auto_pause bool Whether automatic pause is allowed for the Aurora DB cluster. AWS API field: AutoPause
seconds_until_auto_pause int32 Remaining amount of time, in seconds, before the Aurora DB cluster is paused AWS API field: SecondsUntilAutoPause
timeout_action string The timeout action of a call to ModifyCurrentDBClusterCapacity AWS API field: TimeoutAction

RdsClusterSettings

AWS configuration for a RDS cluster.

Fields extracted from: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-clusters.html

Field Type Label Description
db_cluster_identifier string User-supplied DB cluster identifier. Unique key that identifies a DB cluster. AWS API field: DBClusterIdentifier
db_cluster_arn string ARN for the DB cluster. AWS API field: DBClusterArn
engine string Name of the database engine to be used for this DB cluster AWS API field: Engine
engine_version string Database engine version. AWS API field: EngineVersion
engine_mode string DB engine mode of the DB cluster AWS API field: EngineMode
status string Current state of this cluster. AWS API field: Status
db_cluster_resource_id string The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed. AWS API field: DbClusterResourceId
master_username string Master username for the DB cluster. AWS API field: MasterUsername
database_name string Name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster. AWS API field: DatabaseName
cluster_create_time google.protobuf.Timestamp Date and time the DB cluster was created. AWS API field: ClusterCreateTime
multi_az bool Whether the DB cluster has instances in multiple Availability Zones. AWS API field: MultiAZ
availability_zones string repeated List of Availability Zones (AZs) where instances in the DB cluster can be created. AWS API field: AvailabilityZones
deletion_protection bool Whether the DB cluster has deletion protection enabled. AWS API field: DeletionProtection
character_set_name string Name of the character set that this cluster is associated with. AWS API field: CharacterSetName
percent_progress string Progress of the operation as a percentage. AWS API field: PercentProgress
iam_database_authentication_enabled bool Whether mapping of IAM accounts to database accounts is enabled. AWS API field: IAMDatabaseAuthenticationEnabled
cross_account_clone bool Whether the DB cluster is a clone of a DB cluster owned by a different AWS account AWS API field: CrossAccountClone
clone_group_id string Identifies the clone group to which the DB cluster is associated. AWS API field: CloneGroupId
enabled_cloudwatch_logs_exports string repeated List of log types that this DB cluster is configured to export to CloudWatch. AWS API field: EnabledCloudwatchLogsExports
preferred_maintenance_window string Specifies the weekly time range during which system maintenance can occur in Universal Coordinated Time (UTC). AWS API field: PreferredMaintenanceWindow
replication_source_identifier string Identifier of the source DB cluster if this DB cluster is a read replica. AWS API field: ReplicationSourceIdentifier
read_replica_identifiers string repeated One or more identifiers of the Read Replicas associated with this DB cluster. AWS API field: ReadReplicaIdentifiers
db_cluster_parameter_group string Name of the DB cluster parameter group for the DB cluster. AWS API field: DBClusterParameterGroup
db_subnet_group string Information on the subnet group associated with the DB cluster. AWS API field: DBSubnetGroup
capacity int32 Current capacity of an Aurora serverless DB cluster. AWS API field: Capacity
scaling_configuration_info RdsClusterScalingConfiguration Scaling configuration for an Aurora DB cluster in serverless DB engine mode
db_cluster_members ClusterMember repeated List of instances that make up the DB cluster. AWS API field: DBClusterMembers
vpc_security_groups VpcSecurityGroup repeated List of VPC security group elements that the DB cluster belongs to. AWS API field: VpcSecurityGroups
db_cluster_option_group_memberships DbOptionGroupMembership repeated List of option group memberships for this DB cluster. AWS API field: DBClusterOptionGroupMemberships
domain_memberships DomainMembership repeated Active Directory Domain membership records associated with the DB cluster. AWS API field: DomainMemberships
associated_roles IamRole repeated IAM roles associated with the DB cluster. AWS API field: AssociatedRoles
activity_stream_mode string The mode of the database activity stream. Database events such as a change or access generate an activity stream event. AWS API field: ActivityStreamMode
activity_stream_status string Status of the database activity stream. AWS API field: ActivityStreamStatus
activity_stream_kms_key_id string AWS KMS key identifier used for encrypting messages in the database activity stream. AWS API field: ActivityStreamKmsKeyId
activity_stream_kinesis_stream_name string Name of the Amazon Kinesis data stream used for the database activity stream. AWS API field: ActivityStreamKinesisStreamName
earliest_restorable_time google.protobuf.Timestamp Earliest time to which a cluster can be restored with point-in-time restore. AWS API field: EarliestRestorableTime
latest_restorable_time google.protobuf.Timestamp Earliest time to which a cluster can be restored with point-in-time restore. AWS API field: EarliestRestorableTime
reader_endpoint string Reader endpoint for the DB cluster. AWS API field: ReaderEndpoint
backtrack_window int64 The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. AWS API field: BacktrackWindow
earliest_backtrack_time google.protobuf.Timestamp Reader endpoint for the DB cluster. AWS API field: EarliestBacktrackTime
backtrack_consumed_change_records int64 Number of change records stored for Backtrack. AWS API field: BacktrackConsumedChangeRecords
allocated_storage int32 Allocated storage for the cluster, returns 1 when this cluster is an aurora cluster AWS API field: AllocatedStorage
storage_encrypted bool Whether the DB cluster is encrypted. AWS API field: StorageEncrypted
kms_key_id string AWS KMS key identifier for the encrypted DB cluster, if applies. AWS API field: KmsKeyId
custom_endpoints string repeated All custom endpoints associated with the cluster. AWS API field: CustomEndpoints
http_endpoint_enabled bool Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled AWS API field: HttpEndpointEnabled
preferred_backup_window string Daily time range during which automated backups are created if enabled AWS API field: PreferredBackupWindow
backup_retention_period int32 Number of days for which automatic DB snapshots are retained. AWS API field: BackupRetentionPeriod
copy_tags_to_snapshot bool Whether tags are copied from the DB instance to snapshots of the DB instance. AWS API field: CopyTagsToSnapshot
port int32 Port that the database engine is listening on. AWS API field: Port
hosted_zone_id string ID that Amazon Route 53 assigns when you create a hosted zone. AWS API field: HostedZoneId
endpoint string AWS API field: Endpoint

VpcSecurityGroup

VPC security group info for RDS instance/cluster.

Field Type Label Description
vpc_security_group_id string Name of the VPC security group. AWS API field: VpcSecurityGroups -> VpcSecurityGroupId
status string Status of the VPC security group. AWS API field: VpcSecurityGroups -> Status

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)