Skip to content

ElastiCache Cluster Data Model Documentation

Table of Contents

Top

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

AwsElasticacheCluster

Wire model definition for AWS ElastiCache cache cluster

Object: CacheCluster Fields extracted from: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheCluster.html

Field Type Label Description
cache_cluster_id string User-supplied cluster identifier AWS API field: CacheClusterId
configuration_endpoint EcEndpoint Represents a MemCached cluster endpoint AWS API field: ConfigurationEndpoint
client_download_landing_page string URL where latest ElastiCache client library can be downloaded AWS API field: ClientDownloadLandingPage
cache_node_type string Name of the compute and memory capacity node type for the cluster AWS API field: CacheNodeType
engine AwsElasticacheCluster.EcEngine Name of cache engine AWS API field: Engine
engine_version string Version of cache engine used in cluster AWS API field: EngineVersion
cache_cluster_status AwsElasticacheCluster.EcClusterStatus Current state of cluster AWS API field: CacheClusterStatus
num_cache_nodes int32 Number of nodes in the cluster AWS API field: NumCacheNodes
preferred_availability_zone string Name of AZ in which the cluster is located or "Multiple" if nodes are located in different AZs AWS API field: PreferredAvailabilityZone
cache_cluster_create_time google.protobuf.Timestamp Date and time when cluster was created AWS API field: CacheClusterCreateTime
preferred_maintenance_window string Specifies the weekly time range during which maintenance on the cluster is performed Format: ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC) AWS API Field: PreferredMaintenanceWindow
pending_modified_values EcPendingModifiedValues Group of settings that are applied to cluster in future, or that are currently being applied AWS API field: PendingModifiedValues
notification_configuration EcNotificationConfiguration Notification topic and status AWS API field: NotificationConfiguration
cache_security_groups EcCacheSecurityGroupMembership repeated List of cache security group elements AWS API field: CacheSecurityGroups
cache_parameter_group EcCacheParameterGroupStatus Status of the parameter group AWS API field: CacheParameterGroup
cache_subnet_group_name string Name of subnet group associated with cluster AWS API field: CacheSubnetGroupName
cache_nodes EcCacheNode repeated List of nodes that are members of the cluster AWS API field: CacheNodes
auto_minor_version_upgrade bool Parameter currently disabled AWS API field: AutoMinorVersionUpgrade
security_groups EcSecurityGroupMembership repeated List of VPC security groups associated with cluster AWS API field: SecurityGroups
replication_group_id string The replication group to which this cluster belongs Empty if cluster is not associated with any replication group AWS API field: ReplicationGroupId
snapshot_retention_limit int32 Number of days for which ElastiCache retains automatic snapshots before deleting them AWS API field: SnapshotRetentionLimit
snapshot_window string Daily time range (UTC) during wich ElastiCache begins taking a daily snapshot of cluster AWS API field: SnapshotWindow
auth_token_enabled bool True if password is used when issuing Redis commands AWS API field: AuthTokenEnabled
auth_token_last_modified_date google.protobuf.Timestamp Date when auth token was last modified AWS API field: AuthTokenLastModifiedDate
transit_encryption_enabled bool Flag that enables in-transit encryption AWS API field: TransitEncryptionEnabled
at_rest_encryption_enabled bool True if data in cluster is encrypted at rest AWS API field: AtRestEncryptionEnabled

EcCacheNode

Represents an individual node within a cluster

Object: CacheNode Fields extracted from https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheNode.html

Field Type Label Description
cache_node_id string Numeric identifier for a node AWS API field: CacheNodes -> CacheNodeId
cache_node_status EcCacheNode.AwsRedisCacheNodeStatus Current state of node AWS API field: CacheNodes -> CacheNodeStatus
cache_node_create_time google.protobuf.Timestamp Date and time when node was created AWS API field: CacheNodes -> CacheNodeCreateTime
endpoint EcEndpoint Hostname for connecting to node. AWS API field: CacheNodes -> Endpoint
parameter_group_status string Status of parameter group applied to node AWS API field: CacheNodes -> ParameterGroupStatus
source_cache_node_id string ID of primary node to which this read replica node is synchronized. Empty if node is not associated with a primary cluster AWS API field: CacheNodes -> SourceCacheNodeID
customer_availability_zone string The availability zone where node was created AWS API field: CacheNodes -> CustomerAvailabilityZone

EcCacheParameterGroupStatus

Represents the status of the cache parameter group

Object: CacheParameterGroupStatus Fields extracted from: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheParameterGroupStatus.html

Field Type Label Description
cache_parameter_group_name string Name of parameter group AWS API field: CacheParameterGroupName
parameter_apply_status string Status of parameter updates AWS API field: ParameterApplyStatus
cache_node_ids_to_reboot string repeated List of node IDs which need to be rebooted for parameter changes to be applied AWS API field: CacheNodeIdsToReboot

EcCacheSecurityGroupMembership

Represents a cluster's status within a particular security group

Object: CacheSecurityGroupMembership Fields extracted from: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheSecurityGroupMembership.html

Field Type Label Description
cache_security_group_name string Name of security group AWS API field: CacheSecurityGroups -> CacheSecurityGroupName
status string Membership status in the cache security group AWS API field: CacheSecurityGroups -> Status

EcEndpoint

Represents information required to connect to a node

Object: Endpoint Fields extracted from: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_Endpoint.html

Field Type Label Description
address string DNS hostname of node AWS API field: Address
port int32 Port number that cache engine is listening on AWS API field: Port

EcNotificationConfiguration

Represents a notification topic and its status, used for publishing events to subscribers using SNS

Object: NotificationConfiguration Fields extracted from: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_NotificationConfiguration.html

Field Type Label Description
topic_arn string Amazon Resource Name that identifies the topic AWS API field: TopicArn
topic_status string Current state of topic AWS API field: TopicStatus

EcPendingModifiedValues

Represents group of settings that will be applied to cluster, or that are currently being applied

Object: PendingModifiedValues Fields extracted from https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_PendingModifiedValues.html

Field Type Label Description
num_cache_nodes int32 AWS API field: NumCacheNodes New number of nodes for the cluster
cache_node_ids_to_remove string repeated AWS API field: CacheNodeIdsToRemove List of node IDs that are being removed (or will be) from cluster
engine_version string AWS API field: EngineVersion New cache engine version that the cluster runs
cache_node_type string AWS API field: CacheNodeType Type of node that this cluster or replication group is scaled to
auth_token_status EcPendingModifiedValues.EcAuthTokenStatus AWS API field: AuthTokenStatus The status of auth token

EcSecurityGroupMembership

Represents a single cache security group and its status.

Object: SecurityGroupMembership Fields extracted from: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_SecurityGroupMembership.html

Field Type Label Description
security_group_id string Identifier of cache security group AWS API field: SecurityGroups -> SecurityGroupId
status string Status of cache security group AWS API field: SecurityGroups -> Status

AwsElasticacheCluster.EcClusterStatus

Describes all posible status that a cluster can be

Name Number Description
UNKNOWN_CLUSTER_STATUS 0
AVAILABLE 1
CREATING 2
DELETED 3
DELETING 4
INCOMPATIBLE_NETWORK 5
MODIFYING 6
REBOOTING_CLUSTER_NODES 7
RESTORE_FAILED 8
SNAPSHOTTING 9

AwsElasticacheCluster.EcEngine

Describes possible cache engines used in cluster

Name Number Description
UNKNOWN_ENGINE 0
MEMCACHED 1
REDIS 2

EcCacheNode.AwsRedisCacheNodeStatus

Describes all posible status that a node can be

Name Number Description
UNKNOWN_CLUSTER_NODE_STATUS 0
AVAILABLE 1
CREATING 2
REBOOTING 3
DELETING 4

EcPendingModifiedValues.EcAuthTokenStatus

Describes all posible status that an auth token can be

Name Number Description
UNKNOWN_TOKEN_STATUS 0
SETTING 1
ROTATING 2

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)