gcp_workstations_workstation_config

allowed_ports

Type: UNORDERED_LIST_STRUCT
Provider name: allowedPorts
Description: Optional. 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.

• first
  Type: INT32
  Provider name: first
  Description: Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
  
• last
  Type: INT32
  Provider name: last
  Description: Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
  

ancestors

Type: UNORDERED_LIST_STRING

annotations

Type: MAP_STRING_STRING
Provider name: annotations
Description: Optional. Client-specified annotations.

conditions

Type: UNORDERED_LIST_STRUCT
Provider name: conditions
Description: Output only. Status conditions describing the workstation configuration’s current state.

• code
  Type: INT32
  Provider name: code
  Description: The status code, which should be an enum value of google.rpc.Code.
  
• message
  Type: STRING
  Provider name: message
  Description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  

container

Type: STRUCT
Provider name: container
Description: Optional. Container that runs upon startup for each workstation using this workstation configuration.

• args
  Type: UNORDERED_LIST_STRING
  Provider name: args
  Description: Optional. Arguments passed to the entrypoint.
  
• command
  Type: UNORDERED_LIST_STRING
  Provider name: command
  Description: Optional. If set, overrides the default ENTRYPOINT specified by the image.
  
• image
  Type: STRING
  Provider name: image
  Description: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
  
• run_as_user
  Type: INT32
  Provider name: runAsUser
  Description: Optional. If set, overrides the USER specified in the image with the given uid.
  
• working_dir
  Type: STRING
  Provider name: workingDir
  Description: Optional. If set, overrides the default DIR specified by the image.
  

create_time

Type: TIMESTAMP
Provider name: createTime
Description: Output only. Time when this workstation configuration was created.

degraded

Type: BOOLEAN
Provider name: degraded
Description: Output 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.

delete_time

Type: TIMESTAMP
Provider name: deleteTime
Description: Output only. Time when this workstation configuration was soft-deleted.

disable_tcp_connections

Type: BOOLEAN
Provider name: disableTcpConnections
Description: Optional. 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.

enable_audit_agent

Type: BOOLEAN
Provider name: enableAuditAgent
Description: Optional. 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"

encryption_key

Type: STRUCT
Provider name: encryptionKey
Description: Immutable. 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.

• kms_key
  Type: STRING
  Provider name: kmsKey
  Description: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
  
• kms_key_service_account
  Type: STRING
  Provider name: kmsKeyServiceAccount
  Description: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.
  

ephemeral_directories

Type: UNORDERED_LIST_STRUCT
Provider name: ephemeralDirectories
Description: Optional. Ephemeral directories which won’t persist across workstation sessions.

• gce_pd
  Type: STRUCT
  Provider name: gcePd
  Description: An EphemeralDirectory backed by a Compute Engine persistent disk.
  
  • disk_type
    Type: STRING
    Provider name: diskType
    Description: Optional. Type of the disk to use. Defaults to "pd-standard".
    
  • read_only
    Type: BOOLEAN
    Provider name: readOnly
    Description: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
    
  • source_image
    Type: STRING
    Provider name: sourceImage
    Description: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the COS documentation. This field is mutable.
    
  • source_snapshot
    Type: STRING
    Provider name: sourceSnapshot
    Description: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, see the filesystems available in Container-Optimized OS. This field is mutable.
    
• mount_path
  Type: STRING
  Provider name: mountPath
  Description: Required. Location of this directory in the running workstation.
  

etag

Type: STRING
Provider name: etag
Description: 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.

gcp_display_name

Type: STRING
Provider name: displayName
Description: Optional. Human-readable name for this workstation configuration.

grant_workstation_admin_role_on_create

Type: BOOLEAN
Provider name: grantWorkstationAdminRoleOnCreate
Description: Optional. 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.

host

Type: STRUCT
Provider name: host
Description: Optional. Runtime host for the workstation.

• gce_instance
  Type: STRUCT
  Provider name: gceInstance
  Description: Specifies a Compute Engine instance as the host.
  
  • accelerators
    Type: UNORDERED_LIST_STRUCT
    Provider name: accelerators
    Description: Optional. A list of the type and count of accelerator cards attached to the instance.
    
    • count
      Type: INT32
      Provider name: count
      Description: Optional. Number of accelerator cards exposed to the instance.
      
    • type
      Type: STRING
      Provider name: type
      Description: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".
      
  • boost_configs
    Type: UNORDERED_LIST_STRUCT
    Provider name: boostConfigs
    Description: Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
    
    • accelerators
      Type: UNORDERED_LIST_STRUCT
      Provider name: accelerators
      Description: Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to none.
      
      • count
        Type: INT32
        Provider name: count
        Description: Optional. Number of accelerator cards exposed to the instance.
        
      • type
        Type: STRING
        Provider name: type
        Description: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".
        
    • boot_disk_size_gb
      Type: INT32
      Provider name: bootDiskSizeGb
      Description: Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30 GB. Defaults to 50 GB.
      
    • enable_nested_virtualization
      Type: BOOLEAN
      Provider name: enableNestedVirtualization
      Description: Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.
      
    • id
      Type: STRING
      Provider name: id
      Description: Required. The ID to be used for the boost configuration.
      
    • machine_type
      Type: STRING
      Provider name: machineType
      Description: Optional. The type of machine that boosted VM instances will use—for example, e2-standard-4. For more information about machine types that Cloud Workstations supports, see the list of available machine types. Defaults to e2-standard-4.
      
    • pool_size
      Type: INT32
      Provider name: poolSize
      Description: Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0.
      
  • boot_disk_size_gb
    Type: INT32
    Provider name: bootDiskSizeGb
    Description: Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30 GB. Defaults to 50 GB.
    
  • confidential_instance_config
    Type: STRUCT
    Provider name: confidentialInstanceConfig
    Description: Optional. A set of Compute Engine Confidential VM instance options.
    
    • enable_confidential_compute
      Type: BOOLEAN
      Provider name: enableConfidentialCompute
      Description: Optional. Whether the instance has confidential compute enabled.
      
  • disable_public_ip_addresses
    Type: BOOLEAN
    Provider name: disablePublicIpAddresses
    Description: Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use private.googleapis.com or restricted.googleapis.com for Container Registry and Artifact Registry, make sure that you set up DNS records for domains *.gcr.io and *.pkg.dev. Defaults to false (VMs have public IP addresses).
    
  • disable_ssh
    Type: BOOLEAN
    Provider name: disableSsh
    Description: Optional. Whether to disable SSH access to the VM.
    
  • enable_nested_virtualization
    Type: BOOLEAN
    Provider name: enableNestedVirtualization
    Description: Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.
    
  • machine_type
    Type: STRING
    Provider name: machineType
    Description: Optional. The type of machine to use for VM instances—for example, "e2-standard-4". For more information about machine types that Cloud Workstations supports, see the list of available machine types.
    
  • pool_size
    Type: INT32
    Provider name: poolSize
    Description: Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to 0 in the API.
    
  • pooled_instances
    Type: INT32
    Provider name: pooledInstances
    Description: Output only. Number of instances currently available in the pool for faster workstation startup.
    
  • service_account
    Type: STRING
    Provider name: serviceAccount
    Description: Optional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has logging.logEntries.create and monitoring.timeSeries.create permissions on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don’t want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
    
  • service_account_scopes
    Type: UNORDERED_LIST_STRING
    Provider name: serviceAccountScopes
    Description: Optional. Scopes to grant to the service_account. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
    
  • shielded_instance_config
    Type: STRUCT
    Provider name: shieldedInstanceConfig
    Description: Optional. A set of Compute Engine Shielded instance options.
    
    • enable_integrity_monitoring
      Type: BOOLEAN
      Provider name: enableIntegrityMonitoring
      Description: Optional. Whether the instance has integrity monitoring enabled.
      
    • enable_secure_boot
      Type: BOOLEAN
      Provider name: enableSecureBoot
      Description: Optional. Whether the instance has Secure Boot enabled.
      
    • enable_vtpm
      Type: BOOLEAN
      Provider name: enableVtpm
      Description: Optional. Whether the instance has the vTPM enabled.
      

idle_timeout

Type: STRING
Provider name: idleTimeout
Description: 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).

labels

Type: UNORDERED_LIST_STRING

max_usable_workstations

Type: INT32
Provider name: maxUsableWorkstations
Description: 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.

name

Type: STRING
Provider name: name
Description: Identifier. Full name of this workstation configuration.

organization_id

Type: STRING

parent

Type: STRING

persistent_directories

Type: UNORDERED_LIST_STRUCT
Provider name: persistentDirectories
Description: Optional. Directories to persist across workstation sessions.

• gce_pd
  Type: STRUCT
  Provider name: gcePd
  Description: A PersistentDirectory backed by a Compute Engine persistent disk.
  
  • disk_type
    Type: STRING
    Provider name: diskType
    Description: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
    
  • fs_type
    Type: STRING
    Provider name: fsType
    Description: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
    
  • reclaim_policy
    Type: STRING
    Provider name: reclaimPolicy
    Description: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
    Possible values:
    
    • RECLAIM_POLICY_UNSPECIFIED - Do not use.
      
    • DELETE - Delete the persistent disk when deleting the workstation.
      
    • RETAIN - Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk.
      
  • size_gb
    Type: INT32
    Provider name: sizeGb
    Description: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
    
  • source_snapshot
    Type: STRING
    Provider name: sourceSnapshot
    Description: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty. Must be formatted as ext4 file system with no partitions.
    
• mount_path
  Type: STRING
  Provider name: mountPath
  Description: Optional. Location of this directory in the running workstation.
  

project_id

Type: STRING

project_number

Type: STRING

readiness_checks

Type: UNORDERED_LIST_STRUCT
Provider name: readinessChecks
Description: Optional. 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.

• path
  Type: STRING
  Provider name: path
  Description: Optional. Path to which the request should be sent.
  
• port
  Type: INT32
  Provider name: port
  Description: Optional. Port to which the request should be sent.
  

reconciling

Type: BOOLEAN
Provider name: reconciling
Description: Output only. Indicates whether this workstation configuration is currently being updated to match its intended state.

replica_zones

Type: UNORDERED_LIST_STRING
Provider name: replicaZones
Description: Optional. 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.

resource_name

Type: STRING

running_timeout

Type: STRING
Provider name: runningTimeout
Description: 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.

tags

Type: UNORDERED_LIST_STRING

uid

Type: STRING
Provider name: uid
Description: Output only. A system-assigned unique identifier for this workstation configuration.

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Time when this workstation configuration was most recently updated.