WorkstationConfig class

Creates a new workstation configuration.

Constructors

WorkstationConfig(String name, {WorkstationConfigArgs? args, CustomResourceOptions? options})

Creates a new WorkstationConfig. name The Pulumi resource name. args Arguments used to configure this WorkstationConfig. The set of arguments for WorkstationConfig. options Resource options controlling this resource's behavior.

Properties

annotations ↔ Output<Map<String, String>>

Optional. Client-specified annotations.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

conditions ↔ Output<List<Map<String, dynamic>>>

Status conditions describing the current resource state.

late, final

container ↔ Output<ContainerResponse>

Optional. Container that runs upon startup for each workstation using this workstation configuration.

late, final

createTime ↔ Output<String>

Time when this workstation configuration was created.

late, final

degraded ↔ Output<bool>

Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.

late, final

deleteTime ↔ Output<String>

Time when this workstation configuration was soft-deleted.

late, final

displayName ↔ Output<String>

Optional. Human-readable name for this workstation configuration.

late, final

encryptionKey ↔ Output<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.

late, final

etag ↔ Output<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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

host ↔ Output<HostResponse>

Optional. Runtime host for the workstation.

late, final

id ↔ Output<String>

getter/setter pair, inherited

idleTimeout ↔ Output<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).

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

Identifier. Full name of this workstation configuration.

late, final

persistentDirectories ↔ Output<List<Map<String, dynamic>>>

Optional. Directories to persist across workstation sessions.

late, final

project ↔ Output<String>

late, final

readinessChecks ↔ Output<List<Map<String, dynamic>>>

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.

late, final

reconciling ↔ Output<bool>

Indicates whether this workstation configuration is currently being updated to match its intended state.

late, final

replicaZones ↔ Output<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.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runningTimeout ↔ Output<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.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

A system-assigned unique identifier for this workstation configuration.

late, final

updateTime ↔ Output<String>

Time when this workstation configuration was most recently updated.

late, final

urn ↔ Output<String>

late, final, inherited

workstationClusterId ↔ Output<String>

late, final

workstationConfigId ↔ Output<String>

Required. ID to use for the workstation configuration.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited