@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; /** * A TensorboardRun is a single execution of a training job. * * To get more information about TensorboardRun, see: * * * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments.runs) * * How-to Guides * * [Official Documentation](https://cloud.google.com/vertex-ai/docs) * * ## Example Usage * * ### Vertex Ai Tensorboard Run Basic * * ```typescript * 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 * * 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: * * ```sh * $ 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}} * ``` */ export declare class AiTensorboardRun extends pulumi.CustomResource { /** * Get an existing AiTensorboardRun resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AiTensorboardRunState, opts?: pulumi.CustomResourceOptions): AiTensorboardRun; /** * Returns true if the given object is an instance of AiTensorboardRun. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is AiTensorboardRun; /** * Timestamp when this TensorboardRun was created. */ readonly createTime: pulumi.Output<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. */ readonly deletionPolicy: pulumi.Output<string>; /** * Description of this TensorboardRun. */ readonly description: pulumi.Output<string | undefined>; /** * User provided name of this TensorboardRun. * This value must be unique among all TensorboardRuns * belonging to the same parent TensorboardExperiment. */ readonly displayName: pulumi.Output<string>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * The Tensorboard Experiment ID. */ readonly experiment: pulumi.Output<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. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The location of the Tensorboard Run. eg us-central1 */ readonly location: pulumi.Output<string>; /** * Name of the TensorboardRun. * Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` */ readonly name: pulumi.Output<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * The Tensorboard instance. */ readonly tensorboard: pulumi.Output<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-/`. */ readonly tensorboardRunId: pulumi.Output<string>; /** * Timestamp when this TensorboardRun was last updated. */ readonly updateTime: pulumi.Output<string>; /** * Create a AiTensorboardRun resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: AiTensorboardRunArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AiTensorboardRun resources. */ export interface AiTensorboardRunState { /** * Timestamp when this TensorboardRun was created. */ createTime?: pulumi.Input<string | undefined>; /** * 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. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * Description of this TensorboardRun. */ description?: pulumi.Input<string | undefined>; /** * User provided name of this TensorboardRun. * This value must be unique among all TensorboardRuns * belonging to the same parent TensorboardExperiment. */ displayName?: pulumi.Input<string | undefined>; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The Tensorboard Experiment ID. */ experiment?: pulumi.Input<string | undefined>; /** * 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. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The location of the Tensorboard Run. eg us-central1 */ location?: pulumi.Input<string | undefined>; /** * Name of the TensorboardRun. * Format: * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` */ name?: pulumi.Input<string | undefined>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The Tensorboard instance. */ tensorboard?: pulumi.Input<string | undefined>; /** * 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-/`. */ tensorboardRunId?: pulumi.Input<string | undefined>; /** * Timestamp when this TensorboardRun was last updated. */ updateTime?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a AiTensorboardRun resource. */ export interface AiTensorboardRunArgs { /** * 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. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * Description of this TensorboardRun. */ description?: pulumi.Input<string | undefined>; /** * User provided name of this TensorboardRun. * This value must be unique among all TensorboardRuns * belonging to the same parent TensorboardExperiment. */ displayName: pulumi.Input<string>; /** * The Tensorboard Experiment ID. */ experiment: pulumi.Input<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. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The location of the Tensorboard Run. eg us-central1 */ location: pulumi.Input<string>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input<string | undefined>; /** * The Tensorboard instance. */ tensorboard: pulumi.Input<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-/`. */ tensorboardRunId: pulumi.Input<string>; } //# sourceMappingURL=aiTensorboardRun.d.ts.map