Skip to content

RDS Snapshot Data Model Documentation

Table of Contents

Top

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

RdsClusterSnapshot

Message corresponding to an RdsClusterSnapshot https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBClusterSnapshot.html

Field Type Label Description
allocated_storage int32 Allocated storage in GBs AWS API field: AllocatedStorage
availability_zones string repeated List of availability zones AWS API field: AvailabilityZones.
cluster_create_time google.protobuf.Timestamp Time when the cluster was created (UTC) AWS API field: ClusterCreateTime
db_cluster_identifier string Identifier of the DB Cluster AWS API Field: DBClusterIdentifier
db_cluster_snapshot_arn string ARN of this snapshot AWS API Field: DBClusterSnapshotArn
db_cluster_snapshot_identifier string Identifier of this snapshot AWS API Field: DBClusterSnapshotIdentifier
engine string Engine of the Database. AWS API Field: Engine
engine_version string Version of the engine used. AWS API Field: EngineVersion
iam_database_authentication_enabled bool Whether or not IAM DB Auth is enabled AWS API Field: IAMDatabaseAuthenticationEnabled
kms_key_id string The KMS Key Id used to encrypt this snapshot. AWS API Field: KmsKeyId
license_model string The License model of the database. AWS API Field: LicenseModel
master_username string The master username of this DB instance. AWS API Field: MasterUsername
percent_progress int32 The percentage of the estimated data that has been transferred. AWS API Field: PercentProgress
port int32 The port this database listens on. AWS API Field: Port
snapshot_create_time google.protobuf.Timestamp Date/time this snapshot was created. AWS API Field: SnapshotCreateTime
snapshot_type string The type of snapshot AWS API Field: SnapshotType
source_db_cluster_snapshot_arn string The DB Cluster from which this snapshot was created. AWS API Field: SourceDBClusterSnapshotArn
status string The status of this snapshot. AWS API Field: Status
storage_encrypted bool Whether or not storage is encrypted. AWS API Field: StorageEncrypted;
vpc_id string The ID of the VPC associated with the snapshot. AWS API Field: VpcId
snapshot_attributes RdsSnapshotAttribute repeated List of snapshot attributes. Result of describe-db-cluster-snapshot-attributes

RdsSnapshot

Information about this database instance snapshots https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-snapshots.html

Field Type Label Description
db_snapshot_identifier string Identifier for the DB snapshot. AWS API field: DBSnapshotIdentifier
db_instance_identifier string Identifier of the DB instance this DB snapshot was created from.. AWS API field: DBInstanceIdentifier
dbi_resource_id string Identifier for the source DB instance, which can’t be changed and which is unique to an AWS Region AWS API field: DbiResourceId
snapshot_create_time google.protobuf.Timestamp Time when the snapshot was taken. AWS API field: SnapshotCreateTime
status string Status of this DB snapshot. AWS API field: Status
snapshot_type string The type of the DB snapshot. AWS API field: SnapshotType
source_region string The AWS Region that the DB snapshot was created in or copied from. AWS API field: SourceRegion
source_db_snapshot_identifier string The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy. AWS API field: SourceDBSnapshotIdentifier
db_snapshot_arn string The Amazon Resource Name (ARN) for the DB snapshot. AWS API field: DBSnapshotArn
engine string Name of the database engine. AWS API field: Engine
engine_version string Version of the database engine. AWS API field: EngineVersion
port int32 Port that the database engine was listening on at the time of the snapshot. AWS API field: Port
availability_zone string Name of the Availability Zone the DB instance was located in at the time of the DB snapshot. AWS API field: AvailabilityZone
vpc_id string VPC ID associated with the DB snapshot. AWS API field: VpcId
instance_create_time google.protobuf.Timestamp Date and time the DB instance associated with this snapshot was created. AWS API field: InstanceCreateTime
master_username string Master username for the DB snapshot. AWS API field: MasterUsername
iam_database_authentication_enabled bool Whether mapping of IAM accounts to database accounts is enabled. AWS API field: IAMDatabaseAuthenticationEnabled
license_model string License model information for the restored DB instance. AWS API field: LicenseModel
option_group_name string Option group name for the DB snapshot. AWS API field: OptionGroupName
tde_credential_arn string ARN from the key store with which the instance is associated for TDE encryption. AWS API field: TdeCredentialArn
percent_progress int32 The percentage of the estimated data that has been transferred. AWS API field: PercentProgress
processor_features RdsProcessorFeature repeated Number of CPU cores and threads per core for the DB instance class. AWS API field: ProcessorFeatures
snapshot_attributes RdsSnapshotAttribute repeated Attributes for this snapshot when type is manual
timezone string Timezone of this snapshot.
allocated_storage int32 Allocated storage in GBs. AWS API field: AllocatedStorage.
encrypted bool True if this snapshot is encrypted. AWS API field: Encrypted.
iops int32 IOPS value of the DBInstance at the time of the snapshot. AWS SDK field: Iops.
kms_key_id string KMS Key ID, if encrypted.
storage_type string Storage type of the snapshot.

RdsSnapshotAttribute

Information about attribute names and values for a manual DB snapshot. https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-snapshot-attributes.html

Field Type Label Description
name string The name of the manual DB snapshot attribute. AWS API field: AttributeName
value string repeated The value or values for the manual DB snapshot attribute. AWS API field: AttributeValues

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)