WorkstationConfigWorkstationsV1betaArgs class

The set of arguments for WorkstationConfig. The set of arguments for WorkstationConfig.

Constructors

WorkstationConfigWorkstationsV1betaArgs({Input<Map<String, String>>? annotations, Input<ContainerWorkstationsV1beta>? container, Input<bool>? disableTcpConnections, Input<String>? displayName, Input<bool>? enableAuditAgent, Input<CustomerEncryptionKeyWorkstationsV1beta>? encryptionKey, Input<List<EphemeralDirectory>>? ephemeralDirectories, Input<String>? etag, Input<HostWorkstationsV1beta>? host, Input<String>? idleTimeout, Input<Map<String, String>>? labels, Input<String>? location, Input<String>? name, Input<List<PersistentDirectoryWorkstationsV1beta>>? persistentDirectories, Input<String>? project, Input<List<ReadinessCheckWorkstationsV1beta>>? readinessChecks, Input<List<String>>? replicaZones, Input<String>? runningTimeout, required Input<String> workstationClusterId, required Input<String> workstationConfigId})
Creates a new WorkstationConfigWorkstationsV1betaArgs. annotations Optional. Client-specified annotations. container Optional. Container that runs upon startup for each workstation using this workstation configuration. disableTcpConnections Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections via 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 Optional. Human-readable name for this workstation configuration. enableAuditAgent 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 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 Optional. Ephemeral directories which won't persist across workstation sessions. 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. host Optional. Runtime host for the workstation. 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). labels Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. location Optional. name Identifier. Full name of this workstation configuration. persistentDirectories Optional. Directories to persist across workstation sessions. project Optional. 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. 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. 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. workstationClusterId Required. workstationConfigId Required. ID to use for the workstation configuration.
const
WorkstationConfigWorkstationsV1betaArgs.fromMap(Map<String, dynamic> map)
factory

Properties

annotations → Input<Map<String, String>>?
Optional. Client-specified annotations.
final
container → Input<ContainerWorkstationsV1beta>?
Optional. Container that runs upon startup for each workstation using this workstation configuration.
final
disableTcpConnections → Input<bool>?
Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections via 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.
final
displayName → Input<String>?
Optional. Human-readable name for this workstation configuration.
final
enableAuditAgent → Input<bool>?
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.
final
encryptionKey → Input<CustomerEncryptionKeyWorkstationsV1beta>?
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.
final
ephemeralDirectories → Input<List<EphemeralDirectory>>?
Optional. Ephemeral directories which won't persist across workstation sessions.
final
etag → Input<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.
final
hashCode → int
The hash code for this object.
no setterinherited
host → Input<HostWorkstationsV1beta>?
Optional. Runtime host for the workstation.
final
idleTimeout → Input<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 terminated by s for seconds—for example, "7200s" (2 hours). The default is "1200s" (20 minutes).
final
labels → Input<Map<String, String>>?
Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
final
location → Input<String>?
final
name → Input<String>?
Identifier. Full name of this workstation configuration.
final
persistentDirectories → Input<List<PersistentDirectoryWorkstationsV1beta>>?
Optional. Directories to persist across workstation sessions.
final
project → Input<String>?
final
readinessChecks → Input<List<ReadinessCheckWorkstationsV1beta>>?
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.
final
replicaZones → Input<List<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.
final
runningTimeout → Input<String>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
workstationClusterId → Input<String>
final
workstationConfigId → Input<String>
Required. ID to use for the workstation configuration.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited