@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
113 lines (112 loc) • 4.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > This resource can be used with an account or workspace-level provider.
*
* A single databricks.Metastore can be shared across Databricks workspaces, and each linked workspace has a consistent view of the data and a single set of access policies. You can only create a single metastore for each region in which your organization operates.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = new databricks.Metastore("this", {
* name: "primary",
* storageRoot: `s3://${metastore.id}/metastore`,
* owner: "uc admins",
* region: "us-east-1",
* forceDestroy: true,
* });
* const thisMetastoreAssignment = new databricks.MetastoreAssignment("this", {
* metastoreId: _this.id,
* workspaceId: workspaceId,
* });
* ```
*
* ## Import
*
* This resource can be imported by combination of workspace id and metastore id:
*
* bash
*
* ```sh
* $ pulumi import databricks:index/metastoreAssignment:MetastoreAssignment this '<workspace_id>|<metastore_id>'
* ```
*/
export declare class MetastoreAssignment extends pulumi.CustomResource {
/**
* Get an existing MetastoreAssignment 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?: MetastoreAssignmentState, opts?: pulumi.CustomResourceOptions): MetastoreAssignment;
/**
* Returns true if the given object is an instance of MetastoreAssignment. 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 MetastoreAssignment;
/**
* Default catalog used for this assignment. Please use databricks.DefaultNamespaceSetting instead.
*
* @deprecated Use databricks.DefaultNamespaceSetting resource instead
*/
readonly defaultCatalogName: pulumi.Output<string>;
/**
* Unique identifier of the parent Metastore
*/
readonly metastoreId: pulumi.Output<string>;
/**
* id of the workspace for the assignment
*/
readonly workspaceId: pulumi.Output<string>;
/**
* Create a MetastoreAssignment 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: MetastoreAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetastoreAssignment resources.
*/
export interface MetastoreAssignmentState {
/**
* Default catalog used for this assignment. Please use databricks.DefaultNamespaceSetting instead.
*
* @deprecated Use databricks.DefaultNamespaceSetting resource instead
*/
defaultCatalogName?: pulumi.Input<string>;
/**
* Unique identifier of the parent Metastore
*/
metastoreId?: pulumi.Input<string>;
/**
* id of the workspace for the assignment
*/
workspaceId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MetastoreAssignment resource.
*/
export interface MetastoreAssignmentArgs {
/**
* Default catalog used for this assignment. Please use databricks.DefaultNamespaceSetting instead.
*
* @deprecated Use databricks.DefaultNamespaceSetting resource instead
*/
defaultCatalogName?: pulumi.Input<string>;
/**
* Unique identifier of the parent Metastore
*/
metastoreId: pulumi.Input<string>;
/**
* id of the workspace for the assignment
*/
workspaceId: pulumi.Input<string>;
}