EnvironmentArgs class
The set of arguments for Environment. The set of arguments for Environment.
Constructors
-
EnvironmentArgs({Input<
EnvironmentContainerImage?> ? containerImage, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<String?> ? displayName, required Input<String> location, Input<String?> ? name, Input<String?> ? postStartupScript, Input<String?> ? project, Input<EnvironmentVmImage?> ? vmImage}) -
Creates a new EnvironmentArgs.
containerImageUse a container image to start the notebook instance.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.descriptionA brief description of this environment.displayNameDisplay name of this environment for the UI.locationA reference to the zone where the machine resides.nameThe name specified for the Environment instance.postStartupScriptPath to a Bash script that automatically runs after a notebook instance fully boots up.projectThe ID of the project in which the resource belongs.vmImageUse a Compute Engine VM image to start the notebook instance.const -
EnvironmentArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
containerImage
→ Input<
EnvironmentContainerImage?> ? -
Use a container image to start the notebook instance.
Structure is documented below.
final
-
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
-
description
→ Input<
String?> ? -
A brief description of this environment.
final
-
displayName
→ Input<
String?> ? -
Display name of this environment for the UI.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
location
→ Input<
String> -
A reference to the zone where the machine resides.
final
-
name
→ Input<
String?> ? -
The name specified for the Environment instance.
Format: projects/{project_id}/locations/{location}/environments/{environmentId}
final
-
postStartupScript
→ Input<
String?> ? -
Path to a Bash script that automatically runs after a notebook instance fully boots up.
The path must be a URL or Cloud Storage path. Example: "gs://path-to-file/file-name"
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
-
vmImage
→ Input<
EnvironmentVmImage?> ? -
Use a Compute Engine VM image to start the notebook instance.
Structure is documented below.
final
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