Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.workstations/v1beta.getWorkstationConfig

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Using getWorkstationConfig

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getWorkstationConfig(args: GetWorkstationConfigArgs, opts?: InvokeOptions): Promise<GetWorkstationConfigResult>
function getWorkstationConfigOutput(args: GetWorkstationConfigOutputArgs, opts?: InvokeOptions): Output<GetWorkstationConfigResult>

def get_workstation_config(location: Optional[str] = None,
                           project: Optional[str] = None,
                           workstation_cluster_id: Optional[str] = None,
                           workstation_config_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetWorkstationConfigResult
def get_workstation_config_output(location: Optional[pulumi.Input[str]] = None,
                           project: Optional[pulumi.Input[str]] = None,
                           workstation_cluster_id: Optional[pulumi.Input[str]] = None,
                           workstation_config_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetWorkstationConfigResult]

func LookupWorkstationConfig(ctx *Context, args *LookupWorkstationConfigArgs, opts ...InvokeOption) (*LookupWorkstationConfigResult, error)
func LookupWorkstationConfigOutput(ctx *Context, args *LookupWorkstationConfigOutputArgs, opts ...InvokeOption) LookupWorkstationConfigResultOutput

> Note: This function is named LookupWorkstationConfig in the Go SDK.

public static class GetWorkstationConfig 
{
    public static Task<GetWorkstationConfigResult> InvokeAsync(GetWorkstationConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkstationConfigResult> Invoke(GetWorkstationConfigInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkstationConfigResult> getWorkstationConfig(GetWorkstationConfigArgs args, InvokeOptions options)
public static Output<GetWorkstationConfigResult> getWorkstationConfig(GetWorkstationConfigArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:workstations/v1beta:getWorkstationConfig
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string
WorkstationClusterId string
WorkstationConfigId string
Project string

Location string
WorkstationClusterId string
WorkstationConfigId string
Project string

location String
workstationClusterId String
workstationConfigId String
project String

location string
workstationClusterId string
workstationConfigId string
project string

location str
workstation_cluster_id str
workstation_config_id str
project str

location String
workstationClusterId String
workstationConfigId String
project String

getWorkstationConfig Result

The following output properties are available:

Annotations Dictionary<string, string>: Optional. Client-specified annotations.
Conditions List<Pulumi.GoogleNative.Workstations.V1Beta.Outputs.StatusResponse>: Status conditions describing the current resource state.
Container Pulumi.GoogleNative.Workstations.V1Beta.Outputs.ContainerResponse: Optional. Container that runs upon startup for each workstation using this workstation configuration.
CreateTime string: Time when this workstation configuration was created.
Degraded bool: Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
DeleteTime string: Time when this workstation configuration was soft-deleted.
DisableTcpConnections 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.
DisplayName string: Optional. Human-readable name for this workstation configuration.
EnableAuditAgent 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.
EncryptionKey Pulumi.GoogleNative.Workstations.V1Beta.Outputs.CustomerEncryptionKeyResponse: 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 List<Pulumi.GoogleNative.Workstations.V1Beta.Outputs.EphemeralDirectoryResponse>: 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 Pulumi.GoogleNative.Workstations.V1Beta.Outputs.HostResponse: Optional. Runtime host for the workstation.
IdleTimeout 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).
Labels Dictionary<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 List<Pulumi.GoogleNative.Workstations.V1Beta.Outputs.PersistentDirectoryResponse>: Optional. Directories to persist across workstation sessions.
ReadinessChecks List<Pulumi.GoogleNative.Workstations.V1Beta.Outputs.ReadinessCheckResponse>: 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.
Reconciling bool: Indicates whether this workstation configuration is currently being updated to match its intended state.
ReplicaZones 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.
RunningTimeout 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.
Uid string: A system-assigned unique identifier for this workstation configuration.
UpdateTime string: Time when this workstation configuration was most recently updated.

Annotations map[string]string: Optional. Client-specified annotations.
Conditions []StatusResponse: Status conditions describing the current resource state.
Container ContainerResponse: Optional. Container that runs upon startup for each workstation using this workstation configuration.
CreateTime string: Time when this workstation configuration was created.
Degraded bool: Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
DeleteTime string: Time when this workstation configuration was soft-deleted.
DisableTcpConnections 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.
DisplayName string: Optional. Human-readable name for this workstation configuration.
EnableAuditAgent 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.
EncryptionKey CustomerEncryptionKeyResponse: 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 []EphemeralDirectoryResponse: 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 HostResponse: Optional. Runtime host for the workstation.
IdleTimeout 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).
Labels map[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 []PersistentDirectoryResponse: Optional. Directories to persist across workstation sessions.
ReadinessChecks []ReadinessCheckResponse: 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.
Reconciling bool: 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 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.
Uid string: A system-assigned unique identifier for this workstation configuration.
UpdateTime string: Time when this workstation configuration was most recently updated.

annotations Map<String,String>: Optional. Client-specified annotations.
conditions List<StatusResponse>: Status conditions describing the current resource state.
container ContainerResponse: Optional. Container that runs upon startup for each workstation using this workstation configuration.
createTime String: Time when this workstation configuration was created.
degraded Boolean: Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
deleteTime String: 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 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 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 CustomerEncryptionKeyResponse: 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 List<EphemeralDirectoryResponse>: 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 HostResponse: Optional. Runtime host for the workstation.
idleTimeout 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).
labels Map<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 List<PersistentDirectoryResponse>: Optional. Directories to persist across workstation sessions.
readinessChecks List<ReadinessCheckResponse>: 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.
reconciling Boolean: Indicates whether this workstation configuration is currently being updated to match its intended state.
replicaZones 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.
runningTimeout 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.
uid String: A system-assigned unique identifier for this workstation configuration.
updateTime String: Time when this workstation configuration was most recently updated.

annotations {[key: string]: string}: Optional. Client-specified annotations.
conditions StatusResponse[]: Status conditions describing the current resource state.
container ContainerResponse: Optional. Container that runs upon startup for each workstation using this workstation configuration.
createTime string: Time when this workstation configuration was created.
degraded boolean: Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
deleteTime string: 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 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 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 CustomerEncryptionKeyResponse: 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 EphemeralDirectoryResponse[]: 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 HostResponse: Optional. Runtime host for the workstation.
idleTimeout 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).
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 PersistentDirectoryResponse[]: Optional. Directories to persist across workstation sessions.
readinessChecks ReadinessCheckResponse[]: 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.
reconciling boolean: 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 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.
uid string: A system-assigned unique identifier for this workstation configuration.
updateTime string: Time when this workstation configuration was most recently updated.

annotations Mapping[str, str]: Optional. Client-specified annotations.
conditions Sequence[StatusResponse]: Status conditions describing the current resource state.
container ContainerResponse: Optional. Container that runs upon startup for each workstation using this workstation configuration.
create_time str: Time when this workstation configuration was created.
degraded bool: Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
delete_time str: Time when this workstation configuration was soft-deleted.
disable_tcp_connections 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.
display_name str: Optional. Human-readable name for this workstation configuration.
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.
encryption_key CustomerEncryptionKeyResponse: 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.
ephemeral_directories Sequence[EphemeralDirectoryResponse]: Optional. Ephemeral directories which won't persist across workstation sessions.
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.
host HostResponse: Optional. Runtime host for the workstation.
idle_timeout str: 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 Mapping[str, str]: Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
name str: Identifier. Full name of this workstation configuration.
persistent_directories Sequence[PersistentDirectoryResponse]: Optional. Directories to persist across workstation sessions.
readiness_checks Sequence[ReadinessCheckResponse]: 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.
reconciling bool: Indicates whether this workstation configuration is currently being updated to match its intended state.
replica_zones Sequence[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.
running_timeout str: 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.
uid str: A system-assigned unique identifier for this workstation configuration.
update_time str: Time when this workstation configuration was most recently updated.

annotations Map<String>: Optional. Client-specified annotations.
conditions List<Property Map>: Status conditions describing the current resource state.
container Property Map: Optional. Container that runs upon startup for each workstation using this workstation configuration.
createTime String: Time when this workstation configuration was created.
degraded Boolean: Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
deleteTime String: 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 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 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 Property Map: 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 List<Property Map>: 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 Property Map: Optional. Runtime host for the workstation.
idleTimeout 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).
labels Map<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 List<Property Map>: Optional. Directories to persist across workstation sessions.
readinessChecks List<Property Map>: 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.
reconciling Boolean: Indicates whether this workstation configuration is currently being updated to match its intended state.
replicaZones 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.
runningTimeout 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.
uid String: A system-assigned unique identifier for this workstation configuration.
updateTime String: Time when this workstation configuration was most recently updated.

Supporting Types

AcceleratorResponse

Count int: Optional. Number of accelerator cards exposed to the instance.
Type string: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".

Count int: Optional. Number of accelerator cards exposed to the instance.
Type string: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".

count Integer: Optional. Number of accelerator cards exposed to the instance.
type String: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".

count number: Optional. Number of accelerator cards exposed to the instance.
type string: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".

count int: Optional. Number of accelerator cards exposed to the instance.
type str: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".

count Number: Optional. Number of accelerator cards exposed to the instance.
type String: Optional. Type of accelerator resource to attach to the instance, for example, "nvidia-tesla-p100".

ContainerResponse

Args List<string>: Optional. Arguments passed to the entrypoint.
Command List<string>: Optional. If set, overrides the default ENTRYPOINT specified by the image.
Env Dictionary<string, string>: Optional. Environment variables passed to the container's entrypoint.
Image string: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
RunAsUser int: Optional. If set, overrides the USER specified in the image with the given uid.
WorkingDir string: Optional. If set, overrides the default DIR specified by the image.

Args []string: Optional. Arguments passed to the entrypoint.
Command []string: Optional. If set, overrides the default ENTRYPOINT specified by the image.
Env map[string]string: Optional. Environment variables passed to the container's entrypoint.
Image string: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
RunAsUser int: Optional. If set, overrides the USER specified in the image with the given uid.
WorkingDir string: Optional. If set, overrides the default DIR specified by the image.

args List<String>: Optional. Arguments passed to the entrypoint.
command List<String>: Optional. If set, overrides the default ENTRYPOINT specified by the image.
env Map<String,String>: Optional. Environment variables passed to the container's entrypoint.
image String: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
runAsUser Integer: Optional. If set, overrides the USER specified in the image with the given uid.
workingDir String: Optional. If set, overrides the default DIR specified by the image.

args string[]: Optional. Arguments passed to the entrypoint.
command string[]: Optional. If set, overrides the default ENTRYPOINT specified by the image.
env {[key: string]: string}: Optional. Environment variables passed to the container's entrypoint.
image string: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
runAsUser number: Optional. If set, overrides the USER specified in the image with the given uid.
workingDir string: Optional. If set, overrides the default DIR specified by the image.

args Sequence[str]: Optional. Arguments passed to the entrypoint.
command Sequence[str]: Optional. If set, overrides the default ENTRYPOINT specified by the image.
env Mapping[str, str]: Optional. Environment variables passed to the container's entrypoint.
image str: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
run_as_user int: Optional. If set, overrides the USER specified in the image with the given uid.
working_dir str: Optional. If set, overrides the default DIR specified by the image.

args List<String>: Optional. Arguments passed to the entrypoint.
command List<String>: Optional. If set, overrides the default ENTRYPOINT specified by the image.
env Map<String>: Optional. Environment variables passed to the container's entrypoint.
image String: Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images, but you can create your own custom container images. If using a private image, the host.gceInstance.serviceAccount field must be specified in the workstation configuration. If using a custom container image, the service account must have Artifact Registry Reader permission to pull the specified image. Otherwise, the image must be publicly accessible.
runAsUser Number: Optional. If set, overrides the USER specified in the image with the given uid.
workingDir String: Optional. If set, overrides the default DIR specified by the image.

CustomerEncryptionKeyResponse

KmsKey string: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
KmsKeyServiceAccount string: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

KmsKey string: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
KmsKeyServiceAccount string: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

kmsKey String: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
kmsKeyServiceAccount String: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

kmsKey string: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
kmsKeyServiceAccount string: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

kms_key str: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
kms_key_service_account str: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

kmsKey String: Immutable. The name of the Google Cloud KMS encryption key. For example, "projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME". The key must be in the same region as the workstation configuration.
kmsKeyServiceAccount String: Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties and gcloud kms keys add-iam-policy-binding --member.

EphemeralDirectoryResponse

GcePd Pulumi.GoogleNative.Workstations.V1Beta.Inputs.GcePersistentDiskResponse: An EphemeralDirectory backed by a Compute Engine persistent disk.
MountPath string: Location of this directory in the running workstation.

GcePd GcePersistentDiskResponse: An EphemeralDirectory backed by a Compute Engine persistent disk.
MountPath string: Location of this directory in the running workstation.

gcePd GcePersistentDiskResponse: An EphemeralDirectory backed by a Compute Engine persistent disk.
mountPath String: Location of this directory in the running workstation.

gcePd GcePersistentDiskResponse: An EphemeralDirectory backed by a Compute Engine persistent disk.
mountPath string: Location of this directory in the running workstation.

gce_pd GcePersistentDiskResponse: An EphemeralDirectory backed by a Compute Engine persistent disk.
mount_path str: Location of this directory in the running workstation.

gcePd Property Map: An EphemeralDirectory backed by a Compute Engine persistent disk.
mountPath String: Location of this directory in the running workstation.

GceConfidentialInstanceConfigResponse

EnableConfidentialCompute bool: Optional. Whether the instance has confidential compute enabled.

EnableConfidentialCompute bool: Optional. Whether the instance has confidential compute enabled.

enableConfidentialCompute Boolean: Optional. Whether the instance has confidential compute enabled.

enableConfidentialCompute boolean: Optional. Whether the instance has confidential compute enabled.

enable_confidential_compute bool: Optional. Whether the instance has confidential compute enabled.

enableConfidentialCompute Boolean: Optional. Whether the instance has confidential compute enabled.

GceInstanceResponse

Accelerators List<Pulumi.GoogleNative.Workstations.V1Beta.Inputs.AcceleratorResponse>: Optional. A list of the type and count of accelerator cards attached to the instance.
BootDiskSizeGb 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.
ConfidentialInstanceConfig Pulumi.GoogleNative.Workstations.V1Beta.Inputs.GceConfidentialInstanceConfigResponse: Optional. A set of Compute Engine Confidential VM instance options.
DisablePublicIpAddresses 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).
EnableNestedVirtualization bool: Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. 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: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * GPUs: nested virtualization may not be enabled on workstation configurations with accelerators. * Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
MachineType string: 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.
PoolSize 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.
PooledInstances int: Number of instances currently available in the pool for faster workstation startup.
ServiceAccount string: 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 logginglogEntries.create permission 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 permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don't want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
ServiceAccountScopes List<string>: Optional. Scopes to grant to the service_account. Various scopes are automatically added based on feature usage. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
ShieldedInstanceConfig Pulumi.GoogleNative.Workstations.V1Beta.Inputs.GceShieldedInstanceConfigResponse: Optional. A set of Compute Engine Shielded instance options.
Tags List<string>: Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

Accelerators []AcceleratorResponse: Optional. A list of the type and count of accelerator cards attached to the instance.
BootDiskSizeGb 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.
ConfidentialInstanceConfig GceConfidentialInstanceConfigResponse: Optional. A set of Compute Engine Confidential VM instance options.
DisablePublicIpAddresses 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).
EnableNestedVirtualization bool: Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. 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: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * GPUs: nested virtualization may not be enabled on workstation configurations with accelerators. * Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
MachineType string: 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.
PoolSize 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.
PooledInstances int: Number of instances currently available in the pool for faster workstation startup.
ServiceAccount string: 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 logginglogEntries.create permission 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 permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don't want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
ServiceAccountScopes []string: Optional. Scopes to grant to the service_account. Various scopes are automatically added based on feature usage. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
ShieldedInstanceConfig GceShieldedInstanceConfigResponse: Optional. A set of Compute Engine Shielded instance options.
Tags []string: Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

accelerators List<AcceleratorResponse>: Optional. A list of the type and count of accelerator cards attached to the instance.
bootDiskSizeGb Integer: 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.
confidentialInstanceConfig GceConfidentialInstanceConfigResponse: Optional. A set of Compute Engine Confidential VM instance options.
disablePublicIpAddresses Boolean: 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).
enableNestedVirtualization Boolean: Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. 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: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * GPUs: nested virtualization may not be enabled on workstation configurations with accelerators. * Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
machineType String: 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.
poolSize Integer: 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.
pooledInstances Integer: Number of instances currently available in the pool for faster workstation startup.
serviceAccount String: 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 logginglogEntries.create permission 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 permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don't want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
serviceAccountScopes List<String>: Optional. Scopes to grant to the service_account. Various scopes are automatically added based on feature usage. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
shieldedInstanceConfig GceShieldedInstanceConfigResponse: Optional. A set of Compute Engine Shielded instance options.
tags List<String>: Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

accelerators AcceleratorResponse[]: Optional. A list of the type and count of accelerator cards attached to the instance.
bootDiskSizeGb number: 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.
confidentialInstanceConfig GceConfidentialInstanceConfigResponse: Optional. A set of Compute Engine Confidential VM instance options.
disablePublicIpAddresses boolean: 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).
enableNestedVirtualization boolean: Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. 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: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * GPUs: nested virtualization may not be enabled on workstation configurations with accelerators. * Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
machineType string: 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.
poolSize number: 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.
pooledInstances number: Number of instances currently available in the pool for faster workstation startup.
serviceAccount string: 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 logginglogEntries.create permission 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 permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don't want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
serviceAccountScopes string[]: Optional. Scopes to grant to the service_account. Various scopes are automatically added based on feature usage. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
shieldedInstanceConfig GceShieldedInstanceConfigResponse: Optional. A set of Compute Engine Shielded instance options.
tags string[]: Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

accelerators Sequence[AcceleratorResponse]: Optional. A list of the type and count of accelerator cards attached to the instance.
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.
confidential_instance_config GceConfidentialInstanceConfigResponse: Optional. A set of Compute Engine Confidential VM instance options.
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 under this workstation configuration. 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: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * GPUs: nested virtualization may not be enabled on workstation configurations with accelerators. * Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
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.
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: Number of instances currently available in the pool for faster workstation startup.
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 logginglogEntries.create permission 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 permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don't want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
service_account_scopes Sequence[str]: Optional. Scopes to grant to the service_account. Various scopes are automatically added based on feature usage. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
shielded_instance_config GceShieldedInstanceConfigResponse: Optional. A set of Compute Engine Shielded instance options.
tags Sequence[str]: Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

accelerators List<Property Map>: Optional. A list of the type and count of accelerator cards attached to the instance.
bootDiskSizeGb Number: 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.
confidentialInstanceConfig Property Map: Optional. A set of Compute Engine Confidential VM instance options.
disablePublicIpAddresses Boolean: 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).
enableNestedVirtualization Boolean: Optional. Whether to enable nested virtualization on Cloud Workstations VMs created under this workstation configuration. 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: * Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualization constraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed. * Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * Machine Type: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * GPUs: nested virtualization may not be enabled on workstation configurations with accelerators. * Operating System: Because Container-Optimized OS does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an Ubuntu LTS image.
machineType String: 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.
poolSize Number: 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.
pooledInstances Number: Number of instances currently available in the pool for faster workstation startup.
serviceAccount String: 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 logginglogEntries.create permission 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 permission to pull the specified image. If you as the administrator want to be able to ssh into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs permission. Conversely, if you don't want anyone to be able to ssh into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
serviceAccountScopes List<String>: Optional. Scopes to grant to the service_account. Various scopes are automatically added based on feature usage. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs on the service account.
shieldedInstanceConfig Property Map: Optional. A set of Compute Engine Shielded instance options.
tags List<String>: Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies network tags to VMs created with this configuration. These network tags enable the creation of firewall rules.

GcePersistentDiskResponse

DiskType string: Optional. Type of the disk to use. Defaults to "pd-standard".
ReadOnly bool: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
SourceImage string: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.
SourceSnapshot string: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.

DiskType string: Optional. Type of the disk to use. Defaults to "pd-standard".
ReadOnly bool: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
SourceImage string: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.
SourceSnapshot string: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.

diskType String: Optional. Type of the disk to use. Defaults to "pd-standard".
readOnly Boolean: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
sourceImage String: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.
sourceSnapshot String: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.

diskType string: Optional. Type of the disk to use. Defaults to "pd-standard".
readOnly boolean: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
sourceImage string: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.
sourceSnapshot string: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.

disk_type str: Optional. Type of the disk to use. Defaults to "pd-standard".
read_only bool: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
source_image str: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.
source_snapshot str: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.

diskType String: Optional. Type of the disk to use. Defaults to "pd-standard".
readOnly Boolean: Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
sourceImage String: Optional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. This field is mutable.
sourceSnapshot String: Optional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. This field is mutable.

GceRegionalPersistentDiskResponse

DiskType string: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
FsType string: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
ReclaimPolicy string: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
SizeGb int: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
SourceSnapshot string: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

DiskType string: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
FsType string: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
ReclaimPolicy string: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
SizeGb int: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
SourceSnapshot string: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

diskType String: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
fsType String: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
reclaimPolicy String: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
sizeGb Integer: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
sourceSnapshot String: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

diskType string: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
fsType string: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
reclaimPolicy string: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
sizeGb number: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
sourceSnapshot string: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

disk_type str: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
fs_type str: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
reclaim_policy str: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
size_gb int: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
source_snapshot str: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

diskType String: Optional. The type of the persistent disk for the home directory. Defaults to "pd-standard".
fsType String: Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to "ext4".
reclaimPolicy String: Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are DELETE and RETAIN. Defaults to DELETE.
sizeGb Number: Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are 10, 50, 100, 200, 500, or 1000. Defaults to 200. If less than 200 GB, the disk_type must be "pd-balanced" or "pd-ssd".
sourceSnapshot String: Optional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.

GceShieldedInstanceConfigResponse

EnableIntegrityMonitoring bool: Optional. Whether the instance has integrity monitoring enabled.
EnableSecureBoot bool: Optional. Whether the instance has Secure Boot enabled.
EnableVtpm bool: Optional. Whether the instance has the vTPM enabled.

EnableIntegrityMonitoring bool: Optional. Whether the instance has integrity monitoring enabled.
EnableSecureBoot bool: Optional. Whether the instance has Secure Boot enabled.
EnableVtpm bool: Optional. Whether the instance has the vTPM enabled.

enableIntegrityMonitoring Boolean: Optional. Whether the instance has integrity monitoring enabled.
enableSecureBoot Boolean: Optional. Whether the instance has Secure Boot enabled.
enableVtpm Boolean: Optional. Whether the instance has the vTPM enabled.

enableIntegrityMonitoring boolean: Optional. Whether the instance has integrity monitoring enabled.
enableSecureBoot boolean: Optional. Whether the instance has Secure Boot enabled.
enableVtpm boolean: Optional. Whether the instance has the vTPM enabled.

enable_integrity_monitoring bool: Optional. Whether the instance has integrity monitoring enabled.
enable_secure_boot bool: Optional. Whether the instance has Secure Boot enabled.
enable_vtpm bool: Optional. Whether the instance has the vTPM enabled.

enableIntegrityMonitoring Boolean: Optional. Whether the instance has integrity monitoring enabled.
enableSecureBoot Boolean: Optional. Whether the instance has Secure Boot enabled.
enableVtpm Boolean: Optional. Whether the instance has the vTPM enabled.

HostResponse

GceInstance Pulumi.GoogleNative.Workstations.V1Beta.Inputs.GceInstanceResponse: Specifies a Compute Engine instance as the host.

GceInstance GceInstanceResponse: Specifies a Compute Engine instance as the host.

gceInstance GceInstanceResponse: Specifies a Compute Engine instance as the host.

gceInstance GceInstanceResponse: Specifies a Compute Engine instance as the host.

gce_instance GceInstanceResponse: Specifies a Compute Engine instance as the host.

gceInstance Property Map: Specifies a Compute Engine instance as the host.

PersistentDirectoryResponse

GcePd Pulumi.GoogleNative.Workstations.V1Beta.Inputs.GceRegionalPersistentDiskResponse: A PersistentDirectory backed by a Compute Engine persistent disk.
MountPath string: Optional. Location of this directory in the running workstation.

GcePd GceRegionalPersistentDiskResponse: A PersistentDirectory backed by a Compute Engine persistent disk.
MountPath string: Optional. Location of this directory in the running workstation.

gcePd GceRegionalPersistentDiskResponse: A PersistentDirectory backed by a Compute Engine persistent disk.
mountPath String: Optional. Location of this directory in the running workstation.

gcePd GceRegionalPersistentDiskResponse: A PersistentDirectory backed by a Compute Engine persistent disk.
mountPath string: Optional. Location of this directory in the running workstation.

gce_pd GceRegionalPersistentDiskResponse: A PersistentDirectory backed by a Compute Engine persistent disk.
mount_path str: Optional. Location of this directory in the running workstation.

gcePd Property Map: A PersistentDirectory backed by a Compute Engine persistent disk.
mountPath String: Optional. Location of this directory in the running workstation.

ReadinessCheckResponse

Path string: Optional. Path to which the request should be sent.
Port int: Optional. Port to which the request should be sent.

Path string: Optional. Path to which the request should be sent.
Port int: Optional. Port to which the request should be sent.

path String: Optional. Path to which the request should be sent.
port Integer: Optional. Port to which the request should be sent.

path string: Optional. Path to which the request should be sent.
port number: Optional. Port to which the request should be sent.

path str: Optional. Path to which the request should be sent.
port int: Optional. Port to which the request should be sent.

path String: Optional. Path to which the request should be sent.
port Number: Optional. Port to which the request should be sent.

StatusResponse

Code int: The status code, which should be an enum value of google.rpc.Code.
Details List<ImmutableDictionary<string, string>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Code int: The status code, which should be an enum value of google.rpc.Code.
Details []map[string]string: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Integer: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String,String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code number: The status code, which should be an enum value of google.rpc.Code.
details {[key: string]: string}[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code int: The status code, which should be an enum value of google.rpc.Code.
details Sequence[Mapping[str, str]]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message str: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Number: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.workstations/v1beta.getWorkstationConfig

On this page

On this page

Using getWorkstationConfig

getWorkstationConfig Result

Supporting Types

AcceleratorResponse

ContainerResponse

CustomerEncryptionKeyResponse

EphemeralDirectoryResponse

GceConfidentialInstanceConfigResponse

GceInstanceResponse

GcePersistentDiskResponse

GceRegionalPersistentDiskResponse

GceShieldedInstanceConfigResponse

HostResponse

PersistentDirectoryResponse

ReadinessCheckResponse

StatusResponse

Package Details

On this page

On this page