clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	google.redis.clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
aclPolicy	string	Optional. The ACL policy to be applied to the cluster.
aclPolicyInSync	boolean	Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync.
aclPolicyInfo	object	Output only. Details of the applied ACL policy. (id: AclPolicyInfo)
allowFewerZonesDeployment	boolean	Optional. Immutable. Deprecated, do not use.
asyncClusterEndpointsDeletionEnabled	boolean	Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
authorizationMode	string	Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. (AUTH_MODE_UNSPECIFIED, AUTH_MODE_IAM_AUTH, AUTH_MODE_DISABLED, AUTH_MODE_TOKEN_AUTH)
automatedBackupConfig	object	Optional. The automated backup config for the cluster. (id: AutomatedBackupConfig)
availableMaintenanceVersions	array	Output only. This field is used to determine the available maintenance versions for the self service update.
backupCollection	string	Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
clusterEndpoints	array	Optional. A list of cluster endpoints.
createTime	string (google-datetime)	Output only. The timestamp associated with the cluster creation request.
crossClusterReplicationConfig	object	Optional. Cross cluster replication config. (id: CrossClusterReplicationConfig)
deletionProtectionEnabled	boolean	Optional. The delete operation will fail when the value is set to true.
discoveryEndpoints	array	Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
effectiveMaintenanceVersion	string	Output only. This field represents the actual maintenance version of the cluster.
encryptionInfo	object	Output only. Encryption information of the data at rest of the cluster. (id: EncryptionInfo)
gcsSource	object	Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. (id: GcsBackupSource)
kmsKey	string	Optional. The KMS key used to encrypt the at-rest data of the cluster.
labels	object	Optional. Labels to represent user-provided metadata.
maintenancePolicy	object	Optional. ClusterMaintenancePolicy determines when to allow or deny updates. (id: ClusterMaintenancePolicy)
maintenanceSchedule	object	Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. (id: ClusterMaintenanceSchedule)
maintenanceVersion	string	Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
managedBackupSource	object	Optional. Backups generated and managed by memorystore service. (id: ManagedBackupSource)
nodeType	string	Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. (NODE_TYPE_UNSPECIFIED, REDIS_SHARED_CORE_NANO, REDIS_HIGHMEM_MEDIUM, REDIS_HIGHMEM_XLARGE, REDIS_STANDARD_SMALL, REDIS_HIGHCPU_MEDIUM, REDIS_STANDARD_LARGE, REDIS_HIGHMEM_2XLARGE)
ondemandMaintenance	boolean	Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.
persistenceConfig	object	Optional. Persistence config (RDB, AOF) for the cluster. (id: ClusterPersistenceConfig)
preciseSizeGb	number (double)	Output only. Precise value of redis memory size in GB for the entire cluster.
pscConfigs	array	Optional. 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.
pscConnections	array	Output only. The list of PSC connections that are auto-created through service connectivity automation.
pscServiceAttachments	array	Output only. Service attachment details to configure Psc connections
redisConfigs	object	Optional. Key/Value pairs of customer overrides for mutable Redis Configs
replicaCount	integer (int32)	Optional. The number of replica nodes per shard.
rotateServerCertificate	boolean	Optional. Input only. Rotate the server certificates.
satisfiesPzi	boolean	Optional. Output only. Reserved for future use.
satisfiesPzs	boolean	Optional. Output only. Reserved for future use.
serverCaMode	string	Optional. Server CA mode for the cluster. (SERVER_CA_MODE_UNSPECIFIED, SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA, SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA, SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA)
serverCaPool	string	Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
shardCount	integer (int32)	Optional. Number of shards for the Redis cluster.
simulateMaintenanceEvent	boolean	Optional. Input only. Simulate a maintenance event.
sizeGb	integer (int32)	Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
state	string	Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING)
stateInfo	object	Output only. Additional information about the current state of the cluster. (id: StateInfo)
transitEncryptionMode	string	Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. (TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, TRANSIT_ENCRYPTION_MODE_DISABLED, TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION)
uid	string	Output only. System assigned, unique identifier for the cluster.
zoneDistributionConfig	object	Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. (id: ZoneDistributionConfig)

list

Name	Datatype	Description
name	string	Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}
aclPolicy	string	Optional. The ACL policy to be applied to the cluster.
aclPolicyInSync	boolean	Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync.
aclPolicyInfo	object	Output only. Details of the applied ACL policy. (id: AclPolicyInfo)
allowFewerZonesDeployment	boolean	Optional. Immutable. Deprecated, do not use.
asyncClusterEndpointsDeletionEnabled	boolean	Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
authorizationMode	string	Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. (AUTH_MODE_UNSPECIFIED, AUTH_MODE_IAM_AUTH, AUTH_MODE_DISABLED, AUTH_MODE_TOKEN_AUTH)
automatedBackupConfig	object	Optional. The automated backup config for the cluster. (id: AutomatedBackupConfig)
availableMaintenanceVersions	array	Output only. This field is used to determine the available maintenance versions for the self service update.
backupCollection	string	Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}
clusterEndpoints	array	Optional. A list of cluster endpoints.
createTime	string (google-datetime)	Output only. The timestamp associated with the cluster creation request.
crossClusterReplicationConfig	object	Optional. Cross cluster replication config. (id: CrossClusterReplicationConfig)
deletionProtectionEnabled	boolean	Optional. The delete operation will fail when the value is set to true.
discoveryEndpoints	array	Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.
effectiveMaintenanceVersion	string	Output only. This field represents the actual maintenance version of the cluster.
encryptionInfo	object	Output only. Encryption information of the data at rest of the cluster. (id: EncryptionInfo)
gcsSource	object	Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects. (id: GcsBackupSource)
kmsKey	string	Optional. The KMS key used to encrypt the at-rest data of the cluster.
labels	object	Optional. Labels to represent user-provided metadata.
maintenancePolicy	object	Optional. ClusterMaintenancePolicy determines when to allow or deny updates. (id: ClusterMaintenancePolicy)
maintenanceSchedule	object	Output only. ClusterMaintenanceSchedule Output only Published maintenance schedule. (id: ClusterMaintenanceSchedule)
maintenanceVersion	string	Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
managedBackupSource	object	Optional. Backups generated and managed by memorystore service. (id: ManagedBackupSource)
nodeType	string	Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node. (NODE_TYPE_UNSPECIFIED, REDIS_SHARED_CORE_NANO, REDIS_HIGHMEM_MEDIUM, REDIS_HIGHMEM_XLARGE, REDIS_STANDARD_SMALL, REDIS_HIGHCPU_MEDIUM, REDIS_STANDARD_LARGE, REDIS_HIGHMEM_2XLARGE)
ondemandMaintenance	boolean	Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.
persistenceConfig	object	Optional. Persistence config (RDB, AOF) for the cluster. (id: ClusterPersistenceConfig)
preciseSizeGb	number (double)	Output only. Precise value of redis memory size in GB for the entire cluster.
pscConfigs	array	Optional. 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.
pscConnections	array	Output only. The list of PSC connections that are auto-created through service connectivity automation.
pscServiceAttachments	array	Output only. Service attachment details to configure Psc connections
redisConfigs	object	Optional. Key/Value pairs of customer overrides for mutable Redis Configs
replicaCount	integer (int32)	Optional. The number of replica nodes per shard.
rotateServerCertificate	boolean	Optional. Input only. Rotate the server certificates.
satisfiesPzi	boolean	Optional. Output only. Reserved for future use.
satisfiesPzs	boolean	Optional. Output only. Reserved for future use.
serverCaMode	string	Optional. Server CA mode for the cluster. (SERVER_CA_MODE_UNSPECIFIED, SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA, SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA, SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA)
serverCaPool	string	Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
shardCount	integer (int32)	Optional. Number of shards for the Redis cluster.
simulateMaintenanceEvent	boolean	Optional. Input only. Simulate a maintenance event.
sizeGb	integer (int32)	Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.
state	string	Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING)
stateInfo	object	Output only. Additional information about the current state of the cluster. (id: StateInfo)
transitEncryptionMode	string	Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. (TRANSIT_ENCRYPTION_MODE_UNSPECIFIED, TRANSIT_ENCRYPTION_MODE_DISABLED, TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION)
uid	string	Output only. System assigned, unique identifier for the cluster.
zoneDistributionConfig	object	Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region. (id: ZoneDistributionConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, clustersId		Gets the details of a specific Redis cluster.
list	select	projectsId, locationsId	pageSize, pageToken	Lists all Redis clusters 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	requestId, clusterId	Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster 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, clustersId	requestId, updateMask	Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster 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, clustersId	requestId	Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
reschedule_cluster_maintenance	exec	projectsId, locationsId, clustersId		Reschedules upcoming maintenance event.
backup	exec	projectsId, locationsId, clustersId		Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

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
clustersId	string
locationsId	string
projectsId	string
clusterId	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of a specific Redis cluster.

SELECT
name,
aclPolicy,
aclPolicyInSync,
aclPolicyInfo,
allowFewerZonesDeployment,
asyncClusterEndpointsDeletionEnabled,
authorizationMode,
automatedBackupConfig,
availableMaintenanceVersions,
backupCollection,
clusterEndpoints,
createTime,
crossClusterReplicationConfig,
deletionProtectionEnabled,
discoveryEndpoints,
effectiveMaintenanceVersion,
encryptionInfo,
gcsSource,
kmsKey,
labels,
maintenancePolicy,
maintenanceSchedule,
maintenanceVersion,
managedBackupSource,
nodeType,
ondemandMaintenance,
persistenceConfig,
preciseSizeGb,
pscConfigs,
pscConnections,
pscServiceAttachments,
redisConfigs,
replicaCount,
rotateServerCertificate,
satisfiesPzi,
satisfiesPzs,
serverCaMode,
serverCaPool,
shardCount,
simulateMaintenanceEvent,
sizeGb,
state,
stateInfo,
transitEncryptionMode,
uid,
zoneDistributionConfig
FROM google.redis.clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
;

list

Lists all Redis clusters 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,
aclPolicy,
aclPolicyInSync,
aclPolicyInfo,
allowFewerZonesDeployment,
asyncClusterEndpointsDeletionEnabled,
authorizationMode,
automatedBackupConfig,
availableMaintenanceVersions,
backupCollection,
clusterEndpoints,
createTime,
crossClusterReplicationConfig,
deletionProtectionEnabled,
discoveryEndpoints,
effectiveMaintenanceVersion,
encryptionInfo,
gcsSource,
kmsKey,
labels,
maintenancePolicy,
maintenanceSchedule,
maintenanceVersion,
managedBackupSource,
nodeType,
ondemandMaintenance,
persistenceConfig,
preciseSizeGb,
pscConfigs,
pscConnections,
pscServiceAttachments,
redisConfigs,
replicaCount,
rotateServerCertificate,
satisfiesPzi,
satisfiesPzs,
serverCaMode,
serverCaPool,
shardCount,
simulateMaintenanceEvent,
sizeGb,
state,
stateInfo,
transitEncryptionMode,
uid,
zoneDistributionConfig
FROM google.redis.clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster 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.clusters (
data__name,
data__transitEncryptionMode,
data__kmsKey,
data__automatedBackupConfig,
data__labels,
data__replicaCount,
data__persistenceConfig,
data__maintenancePolicy,
data__redisConfigs,
data__shardCount,
data__simulateMaintenanceEvent,
data__managedBackupSource,
data__serverCaPool,
data__gcsSource,
data__asyncClusterEndpointsDeletionEnabled,
data__deletionProtectionEnabled,
data__maintenanceVersion,
data__rotateServerCertificate,
data__clusterEndpoints,
data__allowFewerZonesDeployment,
data__zoneDistributionConfig,
data__ondemandMaintenance,
data__pscConfigs,
data__crossClusterReplicationConfig,
data__serverCaMode,
data__aclPolicy,
data__nodeType,
data__authorizationMode,
projectsId,
locationsId,
requestId,
clusterId
)
SELECT 
'{{ name }}',
'{{ transitEncryptionMode }}',
'{{ kmsKey }}',
'{{ automatedBackupConfig }}',
'{{ labels }}',
{{ replicaCount }},
'{{ persistenceConfig }}',
'{{ maintenancePolicy }}',
'{{ redisConfigs }}',
{{ shardCount }},
{{ simulateMaintenanceEvent }},
'{{ managedBackupSource }}',
'{{ serverCaPool }}',
'{{ gcsSource }}',
{{ asyncClusterEndpointsDeletionEnabled }},
{{ deletionProtectionEnabled }},
'{{ maintenanceVersion }}',
{{ rotateServerCertificate }},
'{{ clusterEndpoints }}',
{{ allowFewerZonesDeployment }},
'{{ zoneDistributionConfig }}',
{{ ondemandMaintenance }},
'{{ pscConfigs }}',
'{{ crossClusterReplicationConfig }}',
'{{ serverCaMode }}',
'{{ aclPolicy }}',
'{{ nodeType }}',
'{{ authorizationMode }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ clusterId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the clusters resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the clusters resource.
  - name: name
    value: "{{ name }}"
    description: |
      Required. Identifier. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
  - name: transitEncryptionMode
    value: "{{ transitEncryptionMode }}"
    description: |
      Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.
    valid_values: ['TRANSIT_ENCRYPTION_MODE_UNSPECIFIED', 'TRANSIT_ENCRYPTION_MODE_DISABLED', 'TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION']
  - name: kmsKey
    value: "{{ kmsKey }}"
    description: |
      Optional. The KMS key used to encrypt the at-rest data of the cluster.
  - name: automatedBackupConfig
    description: |
      Optional. The automated backup config for the cluster.
    value:
      automatedBackupMode: "{{ automatedBackupMode }}"
      retention: "{{ retention }}"
      fixedFrequencySchedule:
        startTime:
          seconds: {{ seconds }}
          nanos: {{ nanos }}
          minutes: {{ minutes }}
          hours: {{ hours }}
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. Labels to represent user-provided metadata.
  - name: replicaCount
    value: {{ replicaCount }}
    description: |
      Optional. The number of replica nodes per shard.
  - name: persistenceConfig
    description: |
      Optional. Persistence config (RDB, AOF) for the cluster.
    value:
      aofConfig:
        appendFsync: "{{ appendFsync }}"
      mode: "{{ mode }}"
      rdbConfig:
        rdbSnapshotPeriod: "{{ rdbSnapshotPeriod }}"
        rdbSnapshotStartTime: "{{ rdbSnapshotStartTime }}"
  - name: maintenancePolicy
    description: |
      Optional. ClusterMaintenancePolicy determines when to allow or deny updates.
    value:
      updateTime: "{{ updateTime }}"
      createTime: "{{ createTime }}"
      weeklyMaintenanceWindow:
        - day: "{{ day }}"
          startTime:
            seconds: {{ seconds }}
            nanos: {{ nanos }}
            minutes: {{ minutes }}
            hours: {{ hours }}
  - name: redisConfigs
    value: "{{ redisConfigs }}"
    description: |
      Optional. Key/Value pairs of customer overrides for mutable Redis Configs
  - name: shardCount
    value: {{ shardCount }}
    description: |
      Optional. Number of shards for the Redis cluster.
  - name: simulateMaintenanceEvent
    value: {{ simulateMaintenanceEvent }}
    description: |
      Optional. Input only. Simulate a maintenance event.
  - name: managedBackupSource
    description: |
      Optional. Backups generated and managed by memorystore service.
    value:
      backup: "{{ backup }}"
  - name: serverCaPool
    value: "{{ serverCaPool }}"
    description: |
      Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".
  - name: gcsSource
    description: |
      Optional. Backups stored in Cloud Storage buckets. The Cloud Storage buckets need to be the same region as the clusters. Read permission is required to import from the provided Cloud Storage objects.
    value:
      uris:
        - "{{ uris }}"
  - name: asyncClusterEndpointsDeletionEnabled
    value: {{ asyncClusterEndpointsDeletionEnabled }}
    description: |
      Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.
  - name: deletionProtectionEnabled
    value: {{ deletionProtectionEnabled }}
    description: |
      Optional. The delete operation will fail when the value is set to true.
  - name: maintenanceVersion
    value: "{{ maintenanceVersion }}"
    description: |
      Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.
  - name: rotateServerCertificate
    value: {{ rotateServerCertificate }}
    description: |
      Optional. Input only. Rotate the server certificates.
  - name: clusterEndpoints
    description: |
      Optional. A list of cluster endpoints.
    value:
      - connections: "{{ connections }}"
  - name: allowFewerZonesDeployment
    value: {{ allowFewerZonesDeployment }}
    description: |
      Optional. Immutable. Deprecated, do not use.
  - name: zoneDistributionConfig
    description: |
      Optional. This config will be used to determine how the customer wants us to distribute cluster resources within the region.
    value:
      zone: "{{ zone }}"
      mode: "{{ mode }}"
      zones:
        - "{{ zones }}"
  - name: ondemandMaintenance
    value: {{ ondemandMaintenance }}
    description: |
      Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.
  - name: pscConfigs
    description: |
      Optional. 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.
    value:
      - network: "{{ network }}"
  - name: crossClusterReplicationConfig
    description: |
      Optional. Cross cluster replication config.
    value:
      primaryCluster:
        cluster: "{{ cluster }}"
        uid: "{{ uid }}"
      clusterRole: "{{ clusterRole }}"
      secondaryClusters:
        - cluster: "{{ cluster }}"
          uid: "{{ uid }}"
      updateTime: "{{ updateTime }}"
      membership:
        primaryCluster:
          cluster: "{{ cluster }}"
          uid: "{{ uid }}"
        secondaryClusters:
          - cluster: "{{ cluster }}"
            uid: "{{ uid }}"
  - name: serverCaMode
    value: "{{ serverCaMode }}"
    description: |
      Optional. Server CA mode for the cluster.
    valid_values: ['SERVER_CA_MODE_UNSPECIFIED', 'SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA', 'SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA', 'SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA']
  - name: aclPolicy
    value: "{{ aclPolicy }}"
    description: |
      Optional. The ACL policy to be applied to the cluster.
  - name: nodeType
    value: "{{ nodeType }}"
    description: |
      Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.
    valid_values: ['NODE_TYPE_UNSPECIFIED', 'REDIS_SHARED_CORE_NANO', 'REDIS_HIGHMEM_MEDIUM', 'REDIS_HIGHMEM_XLARGE', 'REDIS_STANDARD_SMALL', 'REDIS_HIGHCPU_MEDIUM', 'REDIS_STANDARD_LARGE', 'REDIS_HIGHMEM_2XLARGE']
  - name: authorizationMode
    value: "{{ authorizationMode }}"
    description: |
      Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.
    valid_values: ['AUTH_MODE_UNSPECIFIED', 'AUTH_MODE_IAM_AUTH', 'AUTH_MODE_DISABLED', 'AUTH_MODE_TOKEN_AUTH']
  - name: requestId
    value: "{{ requestId }}"
  - name: clusterId
    value: "{{ clusterId }}"

UPDATE examples

patch

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster 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.clusters
SET 
data__name = '{{ name }}',
data__transitEncryptionMode = '{{ transitEncryptionMode }}',
data__kmsKey = '{{ kmsKey }}',
data__automatedBackupConfig = '{{ automatedBackupConfig }}',
data__labels = '{{ labels }}',
data__replicaCount = {{ replicaCount }},
data__persistenceConfig = '{{ persistenceConfig }}',
data__maintenancePolicy = '{{ maintenancePolicy }}',
data__redisConfigs = '{{ redisConfigs }}',
data__shardCount = {{ shardCount }},
data__simulateMaintenanceEvent = {{ simulateMaintenanceEvent }},
data__managedBackupSource = '{{ managedBackupSource }}',
data__serverCaPool = '{{ serverCaPool }}',
data__gcsSource = '{{ gcsSource }}',
data__asyncClusterEndpointsDeletionEnabled = {{ asyncClusterEndpointsDeletionEnabled }},
data__deletionProtectionEnabled = {{ deletionProtectionEnabled }},
data__maintenanceVersion = '{{ maintenanceVersion }}',
data__rotateServerCertificate = {{ rotateServerCertificate }},
data__clusterEndpoints = '{{ clusterEndpoints }}',
data__allowFewerZonesDeployment = {{ allowFewerZonesDeployment }},
data__zoneDistributionConfig = '{{ zoneDistributionConfig }}',
data__ondemandMaintenance = {{ ondemandMaintenance }},
data__pscConfigs = '{{ pscConfigs }}',
data__crossClusterReplicationConfig = '{{ crossClusterReplicationConfig }}',
data__serverCaMode = '{{ serverCaMode }}',
data__aclPolicy = '{{ aclPolicy }}',
data__nodeType = '{{ nodeType }}',
data__authorizationMode = '{{ authorizationMode }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

DELETE FROM google.redis.clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

reschedule_cluster_maintenance

Reschedules upcoming maintenance event.

EXEC google.redis.clusters.reschedule_cluster_maintenance 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required 
@@json=
'{
"rescheduleType": "{{ rescheduleType }}", 
"scheduleTime": "{{ scheduleTime }}"
}'
;

backup

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

EXEC google.redis.clusters.backup 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required 
@@json=
'{
"backupId": "{{ backupId }}", 
"ttl": "{{ ttl }}"
}'
;