» google_notebooks_environment

A Cloud AI Platform Notebook environment.

To get more information about Environment, see:

» Example Usage - Notebook Environment Basic

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

» Argument Reference

The following arguments are supported:

  • name - (Required) The name specified for the Environment instance. Format: projects/{project_id}/locations/{location}/environments/{environmentId}

  • location - (Required) A reference to the zone where the machine resides.


  • display_name - (Optional) Display name of this environment for the UI.

  • description - (Optional) A brief description of this environment.

  • post_startup_script - (Optional) 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"

  • vm_image - (Optional) Use a Compute Engine VM image to start the notebook instance. Structure is documented below.

  • container_image - (Optional) Use a container image to start the notebook instance. Structure is documented below.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The vm_image block supports:

  • project - (Required) The name of the Google Cloud project that this VM image belongs to. Format: projects/{project_id}

  • image_name - (Optional) Use VM image name to find the image.

  • image_family - (Optional) Use this VM image family to find the image; the newest image in this family will be used.

The container_image block supports:

  • repository - (Required) The path to the container image repository. For example: gcr.io/{project_id}/{imageName}

  • tag - (Optional) The tag of the container image. If not specified, this defaults to the latest tag.

» Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/locations/{{location}}/environments/{{name}}

  • create_time - Instance creation time

» Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 4 minutes.
  • update - Default is 4 minutes.
  • delete - Default is 4 minutes.

» Import

Environment can be imported using any of these accepted formats:

$ terraform import -provider=google-beta google_notebooks_environment.default projects/{{project}}/locations/{{location}}/environments/{{name}}
$ terraform import -provider=google-beta google_notebooks_environment.default {{project}}/{{location}}/{{name}}
$ terraform import -provider=google-beta google_notebooks_environment.default {{location}}/{{name}}

» User Project Overrides

This resource supports User Project Overrides.