@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
92 lines • 4.69 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.CatalogWorkspaceBinding = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* > This resource has been deprecated and will be removed soon. Please use the databricks.WorkspaceBinding resource instead.
*
* If you use workspaces to isolate user data access, you may want to limit catalog access to specific workspaces in your account, also known as workspace-catalog binding
*
* By default, Databricks assigns the catalog to all workspaces attached to the current metastore. By using `databricks.CatalogWorkspaceBinding`, the catalog will be unassigned from all workspaces and only assigned explicitly using this resource.
*
* > To use this resource the catalog must have its isolation mode set to `ISOLATED` in the `databricks.Catalog` resource. Alternatively, the isolation mode can be set using the UI or API by following [this guide](https://docs.databricks.com/data-governance/unity-catalog/create-catalogs.html#configuration).
*
* > If the catalog's isolation mode was set to `ISOLATED` using Pulumi then the catalog will have been automatically bound to the workspace it was created from.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const sandbox = new databricks.Catalog("sandbox", {
* name: "sandbox",
* isolationMode: "ISOLATED",
* });
* const sandboxCatalogWorkspaceBinding = new databricks.CatalogWorkspaceBinding("sandbox", {
* securableName: sandbox.name,
* workspaceId: other.workspaceId,
* });
* ```
*
* ## Import
*
* This resource can be imported by using combination of workspace ID, securable type and name:
*
* ```sh
* $ pulumi import databricks:index/catalogWorkspaceBinding:CatalogWorkspaceBinding this "<workspace_id>|<securable_type>|<securable_name>"
* ```
*/
class CatalogWorkspaceBinding extends pulumi.CustomResource {
/**
* Get an existing CatalogWorkspaceBinding 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 CatalogWorkspaceBinding(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of CatalogWorkspaceBinding. 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'] === CatalogWorkspaceBinding.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bindingType"] = state ? state.bindingType : undefined;
resourceInputs["catalogName"] = state ? state.catalogName : undefined;
resourceInputs["securableName"] = state ? state.securableName : undefined;
resourceInputs["securableType"] = state ? state.securableType : undefined;
resourceInputs["workspaceId"] = state ? state.workspaceId : undefined;
}
else {
const args = argsOrState;
resourceInputs["bindingType"] = args ? args.bindingType : undefined;
resourceInputs["catalogName"] = args ? args.catalogName : undefined;
resourceInputs["securableName"] = args ? args.securableName : undefined;
resourceInputs["securableType"] = args ? args.securableType : undefined;
resourceInputs["workspaceId"] = args ? args.workspaceId : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(CatalogWorkspaceBinding.__pulumiType, name, resourceInputs, opts);
}
}
exports.CatalogWorkspaceBinding = CatalogWorkspaceBinding;
/** @internal */
CatalogWorkspaceBinding.__pulumiType = 'databricks:index/catalogWorkspaceBinding:CatalogWorkspaceBinding';
//# sourceMappingURL=catalogWorkspaceBinding.js.map