MemorystoreInstance
| Property | Value |
|---|---|
| Google Cloud Service Name | Cloud Memorystore for Valkey |
| Google Cloud Service Documentation | /memorystore/docs/valkey/ |
| Google Cloud REST Resource Name | v1.projects.locations.instances |
| Google Cloud REST Resource Documentation | /memorystore/docs/valkey/reference/rest/v1/projects.locations.instances |
| Config Connector Resource Short Names | gcpmemorystoreinstance gcpmemorystoreinstances memorystoreinstance |
| Config Connector Service Name | memorystore.googleapis.com |
| Config Connector Resource Fully Qualified Name | memorystoreinstances.memorystore.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
crossInstanceReplicationConfig:
instanceRole: string
primaryInstance:
instanceRef:
external: string
name: string
namespace: string
deletionProtectionEnabled: boolean
endpoints:
- connections:
- pscAutoConnection:
networkRef:
external: string
name: string
namespace: string
projectRef:
external: string
kind: string
name: string
namespace: string
engineConfigs:
string: string
engineVersion: string
labels:
string: string
location: string
maintenanceVersion: string
mode: string
nodeType: string
persistenceConfig:
aofConfig:
appendFsync: string
mode: string
rdbConfig:
rdbSnapshotPeriod: string
rdbSnapshotStartTime: string
projectRef:
external: string
kind: string
name: string
namespace: string
replicaCount: integer
resourceID: string
shardCount: integer
transitEncryptionMode: string
zoneDistributionConfig:
mode: string
zone: string
| Fields | |
|---|---|
|
Optional |
Optional. Immutable. Authorization mode of the instance. |
|
Optional |
Optional. The automated backup config for the instance. |
|
Optional |
Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored. |
|
Optional |
Optional. Trigger automated backups at a fixed frequency. |
|
Optional |
Required. The start time of every automated backup in UTC. It must be set to the start of an hour. This field is required. |
|
Optional |
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. |
|
Optional |
Minutes of hour of day. Must be from 0 to 59. |
|
Optional |
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
|
Optional |
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. |
|
Optional |
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. |
|
Optional |
Optional. The cross instance replication config for the instance. |
|
Optional |
Required. The role of the instance in cross instance replication. |
|
Optional |
Optional. Details of the primary instance that is used as the replication source for this secondary instance. This field is only set for a secondary instance. |
|
Optional |
Optional. The full resource path of the remote instance. |
|
Optional |
A reference to an externally managed MemorystoreInstance resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/instances/{{instanceID}}". |
|
Optional |
The name of a MemorystoreInstance resource. |
|
Optional |
The namespace of a MemorystoreInstance resource. |
|
Optional |
Optional. If set to true deletion of the instance will fail. |
|
Optional |
Optional. Endpoints for the instance. |
|
Optional |
|
|
Optional |
Optional. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. |
|
Optional |
|
|
Optional |
Detailed information of a PSC connection that is created through service connectivity automation. |
|
Required* |
Required. The network where the PSC endpoints are created, in the form of projects/{project_id}/global/networks/{network_id}. |
|
Optional |
The value of an externally managed ComputeNetwork resource. Should be in the format "https://www.googleapis.com/compute/{{version}}/projects/{{projectId}}/global/networks/{{networkId}}" or "projects/{{projectId}}/global/networks/{{networkId}}" |
|
Optional |
The name of a ComputeNetwork resource. |
|
Optional |
The namespace of a ComputeNetwork resource. |
|
Required* |
Required. The consumer project_id where PSC connections are established. This should be the same project_id that the instance is being created in. |
|
Optional |
The `projectID` field of a project, when not managed by Config Connector. |
|
Optional |
The kind of the Project resource; optional but must be `Project` if provided. |
|
Optional |
The `name` field of a `Project` resource. |
|
Optional |
The `namespace` field of a `Project` resource. |
|
Optional |
Optional. User-provided engine configurations for the instance. |
|
Optional |
Optional. Immutable. Engine version of the instance. |
|
Optional |
Optional. Labels to represent user-provided metadata. |
|
Required |
Immutable. |
|
Optional |
Optional. The maintenance version of the instance. |
|
Optional |
Optional. The mode config for the instance. |
|
Optional |
Optional. Immutable. Machine type for individual nodes of the instance. |
|
Optional |
Optional. Persistence configuration of the instance. |
|
Optional |
Optional. AOF configuration. This field will be ignored if mode is not AOF. |
|
Optional |
Optional. The fsync mode. |
|
Optional |
Optional. Current persistence mode. |
|
Optional |
Optional. RDB configuration. This field will be ignored if mode is not RDB. |
|
Optional |
Optional. Period between RDB snapshots. |
|
Optional |
Optional. 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. |
|
Required |
The Project that this resource belongs to. |
|
Optional |
The `projectID` field of a project, when not managed by Config Connector. |
|
Optional |
The kind of the Project resource; optional but must be `Project` if provided. |
|
Optional |
The `name` field of a `Project` resource. |
|
Optional |
The `namespace` field of a `Project` resource. |
|
Optional |
Optional. Number of replica nodes per shard. If omitted the default is 0 replicas. |
|
Optional |
The MemorystoreInstance name. If not given, the metadata.name will be used. |
|
Optional |
Optional. Number of shards for the instance. |
|
Optional |
Optional. Immutable. In-transit encryption mode of the instance. |
|
Optional |
Optional. Immutable. Zone distribution configuration of the instance for node allocation. |
|
Optional |
Optional. Current zone distribution mode. Defaults to MULTI_ZONE. |
|
Optional |
Optional. Defines zone where all resources will be allocated with SINGLE_ZONE mode. Ignored for MULTI_ZONE mode. |
* 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:
availableMaintenanceVersions:
- string
createTime: string
crossInstanceReplicationConfig:
membership:
primaryInstance:
instance: string
uid: string
secondaryInstances:
- instance: string
uid: string
primaryInstance:
instance: string
uid: string
secondaryInstances:
- instance: string
uid: string
effectiveMaintenanceVersion: string
endpoints:
- connections:
- pscAutoConnection:
connectionType: string
forwardingRule: string
ipAddress: string
port: integer
pscConnectionID: string
pscConnectionStatus: string
serviceAttachment: string
nodeConfig:
sizeGB: float
pscAttachmentDetails:
- connectionType: string
serviceAttachment: string
state: string
stateInfo:
updateInfo:
targetReplicaCount: integer
targetShardCount: integer
uid: string
updateTime: string
| Fields | |
|---|---|
conditions |
Conditions represent the latest available observations of the object's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
externalRef |
A unique specifier for the MemorystoreInstance resource in Google Cloud. |
observedGeneration |
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 |
ObservedState is the state of the resource as most recently observed in GCP. |
observedState.availableMaintenanceVersions |
Output only. The list of available maintenance versions for the instance. |
observedState.availableMaintenanceVersions[] |
|
observedState.createTime |
Output only. Creation timestamp of the instance. |
observedState.crossInstanceReplicationConfig |
Optional. The cross instance replication config for the instance. |
observedState.crossInstanceReplicationConfig.membership |
Output only. An output only view of all the member instances participating in the cross instance replication. This view will be provided by every member instance irrespective of its instance role(primary or secondary). |
observedState.crossInstanceReplicationConfig.membership.primaryInstance |
Output only. The primary instance that acts as the source of replication for the secondary instances. |
observedState.crossInstanceReplicationConfig.membership.primaryInstance.instance |
Optional. The full resource path of the remote instance. |
observedState.crossInstanceReplicationConfig.membership.primaryInstance.uid |
Output only. The unique identifier of the remote instance. |
observedState.crossInstanceReplicationConfig.membership.secondaryInstances |
Output only. The list of secondary instances replicating from the primary instance. |
observedState.crossInstanceReplicationConfig.membership.secondaryInstances[] |
|
observedState.crossInstanceReplicationConfig.membership.secondaryInstances[].instance |
Optional. The full resource path of the remote instance. |
observedState.crossInstanceReplicationConfig.membership.secondaryInstances[].uid |
Output only. The unique identifier of the remote instance. |
observedState.crossInstanceReplicationConfig.primaryInstance |
Optional. Details of the primary instance that is used as the replication source for this secondary instance. This field is only set for a secondary instance. |
observedState.crossInstanceReplicationConfig.primaryInstance.instance |
Optional. The full resource path of the remote instance. |
observedState.crossInstanceReplicationConfig.primaryInstance.uid |
Output only. The unique identifier of the remote instance. |
observedState.crossInstanceReplicationConfig.secondaryInstances |
Optional. List of secondary instances that are replicating from this primary instance. This field is only set for a primary instance. |
observedState.crossInstanceReplicationConfig.secondaryInstances[] |
|
observedState.crossInstanceReplicationConfig.secondaryInstances[].instance |
Optional. The full resource path of the remote instance. |
observedState.crossInstanceReplicationConfig.secondaryInstances[].uid |
Output only. The unique identifier of the remote instance. |
observedState.effectiveMaintenanceVersion |
Output only. The current version of the maintenance schedule. |
observedState.endpoints |
Optional. Endpoints for the instance. |
observedState.endpoints[] |
|
observedState.endpoints[].connections |
Optional. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster. |
observedState.endpoints[].connections[] |
|
observedState.endpoints[].connections[].pscAutoConnection |
Detailed information of a PSC connection that is created through service connectivity automation. |
observedState.endpoints[].connections[].pscAutoConnection.connectionType |
Output only. Type of the PSC connection. |
observedState.endpoints[].connections[].pscAutoConnection.forwardingRule |
Output only. The URI of the consumer side forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule} |
observedState.endpoints[].connections[].pscAutoConnection.ipAddress |
Output only. The IP allocated on the consumer network for the PSC forwarding rule. |
observedState.endpoints[].connections[].pscAutoConnection.port |
Optional. Output only. port will only be set for Primary/Reader or Discovery endpoint. |
observedState.endpoints[].connections[].pscAutoConnection.pscConnectionID |
Output only. The PSC connection id of the forwarding rule connected to the service attachment. |
observedState.endpoints[].connections[].pscAutoConnection.pscConnectionStatus |
Output only. The status of the PSC connection: whether a connection exists and ACTIVE or it no longer exists. Please note that this value is updated periodically. Please use Private Service Connect APIs for the latest status. |
observedState.endpoints[].connections[].pscAutoConnection.serviceAttachment |
Output only. 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.nodeConfig |
Output only. Configuration of individual nodes of the instance. |
observedState.nodeConfig.sizeGB |
Output only. Memory size in GB of the node. |
observedState.pscAttachmentDetails |
Output only. List of PSC connections for the instance. |
observedState.pscAttachmentDetails[] |
|
observedState.pscAttachmentDetails[].connectionType |
Output only. Type of Psc endpoint. |
observedState.pscAttachmentDetails[].serviceAttachment |
Output only. Service attachment URI which your self-created PscConnection should use as target. |
observedState.state |
Output only. Current state of the instance. |
observedState.stateInfo |
Output only. Additional information about the state of the instance. |
observedState.stateInfo.updateInfo |
Output only. Describes ongoing update when instance state is UPDATING. |
observedState.stateInfo.updateInfo.targetReplicaCount |
Output only. Target number of replica nodes per shard for the instance. |
observedState.stateInfo.updateInfo.targetShardCount |
Output only. Target number of shards for the instance. |
observedState.uid |
Output only. System assigned, unique identifier for the instance. |
observedState.updateTime |
Output only. Latest update timestamp of the instance. |
Sample YAML(s)
Typical Use Case
# Copyright 2026 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: memorystore.cnrm.cloud.google.com/v1beta1
kind: MemorystoreInstance
metadata:
name: memorystoreinstance-sample
spec:
shardCount: 6
location: us-central1
projectRef:
external: projects/${PROJECT_ID?}
replicaCount: 2
nodeType: STANDARD_SMALL
transitEncryptionMode: SERVER_AUTHENTICATION
authorizationMode: IAM_AUTH
engineVersion: VALKEY_7_2
engineConfigs:
maxmemory-policy: volatile-ttl
zoneDistributionConfig:
mode: SINGLE_ZONE
zone: us-central1-b
persistenceConfig:
mode: AOF
aofConfig:
appendFsync: EVERY_SEC
deletionProtectionEnabled: true
endpoints:
- connections:
- pscAutoConnection:
networkRef:
name: memorystoreinstance-dep
projectRef:
external: projects/${PROJECT_ID?}
mode: CLUSTER
labels:
key1: val1
key2: val2
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
name: memorystoreinstance-dep
spec:
description: Test network for the project
autoCreateSubnetworks: false
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeSubnetwork
metadata:
name: memorystoreinstance-dep
spec:
ipCidrRange: 10.128.0.0/20
region: us-central1
networkRef:
name: memorystoreinstance-dep
---
apiVersion: networkconnectivity.cnrm.cloud.google.com/v1alpha1
kind: NetworkConnectivityServiceConnectionPolicy
metadata:
name: memorystoreinstance-dep
labels:
label-one: "value-one"
spec:
projectRef:
external: projects/${PROJECT_ID?}
location: us-central1
serviceClass: "gcp-memorystore"
description: "Service Connection Policy for memorystore"
networkRef:
name: memorystoreinstance-dep
pscConfig:
subnetworkRefs:
- name: memorystoreinstance-dep