Class WorkstationConfig
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.
Implements
Inherited Members
Namespace: Google.Apis.CloudWorkstations.v1.Data
Assembly: Google.Apis.CloudWorkstations.v1.dll
Syntax
public class WorkstationConfig : IDirectResponseSchema
Properties
AllowedPorts
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.
Declaration
[JsonProperty("allowedPorts")]
public virtual IList<PortRange> AllowedPorts { get; set; }
Property Value
Type | Description |
---|---|
IList<PortRange> |
Annotations
Optional. Client-specified annotations.
Declaration
[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
Conditions
Output only. Status conditions describing the current resource state.
Declaration
[JsonProperty("conditions")]
public virtual IList<Status> Conditions { get; set; }
Property Value
Type | Description |
---|---|
IList<Status> |
Container
Optional. Container that runs upon startup for each workstation using this workstation configuration.
Declaration
[JsonProperty("container")]
public virtual Container Container { get; set; }
Property Value
Type | Description |
---|---|
Container |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Time when this workstation configuration was created.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
Degraded
Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
Declaration
[JsonProperty("degraded")]
public virtual bool? Degraded { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DeleteTime
object representation of DeleteTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DeleteTimeDateTimeOffset instead.")]
public virtual object DeleteTime { get; set; }
Property Value
Type | Description |
---|---|
object |
DeleteTimeDateTimeOffset
DateTimeOffset representation of DeleteTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? DeleteTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
DeleteTimeRaw
Output only. Time when this workstation configuration was soft-deleted.
Declaration
[JsonProperty("deleteTime")]
public virtual string DeleteTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
DisableTcpConnections
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.
Declaration
[JsonProperty("disableTcpConnections")]
public virtual bool? DisableTcpConnections { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DisplayName
Optional. Human-readable name for this workstation configuration.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EnableAuditAgent
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"
Declaration
[JsonProperty("enableAuditAgent")]
public virtual bool? EnableAuditAgent { get; set; }
Property Value
Type | Description |
---|---|
bool? |
EncryptionKey
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.
Declaration
[JsonProperty("encryptionKey")]
public virtual CustomerEncryptionKey EncryptionKey { get; set; }
Property Value
Type | Description |
---|---|
CustomerEncryptionKey |
EphemeralDirectories
Optional. Ephemeral directories which won't persist across workstation sessions.
Declaration
[JsonProperty("ephemeralDirectories")]
public virtual IList<EphemeralDirectory> EphemeralDirectories { get; set; }
Property Value
Type | Description |
---|---|
IList<EphemeralDirectory> |
GrantWorkstationAdminRoleOnCreate
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.
Declaration
[JsonProperty("grantWorkstationAdminRoleOnCreate")]
public virtual bool? GrantWorkstationAdminRoleOnCreate { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Host
Optional. Runtime host for the workstation.
Declaration
[JsonProperty("host")]
public virtual Host Host { get; set; }
Property Value
Type | Description |
---|---|
Host |
IdleTimeout
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).
Declaration
[JsonProperty("idleTimeout")]
public virtual object IdleTimeout { get; set; }
Property Value
Type | Description |
---|---|
object |
Labels
Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, string> |
MaxUsableWorkstations
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.
Declaration
[JsonProperty("maxUsableWorkstations")]
public virtual int? MaxUsableWorkstations { get; set; }
Property Value
Type | Description |
---|---|
int? |
Name
Identifier. Full name of this workstation configuration.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
PersistentDirectories
Optional. Directories to persist across workstation sessions.
Declaration
[JsonProperty("persistentDirectories")]
public virtual IList<PersistentDirectory> PersistentDirectories { get; set; }
Property Value
Type | Description |
---|---|
IList<PersistentDirectory> |
ReadinessChecks
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.
Declaration
[JsonProperty("readinessChecks")]
public virtual IList<ReadinessCheck> ReadinessChecks { get; set; }
Property Value
Type | Description |
---|---|
IList<ReadinessCheck> |
Reconciling
Output only. Indicates whether this workstation configuration is currently being updated to match its intended state.
Declaration
[JsonProperty("reconciling")]
public virtual bool? Reconciling { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ReplicaZones
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.
Declaration
[JsonProperty("replicaZones")]
public virtual IList<string> ReplicaZones { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
RunningTimeout
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.
Declaration
[JsonProperty("runningTimeout")]
public virtual object RunningTimeout { get; set; }
Property Value
Type | Description |
---|---|
object |
Uid
Output only. A system-assigned unique identifier for this workstation configuration.
Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Output only. Time when this workstation configuration was most recently updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |