RedisCluster

Property	Value
Google Cloud Service Name	Cloud Memorystore for Redis
Google Cloud Service Documentation	/memorystore/docs/redis/
Google Cloud REST Resource Name	v1.projects.locations.instances
Google Cloud REST Resource Documentation	/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 
 deletionProtectionEnabled 
 : 
  
 boolean 
 location 
 : 
  
 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

Fields
`authorizationMode` Optional	`string` Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
`deletionProtectionEnabled` Optional	`boolean` Optional. The delete operation will fail when the value is set to true.
`location` Required*	`string` Immutable. Location of the resource.
`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`
`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 Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`.
`pscConfigs[].networkRef.name` Optional	`string` The `name` field of a `ComputeNetwork` resource.
`pscConfigs[].networkRef.namespace` Optional	`string` The `namespace` field 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.

authorizationMode

Optional

string

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

deletionProtectionEnabled

Optional

boolean

Optional. The delete operation will fail when the value is set to true.

location

Required*

string

Immutable. Location of the resource.

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

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 Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`.

pscConfigs[].networkRef.name

Optional

string

The `name` field of a `ComputeNetwork` resource.

pscConfigs[].networkRef.namespace

Optional

string

The `namespace` field 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 
 : 
  
 createTime 
 : 
  
 string 
  
 discoveryEndpoints 
 : 
  
 - 
  
 address 
 : 
  
 string 
  
 port 
 : 
  
 integer 
  
 pscConfig 
 : 
  
 network 
 : 
  
 string 
  
 preciseSizeGb 
 : 
  
 float 
  
 pscConnections 
 : 
  
 - 
  
 address 
 : 
  
 string 
  
 forwardingRule 
 : 
  
 string 
  
 network 
 : 
  
 string 
  
 projectID 
 : 
  
 string 
  
 pscConnectionID 
 : 
  
 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`
`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 GCP.
`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 GCP.
`observedState.createTime`	`string` Output only. The timestamp associated with the cluster creation request.
`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`
`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.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`
`observedState.pscConnections[].address`	`string` Output only. The IP allocated on the consumer network for the PSC forwarding rule.
`observedState.pscConnections[].forwardingRule`	`string` Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.
`observedState.pscConnections[].network`	`string` The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.
`observedState.pscConnections[].projectID`	`string` Output only. The consumer project_id where the forwarding rule is created from.
`observedState.pscConnections[].pscConnectionID`	`string` Output only. The PSC connection id of the forwarding rule connected to the service attachment.
`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

  # Copyright 2024 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 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