@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
175 lines • 8.14 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.AiTensorboardRun = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* 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}}
* ```
*/
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, id, state, opts) {
return new AiTensorboardRun(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:vertex/aiTensorboardRun: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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === AiTensorboardRun.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["experiment"] = state?.experiment;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["tensorboard"] = state?.tensorboard;
resourceInputs["tensorboardRunId"] = state?.tensorboardRunId;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
if (args?.experiment === undefined && !opts.urn) {
throw new Error("Missing required property 'experiment'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.tensorboard === undefined && !opts.urn) {
throw new Error("Missing required property 'tensorboard'");
}
if (args?.tensorboardRunId === undefined && !opts.urn) {
throw new Error("Missing required property 'tensorboardRunId'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["experiment"] = args?.experiment;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["project"] = args?.project;
resourceInputs["tensorboard"] = args?.tensorboard;
resourceInputs["tensorboardRunId"] = args?.tensorboardRunId;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(AiTensorboardRun.__pulumiType, name, resourceInputs, opts);
}
}
exports.AiTensorboardRun = AiTensorboardRun;
//# sourceMappingURL=aiTensorboardRun.js.map