1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. MetastoreDataAccess
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Private Preview This feature is in Private Preview. Contact your Databricks representative to request access.

    Each databricks.Metastore requires an IAM role that will be assumed by Unity Catalog to access data. databricks.MetastoreDataAccess defines this

    Create MetastoreDataAccess Resource

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

    Constructor syntax

    new MetastoreDataAccess(name: string, args: MetastoreDataAccessArgs, opts?: CustomResourceOptions);
    @overload
    def MetastoreDataAccess(resource_name: str,
                            args: MetastoreDataAccessArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def MetastoreDataAccess(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            metastore_id: Optional[str] = None,
                            aws_iam_role: Optional[MetastoreDataAccessAwsIamRoleArgs] = None,
                            azure_service_principal: Optional[MetastoreDataAccessAzureServicePrincipalArgs] = None,
                            configuration_type: Optional[str] = None,
                            is_default: Optional[bool] = None,
                            name: Optional[str] = None)
    func NewMetastoreDataAccess(ctx *Context, name string, args MetastoreDataAccessArgs, opts ...ResourceOption) (*MetastoreDataAccess, error)
    public MetastoreDataAccess(string name, MetastoreDataAccessArgs args, CustomResourceOptions? opts = null)
    public MetastoreDataAccess(String name, MetastoreDataAccessArgs args)
    public MetastoreDataAccess(String name, MetastoreDataAccessArgs args, CustomResourceOptions options)
    
    type: databricks:MetastoreDataAccess
    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 MetastoreDataAccessArgs
    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 MetastoreDataAccessArgs
    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 MetastoreDataAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetastoreDataAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetastoreDataAccessArgs
    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 metastoreDataAccessResource = new Databricks.MetastoreDataAccess("metastoreDataAccessResource", new()
    {
        MetastoreId = "string",
        AwsIamRole = new Databricks.Inputs.MetastoreDataAccessAwsIamRoleArgs
        {
            RoleArn = "string",
        },
        AzureServicePrincipal = new Databricks.Inputs.MetastoreDataAccessAzureServicePrincipalArgs
        {
            ApplicationId = "string",
            ClientSecret = "string",
            DirectoryId = "string",
        },
        ConfigurationType = "string",
        IsDefault = false,
        Name = "string",
    });
    
    example, err := databricks.NewMetastoreDataAccess(ctx, "metastoreDataAccessResource", &databricks.MetastoreDataAccessArgs{
    	MetastoreId: pulumi.String("string"),
    	AwsIamRole: &databricks.MetastoreDataAccessAwsIamRoleArgs{
    		RoleArn: pulumi.String("string"),
    	},
    	AzureServicePrincipal: &databricks.MetastoreDataAccessAzureServicePrincipalArgs{
    		ApplicationId: pulumi.String("string"),
    		ClientSecret:  pulumi.String("string"),
    		DirectoryId:   pulumi.String("string"),
    	},
    	ConfigurationType: pulumi.String("string"),
    	IsDefault:         pulumi.Bool(false),
    	Name:              pulumi.String("string"),
    })
    
    var metastoreDataAccessResource = new MetastoreDataAccess("metastoreDataAccessResource", MetastoreDataAccessArgs.builder()
        .metastoreId("string")
        .awsIamRole(MetastoreDataAccessAwsIamRoleArgs.builder()
            .roleArn("string")
            .build())
        .azureServicePrincipal(MetastoreDataAccessAzureServicePrincipalArgs.builder()
            .applicationId("string")
            .clientSecret("string")
            .directoryId("string")
            .build())
        .configurationType("string")
        .isDefault(false)
        .name("string")
        .build());
    
    metastore_data_access_resource = databricks.MetastoreDataAccess("metastoreDataAccessResource",
        metastore_id="string",
        aws_iam_role={
            "role_arn": "string",
        },
        azure_service_principal={
            "application_id": "string",
            "client_secret": "string",
            "directory_id": "string",
        },
        configuration_type="string",
        is_default=False,
        name="string")
    
    const metastoreDataAccessResource = new databricks.MetastoreDataAccess("metastoreDataAccessResource", {
        metastoreId: "string",
        awsIamRole: {
            roleArn: "string",
        },
        azureServicePrincipal: {
            applicationId: "string",
            clientSecret: "string",
            directoryId: "string",
        },
        configurationType: "string",
        isDefault: false,
        name: "string",
    });
    
    type: databricks:MetastoreDataAccess
    properties:
        awsIamRole:
            roleArn: string
        azureServicePrincipal:
            applicationId: string
            clientSecret: string
            directoryId: string
        configurationType: string
        isDefault: false
        metastoreId: string
        name: string
    

    MetastoreDataAccess 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 MetastoreDataAccess resource accepts the following input properties:

    MetastoreId string
    Unique identifier of the parent Metastore
    AwsIamRole MetastoreDataAccessAwsIamRole
    AzureServicePrincipal MetastoreDataAccessAzureServicePrincipal
    ConfigurationType string
    IsDefault bool
    Name string
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    MetastoreId string
    Unique identifier of the parent Metastore
    AwsIamRole MetastoreDataAccessAwsIamRoleArgs
    AzureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
    ConfigurationType string
    IsDefault bool
    Name string
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    metastoreId String
    Unique identifier of the parent Metastore
    awsIamRole MetastoreDataAccessAwsIamRole
    azureServicePrincipal MetastoreDataAccessAzureServicePrincipal
    configurationType String
    isDefault Boolean
    name String
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    metastoreId string
    Unique identifier of the parent Metastore
    awsIamRole MetastoreDataAccessAwsIamRole
    azureServicePrincipal MetastoreDataAccessAzureServicePrincipal
    configurationType string
    isDefault boolean
    name string
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    metastore_id str
    Unique identifier of the parent Metastore
    aws_iam_role MetastoreDataAccessAwsIamRoleArgs
    azure_service_principal MetastoreDataAccessAzureServicePrincipalArgs
    configuration_type str
    is_default bool
    name str
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    metastoreId String
    Unique identifier of the parent Metastore
    awsIamRole Property Map
    azureServicePrincipal Property Map
    configurationType String
    isDefault Boolean
    name String
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MetastoreDataAccess 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 MetastoreDataAccess Resource

    Get an existing MetastoreDataAccess 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?: MetastoreDataAccessState, opts?: CustomResourceOptions): MetastoreDataAccess
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aws_iam_role: Optional[MetastoreDataAccessAwsIamRoleArgs] = None,
            azure_service_principal: Optional[MetastoreDataAccessAzureServicePrincipalArgs] = None,
            configuration_type: Optional[str] = None,
            is_default: Optional[bool] = None,
            metastore_id: Optional[str] = None,
            name: Optional[str] = None) -> MetastoreDataAccess
    func GetMetastoreDataAccess(ctx *Context, name string, id IDInput, state *MetastoreDataAccessState, opts ...ResourceOption) (*MetastoreDataAccess, error)
    public static MetastoreDataAccess Get(string name, Input<string> id, MetastoreDataAccessState? state, CustomResourceOptions? opts = null)
    public static MetastoreDataAccess get(String name, Output<String> id, MetastoreDataAccessState state, CustomResourceOptions options)
    resources:  _:    type: databricks:MetastoreDataAccess    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:
    AwsIamRole MetastoreDataAccessAwsIamRole
    AzureServicePrincipal MetastoreDataAccessAzureServicePrincipal
    ConfigurationType string
    IsDefault bool
    MetastoreId string
    Unique identifier of the parent Metastore
    Name string
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    AwsIamRole MetastoreDataAccessAwsIamRoleArgs
    AzureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
    ConfigurationType string
    IsDefault bool
    MetastoreId string
    Unique identifier of the parent Metastore
    Name string
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    awsIamRole MetastoreDataAccessAwsIamRole
    azureServicePrincipal MetastoreDataAccessAzureServicePrincipal
    configurationType String
    isDefault Boolean
    metastoreId String
    Unique identifier of the parent Metastore
    name String
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    awsIamRole MetastoreDataAccessAwsIamRole
    azureServicePrincipal MetastoreDataAccessAzureServicePrincipal
    configurationType string
    isDefault boolean
    metastoreId string
    Unique identifier of the parent Metastore
    name string
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    aws_iam_role MetastoreDataAccessAwsIamRoleArgs
    azure_service_principal MetastoreDataAccessAzureServicePrincipalArgs
    configuration_type str
    is_default bool
    metastore_id str
    Unique identifier of the parent Metastore
    name str
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.
    awsIamRole Property Map
    azureServicePrincipal Property Map
    configurationType String
    isDefault Boolean
    metastoreId String
    Unique identifier of the parent Metastore
    name String
    Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.

    Supporting Types

    MetastoreDataAccessAwsIamRole, MetastoreDataAccessAwsIamRoleArgs

    RoleArn string
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    RoleArn string
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    roleArn String
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    roleArn string
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    role_arn str
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF
    roleArn String
    The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF

    MetastoreDataAccessAzureServicePrincipal, MetastoreDataAccessAzureServicePrincipalArgs

    ApplicationId string
    The application ID of the application registration within the referenced AAD tenant
    ClientSecret string
    The client secret generated for the above app ID in AAD. This field is redacted on output
    DirectoryId string
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    ApplicationId string
    The application ID of the application registration within the referenced AAD tenant
    ClientSecret string
    The client secret generated for the above app ID in AAD. This field is redacted on output
    DirectoryId string
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    applicationId String
    The application ID of the application registration within the referenced AAD tenant
    clientSecret String
    The client secret generated for the above app ID in AAD. This field is redacted on output
    directoryId String
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    applicationId string
    The application ID of the application registration within the referenced AAD tenant
    clientSecret string
    The client secret generated for the above app ID in AAD. This field is redacted on output
    directoryId string
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    application_id str
    The application ID of the application registration within the referenced AAD tenant
    client_secret str
    The client secret generated for the above app ID in AAD. This field is redacted on output
    directory_id str
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application
    applicationId String
    The application ID of the application registration within the referenced AAD tenant
    clientSecret String
    The client secret generated for the above app ID in AAD. This field is redacted on output
    directoryId String
    The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application

    Import

    -> Note Importing this resource is not currently supported.

    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
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.