Resource: WorkstationCluster
A workstation cluster resource in the Cloud Workstations API.
Defines a group of workstations in a particular region and the VPC network they're attached to.
JSON representation |
---|
{ "name": string, "displayName": string, "uid": string, "reconciling": boolean, "annotations": { string: string, ... }, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "etag": string, "network": string, "subnetwork": string, "controlPlaneIp": string, "privateClusterConfig": { object ( |
Fields | |
---|---|
name |
Identifier. Full name of this workstation cluster. |
display |
Optional. Human-readable name for this workstation cluster. |
uid |
Output only. A system-assigned unique identifier for this workstation cluster. |
reconciling |
Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. |
annotations |
Optional. Client-specified annotations. An object containing a list of |
labels |
Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. An object containing a list of |
create |
Output only. Time when this workstation cluster was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. Time when this workstation cluster was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
delete |
Output only. Time when this workstation cluster was soft-deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
etag |
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. |
network |
Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. |
subnetwork |
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. |
control |
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. |
private |
Optional. Configuration for private workstation cluster. |
domain |
Optional. Configuration options for a custom domain. |
degraded |
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[] |
Output only. Status conditions describing the workstation cluster's current state. |
tags |
Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" An object containing a list of |
PrivateClusterConfig
Configuration options for private workstation clusters.
JSON representation |
---|
{ "enablePrivateEndpoint": boolean, "clusterHostname": string, "serviceAttachmentUri": string, "allowedProjects": [ string ] } |
Fields | |
---|---|
enable |
Immutable. Whether Workstations endpoint is private. |
cluster |
Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. |
service |
Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect. |
allowed |
Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. |
DomainConfig
Configuration options for a custom domain.
JSON representation |
---|
{ "domain": string } |
Fields | |
---|---|
domain |
Immutable. Domain used by Workstations for HTTP ingress. |
Methods |
|
---|---|
|
Creates a new workstation cluster. |
|
Deletes the specified workstation cluster. |
|
Returns the requested workstation cluster. |
|
Returns all workstation clusters in the specified location. |
|
Updates an existing workstation cluster. |