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

gcp.vertex.AiTensorboardExperiment

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

    A TensorboardExperiment is a group of TensorboardRuns that are logically grouped together.

    To get more information about TensorboardExperiment, see:

    Example Usage

    Vertex Ai Tensorboard Experiment 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 Experiment",
    region: "us-central1",
});
const tensorboardExperiment = new gcp.vertex.AiTensorboardExperiment("tensorboard_experiment", {
    location: "us-central1",
    displayName: "sample experiment",
    tensorboard: std.basenameOutput({
        input: tensorboard.id,
    }).apply(invoke => invoke.result),
    tensorboardExperimentId: "experiment",
    source: "a custom training job",
    labels: {
        key: "value",
    },
});

    import pulumi
import pulumi_gcp as gcp
import pulumi_std as std

tensorboard = gcp.vertex.AiTensorboard("tensorboard",
    display_name="Tensorboard for Experiment",
    region="us-central1")
tensorboard_experiment = gcp.vertex.AiTensorboardExperiment("tensorboard_experiment",
    location="us-central1",
    display_name="sample experiment",
    tensorboard=std.basename_output(input=tensorboard.id).apply(lambda invoke: invoke.result),
    tensorboard_experiment_id="experiment",
    source="a custom training job",
    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 Experiment"),
			Region:      pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		_, err = vertex.NewAiTensorboardExperiment(ctx, "tensorboard_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"),
			Source:                  pulumi.String("a custom training job"),
			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 Experiment",
        Region = "us-central1",
    });

    var tensorboardExperiment = new Gcp.Vertex.AiTensorboardExperiment("tensorboard_experiment", new()
    {
        Location = "us-central1",
        DisplayName = "sample experiment",
        Tensorboard = Std.Basename.Invoke(new()
        {
            Input = tensorboard.Id,
        }).Apply(invoke => invoke.Result),
        TensorboardExperimentId = "experiment",
        Source = "a custom training job",
        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 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 Experiment")
            .region("us-central1")
            .build());

        var tensorboardExperiment = new AiTensorboardExperiment("tensorboardExperiment", AiTensorboardExperimentArgs.builder()
            .location("us-central1")
            .displayName("sample experiment")
            .tensorboard(StdFunctions.basename(BasenameArgs.builder()
                .input(tensorboard.id())
                .build()).applyValue(_invoke -> _invoke.result()))
            .tensorboardExperimentId("experiment")
            .source("a custom training job")
            .labels(Map.of("key", "value"))
            .build());

    }
}

    resources:
  tensorboard:
    type: gcp:vertex:AiTensorboard
    properties:
      displayName: Tensorboard for Experiment
      region: us-central1
  tensorboardExperiment:
    type: gcp:vertex:AiTensorboardExperiment
    name: tensorboard_experiment
    properties:
      location: us-central1
      displayName: sample experiment
      tensorboard:
        fn::invoke:
          function: std:basename
          arguments:
            input: ${tensorboard.id}
          return: result
      tensorboardExperimentId: experiment
      source: a custom training job
      labels:
        key: value

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

resource "gcp_vertex_aitensorboard" "tensorboard" {
  display_name = "Tensorboard for Experiment"
  region       = "us-central1"
}
resource "gcp_vertex_aitensorboardexperiment" "tensorboard_experiment" {
  location                  = "us-central1"
  display_name              = "sample experiment"
  tensorboard               = basename(gcp_vertex_aitensorboard.tensorboard.id)
  tensorboard_experiment_id = "experiment"
  source                    = "a custom training job"
  labels = {
    "key" = "value"
  }
}

    Create AiTensorboardExperiment Resource

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

    Constructor syntax

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

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

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


    resource "gcp_vertex_aitensorboardexperiment" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AiTensorboardExperimentArgs
    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 AiTensorboardExperimentArgs
    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 AiTensorboardExperimentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiTensorboardExperimentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiTensorboardExperimentArgs
    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 aiTensorboardExperimentResource = new Gcp.Vertex.AiTensorboardExperiment("aiTensorboardExperimentResource", new()
{
    Location = "string",
    Tensorboard = "string",
    TensorboardExperimentId = "string",
    DeletionPolicy = "string",
    Description = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
    Source = "string",
});

    example, err := vertex.NewAiTensorboardExperiment(ctx, "aiTensorboardExperimentResource", &vertex.AiTensorboardExperimentArgs{
	Location:                pulumi.String("string"),
	Tensorboard:             pulumi.String("string"),
	TensorboardExperimentId: pulumi.String("string"),
	DeletionPolicy:          pulumi.String("string"),
	Description:             pulumi.String("string"),
	DisplayName:             pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
	Source:  pulumi.String("string"),
})

    resource "gcp_vertex_aitensorboardexperiment" "aiTensorboardExperimentResource" {
  location                  = "string"
  tensorboard               = "string"
  tensorboard_experiment_id = "string"
  deletion_policy           = "string"
  description               = "string"
  display_name              = "string"
  labels = {
    "string" = "string"
  }
  project = "string"
  source  = "string"
}

    var aiTensorboardExperimentResource = new AiTensorboardExperiment("aiTensorboardExperimentResource", AiTensorboardExperimentArgs.builder()
    .location("string")
    .tensorboard("string")
    .tensorboardExperimentId("string")
    .deletionPolicy("string")
    .description("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .source("string")
    .build());

    ai_tensorboard_experiment_resource = gcp.vertex.AiTensorboardExperiment("aiTensorboardExperimentResource",
    location="string",
    tensorboard="string",
    tensorboard_experiment_id="string",
    deletion_policy="string",
    description="string",
    display_name="string",
    labels={
        "string": "string",
    },
    project="string",
    source="string")

    const aiTensorboardExperimentResource = new gcp.vertex.AiTensorboardExperiment("aiTensorboardExperimentResource", {
    location: "string",
    tensorboard: "string",
    tensorboardExperimentId: "string",
    deletionPolicy: "string",
    description: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    project: "string",
    source: "string",
});

    type: gcp:vertex:AiTensorboardExperiment
properties:
    deletionPolicy: string
    description: string
    displayName: string
    labels:
        string: string
    location: string
    project: string
    source: string
    tensorboard: string
    tensorboardExperimentId: string

    AiTensorboardExperiment 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 AiTensorboardExperiment resource accepts the following input properties:

    Location string
    The location of the Tensorboard Experiment. eg us-central1
    Tensorboard string
    The Tensorboard instance.
    TensorboardExperimentId string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    DisplayName string
    User provided name of this TensorboardExperiment.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    Source string
    Source of the TensorboardExperiment. Example: a custom training job.
    Location string
    The location of the Tensorboard Experiment. eg us-central1
    Tensorboard string
    The Tensorboard instance.
    TensorboardExperimentId string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    DisplayName string
    User provided name of this TensorboardExperiment.
    Labels map[string]string
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    Source string
    Source of the TensorboardExperiment. Example: a custom training job.
    location string
    The location of the Tensorboard Experiment. eg us-central1
    tensorboard string
    The Tensorboard instance.
    tensorboard_experiment_id string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    display_name string
    User provided name of this TensorboardExperiment.
    labels map(string)
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    source string
    Source of the TensorboardExperiment. Example: a custom training job.
    location String
    The location of the Tensorboard Experiment. eg us-central1
    tensorboard String
    The Tensorboard instance.
    tensorboardExperimentId String
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    displayName String
    User provided name of this TensorboardExperiment.
    labels Map<String,String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    source String
    Source of the TensorboardExperiment. Example: a custom training job.
    location string
    The location of the Tensorboard Experiment. eg us-central1
    tensorboard string
    The Tensorboard instance.
    tensorboardExperimentId string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    displayName string
    User provided name of this TensorboardExperiment.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    source string
    Source of the TensorboardExperiment. Example: a custom training job.
    location str
    The location of the Tensorboard Experiment. eg us-central1
    tensorboard str
    The Tensorboard instance.
    tensorboard_experiment_id str
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    display_name str
    User provided name of this TensorboardExperiment.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    source str
    Source of the TensorboardExperiment. Example: a custom training job.
    location String
    The location of the Tensorboard Experiment. eg us-central1
    tensorboard String
    The Tensorboard instance.
    tensorboardExperimentId String
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 TensorboardExperiment.
    displayName String
    User provided name of this TensorboardExperiment.
    labels Map<String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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.
    source String
    Source of the TensorboardExperiment. Example: a custom training job.

    Outputs

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

    CreateTime string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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 TensorboardExperiment was last updated.
    CreateTime string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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 TensorboardExperiment was last updated.
    create_time string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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 TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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 TensorboardExperiment was last updated.
    createTime string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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 TensorboardExperiment was last updated.
    create_time str
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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 TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.

    Look up Existing AiTensorboardExperiment Resource

    Get an existing AiTensorboardExperiment 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?: AiTensorboardExperimentState, opts?: CustomResourceOptions): AiTensorboardExperiment
    @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,
        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,
        source: Optional[str] = None,
        tensorboard: Optional[str] = None,
        tensorboard_experiment_id: Optional[str] = None,
        update_time: Optional[str] = None) -> AiTensorboardExperiment
    func GetAiTensorboardExperiment(ctx *Context, name string, id IDInput, state *AiTensorboardExperimentState, opts ...ResourceOption) (*AiTensorboardExperiment, error)
    public static AiTensorboardExperiment Get(string name, Input<string> id, AiTensorboardExperimentState? state, CustomResourceOptions? opts = null)
    public static AiTensorboardExperiment get(String name, Output<String> id, AiTensorboardExperimentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:vertex:AiTensorboardExperiment    get:      id: ${id}
    import {
  to = gcp_vertex_aitensorboardexperiment.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 TensorboardExperiment 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 TensorboardExperiment.
    DisplayName string
    User provided name of this 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.
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    Name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    Source string
    Source of the TensorboardExperiment. Example: a custom training job.
    Tensorboard string
    The Tensorboard instance.
    TensorboardExperimentId string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    UpdateTime string
    Timestamp when this TensorboardExperiment was last updated.
    CreateTime string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
    DisplayName string
    User provided name of this 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.
    Labels map[string]string
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    Name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    Source string
    Source of the TensorboardExperiment. Example: a custom training job.
    Tensorboard string
    The Tensorboard instance.
    TensorboardExperimentId string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    UpdateTime string
    Timestamp when this TensorboardExperiment was last updated.
    create_time string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
    display_name string
    User provided name of this 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.
    labels map(string)
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    source string
    Source of the TensorboardExperiment. Example: a custom training job.
    tensorboard string
    The Tensorboard instance.
    tensorboard_experiment_id string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    update_time string
    Timestamp when this TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
    displayName String
    User provided name of this 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.
    labels Map<String,String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    name String
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    source String
    Source of the TensorboardExperiment. Example: a custom training job.
    tensorboard String
    The Tensorboard instance.
    tensorboardExperimentId String
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.
    createTime string
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
    displayName string
    User provided name of this 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.
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    name string
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    source string
    Source of the TensorboardExperiment. Example: a custom training job.
    tensorboard string
    The Tensorboard instance.
    tensorboardExperimentId string
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    updateTime string
    Timestamp when this TensorboardExperiment was last updated.
    create_time str
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
    display_name str
    User provided name of this 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.
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    name str
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    source str
    Source of the TensorboardExperiment. Example: a custom training job.
    tensorboard str
    The Tensorboard instance.
    tensorboard_experiment_id str
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    update_time str
    Timestamp when this TensorboardExperiment was last updated.
    createTime String
    Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
    displayName String
    User provided name of this 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.
    labels Map<String>
    The labels with user-defined metadata to organize your TensorboardExperiment. Label keys and values cannot be 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 Dataset (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. The following system labels exist for each Dataset:

    • aiplatform.googleapis.com/dataset_metadata_schema: output only. Its value is the metadata_schema's title. 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 Experiment. eg us-central1
    name String
    Name of the TensorboardExperiment. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}
    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.
    source String
    Source of the TensorboardExperiment. Example: a custom training job.
    tensorboard String
    The Tensorboard instance.
    tensorboardExperimentId String
    The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
    updateTime String
    Timestamp when this TensorboardExperiment was last updated.

    Import

    TensorboardExperiment can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/tensorboards/{{tensorboard}}/experiments/{{tensorboard_experiment_id}}
    • {{project}}/{{location}}/{{tensorboard}}/{{tensorboard_experiment_id}}
    • {{location}}/{{tensorboard}}/{{tensorboard_experiment_id}}

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

    $ pulumi import gcp:vertex/aiTensorboardExperiment:AiTensorboardExperiment default projects/{{project}}/locations/{{location}}/tensorboards/{{tensorboard}}/experiments/{{tensorboard_experiment_id}}
$ pulumi import gcp:vertex/aiTensorboardExperiment:AiTensorboardExperiment default {{project}}/{{location}}/{{tensorboard}}/{{tensorboard_experiment_id}}
$ pulumi import gcp:vertex/aiTensorboardExperiment:AiTensorboardExperiment default {{location}}/{{tensorboard}}/{{tensorboard_experiment_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