clusters

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

Overview

Name	clusters
Type	Resource
Id	google.alloydb.clusters

Fields

Name	Datatype	Description
name	string	Output only. The name of the cluster resource with the format: projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: projects/{project}/locations/{region}
annotations	object	Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
automatedBackupPolicy	object	Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.
backupSource	object	Message describing a BackupSource.
clusterType	string	Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster
continuousBackupConfig	object	ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
continuousBackupInfo	object	ContinuousBackupInfo describes the continuous backup properties of a cluster.
createTime	string	Output only. Create time stamp
databaseVersion	string	Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
deleteTime	string	Output only. Delete time stamp
displayName	string	User-settable and human-readable display name for the Cluster.
encryptionConfig	object	EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).
encryptionInfo	object	EncryptionInfo describes the encryption information of a cluster or a backup.
etag	string	For Resource freshness validation (https://google.aip.dev/154)
initialUser	object	The username/password for a database user. Used for specifying initial users at cluster creation time.
labels	object	Labels as key value pairs
maintenanceSchedule	object	MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead.
maintenanceUpdatePolicy	object	MaintenanceUpdatePolicy defines the policy for system updates.
migrationSource	object	Subset of the source instance configuration that is available when reading the cluster resource.
network	string	Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project}/global/networks/{network_id}. This is required to create a cluster. Deprecated, use network_config.network instead.
networkConfig	object	Metadata related to network configuration.
primaryConfig	object	Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.
pscConfig	object	PscConfig contains PSC related configuration at a cluster level.
reconciling	boolean	Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
satisfiesPzs	boolean	Output only. Reserved for future use.
secondaryConfig	object	Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
sslConfig	object	SSL configuration.
state	string	Output only. The current serving state of the cluster.
subscriptionType	string	Optional. Subscription type of the cluster.
trialMetadata	object	Contains information and all metadata related to TRIAL clusters.
uid	string	Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime	string	Output only. Update time stamp

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clustersId, locationsId, projectsId	Gets details of a single Cluster.
list	SELECT	locationsId, projectsId	Lists Clusters in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new Cluster in a given project and location.
delete	DELETE	clustersId, locationsId, projectsId	Deletes a single Cluster.
patch	UPDATE	clustersId, locationsId, projectsId	Updates the parameters of a single Cluster.
promote	EXEC	clustersId, locationsId, projectsId	Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
restore	EXEC	locationsId, projectsId	Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
switchover	EXEC	clustersId, locationsId, projectsId	Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.
upgrade	EXEC	clustersId, locationsId, projectsId	Upgrades a single Cluster. Imperative only.

SELECT examples

Lists Clusters in a given project and location.

SELECT
name,
annotations,
automatedBackupPolicy,
backupSource,
clusterType,
continuousBackupConfig,
continuousBackupInfo,
createTime,
databaseVersion,
deleteTime,
displayName,
encryptionConfig,
encryptionInfo,
etag,
initialUser,
labels,
maintenanceSchedule,
maintenanceUpdatePolicy,
migrationSource,
network,
networkConfig,
primaryConfig,
pscConfig,
reconciling,
satisfiesPzs,
secondaryConfig,
sslConfig,
state,
subscriptionType,
trialMetadata,
uid,
updateTime
FROM google.alloydb.clusters
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'; 

INSERT example

Use the following StackQL query and manifest file to create a new clusters resource.

All Properties

/*+ create */
INSERT INTO google.alloydb.clusters (
locationsId,
projectsId,
displayName,
labels,
databaseVersion,
networkConfig,
network,
etag,
annotations,
initialUser,
automatedBackupPolicy,
sslConfig,
encryptionConfig,
continuousBackupConfig,
secondaryConfig,
pscConfig,
maintenanceUpdatePolicy,
subscriptionType
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ labels }}',
'{{ databaseVersion }}',
'{{ networkConfig }}',
'{{ network }}',
'{{ etag }}',
'{{ annotations }}',
'{{ initialUser }}',
'{{ automatedBackupPolicy }}',
'{{ sslConfig }}',
'{{ encryptionConfig }}',
'{{ continuousBackupConfig }}',
'{{ secondaryConfig }}',
'{{ pscConfig }}',
'{{ maintenanceUpdatePolicy }}',
'{{ subscriptionType }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: displayName
      value: '{{ displayName }}'
    - name: labels
      value: '{{ labels }}'
    - name: databaseVersion
      value: '{{ databaseVersion }}'
    - name: networkConfig
      value:
        - name: network
          value: '{{ network }}'
        - name: allocatedIpRange
          value: '{{ allocatedIpRange }}'
    - name: network
      value: '{{ network }}'
    - name: etag
      value: '{{ etag }}'
    - name: annotations
      value: '{{ annotations }}'
    - name: initialUser
      value:
        - name: user
          value: '{{ user }}'
        - name: password
          value: '{{ password }}'
    - name: automatedBackupPolicy
      value:
        - name: weeklySchedule
          value:
            - name: startTimes
              value:
                - name: $ref
                  value: '{{ $ref }}'
            - name: daysOfWeek
              value:
                - name: type
                  value: '{{ type }}'
                - name: enumDescriptions
                  value: '{{ enumDescriptions }}'
                - name: enum
                  value: '{{ enum }}'
        - name: timeBasedRetention
          value:
            - name: retentionPeriod
              value: '{{ retentionPeriod }}'
        - name: quantityBasedRetention
          value:
            - name: count
              value: '{{ count }}'
        - name: enabled
          value: '{{ enabled }}'
        - name: backupWindow
          value: '{{ backupWindow }}'
        - name: encryptionConfig
          value:
            - name: kmsKeyName
              value: '{{ kmsKeyName }}'
        - name: location
          value: '{{ location }}'
        - name: labels
          value: '{{ labels }}'
    - name: sslConfig
      value:
        - name: sslMode
          value: '{{ sslMode }}'
        - name: caSource
          value: '{{ caSource }}'
    - name: continuousBackupConfig
      value:
        - name: enabled
          value: '{{ enabled }}'
        - name: recoveryWindowDays
          value: '{{ recoveryWindowDays }}'
    - name: secondaryConfig
      value:
        - name: primaryClusterName
          value: '{{ primaryClusterName }}'
    - name: pscConfig
      value:
        - name: pscEnabled
          value: '{{ pscEnabled }}'
    - name: maintenanceUpdatePolicy
      value:
        - name: maintenanceWindows
          value:
            - name: $ref
              value: '{{ $ref }}'
    - name: subscriptionType
      value: '{{ subscriptionType }}'

UPDATE example

Updates a clusters resource.

/*+ update */
UPDATE google.alloydb.clusters
SET 
displayName = '{{ displayName }}',
labels = '{{ labels }}',
databaseVersion = '{{ databaseVersion }}',
networkConfig = '{{ networkConfig }}',
network = '{{ network }}',
etag = '{{ etag }}',
annotations = '{{ annotations }}',
initialUser = '{{ initialUser }}',
automatedBackupPolicy = '{{ automatedBackupPolicy }}',
sslConfig = '{{ sslConfig }}',
encryptionConfig = '{{ encryptionConfig }}',
continuousBackupConfig = '{{ continuousBackupConfig }}',
secondaryConfig = '{{ secondaryConfig }}',
pscConfig = '{{ pscConfig }}',
maintenanceUpdatePolicy = '{{ maintenanceUpdatePolicy }}',
subscriptionType = '{{ subscriptionType }}'
WHERE 
clustersId = '{{ clustersId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified clusters resource.

/*+ delete */
DELETE FROM google.alloydb.clusters
WHERE clustersId = '{{ clustersId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';