# Source: https://docs.datadoghq.com/ddsql_reference/data_directory/gcp/gcp.redis_instance.dataset.md

---
title: Redis Instance
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > DDSQL Reference > Data Directory > Redis Instance
---

# Redis Instance

A Redis Instance in Google Cloud is a managed in-memory data store service built on open-source Redis. It provides high-performance caching, real-time analytics, and session management without the need to manage infrastructure. Google Cloud handles scaling, availability, monitoring, and security, allowing developers to focus on application logic while benefiting from low-latency data access.

```
gcp.redis_instance
```

## Fields

| Title                          | ID   | Type          | Data Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Description |
| ------------------------------ | ---- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| _key                           | core | string        |
| alternative_location_id        | core | string        | Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service.                                                                                                                                                                          |
| ancestors                      | core | array<string> |
| auth_enabled                   | core | bool          | Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled.                                                                                                                                                                                                                                                                                                                                  |
| authorized_network             | core | string        | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.                                                                                                                                                                                                                                                                                                            |
| available_maintenance_versions | core | array<string> | Optional. The available maintenance versions that an instance could update to.                                                                                                                                                                                                                                                                                                                                                                                                                                |
| connect_mode                   | core | string        | Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.                                                                                                                                                                                                                                                                                                                                                                                       |
| create_time                    | core | timestamp     | Output only. The time the instance was created.                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| current_location_id            | core | string        | Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance.                                                                                                                                                                                                                                                                                                      |
| datadog_display_name           | core | string        |
| gcp_display_name               | core | string        | An arbitrary and optional user-provided name for the instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| host                           | core | string        | Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.                                                                                                                                                                                                                                                                                                                                                                                                  |
| labels                         | core | array<string> | Resource labels to represent user provided metadata                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| location_id                    | core | string        | Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone.                                                                                                                                                                       |
| maintenance_policy             | core | json          | Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.                                                                                                                                                                                                                                                                                                                                                                                          |
| maintenance_schedule           | core | json          | Output only. Date and time of upcoming maintenance events which have been scheduled.                                                                                                                                                                                                                                                                                                                                                                                                                          |
| maintenance_version            | core | string        | Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".                                                                                                                                                                                                                                                                                                                                                                                                    |
| memory_size_gb                 | core | int64         | Required. Redis memory size in GiB.                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| name                           | core | string        | Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.      |
| nodes                          | core | json          | Output only. Info per node.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| organization_id                | core | string        |
| parent                         | core | string        |
| persistence_config             | core | json          | Optional. Persistence configuration parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| persistence_iam_identity       | core | string        | Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.                                                                                                                                                                                                                                                         |
| port                           | core | int64         | Output only. The port number of the exposed Redis endpoint.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| project_id                     | core | string        |
| project_number                 | core | string        |
| read_endpoint                  | core | string        | Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'.                                                                                                                                                                                                                                     |
| read_endpoint_port             | core | int64         | Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.                                                                                                                                                                                                                                                                                                                                                                                 |
| read_replicas_mode             | core | string        | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.                                                                                                                                                                                                                                                                                                                                                                                                                            |
| redis_version                  | core | string        | Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility                                                                                                        |
| region_id                      | core | string        |
| replica_count                  | core | int64         | Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0.                                                                                                                                                                                             |
| reserved_ip_range              | core | string        | Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. |
| resource_name                  | core | string        |
| satisfies_pzi                  | core | bool          | Optional. Output only. Reserved for future use.                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| satisfies_pzs                  | core | bool          | Optional. Output only. Reserved for future use.                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| secondary_ip_range             | core | string        | Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto".                                                                                                                                                             |
| server_ca_certs                | core | json          | Output only. List of server CA certificates for the instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| state                          | core | string        | Output only. The current state of this instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| status_message                 | core | string        | Output only. Additional information about the current status of this instance, if available.                                                                                                                                                                                                                                                                                                                                                                                                                  |
| suspension_reasons             | core | array<string> | Optional. reasons that causes instance in "SUSPENDED" state.                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| tags                           | core | hstore_csv    |
| tier                           | core | string        | Required. The service tier of the instance.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| transit_encryption_mode        | core | string        | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.                                                                                                                                                                                                                                                                                                                                                                                                              |
| zone_id                        | core | string        |