InstanceArgs class - workbench library

Constructors

InstanceArgs({Input<String?>? deletionPolicy, Input<String?>? desiredState, Input<bool?>? disableProxyAccess, Input<bool?>? enableDeletionProtection, Input<bool?>? enableManagedEuc, Input<bool?>? enableThirdPartyIdentity, Input<InstanceGceSetup?>? gceSetup, Input<String?>? instanceId, Input<List<String>?>? instanceOwners, Input<Map<String, String>?>? labels, required Input<String> location, Input<String?>? name, Input<String?>? project}): Creates a new InstanceArgs. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. desiredState Desired state of the Workbench Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance. disableProxyAccess Optional. If true, the workbench instance will not register with the proxy. enableDeletionProtection Optional. If true, deletion protection will be enabled for this Workbench Instance. enableManagedEuc Flag to enable managed end user credentials for the instance. enableThirdPartyIdentity Flag that specifies that a notebook can be accessed with third party gceSetup The definition of how to configure a VM instance outside of Resources and Identity. instanceId Required. User-defined unique ID of this instance. instanceOwners 'Optional. Input only. The owner of this instance after creation. Format: labels Optional. Labels to apply to this instance. These can be later modified location Part of parent. See documentation of projectsId. name The name of this workbench instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id} project The ID of the project in which the resource belongs.
const
InstanceArgs.fromMap(Map<String, dynamic> map): factory

Properties

deletionPolicy → Input<String?>?: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
desiredState → Input<String?>?: Desired state of the Workbench Instance. Set this field to ACTIVE to start the Instance, and STOPPED to stop the Instance.
final
disableProxyAccess → Input<bool?>?: Optional. If true, the workbench instance will not register with the proxy.
final
enableDeletionProtection → Input<bool?>?: Optional. If true, deletion protection will be enabled for this Workbench Instance.
final
enableManagedEuc → Input<bool?>?: Flag to enable managed end user credentials for the instance.
final
enableThirdPartyIdentity → Input<bool?>?: Flag that specifies that a notebook can be accessed with third party identity provider.
final
gceSetup → Input<InstanceGceSetup?>?: The definition of how to configure a VM instance outside of Resources and Identity. Structure is documented below.
final
hashCode → int: The hash code for this object.
no setterinherited
instanceId → Input<String?>?: Required. User-defined unique ID of this instance.
final
instanceOwners → Input<List<String>?>?: 'Optional. Input only. The owner of this instance after creation. Format: alias@example.com Currently supports one owner only. If not specified, all of the service account users of your VM instance''s service account can use the instance. If specified, sets the access mode to Single user. For more details, see https://cloud.google.com/vertex-ai/docs/workbench/instances/manage-access-jupyterlab'
final
labels → Input<Map<String, String>?>?: Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.
final
location → Input<String>: Part of parent. See documentation of projectsId.
final
name → Input<String?>?: The name of this workbench instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}
final
project → Input<String?>?: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

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

Operators

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