01README
Google Cloud workstations infrastructure models
02Models
@swamp/gcp/workstations/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync()
Sync locations state from GCP
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/workstations/workstationclustersv2026.04.23.1workstationclusters.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Optional. Client-specified annotations. |
| displayName? | string | Optional. Human-readable name for this workstation cluster. |
| domainConfig? | object | Configuration options for a custom domain. |
| gatewayConfig? | object | Configuration options for Cluster HTTP Gateway. |
| labels? | record | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. |
| name? | string | Identifier. Full name of this workstation cluster. |
| 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. |
| 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. |
| tags? | record | Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" |
| workstationAuthorizationUrl? | string | Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded `state` query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using `GenerateAccessToken` and redirecting back to the original hostname with the token. |
| workstationLaunchUrl? | string | Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a `workstation` and `project` query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches `STATE_RUNNING`, and then issuing a redirect to the workstation's host URL. |
| workstationClusterId? | string | Required. ID to use for the workstation cluster. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a workstationClusters
fn get(identifier: string)
Get a workstationClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workstationClusters |
fn update()
Update workstationClusters attributes
fn delete(identifier: string)
Delete the workstationClusters
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workstationClusters |
fn sync()
Sync workstationClusters state from GCP
Resources
state(infinite)— A workstation cluster resource in the Cloud Workstations API. Defines a group...
@swamp/gcp/workstations/workstationclusters-workstationconfigsv2026.04.23.1workstationclusters_workstationconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| allowedPorts? | array | 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. |
| annotations? | record | Optional. Client-specified annotations. |
| container? | object | A Docker container. |
| disableTcpConnections? | boolean | 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. |
| displayName? | string | Optional. Human-readable name for this workstation configuration. |
| enableAuditAgent? | boolean | 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](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cl |
| encryptionKey? | object | A 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](https://cloud.google.com/kms/docs/separation-of-duties). |
| ephemeralDirectories? | array | Optional. Ephemeral directories which won't persist across workstation sessions. |
| grantWorkstationAdminRoleOnCreate? | boolean | 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? | object | Runtime host for a workstation. |
| idleTimeout? | string | 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](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). |
| labels? | record | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. |
| maxUsableWorkstations? | number | 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, defaul |
| name? | string | Identifier. Full name of this workstation configuration. |
| persistentDirectories? | array | Optional. Directories to persist across workstation sessions. |
| readinessChecks? | array | 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. |
| replicaZones? | array | 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. |
| runningTimeout? | string | Optional. Number of seconds that a workstation can run until it is automatically shut down. This field applies to workstations in both STATE_RUNNING and STATE_SUSPENDED. 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 |
| workstationConfigId? | string | Required. ID to use for the workstation configuration. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a workstationConfigs
fn get(identifier: string)
Get a workstationConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workstationConfigs |
fn update()
Update workstationConfigs attributes
fn delete(identifier: string)
Delete the workstationConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workstationConfigs |
fn sync()
Sync workstationConfigs state from GCP
fn list_usable()
list usable
Resources
state(infinite)— A workstation configuration resource in the Cloud Workstations API. Workstati...
@swamp/gcp/workstations/workstationclusters-workstationconfigs-workstationsv2026.04.23.1workstationclusters_workstationconfigs_workstations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| annotations? | record | Optional. Client-specified annotations. |
| displayName? | string | Optional. Human-readable name for this workstation. |
| env? | record | Optional. Environment variables passed to the workstation container's entrypoint. |
| labels? | record | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources. |
| name? | string | Identifier. Full name of this workstation. |
| runtimeHost? | object | Runtime host for the workstation. |
| sourceWorkstation? | string | Optional. The source workstation from which this workstation's persistent directories were cloned on creation. |
| workstationId? | string | Required. ID to use for the workstation. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a workstations
fn get(identifier: string)
Get a workstations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workstations |
fn update()
Update workstations attributes
fn delete(identifier: string)
Delete the workstations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workstations |
fn sync()
Sync workstations state from GCP
fn generate_access_token(expireTime?: any, port?: any, ttl?: any)
generate access token
| Argument | Type | Description |
|---|---|---|
| expireTime? | any | |
| port? | any | |
| ttl? | any |
fn list_usable()
list usable
fn start(boostConfig?: any, etag?: any, validateOnly?: any)
start
| Argument | Type | Description |
|---|---|---|
| boostConfig? | any | |
| etag? | any | |
| validateOnly? | any |
fn stop(etag?: any, validateOnly?: any)
stop
| Argument | Type | Description |
|---|---|---|
| etag? | any | |
| validateOnly? | any |
Resources
state(infinite)— A single instance of a developer workstation with its own persistent storage.
03Previous Versions
2026.04.11.1Apr 11, 2026
- Updated: workstationclusters
2026.04.09.1Apr 9, 2026
- Updated: workstationclusters
2026.04.08.1Apr 8, 2026
- Updated: workstationclusters
2026.04.04.1Apr 4, 2026
- Updated: workstationclusters_workstationconfigs
2026.04.03.3Apr 3, 2026
- Updated: locations, workstationclusters, workstationclusters_workstationconfigs, workstationclusters_workstationconfigs_workstations
2026.04.03.1Apr 3, 2026
- Updated: locations, workstationclusters, workstationclusters_workstationconfigs, workstationclusters_workstationconfigs_workstations
2026.04.02.2Apr 2, 2026
- Updated: workstationclusters_workstationconfigs
2026.03.27.1Mar 27, 2026
- Added: locations, workstationclusters, workstationclusters_workstationconfigs, workstationclusters_workstationconfigs_workstations
04Stats
A
100 / 100
Downloads
0
Archive size
46.2 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels