google_vertex_ai_tensorboard

Tensorboard is a physical database that stores users' training metrics. A default Tensorboard is provided in each region of a GCP project. If needed users can also create extra Tensorboards in their projects.

To get more information about Tensorboard, see:

Open in Cloud Shell

Example Usage - Vertex Ai Tensorboard

resource "google_vertex_ai_tensorboard" "tensorboard" {
  display_name = "terraform"
  description  = "sample description"
  labels       = {
    "key1" : "value1",
    "key2" : "value2"
  }
  region       = "us-central1"
}
Open in Cloud Shell

Example Usage - Vertex Ai Tensorboard Full

resource "google_vertex_ai_tensorboard" "tensorboard" {
  display_name = "terraform"
  description  = "sample description"
  labels       = {
    "key1" : "value1",
    "key2" : "value2"
  }
  region       = "us-central1"
  encryption_spec {
    kms_key_name = "kms-name"
  }
  depends_on = [google_kms_crypto_key_iam_member.crypto_key]
}

resource "google_kms_crypto_key_iam_member" "crypto_key" {
  crypto_key_id = "kms-name"
  role          = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
  member        = "serviceAccount:service-${data.google_project.project.number}@gcp-sa-aiplatform.iam.gserviceaccount.com"
}

data "google_project" "project" {}

Argument Reference

The following arguments are supported:


The encryption_spec block supports:

Attributes Reference

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

Timeouts

This resource provides the following Timeouts configuration options:

Import

Tensorboard can be imported using any of these accepted formats:

In Terraform v1.5.0 and later, use an import block to import Tensorboard using one of the formats above. For example:

import {
  id = "projects/{{project}}/locations/{{region}}/tensorboards/{{name}}"
  to = google_vertex_ai_tensorboard.default
}

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

$ terraform import google_vertex_ai_tensorboard.default projects/{{project}}/locations/{{region}}/tensorboards/{{name}}
$ terraform import google_vertex_ai_tensorboard.default {{project}}/{{region}}/{{name}}
$ terraform import google_vertex_ai_tensorboard.default {{region}}/{{name}}
$ terraform import google_vertex_ai_tensorboard.default {{name}}

User Project Overrides

This resource supports User Project Overrides.