@pulumi/gcp/vertex/aiTensorboardExperiment.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * A TensorboardExperiment is a group of TensorboardRuns that are logically grouped together.
 *
 * To get more information about TensorboardExperiment, see:
 *
 * * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.tensorboards.experiments)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/vertex-ai/docs)
 *
 * ## Example Usage
 *
 * ### Vertex Ai Tensorboard Experiment 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 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
 *
 * 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:
 *
 * ```sh
 * $ 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}}
 * ```
 */
export declare class AiTensorboardExperiment extends pulumi.CustomResource {
    /**
     * Get an existing AiTensorboardExperiment 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?: AiTensorboardExperimentState, opts?: pulumi.CustomResourceOptions): AiTensorboardExperiment;
    /**
     * Returns true if the given object is an instance of AiTensorboardExperiment.  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 AiTensorboardExperiment;
    /**
     * Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * User provided name of this TensorboardExperiment.
     */
    readonly displayName: pulumi.Output<string | undefined>;
    /**
     * 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 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.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The location of the Tensorboard Experiment. eg us-central1
     */
    readonly location: pulumi.Output<string>;
    /**
     * Name of the TensorboardExperiment.
     * Format:
     * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     */
    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;
    }>;
    /**
     * Source of the TensorboardExperiment. Example: a custom training job.
     */
    readonly source: pulumi.Output<string | undefined>;
    /**
     * The Tensorboard instance.
     */
    readonly tensorboard: pulumi.Output<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-/`.
     */
    readonly tensorboardExperimentId: pulumi.Output<string>;
    /**
     * Timestamp when this TensorboardExperiment was last updated.
     */
    readonly updateTime: pulumi.Output<string>;
    /**
     * Create a AiTensorboardExperiment 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: AiTensorboardExperimentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AiTensorboardExperiment resources.
 */
export interface AiTensorboardExperimentState {
    /**
     * Timestamp when this TensorboardExperiment 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 TensorboardExperiment.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User provided name of this 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 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.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The location of the Tensorboard Experiment. eg us-central1
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * Name of the TensorboardExperiment.
     * Format:
     * `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`
     */
    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>;
    /**
     * Source of the TensorboardExperiment. Example: a custom training job.
     */
    source?: pulumi.Input<string | undefined>;
    /**
     * The Tensorboard instance.
     */
    tensorboard?: pulumi.Input<string | undefined>;
    /**
     * 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-/`.
     */
    tensorboardExperimentId?: pulumi.Input<string | undefined>;
    /**
     * Timestamp when this TensorboardExperiment was last updated.
     */
    updateTime?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a AiTensorboardExperiment resource.
 */
export interface AiTensorboardExperimentArgs {
    /**
     * 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 TensorboardExperiment.
     */
    description?: pulumi.Input<string | undefined>;
    /**
     * User provided name of this TensorboardExperiment.
     */
    displayName?: pulumi.Input<string | undefined>;
    /**
     * 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.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The location of the Tensorboard Experiment. 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>;
    /**
     * Source of the TensorboardExperiment. Example: a custom training job.
     */
    source?: pulumi.Input<string | undefined>;
    /**
     * The Tensorboard instance.
     */
    tensorboard: pulumi.Input<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-/`.
     */
    tensorboardExperimentId: pulumi.Input<string>;
}
//# sourceMappingURL=aiTensorboardExperiment.d.ts.map