Skip to main content

workstation_configs

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

Overview​

Nameworkstation_configs
TypeResource
Idgoogle.workstations.workstation_configs

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. Full name of this workstation configuration.
allowedPortsarrayOptional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535.
annotationsobjectOptional. Client-specified annotations.
conditionsarrayOutput only. Status conditions describing the workstation configuration's current state.
containerobjectOptional. Container that runs upon startup for each workstation using this workstation configuration. (id: Container)
createTimestring (google-datetime)Output only. Time when this workstation configuration was created.
degradedbooleanOutput only. Whether this workstation configuration is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the configuration.
deleteTimestring (google-datetime)Output only. Time when this workstation configuration was soft-deleted.
disableTcpConnectionsbooleanOptional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.
displayNamestringOptional. Human-readable name for this workstation configuration.
enableAuditAgentbooleanOptional. Whether to enable Linux auditd logging on the workstation. When enabled, a service_account must also be specified that has roles/logging.logWriter and roles/monitoring.metricWriter on the project. Operating system audit logging is distinct from Cloud Audit Logs and Container output logging. Operating system audit logs are available in the Cloud Logging console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd"
encryptionKeyobjectImmutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. (id: CustomerEncryptionKey)
ephemeralDirectoriesarrayOptional. Ephemeral directories which won't persist across workstation sessions.
etagstringOptional. 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.
grantWorkstationAdminRoleOnCreatebooleanOptional. Grant creator of a workstation roles/workstations.policyAdmin role along with roles/workstations.user role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.
hostobjectOptional. Runtime host for the workstation. (id: Host)
idleTimeoutstring (google-duration)Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of "0s" indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide duration terminated by s for seconds—for example, "7200s" (2 hours). The default is "1200s" (20 minutes).
labelsobjectOptional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
maxUsableWorkstationsinteger (int32)Optional. Maximum number of workstations under this configuration a user can have workstations.workstation.use permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user workstations.workstation.use permission on that workstation. If not specified, defaults to 0, which indicates unlimited.
persistentDirectoriesarrayOptional. Directories to persist across workstation sessions.
readinessChecksarrayOptional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
reconcilingbooleanOutput only. Indicates whether this workstation configuration is currently being updated to match its intended state.
replicaZonesarrayOptional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, ['us-central1-a', 'us-central1-f']. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
runningTimeoutstring (google-duration)Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by s for seconds—for example, "54000s" (15 hours). Defaults to "43200s" (12 hours). A value of "0s" indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than "0s" and less than "86400s" (24 hours). Warning: A value of "0s" indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
uidstringOutput only. A system-assigned unique identifier for this workstation configuration.
updateTimestring (google-datetime)Output only. Time when this workstation configuration was most recently updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, workstationClustersId, workstationConfigsIdReturns the requested workstation configuration.
listselectprojectsId, locationsId, workstationClustersIdpageSize, pageToken, filterReturns all workstation configurations in the specified cluster.
createinsertprojectsId, locationsId, workstationClustersIdworkstationConfigId, validateOnlyCreates a new workstation configuration.
patchupdateprojectsId, locationsId, workstationClustersId, workstationConfigsIdupdateMask, validateOnly, allowMissingUpdates an existing workstation configuration.
deletedeleteprojectsId, locationsId, workstationClustersId, workstationConfigsIdvalidateOnly, etag, forceDeletes the specified workstation configuration.

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.

NameDatatypeDescription
locationsIdstring
projectsIdstring
workstationClustersIdstring
workstationConfigsIdstring
allowMissingboolean
etagstring
filterstring
forceboolean
pageSizeinteger (int32)
pageTokenstring
updateMaskstring (google-fieldmask)
validateOnlyboolean
workstationConfigIdstring

SELECT examples​

Returns the requested workstation configuration.

SELECT
name,
allowedPorts,
annotations,
conditions,
container,
createTime,
degraded,
deleteTime,
disableTcpConnections,
displayName,
enableAuditAgent,
encryptionKey,
ephemeralDirectories,
etag,
grantWorkstationAdminRoleOnCreate,
host,
idleTimeout,
labels,
maxUsableWorkstations,
persistentDirectories,
readinessChecks,
reconciling,
replicaZones,
runningTimeout,
uid,
updateTime
FROM google.workstations.workstation_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workstationClustersId = '{{ workstationClustersId }}' -- required
AND workstationConfigsId = '{{ workstationConfigsId }}' -- required;

INSERT examples​

Creates a new workstation configuration.

INSERT INTO google.workstations.workstation_configs (
data__name,
data__displayName,
data__annotations,
data__labels,
data__etag,
data__idleTimeout,
data__runningTimeout,
data__maxUsableWorkstations,
data__host,
data__persistentDirectories,
data__ephemeralDirectories,
data__container,
data__encryptionKey,
data__readinessChecks,
data__replicaZones,
data__enableAuditAgent,
data__disableTcpConnections,
data__allowedPorts,
data__grantWorkstationAdminRoleOnCreate,
projectsId,
locationsId,
workstationClustersId,
workstationConfigId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ annotations }}',
'{{ labels }}',
'{{ etag }}',
'{{ idleTimeout }}',
'{{ runningTimeout }}',
{{ maxUsableWorkstations }},
'{{ host }}',
'{{ persistentDirectories }}',
'{{ ephemeralDirectories }}',
'{{ container }}',
'{{ encryptionKey }}',
'{{ readinessChecks }}',
'{{ replicaZones }}',
{{ enableAuditAgent }},
{{ disableTcpConnections }},
'{{ allowedPorts }}',
{{ grantWorkstationAdminRoleOnCreate }},
'{{ projectsId }}',
'{{ locationsId }}',
'{{ workstationClustersId }}',
'{{ workstationConfigId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates an existing workstation configuration.

UPDATE google.workstations.workstation_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__idleTimeout = '{{ idleTimeout }}',
data__runningTimeout = '{{ runningTimeout }}',
data__maxUsableWorkstations = {{ maxUsableWorkstations }},
data__host = '{{ host }}',
data__persistentDirectories = '{{ persistentDirectories }}',
data__ephemeralDirectories = '{{ ephemeralDirectories }}',
data__container = '{{ container }}',
data__encryptionKey = '{{ encryptionKey }}',
data__readinessChecks = '{{ readinessChecks }}',
data__replicaZones = '{{ replicaZones }}',
data__enableAuditAgent = {{ enableAuditAgent }},
data__disableTcpConnections = {{ disableTcpConnections }},
data__allowedPorts = '{{ allowedPorts }}',
data__grantWorkstationAdminRoleOnCreate = {{ grantWorkstationAdminRoleOnCreate }}
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workstationClustersId = '{{ workstationClustersId }}' --required
AND workstationConfigsId = '{{ workstationConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes the specified workstation configuration.

DELETE FROM google.workstations.workstation_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workstationClustersId = '{{ workstationClustersId }}' --required
AND workstationConfigsId = '{{ workstationConfigsId }}' --required
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}'
AND force = '{{ force }}';