Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

WorkstationConfig

import type { WorkstationConfig } from "https://googleapis.deno.dev/v1/workstations:v1.ts";

A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) rules to grant access to teams or to individual developers.

interface WorkstationConfig {

annotations?: {

[key: string]: string;

};

readonly conditions?: Status[];

container?: Container;

readonly createTime?: Date;

readonly degraded?: boolean;

readonly deleteTime?: Date;

disableTcpConnections?: boolean;

displayName?: string;

enableAuditAgent?: boolean;

encryptionKey?: CustomerEncryptionKey;

ephemeralDirectories?: EphemeralDirectory[];

etag?: string;

host?: Host;

idleTimeout?: number;

labels?: {

[key: string]: string;

};

name?: string;

persistentDirectories?: PersistentDirectory[];

readinessChecks?: ReadinessCheck[];

readonly reconciling?: boolean;

replicaZones?: string[];

runningTimeout?: number;

readonly uid?: string;

readonly updateTime?: Date;

}

§Properties

annotations?: {

[key: string]: string;

}

Optional. Client-specified annotations.

readonly conditions?: Status[]

Output only. Status conditions describing the current resource state.

container?: Container

Optional. Container that runs upon startup for each workstation using this workstation configuration.

readonly createTime?: Date

Output only. Time when this workstation configuration was created.

readonly degraded?: boolean

Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.

readonly deleteTime?: Date

Output only. Time when this workstation configuration was soft-deleted.

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 logging.buckets.write permission on the project. Operating system audit logging is distinct from Cloud Audit Logs.

encryptionKey?: CustomerEncryptionKey

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.

ephemeralDirectories?: EphemeralDirectory[]

Optional. Ephemeral directories which won't persist across workstation sessions.

etag?: string

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.

host?: Host

Optional. Runtime host for the workstation.

idleTimeout?: number

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?: {

[key: string]: string;

}

Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.

name?: string

Identifier. Full name of this workstation configuration.

persistentDirectories?: PersistentDirectory[]

Optional. Directories to persist across workstation sessions.

readinessChecks?: ReadinessCheck[]

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.

readonly reconciling?: boolean

Output only. Indicates whether this workstation configuration is currently being updated to match its intended state.

replicaZones?: string[]

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?: number

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.

readonly uid?: string

Output only. A system-assigned unique identifier for this workstation configuration.

readonly updateTime?: Date

Output only. Time when this workstation configuration was most recently updated.