instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	google.redis.instances

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	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.
alternativeLocationId	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.
authEnabled	boolean	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.
authorizedNetwork	string	Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
availableMaintenanceVersions	array	Optional. The available maintenance versions that an instance could update to.
connectMode	string	Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
createTime	string (google-datetime)	Output only. The time the instance was created.
currentLocationId	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.
customerManagedKey	string	Optional. The KMS key reference that the customer provides when trying to create the instance.
displayName	string	An arbitrary and optional user-provided name for the instance.
host	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
labels	object	Resource labels to represent user provided metadata
locationId	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.
maintenancePolicy	object	Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time. (id: MaintenancePolicy)
maintenanceSchedule	object	Output only. Date and time of upcoming maintenance events which have been scheduled. (id: MaintenanceSchedule)
maintenanceVersion	string	Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
memorySizeGb	integer (int32)	Required. Redis memory size in GiB.
nodes	array	Output only. Info per node.
persistenceConfig	object	Optional. Persistence configuration parameters (id: PersistenceConfig)
persistenceIamIdentity	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	integer (int32)	Output only. The port number of the exposed Redis endpoint.
readEndpoint	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'.
readEndpointPort	integer (int32)	Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
readReplicasMode	string	Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
redisConfigs	object	Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
redisVersion	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
replicaCount	integer (int32)	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.
reservedIpRange	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.
satisfiesPzi	boolean	Optional. Output only. Reserved for future use.
satisfiesPzs	boolean	Optional. Output only. Reserved for future use.
secondaryIpRange	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".
serverCaCerts	array	Output only. List of server CA certificates for the instance.
state	string	Output only. The current state of this instance.
statusMessage	string	Output only. Additional information about the current status of this instance, if available.
suspensionReasons	array	Optional. reasons that causes instance in "SUSPENDED" state.
tags	object	Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
tier	string	Required. The service tier of the instance.
transitEncryptionMode	string	Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

list

Successful response

Name	Datatype	Description
name	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.
alternativeLocationId	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.
authEnabled	boolean	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.
authorizedNetwork	string	Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
availableMaintenanceVersions	array	Optional. The available maintenance versions that an instance could update to.
connectMode	string	Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
createTime	string (google-datetime)	Output only. The time the instance was created.
currentLocationId	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.
customerManagedKey	string	Optional. The KMS key reference that the customer provides when trying to create the instance.
displayName	string	An arbitrary and optional user-provided name for the instance.
host	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
labels	object	Resource labels to represent user provided metadata
locationId	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.
maintenancePolicy	object	Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time. (id: MaintenancePolicy)
maintenanceSchedule	object	Output only. Date and time of upcoming maintenance events which have been scheduled. (id: MaintenanceSchedule)
maintenanceVersion	string	Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
memorySizeGb	integer (int32)	Required. Redis memory size in GiB.
nodes	array	Output only. Info per node.
persistenceConfig	object	Optional. Persistence configuration parameters (id: PersistenceConfig)
persistenceIamIdentity	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	integer (int32)	Output only. The port number of the exposed Redis endpoint.
readEndpoint	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'.
readEndpointPort	integer (int32)	Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'.
readReplicasMode	string	Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
redisConfigs	object	Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
redisVersion	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
replicaCount	integer (int32)	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.
reservedIpRange	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.
satisfiesPzi	boolean	Optional. Output only. Reserved for future use.
satisfiesPzs	boolean	Optional. Output only. Reserved for future use.
secondaryIpRange	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".
serverCaCerts	array	Output only. List of server CA certificates for the instance.
state	string	Output only. The current state of this instance.
statusMessage	string	Output only. Additional information about the current status of this instance, if available.
suspensionReasons	array	Optional. reasons that causes instance in "SUSPENDED" state.
tags	object	Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
tier	string	Required. The service tier of the instance.
transitEncryptionMode	string	Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, instancesId		Gets the details of a specific Redis instance.
list	select	projectsId, locationsId	pageSize, pageToken	Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.
create	insert	projectsId, locationsId	instanceId	Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
patch	update	projectsId, locationsId, instancesId	updateMask	Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
delete	delete	projectsId, locationsId, instancesId		Deletes a specific Redis instance. Instance stops serving and data is deleted.
upgrade	exec	projectsId, locationsId, instancesId		Upgrades Redis instance to the newer Redis version specified in the request.
import	exec	projectsId, locationsId, instancesId		Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
export	exec	projectsId, locationsId, instancesId		Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
failover	exec	projectsId, locationsId, instancesId		Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
reschedule_maintenance	exec	projectsId, locationsId, instancesId		Reschedule maintenance for a given instance in a given project and location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instancesId	string
locationsId	string
projectsId	string
instanceId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of a specific Redis instance.

SELECT
name,
alternativeLocationId,
authEnabled,
authorizedNetwork,
availableMaintenanceVersions,
connectMode,
createTime,
currentLocationId,
customerManagedKey,
displayName,
host,
labels,
locationId,
maintenancePolicy,
maintenanceSchedule,
maintenanceVersion,
memorySizeGb,
nodes,
persistenceConfig,
persistenceIamIdentity,
port,
readEndpoint,
readEndpointPort,
readReplicasMode,
redisConfigs,
redisVersion,
replicaCount,
reservedIpRange,
satisfiesPzi,
satisfiesPzs,
secondaryIpRange,
serverCaCerts,
state,
statusMessage,
suspensionReasons,
tags,
tier,
transitEncryptionMode
FROM google.redis.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

list

Lists all Redis instances owned by a project in either the specified location (region) or all locations. The location should have the following format: * projects/{project_id}/locations/{location_id} If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

SELECT
name,
alternativeLocationId,
authEnabled,
authorizedNetwork,
availableMaintenanceVersions,
connectMode,
createTime,
currentLocationId,
customerManagedKey,
displayName,
host,
labels,
locationId,
maintenancePolicy,
maintenanceSchedule,
maintenanceVersion,
memorySizeGb,
nodes,
persistenceConfig,
persistenceIamIdentity,
port,
readEndpoint,
readEndpointPort,
readReplicasMode,
redisConfigs,
redisVersion,
replicaCount,
reservedIpRange,
satisfiesPzi,
satisfiesPzs,
secondaryIpRange,
serverCaCerts,
state,
statusMessage,
suspensionReasons,
tags,
tier,
transitEncryptionMode
FROM google.redis.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a Redis instance based on the specified tier and memory size. By default, the instance is accessible from the project's default network. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

INSERT INTO google.redis.instances (
data__name,
data__displayName,
data__labels,
data__locationId,
data__alternativeLocationId,
data__redisVersion,
data__reservedIpRange,
data__secondaryIpRange,
data__redisConfigs,
data__tier,
data__memorySizeGb,
data__authorizedNetwork,
data__connectMode,
data__authEnabled,
data__transitEncryptionMode,
data__maintenancePolicy,
data__replicaCount,
data__readReplicasMode,
data__customerManagedKey,
data__persistenceConfig,
data__suspensionReasons,
data__maintenanceVersion,
data__availableMaintenanceVersions,
data__tags,
projectsId,
locationsId,
instanceId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ labels }}',
'{{ locationId }}',
'{{ alternativeLocationId }}',
'{{ redisVersion }}',
'{{ reservedIpRange }}',
'{{ secondaryIpRange }}',
'{{ redisConfigs }}',
'{{ tier }}',
{{ memorySizeGb }},
'{{ authorizedNetwork }}',
'{{ connectMode }}',
{{ authEnabled }},
'{{ transitEncryptionMode }}',
'{{ maintenancePolicy }}',
{{ replicaCount }},
'{{ readReplicasMode }}',
'{{ customerManagedKey }}',
'{{ persistenceConfig }}',
'{{ suspensionReasons }}',
'{{ maintenanceVersion }}',
'{{ availableMaintenanceVersions }}',
'{{ tags }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instanceId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: projectsId
      value: string
      description: Required parameter for the instances resource.
    - name: locationsId
      value: string
      description: Required parameter for the instances resource.
    - name: name
      value: string
      description: >
        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.
        
    - name: displayName
      value: string
      description: >
        An arbitrary and optional user-provided name for the instance.
        
    - name: labels
      value: object
      description: >
        Resource labels to represent user provided metadata
        
    - name: locationId
      value: string
      description: >
        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.
        
    - name: alternativeLocationId
      value: string
      description: >
        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.
        
    - name: redisVersion
      value: string
      description: >
        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
        
    - name: reservedIpRange
      value: string
      description: >
        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.
        
    - name: secondaryIpRange
      value: string
      description: >
        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".
        
    - name: redisConfigs
      value: object
      description: >
        Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries
        
    - name: tier
      value: string
      description: >
        Required. The service tier of the instance.
        
      valid_values: ['TIER_UNSPECIFIED', 'BASIC', 'STANDARD_HA']
    - name: memorySizeGb
      value: integer
      description: >
        Required. Redis memory size in GiB.
        
    - name: authorizedNetwork
      value: string
      description: >
        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.
        
    - name: connectMode
      value: string
      description: >
        Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING.
        
      valid_values: ['CONNECT_MODE_UNSPECIFIED', 'DIRECT_PEERING', 'PRIVATE_SERVICE_ACCESS']
    - name: authEnabled
      value: boolean
      description: >
        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.
        
    - name: transitEncryptionMode
      value: string
      description: >
        Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance.
        
      valid_values: ['TRANSIT_ENCRYPTION_MODE_UNSPECIFIED', 'SERVER_AUTHENTICATION', 'DISABLED']
    - name: maintenancePolicy
      value: object
      description: >
        Optional. The maintenance policy for the instance. If not provided, maintenance events can be performed at any time.
        
    - name: replicaCount
      value: integer
      description: >
        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.
        
    - name: readReplicasMode
      value: string
      description: >
        Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED.
        
      valid_values: ['READ_REPLICAS_MODE_UNSPECIFIED', 'READ_REPLICAS_DISABLED', 'READ_REPLICAS_ENABLED']
    - name: customerManagedKey
      value: string
      description: >
        Optional. The KMS key reference that the customer provides when trying to create the instance.
        
    - name: persistenceConfig
      value: object
      description: >
        Optional. Persistence configuration parameters
        
    - name: suspensionReasons
      value: array
      description: >
        Optional. reasons that causes instance in "SUSPENDED" state.
        
    - name: maintenanceVersion
      value: string
      description: >
        Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".
        
    - name: availableMaintenanceVersions
      value: array
      description: >
        Optional. The available maintenance versions that an instance could update to.
        
    - name: tags
      value: object
      description: >
        Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
        
    - name: instanceId
      value: string

UPDATE examples

patch

Updates the metadata and configuration of a specific Redis instance. Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

UPDATE google.redis.instances
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__labels = '{{ labels }}',
data__locationId = '{{ locationId }}',
data__alternativeLocationId = '{{ alternativeLocationId }}',
data__redisVersion = '{{ redisVersion }}',
data__reservedIpRange = '{{ reservedIpRange }}',
data__secondaryIpRange = '{{ secondaryIpRange }}',
data__redisConfigs = '{{ redisConfigs }}',
data__tier = '{{ tier }}',
data__memorySizeGb = {{ memorySizeGb }},
data__authorizedNetwork = '{{ authorizedNetwork }}',
data__connectMode = '{{ connectMode }}',
data__authEnabled = {{ authEnabled }},
data__transitEncryptionMode = '{{ transitEncryptionMode }}',
data__maintenancePolicy = '{{ maintenancePolicy }}',
data__replicaCount = {{ replicaCount }},
data__readReplicasMode = '{{ readReplicasMode }}',
data__customerManagedKey = '{{ customerManagedKey }}',
data__persistenceConfig = '{{ persistenceConfig }}',
data__suspensionReasons = '{{ suspensionReasons }}',
data__maintenanceVersion = '{{ maintenanceVersion }}',
data__availableMaintenanceVersions = '{{ availableMaintenanceVersions }}',
data__tags = '{{ tags }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a specific Redis instance. Instance stops serving and data is deleted.

DELETE FROM google.redis.instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required;

Lifecycle Methods

upgrade

Upgrades Redis instance to the newer Redis version specified in the request.

EXEC google.redis.instances.upgrade 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"redisVersion": "{{ redisVersion }}"
}';

import

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance. Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

EXEC google.redis.instances.import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"inputConfig": "{{ inputConfig }}"
}';

export

Export Redis instance data into a Redis RDB format file in Cloud Storage. Redis will continue serving during this operation. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

EXEC google.redis.instances.export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"outputConfig": "{{ outputConfig }}"
}';

failover

Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

EXEC google.redis.instances.failover 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"dataProtectionMode": "{{ dataProtectionMode }}"
}';

reschedule_maintenance

Reschedule maintenance for a given instance in a given project and location.

EXEC google.redis.instances.reschedule_maintenance 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"rescheduleType": "{{ rescheduleType }}", 
"scheduleTime": "{{ scheduleTime }}"
}';