pulumi-gcp-kotlin/com.pulumi.gcp.notebooks.kotlin/Environment

Environment

class Environment : KotlinCustomResource

A Cloud AI Platform Notebook environment. To get more information about Environment, see:

Example Usage

Notebook Environment Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.notebooks.Environment;
import com.pulumi.gcp.notebooks.EnvironmentArgs;
import com.pulumi.gcp.notebooks.inputs.EnvironmentContainerImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var environment = new Environment("environment", EnvironmentArgs.builder()
            .containerImage(EnvironmentContainerImageArgs.builder()
                .repository("gcr.io/deeplearning-platform-release/base-cpu")
                .build())
            .location("us-west1-a")
            .build());
    }
}
Content copied to clipboard

Import

Environment can be imported using any of these accepted formats

$ pulumi import gcp:notebooks/environment:Environment default projects/{{project}}/locations/{{location}}/environments/{{name}}
Content copied to clipboard
$ pulumi import gcp:notebooks/environment:Environment default {{project}}/{{location}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:notebooks/environment:Environment default {{location}}/{{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val containerImage: Output<EnvironmentContainerImage>?

Use a container image to start the notebook instance. Structure is documented below.

Link copied to clipboard
val createTime: Output<String>

Instance creation time

Link copied to clipboard
val description: Output<String>?

A brief description of this environment.

Link copied to clipboard
val displayName: Output<String>?

Display name of this environment for the UI.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

A reference to the zone where the machine resides.

Link copied to clipboard
val name: Output<String>

The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}

Link copied to clipboard
val postStartupScript: Output<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"

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val vmImage: Output<EnvironmentVmImage>?

Use a Compute Engine VM image to start the notebook instance. Structure is documented below.