Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. vertex
  6. AiTensorboardRun
Viewing docs for Google Cloud v9.29.0
published on Wednesday, Jun 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.vertex.AiTensorboardRun

gcp logo
Viewing docs for Google Cloud v9.29.0
published on Wednesday, Jun 24, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    A TensorboardRun is a single execution of a training job.

    To get more information about TensorboardRun, see:

    Example Usage

    Vertex Ai Tensorboard Run Basic

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

const tensorboard = new gcp.vertex.AiTensorboard("tensorboard", {
    displayName: "Tensorboard for Run",
    region: "us-central1",
});
const experiment = new gcp.vertex.AiTensorboardExperiment("experiment", {
    location: "us-central1",
    displayName: "sample experiment",
    tensorboard: std.basenameOutput({
        input: tensorboard.id,
    }).apply(invoke => invoke.result),
    tensorboardExperimentId: "experiment",
});
const tensorboardRun = new gcp.vertex.AiTensorboardRun("tensorboard_run", {
    location: "us-central1",
    displayName: "sample run",
    tensorboard: std.basenameOutput({
        input: tensorboard.id,
    }).apply(invoke => invoke.result),
    experiment: experiment.tensorboardExperimentId,
    tensorboardRunId: "run",
    labels: {
        key: "value",
    },
});

    import pulumi
import pulumi_gcp as gcp
import pulumi_std as std

tensorboard = gcp.vertex.AiTensorboard("tensorboard",
    display_name="Tensorboard for Run",
    region="us-central1")
experiment = gcp.vertex.AiTensorboardExperiment("experiment",
    location="us-central1",
    display_name="sample experiment",
    tensorboard=std.basename_output(input=tensorboard.id).apply(lambda invoke: invoke.result),
    tensorboard_experiment_id="experiment")
tensorboard_run = gcp.vertex.AiTensorboardRun("tensorboard_run",
    location="us-central1",
    display_name="sample run",
    tensorboard=std.basename_output(input=tensorboard.id).apply(lambda invoke: invoke.result),
    experiment=experiment.tensorboard_experiment_id,
    tensorboard_run_id="run",
    labels={
        "key": "value",
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tensorboard, err := vertex.NewAiTensorboard(ctx, "tensorboard", &vertex.AiTensorboardArgs{
			DisplayName: pulumi.String("Tensorboard for Run"),
			Region:      pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		experiment, err := vertex.NewAiTensorboardExperiment(ctx, "experiment", &vertex.AiTensorboardExperimentArgs{
			Location:    pulumi.String("us-central1"),
			DisplayName: pulumi.String("sample experiment"),
			Tensorboard: pulumi.String(std.BasenameOutput(ctx, std.BasenameOutputArgs{
				Input: tensorboard.ID(),
			}, nil).ApplyT(func(invoke std.BasenameResult) (*string, error) {
				val := invoke.Result
				return &val, nil
			}).(pulumi.StringPtrOutput)),
			TensorboardExperimentId: pulumi.String("experiment"),
		})
		if err != nil {
			return err
		}
		_, err = vertex.NewAiTensorboardRun(ctx, "tensorboard_run", &vertex.AiTensorboardRunArgs{
			Location:    pulumi.String("us-central1"),
			DisplayName: pulumi.String("sample run"),
			Tensorboard: pulumi.String(std.BasenameOutput(ctx, std.BasenameOutputArgs{
				Input: tensorboard.ID(),
			}, nil).ApplyT(func(invoke std.BasenameResult) (*string, error) {
				val := invoke.Result
				return &val, nil
			}).(pulumi.StringPtrOutput)),
			Experiment:       experiment.TensorboardExperimentId,
			TensorboardRunId: pulumi.String("run"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var tensorboard = new Gcp.Vertex.AiTensorboard("tensorboard", new()
    {
        DisplayName = "Tensorboard for Run",
        Region = "us-central1",
    });

    var experiment = new Gcp.Vertex.AiTensorboardExperiment("experiment", new()
    {
        Location = "us-central1",
        DisplayName = "sample experiment",
        Tensorboard = Std.Basename.Invoke(new()
        {
            Input = tensorboard.Id,
        }).Apply(invoke => invoke.Result),
        TensorboardExperimentId = "experiment",
    });

    var tensorboardRun = new Gcp.Vertex.AiTensorboardRun("tensorboard_run", new()
    {
        Location = "us-central1",
        DisplayName = "sample run",
        Tensorboard = Std.Basename.Invoke(new()
        {
            Input = tensorboard.Id,
        }).Apply(invoke => invoke.Result),
        Experiment = experiment.TensorboardExperimentId,
        TensorboardRunId = "run",
        Labels = 
        {
            { "key", "value" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vertex.AiTensorboard;
import com.pulumi.gcp.vertex.AiTensorboardArgs;
import com.pulumi.gcp.vertex.AiTensorboardExperiment;
import com.pulumi.gcp.vertex.AiTensorboardExperimentArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.BasenameArgs;
import com.pulumi.gcp.vertex.AiTensorboardRun;
import com.pulumi.gcp.vertex.AiTensorboardRunArgs;
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 tensorboard = new AiTensorboard("tensorboard", AiTensorboardArgs.builder()
            .displayName("Tensorboard for Run")
            .region("us-central1")
            .build());

        var experiment = new AiTensorboardExperiment("experiment", AiTensorboardExperimentArgs.builder()
            .location("us-central1")
            .displayName("sample experiment")
            .tensorboard(StdFunctions.basename(BasenameArgs.builder()
                .input(tensorboard.id())
                .build()).applyValue(_invoke -> _invoke.result()))
            .tensorboardExperimentId("experiment")
            .build());

        var tensorboardRun = new AiTensorboardRun("tensorboardRun", AiTensorboardRunArgs.builder()
            .location("us-central1")
            .displayName("sample run")
            .tensorboard(StdFunctions.basename(BasenameArgs.builder()
                .input(tensorboard.id())
                .build()).applyValue(_invoke -> _invoke.result()))
            .experiment(experiment.tensorboardExperimentId())
            .tensorboardRunId("run")
            .labels(Map.of("key", "value"))
            .build());

    }
}

    resources:
  tensorboard:
    type: gcp:vertex:AiTensorboard
    properties:
      displayName: Tensorboard for Run
      region: us-central1
  experiment:
    type: gcp:vertex:AiTensorboardExperiment
    properties:
      location: us-central1
      displayName: sample experiment
      tensorboard:
        fn::invoke:
          function: std:basename
          arguments:
            input: ${tensorboard.id}
          return: result
      tensorboardExperimentId: experiment
  tensorboardRun:
    type: gcp:vertex:AiTensorboardRun
    name: tensorboard_run
    properties:
      location: us-central1
      displayName: sample run
      tensorboard:
        fn::invoke:
          function: std:basename
          arguments:
            input: ${tensorboard.id}
          return: result
      experiment: ${experiment.tensorboardExperimentId}
      tensorboardRunId: run
      labels:
        key: value

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

resource "gcp_vertex_aitensorboard" "tensorboard" {
  display_name = "Tensorboard for Run"
  region       = "us-central1"
}
resource "gcp_vertex_aitensorboardexperiment" "experiment" {
  location                  = "us-central1"
  display_name              = "sample experiment"
  tensorboard               = basename(gcp_vertex_aitensorboard.tensorboard.id)
  tensorboard_experiment_id = "experiment"
}
resource "gcp_vertex_aitensorboardrun" "tensorboard_run" {
  location           = "us-central1"
  display_name       = "sample run"
  tensorboard        = basename(gcp_vertex_aitensorboard.tensorboard.id)
  experiment         = gcp_vertex_aitensorboardexperiment.experiment.tensorboard_experiment_id
  tensorboard_run_id = "run"
  labels = {
    "key" = "value"
  }
}

    Create AiTensorboardRun Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AiTensorboardRun(name: string, args: AiTensorboardRunArgs, opts?: CustomResourceOptions);
    @overload
def AiTensorboardRun(resource_name: str,
                     args: AiTensorboardRunArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def AiTensorboardRun(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     display_name: Optional[str] = None,
                     experiment: Optional[str] = None,
                     location: Optional[str] = None,
                     tensorboard: Optional[str] = None,
                     tensorboard_run_id: Optional[str] = None,
                     deletion_policy: Optional[str] = None,
                     description: Optional[str] = None,
                     labels: Optional[Mapping[str, str]] = None,
                     project: Optional[str] = None)
    func NewAiTensorboardRun(ctx *Context, name string, args AiTensorboardRunArgs, opts ...ResourceOption) (*AiTensorboardRun, error)
    public AiTensorboardRun(string name, AiTensorboardRunArgs args, CustomResourceOptions? opts = null)
    public AiTensorboardRun(String name, AiTensorboardRunArgs args)
public AiTensorboardRun(String name, AiTensorboardRunArgs args, CustomResourceOptions options)

    type: gcp:vertex:AiTensorboardRun
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_vertex_aitensorboardrun" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AiTensorboardRunArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AiTensorboardRunArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AiTensorboardRunArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiTensorboardRunArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiTensorboardRunArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aiTensorboardRunResource = new Gcp.Vertex.AiTensorboardRun("aiTensorboardRunResource", new()
{
    DisplayName = "string",
    Experiment = "string",
    Location = "string",
    Tensorboard = "string",
    TensorboardRunId = "string",
    DeletionPolicy = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := vertex.NewAiTensorboardRun(ctx, "aiTensorboardRunResource", &vertex.AiTensorboardRunArgs{
	DisplayName:      pulumi.String("string"),
	Experiment:       pulumi.String("string"),
	Location:         pulumi.String("string"),
	Tensorboard:      pulumi.String("string"),
	TensorboardRunId: pulumi.String("string"),
	DeletionPolicy:   pulumi.String("string"),
	Description:      pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    resource "gcp_vertex_aitensorboardrun" "aiTensorboardRunResource" {
  display_name       = "string"
  experiment         = "string"
  location           = "string"
  tensorboard        = "string"
  tensorboard_run_id = "string"
  deletion_policy    = "string"
  description        = "string"
  labels = {
    "string" = "string"
  }
  project = "string"
}

    var aiTensorboardRunResource = new AiTensorboardRun("aiTensorboardRunResource", AiTensorboardRunArgs.builder()
    .displayName("string")
    .experiment("string")
    .location("string")
    .tensorboard("string")
    .tensorboardRunId("string")
    .deletionPolicy("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    ai_tensorboard_run_resource = gcp.vertex.AiTensorboardRun("aiTensorboardRunResource",
    display_name="string",
    experiment="string",
    location="string",
    tensorboard="string",
    tensorboard_run_id="string",
    deletion_policy="string",
    description="string",
    labels={
        "string": "string",
    },
    project="string")

    const aiTensorboardRunResource = new gcp.vertex.AiTensorboardRun("aiTensorboardRunResource", {
    displayName: "string",
    experiment: "string",
    location: "string",
    tensorboard: "string",
    tensorboardRunId: "string",
    deletionPolicy: "string",
    description: "string",
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:vertex:AiTensorboardRun
properties:
    deletionPolicy: string
    description: string
    displayName: string
    experiment: string
    labels:
        string: string
    location: string
    project: string
    tensorboard: string
    tensorboardRunId: string

    AiTensorboardRun Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AiTensorboardRun resource accepts the following input properties:

    DisplayName string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    Experiment string
    The Tensorboard Experiment ID.
    Location string
    The location of the Tensorboard Run. eg us-central1
    Tensorboard string
    The Tensorboard instance.
    TensorboardRunId string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    DeletionPolicy 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.
    Description string
    Description of this TensorboardRun.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    DisplayName string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    Experiment string
    The Tensorboard Experiment ID.
    Location string
    The location of the Tensorboard Run. eg us-central1
    Tensorboard string
    The Tensorboard instance.
    TensorboardRunId string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    DeletionPolicy 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.
    Description string
    Description of this TensorboardRun.
    Labels map[string]string
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    display_name string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    experiment string
    The Tensorboard Experiment ID.
    location string
    The location of the Tensorboard Run. eg us-central1
    tensorboard string
    The Tensorboard instance.
    tensorboard_run_id string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    deletion_policy 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.
    description string
    Description of this TensorboardRun.
    labels map(string)
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    experiment String
    The Tensorboard Experiment ID.
    location String
    The location of the Tensorboard Run. eg us-central1
    tensorboard String
    The Tensorboard instance.
    tensorboardRunId String
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    deletionPolicy 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.
    description String
    Description of this TensorboardRun.
    labels Map<String,String>
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    experiment string
    The Tensorboard Experiment ID.
    location string
    The location of the Tensorboard Run. eg us-central1
    tensorboard string
    The Tensorboard instance.
    tensorboardRunId string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    deletionPolicy 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.
    description string
    Description of this TensorboardRun.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    display_name str
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    experiment str
    The Tensorboard Experiment ID.
    location str
    The location of the Tensorboard Run. eg us-central1
    tensorboard str
    The Tensorboard instance.
    tensorboard_run_id str
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    deletion_policy str
    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.
    description str
    Description of this TensorboardRun.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    displayName String
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    experiment String
    The Tensorboard Experiment ID.
    location String
    The location of the Tensorboard Run. eg us-central1
    tensorboard String
    The Tensorboard instance.
    tensorboardRunId String
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    deletionPolicy 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.
    description String
    Description of this TensorboardRun.
    labels Map<String>
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiTensorboardRun resource produces the following output properties:

    CreateTime string
    Timestamp when this TensorboardRun was created.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    Timestamp when this TensorboardRun was last updated.
    CreateTime string
    Timestamp when this TensorboardRun was created.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    UpdateTime string
    Timestamp when this TensorboardRun was last updated.
    create_time string
    Timestamp when this TensorboardRun was created.
    effective_labels map(string)
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    pulumi_labels map(string)
    The combination of labels configured directly on the resource and default labels configured on the provider.
    update_time string
    Timestamp when this TensorboardRun was last updated.
    createTime String
    Timestamp when this TensorboardRun was created.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    Timestamp when this TensorboardRun was last updated.
    createTime string
    Timestamp when this TensorboardRun was created.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime string
    Timestamp when this TensorboardRun was last updated.
    create_time str
    Timestamp when this TensorboardRun was created.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    update_time str
    Timestamp when this TensorboardRun was last updated.
    createTime String
    Timestamp when this TensorboardRun was created.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    Timestamp when this TensorboardRun was last updated.

    Look up Existing AiTensorboardRun Resource

    Get an existing AiTensorboardRun resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AiTensorboardRunState, opts?: CustomResourceOptions): AiTensorboardRun
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        experiment: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        tensorboard: Optional[str] = None,
        tensorboard_run_id: Optional[str] = None,
        update_time: Optional[str] = None) -> AiTensorboardRun
    func GetAiTensorboardRun(ctx *Context, name string, id IDInput, state *AiTensorboardRunState, opts ...ResourceOption) (*AiTensorboardRun, error)
    public static AiTensorboardRun Get(string name, Input<string> id, AiTensorboardRunState? state, CustomResourceOptions? opts = null)
    public static AiTensorboardRun get(String name, Output<String> id, AiTensorboardRunState state, CustomResourceOptions options)
    resources:  _:    type: gcp:vertex:AiTensorboardRun    get:      id: ${id}
    import {
  to = gcp_vertex_aitensorboardrun.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    Timestamp when this TensorboardRun was created.
    DeletionPolicy 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.
    Description string
    Description of this TensorboardRun.
    DisplayName string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Experiment string
    The Tensorboard Experiment ID.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Location string
    The location of the Tensorboard Run. eg us-central1
    Name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Tensorboard string
    The Tensorboard instance.
    TensorboardRunId string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    UpdateTime string
    Timestamp when this TensorboardRun was last updated.
    CreateTime string
    Timestamp when this TensorboardRun was created.
    DeletionPolicy 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.
    Description string
    Description of this TensorboardRun.
    DisplayName string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Experiment string
    The Tensorboard Experiment ID.
    Labels map[string]string
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    Location string
    The location of the Tensorboard Run. eg us-central1
    Name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Tensorboard string
    The Tensorboard instance.
    TensorboardRunId string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    UpdateTime string
    Timestamp when this TensorboardRun was last updated.
    create_time string
    Timestamp when this TensorboardRun was created.
    deletion_policy 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.
    description string
    Description of this TensorboardRun.
    display_name string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    effective_labels map(string)
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    experiment string
    The Tensorboard Experiment ID.
    labels map(string)
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location string
    The location of the Tensorboard Run. eg us-central1
    name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels map(string)
    The combination of labels configured directly on the resource and default labels configured on the provider.
    tensorboard string
    The Tensorboard instance.
    tensorboard_run_id string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    update_time string
    Timestamp when this TensorboardRun was last updated.
    createTime String
    Timestamp when this TensorboardRun was created.
    deletionPolicy 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.
    description String
    Description of this TensorboardRun.
    displayName String
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    experiment String
    The Tensorboard Experiment ID.
    labels Map<String,String>
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location String
    The location of the Tensorboard Run. eg us-central1
    name String
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    tensorboard String
    The Tensorboard instance.
    tensorboardRunId String
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    updateTime String
    Timestamp when this TensorboardRun was last updated.
    createTime string
    Timestamp when this TensorboardRun was created.
    deletionPolicy 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.
    description string
    Description of this TensorboardRun.
    displayName string
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    experiment string
    The Tensorboard Experiment ID.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location string
    The location of the Tensorboard Run. eg us-central1
    name string
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    tensorboard string
    The Tensorboard instance.
    tensorboardRunId string
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    updateTime string
    Timestamp when this TensorboardRun was last updated.
    create_time str
    Timestamp when this TensorboardRun was created.
    deletion_policy str
    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.
    description str
    Description of this TensorboardRun.
    display_name str
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    experiment str
    The Tensorboard Experiment ID.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location str
    The location of the Tensorboard Run. eg us-central1
    name str
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    tensorboard str
    The Tensorboard instance.
    tensorboard_run_id str
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    update_time str
    Timestamp when this TensorboardRun was last updated.
    createTime String
    Timestamp when this TensorboardRun was created.
    deletionPolicy 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.
    description String
    Description of this TensorboardRun.
    displayName String
    User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    experiment String
    The Tensorboard Experiment ID.
    labels Map<String>
    The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.
    location String
    The location of the Tensorboard Run. eg us-central1
    name String
    Name of the TensorboardRun. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    tensorboard String
    The Tensorboard instance.
    tensorboardRunId String
    The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    updateTime String
    Timestamp when this TensorboardRun was last updated.

    Import

    TensorboardRun can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/tensorboards/{{tensorboard}}/experiments/{{experiment}}/runs/{{tensorboard_run_id}}
    • {{project}}/{{location}}/{{tensorboard}}/{{experiment}}/{{tensorboard_run_id}}
    • {{location}}/{{tensorboard}}/{{experiment}}/{{tensorboard_run_id}}

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

    $ pulumi import gcp:vertex/aiTensorboardRun:AiTensorboardRun default projects/{{project}}/locations/{{location}}/tensorboards/{{tensorboard}}/experiments/{{experiment}}/runs/{{tensorboard_run_id}}
$ pulumi import gcp:vertex/aiTensorboardRun:AiTensorboardRun default {{project}}/{{location}}/{{tensorboard}}/{{experiment}}/{{tensorboard_run_id}}
$ pulumi import gcp:vertex/aiTensorboardRun:AiTensorboardRun default {{location}}/{{tensorboard}}/{{experiment}}/{{tensorboard_run_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.29.0
    published on Wednesday, Jun 24, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial