workstation_clusters

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

Overview

Name	workstation_clusters
Type	Resource
Id	google.workstations.workstation_clusters

Fields

Name	Datatype	Description
name	string	Identifier. Full name of this workstation cluster.
annotations	object	Optional. Client-specified annotations.
conditions	array	Output only. Status conditions describing the workstation cluster's current state.
controlPlaneIp	string	Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
createTime	string	Output only. Time when this workstation cluster was created.
degraded	boolean	Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
deleteTime	string	Output only. Time when this workstation cluster was soft-deleted.
displayName	string	Optional. Human-readable name for this workstation cluster.
domainConfig	object	Configuration options for a custom domain.
etag	string	Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
labels	object	Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
network	string	Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
privateClusterConfig	object	Configuration options for private workstation clusters.
reconciling	boolean	Output only. Indicates whether this workstation cluster is currently being updated to match its intended state.
subnetwork	string	Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
uid	string	Output only. A system-assigned unique identifier for this workstation cluster.
updateTime	string	Output only. Time when this workstation cluster was most recently updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, workstationClustersId	Returns the requested workstation cluster.
list	SELECT	locationsId, projectsId	Returns all workstation clusters in the specified location.
create	INSERT	locationsId, projectsId	Creates a new workstation cluster.
delete	DELETE	locationsId, projectsId, workstationClustersId	Deletes the specified workstation cluster.
patch	UPDATE	locationsId, projectsId, workstationClustersId	Updates an existing workstation cluster.

SELECT examples

Returns all workstation clusters in the specified location.

SELECT
name,
annotations,
conditions,
controlPlaneIp,
createTime,
degraded,
deleteTime,
displayName,
domainConfig,
etag,
labels,
network,
privateClusterConfig,
reconciling,
subnetwork,
uid,
updateTime
FROM google.workstations.workstation_clusters
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.workstations.workstation_clusters (
locationsId,
projectsId,
name,
displayName,
annotations,
labels,
etag,
network,
subnetwork,
privateClusterConfig,
domainConfig
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ annotations }}',
'{{ labels }}',
'{{ etag }}',
'{{ network }}',
'{{ subnetwork }}',
'{{ privateClusterConfig }}',
'{{ domainConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: uid
      value: string
    - name: reconciling
      value: boolean
    - name: annotations
      value: object
    - name: labels
      value: object
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: deleteTime
      value: string
    - name: etag
      value: string
    - name: network
      value: string
    - name: subnetwork
      value: string
    - name: controlPlaneIp
      value: string
    - name: privateClusterConfig
      value:
        - name: enablePrivateEndpoint
          value: boolean
        - name: clusterHostname
          value: string
        - name: serviceAttachmentUri
          value: string
        - name: allowedProjects
          value:
            - string
    - name: domainConfig
      value:
        - name: domain
          value: string
    - name: degraded
      value: boolean
    - name: conditions
      value:
        - - name: code
            value: integer
          - name: message
            value: string
          - name: details
            value:
              - object

UPDATE example

Updates a workstation_clusters resource.

/*+ update */
UPDATE google.workstations.workstation_clusters
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
annotations = '{{ annotations }}',
labels = '{{ labels }}',
etag = '{{ etag }}',
network = '{{ network }}',
subnetwork = '{{ subnetwork }}',
privateClusterConfig = '{{ privateClusterConfig }}',
domainConfig = '{{ domainConfig }}'
WHERE 
locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND workstationClustersId = '{{ workstationClustersId }}';

DELETE example

Deletes the specified workstation_clusters resource.

/*+ delete */
DELETE FROM google.workstations.workstation_clusters
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND workstationClustersId = '{{ workstationClustersId }}';