GceInstance(mapping=None, *, ignore_unknown_fields=False, **kwargs)A runtime using a Compute Engine instance.
Attributes |
|
|---|---|
| Name | Description |
machine_type |
str
Optional. The type of machine to use for VM instances—for example, "e2-standard-4". For more information about
machine types that Cloud Workstations supports, see the list
of `available machine
types |
service_account |
str
Optional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has logging.logEntries.create and
monitoring.timeSeries.create permissions on the project
so it can write logs out to Cloud Logging. If using a custom
container image, the service account must have `Artifact
Registry
Reader |
service_account_scopes |
MutableSequence[str]
Optional. Scopes to grant to the service_account. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the
service account.
|
tags |
MutableSequence[str]
Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies `network tags |
pool_size |
int
Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to 0 in the API.
|
pooled_instances |
int
Output only. Number of instances currently available in the pool for faster workstation startup. |
disable_public_ip_addresses |
bool
Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use private.googleapis.com or restricted.googleapis.com
for Container Registry and Artifact Registry, make sure that
you set up DNS records for domains *.gcr.io and
*.pkg.dev. Defaults to false (VMs have public IP
addresses).
|
enable_nested_virtualization |
bool
Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the `same restrictions as Compute Engine instances |
shielded_instance_config |
google.cloud.workstations_v1beta.types.WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig
Optional. A set of Compute Engine Shielded instance options. |
confidential_instance_config |
google.cloud.workstations_v1beta.types.WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig
Optional. A set of Compute Engine Confidential VM instance options. |
boot_disk_size_gb |
int
Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30 GB. Defaults to
50 GB.
|
accelerators |
MutableSequence[google.cloud.workstations_v1beta.types.WorkstationConfig.Host.GceInstance.Accelerator]
Optional. A list of the type and count of accelerator cards attached to the instance. |
boost_configs |
MutableSequence[google.cloud.workstations_v1beta.types.WorkstationConfig.Host.GceInstance.BoostConfig]
Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation. |
disable_ssh |
bool
Optional. Whether to disable SSH access to the VM. |
vm_tags |
MutableMapping[str, str]
Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as `resource manager tags |
reservation_affinity |
google.cloud.workstations_v1beta.types.WorkstationConfig.Host.GceInstance.ReservationAffinity
Optional. ReservationAffinity __
specifies a reservation that can be consumed to create VM
instances. If SPECIFIC_RESERVATION is specified, Cloud
Workstations will only create VMs in the zone where the
reservation is located. This would affect availability since
the service will no longer be resilient to zonal outages. If
ANY_RESERVATION is specified, creating reservations in both
zones that the config creates VMs in will ensure higher
availability. **Important Considerations for Reservation
Affinity:**
- This feature is intended for advanced users and requires
familiarity with Google Compute Engine reservations.
- Using reservations incurs charges, regardless of
utilization.
- The resources in the pool will consume the specified
reservation. Take this into account when setting the pool
size.
|
startup_script_uri |
str
Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have `Permission to access the bucket and script file in Cloud Storage |
instance_metadata |
MutableMapping[str, str]
Optional. Custom metadata to apply to Compute Engine instances. |
Classes
Accelerator
Accelerator(mapping=None, *, ignore_unknown_fields=False, **kwargs)An accelerator card attached to the instance.
BoostConfig
BoostConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.
GceConfidentialInstanceConfig
GceConfidentialInstanceConfig(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)A set of Compute Engine Confidential VM instance options.
GceShieldedInstanceConfig
GceShieldedInstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)A set of Compute Engine Shielded instance options.
InstanceMetadataEntry
InstanceMetadataEntry(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 |
ReservationAffinity
ReservationAffinity(mapping=None, *, ignore_unknown_fields=False, **kwargs)ReservationAffinity is the configuration of the desired reservation from which instances can consume resources.
VmTagsEntry
VmTagsEntry(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 |