WorkstationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)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) <https://cloud.google.com/iam/docs/overview>__ rules to grant
access to teams or to individual developers.
Attributes | |
|---|---|
| Name | Description |
name |
str
Full name of this workstation configuration. |
display_name |
str
Optional. Human-readable name for this workstation configuration. |
uid |
str
Output only. A system-assigned unique identifier for this workstation configuration. |
reconciling |
bool
Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. |
annotations |
MutableMapping[str, str]
Optional. Client-specified annotations. |
labels |
MutableMapping[str, str]
Optional. Labels __
that are applied to the workstation configuration and that
are also propagated to the underlying Compute Engine
resources.
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when this workstation configuration was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when this workstation configuration was most recently updated. |
delete_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Time when this workstation configuration was soft-deleted. |
etag |
str
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. |
idle_timeout |
google.protobuf.duration_pb2.Duration
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).
|
running_timeout |
google.protobuf.duration_pb2.Duration
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.
|
host |
google.cloud.workstations_v1beta.types.WorkstationConfig.Host
Optional. Runtime host for the workstation. |
persistent_directories |
MutableSequence[google.cloud.workstations_v1beta.types.WorkstationConfig.PersistentDirectory]
Optional. Directories to persist across workstation sessions. |
ephemeral_directories |
MutableSequence[google.cloud.workstations_v1beta.types.WorkstationConfig.EphemeralDirectory]
Optional. Ephemeral directories which won't persist across workstation sessions. |
container |
google.cloud.workstations_v1beta.types.WorkstationConfig.Container
Optional. Container that runs upon startup for each workstation using this workstation configuration. |
encryption_key |
google.cloud.workstations_v1beta.types.WorkstationConfig.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. |
readiness_checks |
MutableSequence[google.cloud.workstations_v1beta.types.WorkstationConfig.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. |
replica_zones |
MutableSequence[str]
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.
|
degraded |
bool
Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field. |
conditions |
MutableSequence[google.rpc.status_pb2.Status]
Output only. Status conditions describing the current resource state. |
enable_audit_agent |
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 |
Classes
AnnotationsEntry
AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
Container
Container(mapping=None, *, ignore_unknown_fields=False, **kwargs)A Docker container.
CustomerEncryptionKey
CustomerEncryptionKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)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>__.
EphemeralDirectory
EphemeralDirectory(mapping=None, *, ignore_unknown_fields=False, **kwargs)An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Host
Host(mapping=None, *, ignore_unknown_fields=False, **kwargs)Runtime host for a workstation.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
PersistentDirectory
PersistentDirectory(mapping=None, *, ignore_unknown_fields=False, **kwargs)A directory to persist across workstation sessions.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReadinessCheck
ReadinessCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)A readiness check to be performed on a workstation.