Skip to content

ElastiCache Snapshot Data Model Documentation

Table of Contents

Top

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

ElastiCacheSnapshot

Represents a copy of an entire Redis cluster https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-snapshots.html

Field Type Label Description
snapshot_name string The name of a snapshot AWS API field: SnapshotName
replication_group_id string The unique identifier of the source replication group. AWS API field: ReplicationGroupId
replication_group_description string A description of the source replication group. AWS API field: ReplicationGroupDescription
cache_cluster_id string user-supplied identifier of the source cluster. AWS API Field: CacheClusterId
snapshot_status string status of the snapshot AWS API Field: SnapshotStatus
snapshot_source string whether the snapshot is from an automatic backup or was created manually AWS API Field: SnapshotSource
CacheNodeType string Name of the compute and memory capacity node type for the source cluster AWS API Field: CacheNodeType
engine string Engine of the Database. AWS API Field: Engine
engine_version string Version of the engine used. AWS API Field: EngineVersion
num_cache_nodes int32 number of cache nodes in the source cluster AWS API Field: NumCacheNodes
preferred_availability_zone string where the source cluster is located AWS API Field: PreferredAvailabilityZone
cache_cluster_create_time google.protobuf.Timestamp Date/time the source cluster was created. AWS API Field: CacheClusterCreateTime
preferred_maintenance_window string weekly time range during which maintenance on the cluster is performed AWS API Field: PreferredMaintenanceWindow
topic_arn string ARN for the topic used by the source cluster for publishing notifications AWS API Field: TopicArn
port int32 The port this database listens on. AWS API Field: Port
snapshot_type string The type of snapshot AWS API Field: SnapshotType
cache_parameter_group_name string parameter group that is associated with the source cluster AWS API Field: CacheParameterGroupName
cache_subnet_group_name string cache subnet group associated with the source cluster AWS API Field: CacheSubnetGroupName
vpc_id string The ID of the VPC associated with the snapshot. AWS API Field: VpcId
auto_minor_version_upgrade bool This parameter is currently disabled AWS API Field: AutoMinorVersionUpgrade
snapshot_retention_limit int32 number of days for which ElastiCache retains the snapshot AWS API Field: SnapshotRetentionLimit
snapshot_window string daily time range during which ElastiCache takes daily snapshots AWS API Field: SnapshotWindow
num_node_groups int32 number of node groups (shards) in this snapshot AWS API Field: NumNodeGroups
automatic_failover string Indicates the status of Multi-AZ with automatic failover for the source Redis replication group. AWS API Field: AutomaticFailover
node_snapshots NodeSnapshot repeated list of the cache nodes in the source cluster AWS API Field: NodeSnapshots
kms_key_id string The ID of the KMS key used to encrypt the snapshot. AWS API Field: KmsKeyId
arn string (Amazon Resource Name) of the snapshot. AWS API Field: ARN

NodeGroupConfiguration

Field Type Label Description
node_group_id string identifier for the source node group (shard) AWS API Field: NodeGroupId
slots string specifies the keyspace for a particular node group AWS API Field: Slots
replica_count int32 number of read replica nodes in this node group AWS API Field: ReplicaCount
primary_availability_zone string location of launch of primary node. AWS API Field: PrimaryAvailabilityZone
replica_availability_zones string repeated Availability Zones to be used for the read replicas AWS API Field: ReplicaAvailabilityZones

NodeSnapshot

Field Type Label Description
cache_cluster_id string unique identifier for the source cluster AWS API Field: CacheClusterId
node_group_id string A unique identifier for the source node group (shard). AWS API Field: NodeGroupId
cache_node_id string TThe cache node identifier for the node in the source cluster. AWS API Field: CacheNodeId
node_group_configuration NodeGroupConfiguration The configuration for the source node group (shard). AWS API Field: NodeGroupConfiguration
cache_size string size of the cache on the source cache node AWS API Field: CacheSize
cache_node_create_time google.protobuf.Timestamp date and time when the cache node was created in the source cluster AWS API Field: CacheNodeCreateTime
snapshot_create_time google.protobuf.Timestamp date and time when the source node's metadata and cache data set was obtained AWS API Field: SnapshotCreateTime

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)