Skip to content

Redshift Snapshot Data Model Documentation

Table of Contents

Top

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

Snapshot

Field Type Label Description
accounts_with_restore_access Snapshot.AccountWithRestoreAccess repeated A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
actual_incremental_backup_size_in_megabytes double The size of the incremental backup.
availability_zone string The Availability Zone in which the cluster was created.
backup_progress_in_megabytes double The number of megabytes that have been transferred to the snapshot backup.
cluster_create_time google.protobuf.Timestamp The time (UTC) when the cluster was originally created.
cluster_identifier string The identifier of the cluster for which the snapshot was taken.
cluster_version string The version ID of the Amazon Redshift engine that is running on the cluster.
current_backup_rate_in_megabytes_per_second double The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
db_name string The name of the database that was created when the cluster was created.
elapsed_time_in_seconds int64 The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
encrypted bool If true, the data in the snapshot is encrypted at rest.
encrypted_with_hsm bool A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. True indicates that the data is encrypted using HSM keys.
enhanced_vpc_routing bool An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
estimated_seconds_to_completion int64 The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
kms_key_id string The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
maintenance_track_name string The name of the maintenance track for the snapshot.
manual_snapshot_remaining_days int32 The number of days until a manual snapshot will pass its retention period.
manual_snapshot_retention_period int32 The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653.
master_username string The master user name for the cluster.
node_type string The node type of the nodes in the cluster.
number_of_nodes int32 The number of nodes in the cluster.
owner_account string For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
port int32 The port that the cluster is listening on.
restorable_node_types string repeated The list of node types that this cluster snapshot is able to restore into.
snapshot_create_time google.protobuf.Timestamp The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
snapshot_identifier string The snapshot identifier that is provided in the request.
snapshot_retention_start_time google.protobuf.Timestamp A timestamp representing the start of the retention period for the snapshot.
snapshot_type string The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
source_region string The source region from which the snapshot was copied.
snapshot_status string The snapshot status. The value of the status depends on the API operation used: CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating". DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed". DeleteClusterSnapshot returns status as "deleted".
tags Tag repeated The list of tags for the cluster snapshot.
total_backup_size_in_megabytes double The size of the complete set of backup data that would be used to restore the cluster.
vpc_id string The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Snapshot.AccountWithRestoreAccess

Field Type Label Description
account_alias string
account_id string

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)