Environment class

> Warning: gcp.notebooks.Environment is deprecated and will be removed in a future major release. Use gcp.workbench.Instance instead.

A Cloud AI Platform Notebook environment.

To get more information about Environment, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Notebook Environment Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const environment = new gcp.notebooks.Environment("environment", {
    name: "notebooks-environment",
    location: "us-west1-a",
    containerImage: {
        repository: "gcr.io/deeplearning-platform-release/base-cpu",
    },
});

import pulumi
import pulumi_gcp as gcp

environment = gcp.notebooks.Environment("environment",
    name="notebooks-environment",
    location="us-west1-a",
    container_image={
        "repository": "gcr.io/deeplearning-platform-release/base-cpu",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var environment = new Gcp.Notebooks.Environment("environment", new()
    {
        Name = "notebooks-environment",
        Location = "us-west1-a",
        ContainerImage = new Gcp.Notebooks.Inputs.EnvironmentContainerImageArgs
        {
            Repository = "gcr.io/deeplearning-platform-release/base-cpu",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/notebooks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := notebooks.NewEnvironment(ctx, "environment", &notebooks.EnvironmentArgs{
			Name:     pulumi.String("notebooks-environment"),
			Location: pulumi.String("us-west1-a"),
			ContainerImage: &notebooks.EnvironmentContainerImageArgs{
				Repository: pulumi.String("gcr.io/deeplearning-platform-release/base-cpu"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_notebooks_environment" "environment" {
  name     = "notebooks-environment"
  location = "us-west1-a"
  container_image = {
    repository = "gcr.io/deeplearning-platform-release/base-cpu"
  }
}

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.ArrayList;
import java.util.Arrays;
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()
            .name("notebooks-environment")
            .location("us-west1-a")
            .containerImage(EnvironmentContainerImageArgs.builder()
                .repository("gcr.io/deeplearning-platform-release/base-cpu")
                .build())
            .build());

    }
}

resources:
  environment:
    type: gcp:notebooks:Environment
    properties:
      name: notebooks-environment
      location: us-west1-a
      containerImage:
        repository: gcr.io/deeplearning-platform-release/base-cpu

Import

Environment can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/environments/{{name}}
• {{project}}/{{location}}/{{name}}
• {{location}}/{{name}}

When using the pulumi import command, Environment can be imported using one of the formats above. For example:

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

Constructors

Environment(String name, {EnvironmentArgs? args, CustomResourceOptions? options})

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

Environment.reference(String urn)

Creates a typed reference to an existing Environment resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

containerImage ↔ Output<EnvironmentContainerImage?>

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

late, final

createTime ↔ Output<String>

Instance creation time

late, final

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

late, final

description ↔ Output<String?>

A brief description of this environment.

late, final

displayName ↔ Output<String?>

Display name of this environment for the UI.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

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

location ↔ Output<String>

A reference to the zone where the machine resides.

late, final

name ↔ Output<String>

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

late, final

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"

late, final

project ↔ Output<String>

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

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

vmImage ↔ Output<EnvironmentVmImage?>

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

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

Static Methods

get(String name, Input<String> id, {EnvironmentState? state, CustomResourceOptions? options}) → Environment

Gets an existing Environment resource's state with the given name and id.