Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. Metastore
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.Metastore

Explore with Pulumi AI

databricks logo
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

    This resource can be used with an account or workspace-level provider.

    A metastore is the top-level container of objects in Unity Catalog. It stores data assets (tables and views) and the permissions that govern access to them. Databricks account admins can create metastores and assign them to Databricks workspaces in order to control which workloads use each metastore.

    Unity Catalog offers a new metastore with built in security and auditing. This is distinct to the metastore used in previous versions of Databricks (based on the Hive Metastore).

    A Unity Catalog metastore can be created without a root location & credential to maintain strict separation of storage across catalogs or environments.

    Example Usage

    For AWS

    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 pulumi
import pulumi_databricks as databricks

this = databricks.Metastore("this",
    name="primary",
    storage_root=f"s3://{metastore['id']}/metastore",
    owner="uc admins",
    region="us-east-1",
    force_destroy=True)
this_metastore_assignment = databricks.MetastoreAssignment("this",
    metastore_id=this.id,
    workspace_id=workspace_id)

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := databricks.NewMetastore(ctx, "this", &databricks.MetastoreArgs{
			Name:         pulumi.String("primary"),
			StorageRoot:  pulumi.Sprintf("s3://%v/metastore", metastore.Id),
			Owner:        pulumi.String("uc admins"),
			Region:       pulumi.String("us-east-1"),
			ForceDestroy: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewMetastoreAssignment(ctx, "this", &databricks.MetastoreAssignmentArgs{
			MetastoreId: this.ID(),
			WorkspaceId: pulumi.Any(workspaceId),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.Metastore("this", new()
    {
        Name = "primary",
        StorageRoot = $"s3://{metastore.Id}/metastore",
        Owner = "uc admins",
        Region = "us-east-1",
        ForceDestroy = true,
    });

    var thisMetastoreAssignment = new Databricks.MetastoreAssignment("this", new()
    {
        MetastoreId = @this.Id,
        WorkspaceId = workspaceId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Metastore;
import com.pulumi.databricks.MetastoreArgs;
import com.pulumi.databricks.MetastoreAssignment;
import com.pulumi.databricks.MetastoreAssignmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new Metastore("this", MetastoreArgs.builder()
            .name("primary")
            .storageRoot(String.format("s3://%s/metastore", metastore.id()))
            .owner("uc admins")
            .region("us-east-1")
            .forceDestroy(true)
            .build());

        var thisMetastoreAssignment = new MetastoreAssignment("thisMetastoreAssignment", MetastoreAssignmentArgs.builder()
            .metastoreId(this_.id())
            .workspaceId(workspaceId)
            .build());

    }
}

    resources:
  this:
    type: databricks:Metastore
    properties:
      name: primary
      storageRoot: s3://${metastore.id}/metastore
      owner: uc admins
      region: us-east-1
      forceDestroy: true
  thisMetastoreAssignment:
    type: databricks:MetastoreAssignment
    name: this
    properties:
      metastoreId: ${this.id}
      workspaceId: ${workspaceId}

    For Azure

    Create Metastore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Metastore(name: string, args?: MetastoreArgs, opts?: CustomResourceOptions);
    @overload
def Metastore(resource_name: str,
              args: Optional[MetastoreArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Metastore(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cloud: Optional[str] = None,
              created_at: Optional[int] = None,
              created_by: Optional[str] = None,
              default_data_access_config_id: Optional[str] = None,
              delta_sharing_organization_name: Optional[str] = None,
              delta_sharing_recipient_token_lifetime_in_seconds: Optional[int] = None,
              delta_sharing_scope: Optional[str] = None,
              force_destroy: Optional[bool] = None,
              global_metastore_id: Optional[str] = None,
              metastore_id: Optional[str] = None,
              name: Optional[str] = None,
              owner: Optional[str] = None,
              region: Optional[str] = None,
              storage_root: Optional[str] = None,
              storage_root_credential_id: Optional[str] = None,
              updated_at: Optional[int] = None,
              updated_by: Optional[str] = None)
    func NewMetastore(ctx *Context, name string, args *MetastoreArgs, opts ...ResourceOption) (*Metastore, error)
    public Metastore(string name, MetastoreArgs? args = null, CustomResourceOptions? opts = null)
    public Metastore(String name, MetastoreArgs args)
public Metastore(String name, MetastoreArgs args, CustomResourceOptions options)

    type: databricks:Metastore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MetastoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MetastoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MetastoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetastoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetastoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var metastoreResource = new Databricks.Metastore("metastoreResource", new()
{
    Cloud = "string",
    CreatedAt = 0,
    CreatedBy = "string",
    DefaultDataAccessConfigId = "string",
    DeltaSharingOrganizationName = "string",
    DeltaSharingRecipientTokenLifetimeInSeconds = 0,
    DeltaSharingScope = "string",
    ForceDestroy = false,
    GlobalMetastoreId = "string",
    MetastoreId = "string",
    Name = "string",
    Owner = "string",
    Region = "string",
    StorageRoot = "string",
    StorageRootCredentialId = "string",
    UpdatedAt = 0,
    UpdatedBy = "string",
});

    example, err := databricks.NewMetastore(ctx, "metastoreResource", &databricks.MetastoreArgs{
	Cloud:                        pulumi.String("string"),
	CreatedAt:                    pulumi.Int(0),
	CreatedBy:                    pulumi.String("string"),
	DefaultDataAccessConfigId:    pulumi.String("string"),
	DeltaSharingOrganizationName: pulumi.String("string"),
	DeltaSharingRecipientTokenLifetimeInSeconds: pulumi.Int(0),
	DeltaSharingScope:       pulumi.String("string"),
	ForceDestroy:            pulumi.Bool(false),
	GlobalMetastoreId:       pulumi.String("string"),
	MetastoreId:             pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Owner:                   pulumi.String("string"),
	Region:                  pulumi.String("string"),
	StorageRoot:             pulumi.String("string"),
	StorageRootCredentialId: pulumi.String("string"),
	UpdatedAt:               pulumi.Int(0),
	UpdatedBy:               pulumi.String("string"),
})

    var metastoreResource = new Metastore("metastoreResource", MetastoreArgs.builder()
    .cloud("string")
    .createdAt(0)
    .createdBy("string")
    .defaultDataAccessConfigId("string")
    .deltaSharingOrganizationName("string")
    .deltaSharingRecipientTokenLifetimeInSeconds(0)
    .deltaSharingScope("string")
    .forceDestroy(false)
    .globalMetastoreId("string")
    .metastoreId("string")
    .name("string")
    .owner("string")
    .region("string")
    .storageRoot("string")
    .storageRootCredentialId("string")
    .updatedAt(0)
    .updatedBy("string")
    .build());

    metastore_resource = databricks.Metastore("metastoreResource",
    cloud="string",
    created_at=0,
    created_by="string",
    default_data_access_config_id="string",
    delta_sharing_organization_name="string",
    delta_sharing_recipient_token_lifetime_in_seconds=0,
    delta_sharing_scope="string",
    force_destroy=False,
    global_metastore_id="string",
    metastore_id="string",
    name="string",
    owner="string",
    region="string",
    storage_root="string",
    storage_root_credential_id="string",
    updated_at=0,
    updated_by="string")

    const metastoreResource = new databricks.Metastore("metastoreResource", {
    cloud: "string",
    createdAt: 0,
    createdBy: "string",
    defaultDataAccessConfigId: "string",
    deltaSharingOrganizationName: "string",
    deltaSharingRecipientTokenLifetimeInSeconds: 0,
    deltaSharingScope: "string",
    forceDestroy: false,
    globalMetastoreId: "string",
    metastoreId: "string",
    name: "string",
    owner: "string",
    region: "string",
    storageRoot: "string",
    storageRootCredentialId: "string",
    updatedAt: 0,
    updatedBy: "string",
});

    type: databricks:Metastore
properties:
    cloud: string
    createdAt: 0
    createdBy: string
    defaultDataAccessConfigId: string
    deltaSharingOrganizationName: string
    deltaSharingRecipientTokenLifetimeInSeconds: 0
    deltaSharingScope: string
    forceDestroy: false
    globalMetastoreId: string
    metastoreId: string
    name: string
    owner: string
    region: string
    storageRoot: string
    storageRootCredentialId: string
    updatedAt: 0
    updatedBy: string

    Metastore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Metastore resource accepts the following input properties:

    Cloud string
    CreatedAt int
    CreatedBy string
    DefaultDataAccessConfigId string
    DeltaSharingOrganizationName string
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    DeltaSharingRecipientTokenLifetimeInSeconds int
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    DeltaSharingScope string
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    ForceDestroy bool
    Destroy metastore regardless of its contents.
    GlobalMetastoreId string
    MetastoreId string
    Name string
    Name of metastore.
    Owner string
    Username/groupname/sp application_id of the metastore owner.
    Region string
    The region of the metastore
    StorageRoot string
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    StorageRootCredentialId string
    UpdatedAt int
    UpdatedBy string
    Cloud string
    CreatedAt int
    CreatedBy string
    DefaultDataAccessConfigId string
    DeltaSharingOrganizationName string
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    DeltaSharingRecipientTokenLifetimeInSeconds int
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    DeltaSharingScope string
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    ForceDestroy bool
    Destroy metastore regardless of its contents.
    GlobalMetastoreId string
    MetastoreId string
    Name string
    Name of metastore.
    Owner string
    Username/groupname/sp application_id of the metastore owner.
    Region string
    The region of the metastore
    StorageRoot string
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    StorageRootCredentialId string
    UpdatedAt int
    UpdatedBy string
    cloud String
    createdAt Integer
    createdBy String
    defaultDataAccessConfigId String
    deltaSharingOrganizationName String
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    deltaSharingRecipientTokenLifetimeInSeconds Integer
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    deltaSharingScope String
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    forceDestroy Boolean
    Destroy metastore regardless of its contents.
    globalMetastoreId String
    metastoreId String
    name String
    Name of metastore.
    owner String
    Username/groupname/sp application_id of the metastore owner.
    region String
    The region of the metastore
    storageRoot String
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storageRootCredentialId String
    updatedAt Integer
    updatedBy String
    cloud string
    createdAt number
    createdBy string
    defaultDataAccessConfigId string
    deltaSharingOrganizationName string
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    deltaSharingRecipientTokenLifetimeInSeconds number
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    deltaSharingScope string
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    forceDestroy boolean
    Destroy metastore regardless of its contents.
    globalMetastoreId string
    metastoreId string
    name string
    Name of metastore.
    owner string
    Username/groupname/sp application_id of the metastore owner.
    region string
    The region of the metastore
    storageRoot string
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storageRootCredentialId string
    updatedAt number
    updatedBy string
    cloud str
    created_at int
    created_by str
    default_data_access_config_id str
    delta_sharing_organization_name str
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    delta_sharing_recipient_token_lifetime_in_seconds int
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    delta_sharing_scope str
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    force_destroy bool
    Destroy metastore regardless of its contents.
    global_metastore_id str
    metastore_id str
    name str
    Name of metastore.
    owner str
    Username/groupname/sp application_id of the metastore owner.
    region str
    The region of the metastore
    storage_root str
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storage_root_credential_id str
    updated_at int
    updated_by str
    cloud String
    createdAt Number
    createdBy String
    defaultDataAccessConfigId String
    deltaSharingOrganizationName String
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    deltaSharingRecipientTokenLifetimeInSeconds Number
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    deltaSharingScope String
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    forceDestroy Boolean
    Destroy metastore regardless of its contents.
    globalMetastoreId String
    metastoreId String
    name String
    Name of metastore.
    owner String
    Username/groupname/sp application_id of the metastore owner.
    region String
    The region of the metastore
    storageRoot String
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storageRootCredentialId String
    updatedAt Number
    updatedBy String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Metastore resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Metastore Resource

    Get an existing Metastore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MetastoreState, opts?: CustomResourceOptions): Metastore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud: Optional[str] = None,
        created_at: Optional[int] = None,
        created_by: Optional[str] = None,
        default_data_access_config_id: Optional[str] = None,
        delta_sharing_organization_name: Optional[str] = None,
        delta_sharing_recipient_token_lifetime_in_seconds: Optional[int] = None,
        delta_sharing_scope: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        global_metastore_id: Optional[str] = None,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        region: Optional[str] = None,
        storage_root: Optional[str] = None,
        storage_root_credential_id: Optional[str] = None,
        updated_at: Optional[int] = None,
        updated_by: Optional[str] = None) -> Metastore
    func GetMetastore(ctx *Context, name string, id IDInput, state *MetastoreState, opts ...ResourceOption) (*Metastore, error)
    public static Metastore Get(string name, Input<string> id, MetastoreState? state, CustomResourceOptions? opts = null)
    public static Metastore get(String name, Output<String> id, MetastoreState state, CustomResourceOptions options)
    resources:  _:    type: databricks:Metastore    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Cloud string
    CreatedAt int
    CreatedBy string
    DefaultDataAccessConfigId string
    DeltaSharingOrganizationName string
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    DeltaSharingRecipientTokenLifetimeInSeconds int
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    DeltaSharingScope string
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    ForceDestroy bool
    Destroy metastore regardless of its contents.
    GlobalMetastoreId string
    MetastoreId string
    Name string
    Name of metastore.
    Owner string
    Username/groupname/sp application_id of the metastore owner.
    Region string
    The region of the metastore
    StorageRoot string
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    StorageRootCredentialId string
    UpdatedAt int
    UpdatedBy string
    Cloud string
    CreatedAt int
    CreatedBy string
    DefaultDataAccessConfigId string
    DeltaSharingOrganizationName string
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    DeltaSharingRecipientTokenLifetimeInSeconds int
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    DeltaSharingScope string
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    ForceDestroy bool
    Destroy metastore regardless of its contents.
    GlobalMetastoreId string
    MetastoreId string
    Name string
    Name of metastore.
    Owner string
    Username/groupname/sp application_id of the metastore owner.
    Region string
    The region of the metastore
    StorageRoot string
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    StorageRootCredentialId string
    UpdatedAt int
    UpdatedBy string
    cloud String
    createdAt Integer
    createdBy String
    defaultDataAccessConfigId String
    deltaSharingOrganizationName String
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    deltaSharingRecipientTokenLifetimeInSeconds Integer
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    deltaSharingScope String
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    forceDestroy Boolean
    Destroy metastore regardless of its contents.
    globalMetastoreId String
    metastoreId String
    name String
    Name of metastore.
    owner String
    Username/groupname/sp application_id of the metastore owner.
    region String
    The region of the metastore
    storageRoot String
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storageRootCredentialId String
    updatedAt Integer
    updatedBy String
    cloud string
    createdAt number
    createdBy string
    defaultDataAccessConfigId string
    deltaSharingOrganizationName string
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    deltaSharingRecipientTokenLifetimeInSeconds number
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    deltaSharingScope string
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    forceDestroy boolean
    Destroy metastore regardless of its contents.
    globalMetastoreId string
    metastoreId string
    name string
    Name of metastore.
    owner string
    Username/groupname/sp application_id of the metastore owner.
    region string
    The region of the metastore
    storageRoot string
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storageRootCredentialId string
    updatedAt number
    updatedBy string
    cloud str
    created_at int
    created_by str
    default_data_access_config_id str
    delta_sharing_organization_name str
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    delta_sharing_recipient_token_lifetime_in_seconds int
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    delta_sharing_scope str
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    force_destroy bool
    Destroy metastore regardless of its contents.
    global_metastore_id str
    metastore_id str
    name str
    Name of metastore.
    owner str
    Username/groupname/sp application_id of the metastore owner.
    region str
    The region of the metastore
    storage_root str
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storage_root_credential_id str
    updated_at int
    updated_by str
    cloud String
    createdAt Number
    createdBy String
    defaultDataAccessConfigId String
    deltaSharingOrganizationName String
    The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing. Once this is set it cannot be removed and can only be modified to another valid value. To delete this value please taint and recreate the resource.
    deltaSharingRecipientTokenLifetimeInSeconds Number
    Required along with delta_sharing_scope. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.
    deltaSharingScope String
    Required along with delta_sharing_recipient_token_lifetime_in_seconds. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL. INTERNAL only allows sharing within the same account, and INTERNAL_AND_EXTERNAL allows cross account sharing and token based sharing.
    forceDestroy Boolean
    Destroy metastore regardless of its contents.
    globalMetastoreId String
    metastoreId String
    name String
    Name of metastore.
    owner String
    Username/groupname/sp application_id of the metastore owner.
    region String
    The region of the metastore
    storageRoot String
    Path on cloud storage account, where managed databricks.Table are stored. Change forces creation of a new resource. If no storage_root is defined for the metastore, each catalog must have a storage_root defined.
    storageRootCredentialId String
    updatedAt Number
    updatedBy String

    Import

    This resource can be imported by ID:

    bash

    $ pulumi import databricks:index/metastore:Metastore this <id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-databricks