Skip to main content

workstation_configs

Overview

Nameworkstation_configs
TypeResource
Idgoogle.workstations.workstation_configs

Fields

NameDatatypeDescription
namestringFull name of this workstation configuration.
idleTimeoutstringOptional. 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).
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 logging.buckets.write permission on the project. Operating system audit logging is distinct from Cloud Audit Logs.
reconcilingbooleanOutput only. Indicates whether this workstation configuration is currently being updated to match its intended state.
runningTimeoutstringOptional. 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.
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.
updateTimestringOutput only. Time when this workstation configuration was most recently updated.
deleteTimestringOutput only. Time when this workstation configuration was soft-deleted.
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.
encryptionKeyobjectA customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices.
conditionsarrayOutput only. Status conditions describing the current resource state.
degradedbooleanOutput only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
containerobjectA Docker container.
hostobjectRuntime host for a workstation.
persistentDirectoriesarrayOptional. Directories to persist across workstation sessions.
annotationsobjectOptional. Client-specified annotations.
labelsobjectOptional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
uidstringOutput only. A system-assigned unique identifier for this workstation configuration.
createTimestringOutput only. Time when this workstation configuration was created.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocationsId, projectsId, workstationClustersId, workstationConfigsIdReturns the requested workstation configuration.
listSELECTlocationsId, projectsId, workstationClustersIdReturns all workstation configurations in the specified cluster.
createINSERTlocationsId, projectsId, workstationClustersIdCreates a new workstation configuration.
deleteDELETElocationsId, projectsId, workstationClustersId, workstationConfigsIdDeletes the specified workstation configuration.
_listEXEClocationsId, projectsId, workstationClustersIdReturns all workstation configurations in the specified cluster.
patchEXEClocationsId, projectsId, workstationClustersId, workstationConfigsIdUpdates an existing workstation configuration.