Skip to content

googleVertexAiTensorboard

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

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.vertexAiTensorboard.VertexAiTensorboard(this, "tensorboard", {
  description: "sample description",
  display_name: "terraform",
  labels: [
    {
      key1: "value1",
      key2: "value2",
    },
  ],
  region: "us-central1",
});
Open in Cloud Shell

Example Usage - Vertex Ai Tensorboard Full

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleProjectProject = new google.dataGoogleProject.DataGoogleProject(
  this,
  "project",
  {}
);
const googleKmsCryptoKeyIamMemberCryptoKey =
  new google.kmsCryptoKeyIamMember.KmsCryptoKeyIamMember(this, "crypto_key", {
    crypto_key_id: "kms-name",
    member: `serviceAccount:service-\${${dataGoogleProjectProject.number}}@gcp-sa-aiplatform.iam.gserviceaccount.com`,
    role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
  });
new google.vertexAiTensorboard.VertexAiTensorboard(this, "tensorboard", {
  depends_on: [`\${${googleKmsCryptoKeyIamMemberCryptoKey.fqn}}`],
  description: "sample description",
  display_name: "terraform",
  encryption_spec: [
    {
      kms_key_name: "kms-name",
    },
  ],
  labels: [
    {
      key1: "value1",
      key2: "value2",
    },
  ],
  region: "us-central1",
});

Argument Reference

The following arguments are supported:

  • displayName - (Required) User provided name of this Tensorboard.

  • description - (Optional) Description of this Tensorboard.

  • encryptionSpec - (Optional) Customer-managed encryption key spec for a Tensorboard. If set, this Tensorboard and all sub-resources of this Tensorboard will be secured by this key. Structure is documented below.

  • labels - (Optional) The labels with user-defined metadata to organize your Tensorboards.

  • region - (Optional) The region of the tensorboard. eg us-central1

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

The encryptionSpec block supports:

  • kmsKeyName - (Required) The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

Attributes Reference

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

  • id - an identifier for the resource with format {{name}}

  • name - Name of the Tensorboard.

  • blobStoragePathPrefix - Consumer project Cloud Storage path prefix used to store blob data, which can either be a bucket or directory. Does not end with a '/'.

  • runCount - The number of Runs stored in this Tensorboard.

  • createTime - The timestamp of when the Tensorboard was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

  • updateTime - The timestamp of when the Tensorboard was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Timeouts

This resource provides the following Timeouts configuration options:

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

Import

Tensorboard can be imported using any of these accepted formats:

$ 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.