Redis Cluster

Redis Cluster on Google Cloud is a managed in-memory data store service based on open-source Redis. It provides high availability, automatic sharding, and horizontal scaling to handle large datasets with low latency. This service is ideal for caching, real-time analytics, session management, and high-throughput workloads, while reducing the operational overhead of managing Redis infrastructure.

gcp.redis_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
async_cluster_endpoints_deletion_enabledcoreboolOptional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
authorization_modecorestringOptional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
automated_backup_configcorejsonOptional. The automated backup config for the cluster.
backup_collectioncorestringOptional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
cluster_endpointscorejsonOptional. A list of cluster endpoints.
create_timecoretimestampOutput only. The timestamp associated with the cluster creation request.
cross_cluster_replication_configcorejsonOptional. Cross cluster replication config.
datadog_display_namecorestring
deletion_protection_enabledcoreboolOptional. The delete operation will fail when the value is set to true.
discovery_endpointscorejsonOutput only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
encryption_infocorejsonOutput only. Encryption information of the data at rest of the cluster.
gcs_sourcecorejsonOptional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
labelscorearray<string>
maintenance_policycorejsonOptional. ClusterMaintenancePolicy determines when to allow or deny updates.
maintenance_schedulecorejsonOutput only. ClusterMaintenanceSchedule Output only Published maintenance schedule.
managed_backup_sourcecorejsonOptional. Backups generated and managed by memorystore service.
namecorestringRequired. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
node_typecorestringOptional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
organization_idcorestring
parentcorestring
persistence_configcorejsonOptional. Persistence config (RDB, AOF) for the cluster.
precise_size_gbcorefloat64Output only. Precise value of redis memory size in GB for the entire cluster.
project_idcorestring
project_numbercorestring
psc_configscorejsonOptional. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.
psc_connectionscorejsonOutput only. The list of PSC connections that are auto-created through service connectivity automation.
psc_service_attachmentscorejsonOutput only. Service attachment details to configure Psc connections
replica_countcoreint64Optional. The number of replica nodes per shard.
resource_namecorestring
shard_countcoreint64Optional. Number of shards for the Redis cluster.
size_gbcoreint64Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
statecorestringOutput only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED
state_infocorejsonOutput only. Additional information about the current state of the cluster.
tagscorehstore
transit_encryption_modecorestringOptional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
uidcorestringOutput only. System assigned, unique identifier for the cluster.
zone_distribution_configcorejsonOptional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.