@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
128 lines • 5.22 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! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.RegisteredModel = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* This resource allows you to create [Models in Unity Catalog](https://docs.databricks.com/en/mlflow/models-in-uc.html) in Databricks.
*
* > This resource can only be used with a workspace-level provider!
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.RegisteredModel("this", {
* name: "my_model",
* catalogName: "main",
* schemaName: "default",
* });
* ```
*
* ## Access Control
*
* * databricks.Grants can be used to grant principals `ALL_PRIVILEGES`, `APPLY_TAG`, and `EXECUTE` privileges.
*
* ## Related Resources
*
* The following resources are often used in the same context:
*
* * databricks.ModelServing to serve this model on a Databricks serving endpoint.
* * databricks.MlflowExperiment to manage [MLflow experiments](https://docs.databricks.com/data/data-sources/mlflow-experiment.html) in Databricks.
* * databricks.Schema to manage schemas within Unity Catalog.
* * databricks.Catalog to manage catalogs within Unity Catalog.
*
* ## Import
*
* The registered model resource can be imported using the full (3-level) name of the model.
*
* hcl
*
* import {
*
* to = databricks_registered_model.this
*
* id = "<catalog_name>.<schema_name>.<model_name>"
*
* }
*
* Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
*
* bash
*
* ```sh
* $ pulumi import databricks:index/registeredModel:RegisteredModel this <catalog_name>.<schema_name>.<model_name>
* ```
*/
class RegisteredModel extends pulumi.CustomResource {
/**
* Get an existing RegisteredModel 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 RegisteredModel(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of RegisteredModel. 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'] === RegisteredModel.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["aliases"] = state?.aliases;
resourceInputs["browseOnly"] = state?.browseOnly;
resourceInputs["catalogName"] = state?.catalogName;
resourceInputs["comment"] = state?.comment;
resourceInputs["createdAt"] = state?.createdAt;
resourceInputs["createdBy"] = state?.createdBy;
resourceInputs["fullName"] = state?.fullName;
resourceInputs["metastoreId"] = state?.metastoreId;
resourceInputs["name"] = state?.name;
resourceInputs["owner"] = state?.owner;
resourceInputs["schemaName"] = state?.schemaName;
resourceInputs["storageLocation"] = state?.storageLocation;
resourceInputs["updatedAt"] = state?.updatedAt;
resourceInputs["updatedBy"] = state?.updatedBy;
}
else {
const args = argsOrState;
resourceInputs["aliases"] = args?.aliases;
resourceInputs["browseOnly"] = args?.browseOnly;
resourceInputs["catalogName"] = args?.catalogName;
resourceInputs["comment"] = args?.comment;
resourceInputs["createdAt"] = args?.createdAt;
resourceInputs["createdBy"] = args?.createdBy;
resourceInputs["fullName"] = args?.fullName;
resourceInputs["metastoreId"] = args?.metastoreId;
resourceInputs["name"] = args?.name;
resourceInputs["owner"] = args?.owner;
resourceInputs["schemaName"] = args?.schemaName;
resourceInputs["storageLocation"] = args?.storageLocation;
resourceInputs["updatedAt"] = args?.updatedAt;
resourceInputs["updatedBy"] = args?.updatedBy;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(RegisteredModel.__pulumiType, name, resourceInputs, opts);
}
}
exports.RegisteredModel = RegisteredModel;
/** @internal */
RegisteredModel.__pulumiType = 'databricks:index/registeredModel:RegisteredModel';
//# sourceMappingURL=registeredModel.js.map