Skip to content

DynamoDB Backups Data Model Documentation

Table of Contents

Top

protos/clouddb/wire/aws/dynamodb/backup.proto

DynamoDbBackup

Information about this table backup https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BackupSummary.html

Field Type Label Description
backup_arn string ARN associated with the backup. AWS API field: BackupArn
backup_creation_date_time google.protobuf.Timestamp Time at which the backup was created. AWS API field: BackupCreationDateTime
backup_expiry_date_time google.protobuf.Timestamp Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation. AWS API field: BackupExpiryDateTime
backup_name string Name of the specified backup. AWS API field: BackupName
backup_size_bytes int64 Size of the backup in bytes. AWS API field: BackupSizeBytes
backup_status DynamoDbBackup.DynamoDbBackupStatus Backup can be in one of the following states: CREATING, ACTIVE, DELETED. AWS API field: BackupStatus
backup_type DynamoDbBackup.DynamoDbBackupType BackupType: USER - You create and manage these using the on-demand backup feature. SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion. AWS_BACKUP - On-demand backup created by you from AWS Backup service. AWS API field: BackupType
table_arn string ARN associated with the table. AWS API field: TableArn
table_id string Unique identifier for the table. AWS API field: TableId
table_name string Name of the table. AWS API field: TableName

DynamoDbBackup.DynamoDbBackupStatus

Name Number Description
UNKNOWN_BACKUP_STATUS 0
CREATING 1
DELETED 2
AVAILABLE 3

DynamoDbBackup.DynamoDbBackupType

Name Number Description
UNKNOWN_BACKUP_TYPE 0
USER 1
SYSTEM 2
AWS_BACKUP 3

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)