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

authorizationMode

Optional

string

Optional. Immutable. Authorization mode of the instance.

automatedBackupConfig

Optional

object

Optional. The automated backup config for the instance.

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.

crossInstanceReplicationConfig

Optional

object

Optional. The cross instance replication config for the instance.

crossInstanceReplicationConfig.instanceRole

Optional

string

Required. The role of the instance in cross instance replication.

crossInstanceReplicationConfig.primaryInstance

Optional

object

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.

crossInstanceReplicationConfig.primaryInstance.instanceRef

Optional

object

Optional. The full resource path of the remote instance.

crossInstanceReplicationConfig.primaryInstance.instanceRef.external

Optional

string

A reference to an externally managed MemorystoreInstance resource. Should be in the format "projects/{{projectID}}/locations/{{location}}/instances/{{instanceID}}".

crossInstanceReplicationConfig.primaryInstance.instanceRef.name

Optional

string

The name of a MemorystoreInstance resource.

crossInstanceReplicationConfig.primaryInstance.instanceRef.namespace

Optional

string

The namespace of a MemorystoreInstance resource.

deletionProtectionEnabled

Optional

boolean

Optional. If set to true deletion of the instance will fail.

endpoints

Optional

list (object)

Optional. Endpoints for the instance.

endpoints[]

Optional

object

endpoints[].connections

Optional

list (object)

Optional. A group of PSC connections. They are created in the same VPC network, one for each service attachment in the cluster.

endpoints[].connections[]

Optional

object

endpoints[].connections[].pscAutoConnection

Optional

object

Detailed information of a PSC connection that is created through service connectivity automation.

endpoints[].connections[].pscAutoConnection.networkRef

Required*

object

Required. The network where the PSC endpoints are created, in the form of projects/{project_id}/global/networks/{network_id}.

endpoints[].connections[].pscAutoConnection.networkRef.external

Optional

string

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}}"

endpoints[].connections[].pscAutoConnection.networkRef.name

Optional

string

The name of a ComputeNetwork resource.

endpoints[].connections[].pscAutoConnection.networkRef.namespace

Optional

string

The namespace of a ComputeNetwork resource.

endpoints[].connections[].pscAutoConnection.projectRef

Required*

object

Required. The consumer project_id where PSC connections are established. This should be the same project_id that the instance is being created in.

endpoints[].connections[].pscAutoConnection.projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

endpoints[].connections[].pscAutoConnection.projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

endpoints[].connections[].pscAutoConnection.projectRef.name

Optional

string

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

endpoints[].connections[].pscAutoConnection.projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

engineConfigs

Optional

map (key: string, value: string)

Optional. User-provided engine configurations for the instance.

engineVersion

Optional

string

Optional. Immutable. Engine version of the instance.

labels

Optional

map (key: string, value: string)

Optional. Labels to represent user-provided metadata.

location

Required

string

Immutable.

maintenanceVersion

Optional

string

Optional. The maintenance version of the instance.

mode

Optional

string

Optional. The mode config for the instance.

nodeType

Optional

string

Optional. Immutable. Machine type for individual nodes of the instance.

persistenceConfig

Optional

object

Optional. Persistence configuration of the instance.

persistenceConfig.aofConfig

Optional

object

Optional. AOF configuration. This field will be ignored if mode is not AOF.

persistenceConfig.aofConfig.appendFsync

Optional

string

Optional. The fsync mode.

persistenceConfig.mode

Optional

string

Optional. Current persistence mode.

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. 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

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.

replicaCount

Optional

integer

Optional. Number of replica nodes per shard. If omitted the default is 0 replicas.

resourceID

Optional

string

The MemorystoreInstance name. If not given, the metadata.name will be used.

shardCount

Optional

integer

Optional. Number of shards for the instance.

transitEncryptionMode

Optional

string

Optional. Immutable. In-transit encryption mode of the instance.

zoneDistributionConfig

Optional

object

Optional. Immutable. Zone distribution configuration of the instance for node allocation.

zoneDistributionConfig.mode

Optional

string

Optional. Current zone distribution mode. Defaults to MULTI_ZONE.

zoneDistributionConfig.zone

Optional

string

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

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 MemorystoreInstance 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 GCP.

observedState.availableMaintenanceVersions

list (string)

Output only. The list of available maintenance versions for the instance.

observedState.availableMaintenanceVersions[]

string

observedState.createTime

string

Output only. Creation timestamp of the instance.

observedState.crossInstanceReplicationConfig

object

Optional. The cross instance replication config for the instance.

observedState.crossInstanceReplicationConfig.membership

object

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

object

Output only. The primary instance that acts as the source of replication for the secondary instances.

observedState.crossInstanceReplicationConfig.membership.primaryInstance.instance

string

Optional. The full resource path of the remote instance.

observedState.crossInstanceReplicationConfig.membership.primaryInstance.uid

string

Output only. The unique identifier of the remote instance.

observedState.crossInstanceReplicationConfig.membership.secondaryInstances

list (object)

Output only. The list of secondary instances replicating from the primary instance.

observedState.crossInstanceReplicationConfig.membership.secondaryInstances[]

object

observedState.crossInstanceReplicationConfig.membership.secondaryInstances[].instance

string

Optional. The full resource path of the remote instance.

observedState.crossInstanceReplicationConfig.membership.secondaryInstances[].uid

string

Output only. The unique identifier of the remote instance.

observedState.crossInstanceReplicationConfig.primaryInstance

object

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

string

Optional. The full resource path of the remote instance.

observedState.crossInstanceReplicationConfig.primaryInstance.uid

string

Output only. The unique identifier of the remote instance.

observedState.crossInstanceReplicationConfig.secondaryInstances

list (object)

Optional. List of secondary instances that are replicating from this primary instance. This field is only set for a primary instance.

observedState.crossInstanceReplicationConfig.secondaryInstances[]

object

observedState.crossInstanceReplicationConfig.secondaryInstances[].instance

string

Optional. The full resource path of the remote instance.

observedState.crossInstanceReplicationConfig.secondaryInstances[].uid

string

Output only. The unique identifier of the remote instance.

observedState.effectiveMaintenanceVersion

string

Output only. The current version of the maintenance schedule.

observedState.endpoints

list (object)

Optional. Endpoints for the instance.

observedState.endpoints[]

object

observedState.endpoints[].connections

list (object)

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[]

object

observedState.endpoints[].connections[].pscAutoConnection

object

Detailed information of a PSC connection that is created through service connectivity automation.

observedState.endpoints[].connections[].pscAutoConnection.connectionType

string

Output only. Type of the PSC connection.

observedState.endpoints[].connections[].pscAutoConnection.forwardingRule

string

Output only. The URI of the consumer side forwarding rule. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}

observedState.endpoints[].connections[].pscAutoConnection.ipAddress

string

Output only. The IP allocated on the consumer network for the PSC forwarding rule.

observedState.endpoints[].connections[].pscAutoConnection.port

integer

Optional. Output only. port will only be set for Primary/Reader or Discovery endpoint.

observedState.endpoints[].connections[].pscAutoConnection.pscConnectionID

string

Output only. The PSC connection id of the forwarding rule connected to the service attachment.

observedState.endpoints[].connections[].pscAutoConnection.pscConnectionStatus

string

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

string

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

object

Output only. Configuration of individual nodes of the instance.

observedState.nodeConfig.sizeGB

float

Output only. Memory size in GB of the node.

observedState.pscAttachmentDetails

list (object)

Output only. List of PSC connections for the instance.

observedState.pscAttachmentDetails[]

object

observedState.pscAttachmentDetails[].connectionType

string

Output only. Type of Psc endpoint.

observedState.pscAttachmentDetails[].serviceAttachment

string

Output only. Service attachment URI which your self-created PscConnection should use as target.

observedState.state

string

Output only. Current state of the instance.

observedState.stateInfo

object

Output only. Additional information about the state of the instance.

observedState.stateInfo.updateInfo

object

Output only. Describes ongoing update when instance state is UPDATING.

observedState.stateInfo.updateInfo.targetReplicaCount

integer

Output only. Target number of replica nodes per shard for the instance.

observedState.stateInfo.updateInfo.targetShardCount

integer

Output only. Target number of shards for the instance.

observedState.uid

string

Output only. System assigned, unique identifier for the instance.

observedState.updateTime

string

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