# RedisCluster

| **Property** | **Value** |
|---|---|
| Google Cloud Service Name | Cloud Memorystore for Redis |
| Google Cloud Service Documentation | [/memorystore/docs/redis/](https://docs.cloud.google.com/memorystore/docs/redis) |
| Google Cloud REST Resource Name | v1.projects.locations.instances |
| Google Cloud REST Resource Documentation | <https://docs.cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances> |
| Config Connector Resource Short Names | gcprediscluster gcpredisclusters rediscluster |
| Config Connector Service Name | redis.googleapis.com |
| Config Connector Resource Fully Qualified Name | redisclusters.redis.cnrm.cloud.google.com |
| Can Be Referenced by IAMPolicy/IAMPolicyMember | No |
| Config Connector Default Average Reconcile Interval In Seconds | 600 |

## Custom Resource Definition Properties

### Spec

#### Schema

    authorizationMode: string
    automatedBackupConfig:
      automatedBackupMode: string
      fixedFrequencySchedule:
        startTime:
          hours: integer
          minutes: integer
          nanos: integer
          seconds: integer
      retention: string
    clusterEndpoints:
    - connections:
      - pscAutoConnection:
          networkRef:
            external: string
            name: string
            namespace: string
          projectRef:
            external: string
            kind: string
            name: string
            namespace: string
    crossClusterReplicationConfig:
      clusterRole: string
      primaryCluster:
        clusterRef:
          external: string
          name: string
          namespace: string
      secondaryClusters:
      - clusterRef:
          external: string
          name: string
          namespace: string
    deletionProtectionEnabled: boolean
    gcsSource:
      uris:
      - string
    kmsKeyRef:
      external: string
      name: string
      namespace: string
    location: string
    maintenancePolicy:
      weeklyMaintenanceWindow:
      - day: string
        startTime:
          hours: integer
          minutes: integer
          nanos: integer
          seconds: integer
    managedBackupSource:
      backupRef:
        external: string
    nodeType: string
    persistenceConfig:
      aofConfig:
        appendFsync: string
      mode: string
      rdbConfig:
        rdbSnapshotPeriod: string
        rdbSnapshotStartTime: string
    projectRef:
      external: string
      kind: string
      name: string
      namespace: string
    pscConfigs:
    - networkRef:
        external: string
        name: string
        namespace: string
    redisConfigs:
      string: string
    replicaCount: integer
    resourceID: string
    shardCount: integer
    transitEncryptionMode: string
    zoneDistributionConfig:
      mode: string
      zone: string

| Fields ||
|---|---|
| `authorizationMode` *Optional* | `string` Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. |
| `automatedBackupConfig` *Optional* | `object` Optional. The automated backup config for the cluster. |
| `automatedBackupConfig.automatedBackupMode` *Optional* | `string` Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored. |
| `automatedBackupConfig.fixedFrequencySchedule` *Optional* | `object` Optional. Trigger automated backups at a fixed frequency. |
| `automatedBackupConfig.fixedFrequencySchedule.startTime` *Optional* | `object` Required. The start time of every automated backup in UTC. It must be set to the start of an hour. This field is required. |
| `automatedBackupConfig.fixedFrequencySchedule.startTime.hours` *Optional* | `integer` Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| `automatedBackupConfig.fixedFrequencySchedule.startTime.minutes` *Optional* | `integer` Minutes of hour of day. Must be from 0 to 59. |
| `automatedBackupConfig.fixedFrequencySchedule.startTime.nanos` *Optional* | `integer` Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| `automatedBackupConfig.fixedFrequencySchedule.startTime.seconds` *Optional* | `integer` Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| `automatedBackupConfig.retention` *Optional* | `string` Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days. |
| `clusterEndpoints` *Optional* | `list (object)` Optional. A list of cluster endpoints. |
| `clusterEndpoints[]` *Optional* | `object` <br /> |
| `clusterEndpoints[].connections` *Optional* | `list (object)` A group of Private Service Connect connections that are created in the same VPC network, one for each service attachment in the cluster. |
| `clusterEndpoints[].connections[]` *Optional* | `object` <br /> |
| `clusterEndpoints[].connections[].pscAutoConnection` *Optional* | `object` Detailed information of a Private Service Connect connection that is created through service connectivity automation. |
| `clusterEndpoints[].connections[].pscAutoConnection.networkRef` *Optional* | `object` Required when pscAutoConnection is specified. The consumer network where the IP address resides. |
| `clusterEndpoints[].connections[].pscAutoConnection.networkRef.external` *Optional* | `string` A reference to an externally managed ComputeNetwork resource. Should be in the format "projects/{{projectID}}/global/networks/{{networkID}}". |
| `clusterEndpoints[].connections[].pscAutoConnection.networkRef.name` *Optional* | `string` The name of a ComputeNetwork resource. |
| `clusterEndpoints[].connections[].pscAutoConnection.networkRef.namespace` *Optional* | `string` The namespace of a ComputeNetwork resource. |
| `clusterEndpoints[].connections[].pscAutoConnection.projectRef` *Optional* | `object` Required when pscAutoConnection is specified. The consumer project where the forwarding rule is created. |
| `clusterEndpoints[].connections[].pscAutoConnection.projectRef.external` *Optional* | `string` The \`projectID\` field of a project, when not managed by Config Connector. |
| `clusterEndpoints[].connections[].pscAutoConnection.projectRef.kind` *Optional* | `string` The kind of the Project resource; optional but must be \`Project\` if provided. |
| `clusterEndpoints[].connections[].pscAutoConnection.projectRef.name` *Optional* | `string` The \`name\` field of a \`Project\` resource. |
| `clusterEndpoints[].connections[].pscAutoConnection.projectRef.namespace` *Optional* | `string` The \`namespace\` field of a \`Project\` resource. |
| `crossClusterReplicationConfig` *Optional* | `object` Optional. Cross cluster replication config. |
| `crossClusterReplicationConfig.clusterRole` *Optional* | `string` The role of the cluster in cross cluster replication. |
| `crossClusterReplicationConfig.primaryCluster` *Optional* | `object` Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. |
| `crossClusterReplicationConfig.primaryCluster.clusterRef` *Optional* | `object` The full resource path of the remote cluster in the format: projects//locations//clusters/ |
| `crossClusterReplicationConfig.primaryCluster.clusterRef.external` *Optional* | `string` A reference to an externally managed RedisCluster resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/clusters/{{clusterID}}". |
| `crossClusterReplicationConfig.primaryCluster.clusterRef.name` *Optional* | `string` The name of a RedisCluster resource. |
| `crossClusterReplicationConfig.primaryCluster.clusterRef.namespace` *Optional* | `string` The namespace of a RedisCluster resource. |
| `crossClusterReplicationConfig.secondaryClusters` *Optional* | `list (object)` List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. |
| `crossClusterReplicationConfig.secondaryClusters[]` *Optional* | `object` <br /> |
| `crossClusterReplicationConfig.secondaryClusters[].clusterRef` *Optional* | `object` The full resource path of the remote cluster in the format: projects//locations//clusters/ |
| `crossClusterReplicationConfig.secondaryClusters[].clusterRef.external` *Optional* | `string` A reference to an externally managed RedisCluster resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/clusters/{{clusterID}}". |
| `crossClusterReplicationConfig.secondaryClusters[].clusterRef.name` *Optional* | `string` The name of a RedisCluster resource. |
| `crossClusterReplicationConfig.secondaryClusters[].clusterRef.namespace` *Optional* | `string` The namespace of a RedisCluster resource. |
| `deletionProtectionEnabled` *Optional* | `boolean` Optional. The delete operation will fail when the value is set to true. |
| `gcsSource` *Optional* | `object` Optional. Backups stored in Cloud Storage buckets. |
| `gcsSource.uris` *Optional* | `list (string)` URIs of the Cloud Storage objects to import. For example, gs://bucket1/object1, gs://bucket2/folder2/object2. |
| `gcsSource.uris[]` *Optional* | `string` <br /> |
| `kmsKeyRef` *Optional* | `object` Optional. The KMS key name to encrypt data at rest. |
| `kmsKeyRef.external` *Optional* | `string` A reference to an externally managed KMSCryptoKey resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/keyRings/{{keyring}}/cryptoKeys/{{cryptokey}}". |
| `kmsKeyRef.name` *Optional* | `string` The name of a KMSCryptoKey resource. |
| `kmsKeyRef.namespace` *Optional* | `string` The namespace of a KMSCryptoKey resource. |
| `location` *Required\** | `string` Immutable. Location of the resource. |
| `maintenancePolicy` *Optional* | `object` Optional. ClusterMaintenancePolicy determines when to allow or deny updates. |
| `maintenancePolicy.weeklyMaintenanceWindow` *Optional* | `list (object)` Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_maintenance_window is expected to be one. |
| `maintenancePolicy.weeklyMaintenanceWindow[]` *Optional* | `object` <br /> |
| `maintenancePolicy.weeklyMaintenanceWindow[].day` *Optional* | `string` Allows to define schedule that runs specified day of the week. |
| `maintenancePolicy.weeklyMaintenanceWindow[].startTime` *Optional* | `object` Start time of the window in UTC. |
| `maintenancePolicy.weeklyMaintenanceWindow[].startTime.hours` *Optional* | `integer` Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
| `maintenancePolicy.weeklyMaintenanceWindow[].startTime.minutes` *Optional* | `integer` Minutes of hour of day. Must be from 0 to 59. |
| `maintenancePolicy.weeklyMaintenanceWindow[].startTime.nanos` *Optional* | `integer` Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
| `maintenancePolicy.weeklyMaintenanceWindow[].startTime.seconds` *Optional* | `integer` Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
| `managedBackupSource` *Optional* | `object` Backups that are generated and managed by Memorystore. |
| `managedBackupSource.backupRef` *Optional* | `object` Optional. The RedisBackup resource that this managed backup source represents. |
| `managedBackupSource.backupRef.external` *Optional* | `string` A reference to an externally managed RedisBackup resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/backupCollections/{{collectionID}}/backups/{{backupID}}". |
| `nodeType` *Optional* | `string` Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. |
| `persistenceConfig` *Optional* | `object` Optional. Persistence config (RDB, AOF) for the cluster. |
| `persistenceConfig.aofConfig` *Optional* | `object` Optional. AOF configuration. This field will be ignored if mode is not AOF. |
| `persistenceConfig.aofConfig.appendFsync` *Optional* | `string` Optional. fsync configuration. |
| `persistenceConfig.mode` *Optional* | `string` Optional. The mode of persistence. |
| `persistenceConfig.rdbConfig` *Optional* | `object` Optional. RDB configuration. This field will be ignored if mode is not RDB. |
| `persistenceConfig.rdbConfig.rdbSnapshotPeriod` *Optional* | `string` Optional. Period between RDB snapshots. |
| `persistenceConfig.rdbConfig.rdbSnapshotStartTime` *Optional* | `string` Optional. The time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. |
| `projectRef` *Required\** | `object` Immutable. The Project that this resource belongs to. |
| `projectRef.external` *Optional* | `string` The \`projectID\` field of a project, when not managed by Config Connector. |
| `projectRef.kind` *Optional* | `string` The kind of the Project resource; optional but must be \`Project\` if provided. |
| `projectRef.name` *Optional* | `string` The \`name\` field of a \`Project\` resource. |
| `projectRef.namespace` *Optional* | `string` The \`namespace\` field of a \`Project\` resource. |
| `pscConfigs` *Optional* | `list (object)` Required. 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. |
| `pscConfigs[]` *Optional* | `object` <br /> |
| `pscConfigs[].networkRef` *Required\** | `object` Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. |
| `pscConfigs[].networkRef.external` *Optional* | `string` A reference to an externally managed ComputeNetwork resource. Should be in the format "projects/{{projectID}}/global/networks/{{networkID}}". |
| `pscConfigs[].networkRef.name` *Optional* | `string` The name of a ComputeNetwork resource. |
| `pscConfigs[].networkRef.namespace` *Optional* | `string` The namespace of a ComputeNetwork resource. |
| `redisConfigs` *Optional* | `map (key: string, value: string)` Optional. Key/Value pairs of customer overrides for mutable Redis Configs |
| `replicaCount` *Optional* | `integer` Optional. The number of replica nodes per shard. |
| `resourceID` *Optional* | `string` The RedisCluster name. If not given, the metadata.name will be used. |
| `shardCount` *Optional* | `integer` Required. Number of shards for the Redis cluster. |
| `transitEncryptionMode` *Optional* | `string` Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. |
| `zoneDistributionConfig` *Optional* | `object` Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. |
| `zoneDistributionConfig.mode` *Optional* | `string` Optional. The mode of zone distribution. Defaults to MULTI_ZONE, when not specified. |
| `zoneDistributionConfig.zone` *Optional* | `string` Optional. When SINGLE ZONE distribution is selected, zone field would be used to allocate all resources in that zone. This is not applicable to MULTI_ZONE, and would be ignored for MULTI_ZONE clusters. |

\* Field is required when parent field is specified

### Status

#### Schema

    conditions:
    - lastTransitionTime: string
      message: string
      reason: string
      status: string
      type: string
    externalRef: string
    observedGeneration: integer
    observedState:
      clusterEndpoints:
      - connections:
        - pscAutoConnection:
            address: string
            connectionType: string
            forwardingRule: string
            pscConnectionID: string
            pscConnectionStatus: string
            serviceAttachment: string
      createTime: string
      crossClusterReplicationConfig:
        membership:
          primaryCluster:
            cluster: string
            uid: string
          secondaryClusters:
          - cluster: string
            uid: string
        primaryCluster:
          cluster: string
          uid: string
        secondaryClusters:
        - cluster: string
          uid: string
        updateTime: string
      discoveryEndpoints:
      - address: string
        port: integer
        pscConfig:
          network: string
      encryptionInfo:
        encryptionType: string
        kmsKeyPrimaryState: string
        kmsKeyVersions:
        - string
        lastUpdateTime: string
      maintenancePolicy:
        createTime: string
        updateTime: string
      maintenanceSchedule:
        endTime: string
        startTime: string
      preciseSizeGb: float
      pscConnections:
      - address: string
        connectionType: string
        forwardingRule: string
        network: string
        projectID: string
        pscConnectionID: string
        pscConnectionStatus: string
        serviceAttachment: string
      pscServiceAttachments:
      - connectionType: string
        serviceAttachment: string
      sizeGb: integer
      state: string
      stateInfo:
        updateInfo:
          targetReplicaCount: integer
          targetShardCount: integer
      uid: string

| Fields ||
|---|---|
| `conditions` | `list (object)` Conditions represent the latest available observations of the object's current state. |
| `conditions[]` | `object` <br /> |
| `conditions[].lastTransitionTime` | `string` Last time the condition transitioned from one status to another. |
| `conditions[].message` | `string` Human-readable message indicating details about last transition. |
| `conditions[].reason` | `string` Unique, one-word, CamelCase reason for the condition's last transition. |
| `conditions[].status` | `string` Status is the status of the condition. Can be True, False, Unknown. |
| `conditions[].type` | `string` Type is the type of the condition. |
| `externalRef` | `string` A unique specifier for the RedisCluster resource in Google Cloud. |
| `observedGeneration` | `integer` ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. |
| `observedState` | `object` ObservedState is the state of the resource as most recently observed in Google Cloud. |
| `observedState.clusterEndpoints` | `list (object)` Output only. A list of cluster endpoints. |
| `observedState.clusterEndpoints[]` | `object` <br /> |
| `observedState.clusterEndpoints[].connections` | `list (object)` A group of Private Service Connect connections that are created in the same VPC network, one for each service attachment in the cluster. |
| `observedState.clusterEndpoints[].connections[]` | `object` <br /> |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection` | `object` Detailed information of a Private Service Connect connection that is created through service connectivity automation. |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection.address` | `string` Output only. The IP allocated on the consumer network for the Private Service Connect forwarding rule. |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection.connectionType` | `string` Output only. Type of the Private Service Connect connection. |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection.forwardingRule` | `string` Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection.pscConnectionID` | `string` Output only. The Private Service Connect connection ID of the forwarding rule connected to the service attachment. |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection.pscConnectionStatus` | `string` Output only. The status of the Private Service Connect connection. Note that this value is updated periodically. Use the Private Service Connect APIs for the latest status. |
| `observedState.clusterEndpoints[].connections[].pscAutoConnection.serviceAttachment` | `string` Output only. The service attachment which is the target of the Private Service Connect connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
| `observedState.createTime` | `string` Output only. The timestamp associated with the cluster creation request. |
| `observedState.crossClusterReplicationConfig` | `object` Output only. Cross cluster replication config. |
| `observedState.crossClusterReplicationConfig.membership` | `object` Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. |
| `observedState.crossClusterReplicationConfig.membership.primaryCluster` | `object` Output only. The primary cluster that acts as the source of replication for the secondary clusters. |
| `observedState.crossClusterReplicationConfig.membership.primaryCluster.cluster` | `string` The full resource path of the remote cluster in the format: projects//locations//clusters/ |
| `observedState.crossClusterReplicationConfig.membership.primaryCluster.uid` | `string` Output only. The unique identifier of the remote cluster. |
| `observedState.crossClusterReplicationConfig.membership.secondaryClusters` | `list (object)` Output only. The list of secondary clusters replicating from the primary cluster. |
| `observedState.crossClusterReplicationConfig.membership.secondaryClusters[]` | `object` <br /> |
| `observedState.crossClusterReplicationConfig.membership.secondaryClusters[].cluster` | `string` The full resource path of the remote cluster in the format: projects//locations//clusters/ |
| `observedState.crossClusterReplicationConfig.membership.secondaryClusters[].uid` | `string` Output only. The unique identifier of the remote cluster. |
| `observedState.crossClusterReplicationConfig.primaryCluster` | `object` Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. |
| `observedState.crossClusterReplicationConfig.primaryCluster.cluster` | `string` The full resource path of the remote cluster in the format: projects//locations//clusters/ |
| `observedState.crossClusterReplicationConfig.primaryCluster.uid` | `string` Output only. The unique identifier of the remote cluster. |
| `observedState.crossClusterReplicationConfig.secondaryClusters` | `list (object)` List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. |
| `observedState.crossClusterReplicationConfig.secondaryClusters[]` | `object` <br /> |
| `observedState.crossClusterReplicationConfig.secondaryClusters[].cluster` | `string` The full resource path of the remote cluster in the format: projects//locations//clusters/ |
| `observedState.crossClusterReplicationConfig.secondaryClusters[].uid` | `string` Output only. The unique identifier of the remote cluster. |
| `observedState.crossClusterReplicationConfig.updateTime` | `string` Output only. The last time cross cluster replication config was updated. |
| `observedState.discoveryEndpoints` | `list (object)` Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. |
| `observedState.discoveryEndpoints[]` | `object` <br /> |
| `observedState.discoveryEndpoints[].address` | `string` Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname. |
| `observedState.discoveryEndpoints[].port` | `integer` Output only. The port number of the exposed Redis endpoint. |
| `observedState.discoveryEndpoints[].pscConfig` | `object` Output only. Customer configuration for where the endpoint is created and accessed from. |
| `observedState.discoveryEndpoints[].pscConfig.network` | `string` Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}. |
| `observedState.encryptionInfo` | `object` Output only. Encryption information for the client to retrieve. |
| `observedState.encryptionInfo.encryptionType` | `string` Output only. Type of encryption. |
| `observedState.encryptionInfo.kmsKeyPrimaryState` | `string` Output only. The state of the primary version of the KMS key perceived by the system. This field is not populated in backups. |
| `observedState.encryptionInfo.kmsKeyVersions` | `list (string)` Output only. KMS key versions that are being used to protect the data at-rest. |
| `observedState.encryptionInfo.kmsKeyVersions[]` | `string` <br /> |
| `observedState.encryptionInfo.lastUpdateTime` | `string` Output only. The most recent time when the encryption info was updated. |
| `observedState.maintenancePolicy` | `object` Optional. ClusterMaintenancePolicy determines when to allow or deny updates. |
| `observedState.maintenancePolicy.createTime` | `string` Output only. The time when the policy was created i.e. Maintenance Window or Deny Period was assigned. |
| `observedState.maintenancePolicy.updateTime` | `string` Output only. The time when the policy was updated i.e. Maintenance Window or Deny Period was updated. |
| `observedState.maintenanceSchedule` | `object` Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. |
| `observedState.maintenanceSchedule.endTime` | `string` Output only. The end time of any upcoming scheduled maintenance for this instance. |
| `observedState.maintenanceSchedule.startTime` | `string` Output only. The start time of any upcoming scheduled maintenance for this instance. |
| `observedState.preciseSizeGb` | `float` Output only. Precise value of redis memory size in GB for the entire cluster. |
| `observedState.pscConnections` | `list (object)` Output only. PSC connections for discovery of the cluster topology and accessing the cluster. |
| `observedState.pscConnections[]` | `object` <br /> |
| `observedState.pscConnections[].address` | `string` Required. The IP allocated on the consumer network for the PSC forwarding rule. |
| `observedState.pscConnections[].connectionType` | `string` Output only. Type of the Private Service Connect connection. |
| `observedState.pscConnections[].forwardingRule` | `string` Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}. |
| `observedState.pscConnections[].network` | `string` Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}. |
| `observedState.pscConnections[].projectID` | `string` Optional. Project ID of the consumer project where the forwarding rule is created in. |
| `observedState.pscConnections[].pscConnectionID` | `string` Required. The PSC connection id of the forwarding rule connected to the service attachment. |
| `observedState.pscConnections[].pscConnectionStatus` | `string` Output only. The status of the Private Service Connect connection. Note that this value is updated periodically. To get the latest status of a Private Service Connect connection, see https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details. |
| `observedState.pscConnections[].serviceAttachment` | `string` Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}. |
| `observedState.pscServiceAttachments` | `list (object)` Output only. Service attachment details to configure Psc connections. |
| `observedState.pscServiceAttachments[]` | `object` <br /> |
| `observedState.pscServiceAttachments[].connectionType` | `string` Output only. Type of a PSC connection targeting this service attachment. |
| `observedState.pscServiceAttachments[].serviceAttachment` | `string` Output only. Service attachment URI which your self-created PscConnection should use as target |
| `observedState.sizeGb` | `integer` Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. |
| `observedState.state` | `string` Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED |
| `observedState.stateInfo` | `object` Output only. Additional information about the current state of the cluster. |
| `observedState.stateInfo.updateInfo` | `object` Describes ongoing update on the cluster when cluster state is UPDATING. |
| `observedState.stateInfo.updateInfo.targetReplicaCount` | `integer` Target number of replica nodes per shard. |
| `observedState.stateInfo.updateInfo.targetShardCount` | `integer` Target number of shards for redis cluster |
| `observedState.uid` | `string` Output only. System assigned, unique identifier for the cluster. |

## Sample YAML(s)

### Typical Use Case

    apiVersion: redis.cnrm.cloud.google.com/v1beta1
    kind: RedisCluster
    metadata:
      labels:
        label-one: "value-one"
      name: rediscluster-sample
    spec:
      shardCount: 6
      pscConfigs:
      - networkRef:
          name: rediscluster-dep
      location: us-central1
      projectRef:
        external: ${PROJECT_ID?}
      replicaCount: 2
      nodeType: REDIS_STANDARD_SMALL
      transitEncryptionMode: TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION
      authorizationMode: AUTH_MODE_IAM_AUTH
      redisConfigs:
        maxmemory-policy: volatile-ttl
      zoneDistributionConfig:
        mode: SINGLE_ZONE
        zone: us-central1-b
      persistenceConfig:
        mode: AOF
        aofConfig:
          appendFsync: EVERYSEC
      deletionProtectionEnabled: false
    ---
    apiVersion: compute.cnrm.cloud.google.com/v1beta1
    kind: ComputeNetwork
    metadata:
      name: rediscluster-dep
    spec:
      description: Test network for the project
      autoCreateSubnetworks: false
    ---
    apiVersion: compute.cnrm.cloud.google.com/v1beta1
    kind: ComputeSubnetwork
    metadata:
      name: rediscluster-dep
    spec:
      ipCidrRange: 10.128.0.0/20
      region: us-central1
      networkRef:
        name: rediscluster-dep
    ---
    apiVersion: networkconnectivity.cnrm.cloud.google.com/v1alpha1
    kind: NetworkConnectivityServiceConnectionPolicy
    metadata:
      name: rediscluster-dep
      labels:
        label-one: "value-one"
    spec:
      projectRef:
        external: ${PROJECT_ID?}
      location: us-central1
      serviceClass: "gcp-memorystore-redis"
      description: "Service Connection Policy for redis"
      networkRef:
        name: rediscluster-dep
      pscConfig:
        subnetworkRefs:
        - name: rediscluster-dep

> [!NOTE]
> **Note:** If you have any trouble with instantiating the resource, refer to [Troubleshoot Config Connector](https://docs.cloud.google.com/config-connector/docs/troubleshooting).