Docs Packages
  1. Pulumi Registry
  2. Databricks
  3. API Docs
  4. MetastoreDataAccess
databricks logo
Databricks v1.14.0, May 23 23

databricks.MetastoreDataAccess

Explore with Pulumi AI

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

Create MetastoreDataAccess Resource

new MetastoreDataAccess(name: string, args: MetastoreDataAccessArgs, opts?: CustomResourceOptions);
@overload
def MetastoreDataAccess(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        aws_iam_role: Optional[MetastoreDataAccessAwsIamRoleArgs] = None,
                        azure_managed_identity: Optional[MetastoreDataAccessAzureManagedIdentityArgs] = None,
                        azure_service_principal: Optional[MetastoreDataAccessAzureServicePrincipalArgs] = None,
                        configuration_type: Optional[str] = None,
                        databricks_gcp_service_account: Optional[MetastoreDataAccessDatabricksGcpServiceAccountArgs] = None,
                        gcp_service_account_key: Optional[MetastoreDataAccessGcpServiceAccountKeyArgs] = None,
                        is_default: Optional[bool] = None,
                        metastore_id: Optional[str] = None,
                        name: Optional[str] = None)
@overload
def MetastoreDataAccess(resource_name: str,
                        args: MetastoreDataAccessArgs,
                        opts: Optional[ResourceOptions] = 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.
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.

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

The MetastoreDataAccess resource accepts the following input properties:

MetastoreId string

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

AwsIamRole MetastoreDataAccessAwsIamRoleArgs
AzureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
AzureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
ConfigurationType string
DatabricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
GcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
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

aws_iam_role optional configuration block for credential details for AWS:

AwsIamRole MetastoreDataAccessAwsIamRoleArgs
AzureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
AzureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
ConfigurationType string
DatabricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
GcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
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

aws_iam_role optional configuration block for credential details for AWS:

awsIamRole MetastoreDataAccessAwsIamRoleArgs
azureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
azureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
configurationType String
databricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
gcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
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

aws_iam_role optional configuration block for credential details for AWS:

awsIamRole MetastoreDataAccessAwsIamRoleArgs
azureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
azureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
configurationType string
databricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
gcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
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 optional configuration block for credential details for AWS:

aws_iam_role MetastoreDataAccessAwsIamRoleArgs
azure_managed_identity MetastoreDataAccessAzureManagedIdentityArgs
azure_service_principal MetastoreDataAccessAzureServicePrincipalArgs
configuration_type str
databricks_gcp_service_account MetastoreDataAccessDatabricksGcpServiceAccountArgs
gcp_service_account_key MetastoreDataAccessGcpServiceAccountKeyArgs
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

aws_iam_role optional configuration block for credential details for AWS:

awsIamRole Property Map
azureManagedIdentity Property Map
azureServicePrincipal Property Map
configurationType String
databricksGcpServiceAccount Property Map
gcpServiceAccountKey Property Map
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_managed_identity: Optional[MetastoreDataAccessAzureManagedIdentityArgs] = None,
        azure_service_principal: Optional[MetastoreDataAccessAzureServicePrincipalArgs] = None,
        configuration_type: Optional[str] = None,
        databricks_gcp_service_account: Optional[MetastoreDataAccessDatabricksGcpServiceAccountArgs] = None,
        gcp_service_account_key: Optional[MetastoreDataAccessGcpServiceAccountKeyArgs] = 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)
Resource lookup is not supported in YAML
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 MetastoreDataAccessAwsIamRoleArgs
AzureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
AzureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
ConfigurationType string
DatabricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
GcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
IsDefault bool
MetastoreId string

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

Name string

Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.

AwsIamRole MetastoreDataAccessAwsIamRoleArgs
AzureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
AzureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
ConfigurationType string
DatabricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
GcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
IsDefault bool
MetastoreId string

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

Name string

Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.

awsIamRole MetastoreDataAccessAwsIamRoleArgs
azureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
azureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
configurationType String
databricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
gcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
isDefault Boolean
metastoreId String

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

name String

Name of Data Access Configuration, which must be unique within the databricks_metastore. Change forces creation of a new resource.

awsIamRole MetastoreDataAccessAwsIamRoleArgs
azureManagedIdentity MetastoreDataAccessAzureManagedIdentityArgs
azureServicePrincipal MetastoreDataAccessAzureServicePrincipalArgs
configurationType string
databricksGcpServiceAccount MetastoreDataAccessDatabricksGcpServiceAccountArgs
gcpServiceAccountKey MetastoreDataAccessGcpServiceAccountKeyArgs
isDefault boolean
metastoreId string

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

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_managed_identity MetastoreDataAccessAzureManagedIdentityArgs
azure_service_principal MetastoreDataAccessAzureServicePrincipalArgs
configuration_type str
databricks_gcp_service_account MetastoreDataAccessDatabricksGcpServiceAccountArgs
gcp_service_account_key MetastoreDataAccessGcpServiceAccountKeyArgs
is_default bool
metastore_id str

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

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
azureManagedIdentity Property Map
azureServicePrincipal Property Map
configurationType String
databricksGcpServiceAccount Property Map
gcpServiceAccountKey Property Map
isDefault Boolean
metastoreId String

Unique identifier of the parent Metastore

aws_iam_role optional configuration block for credential details for AWS:

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

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

azure_service_principal optional configuration block for credential details for Azure:

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

azure_service_principal optional configuration block for credential details for Azure:

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

azure_service_principal optional configuration block for credential details for Azure:

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

azure_service_principal optional configuration block for credential details for Azure:

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

azure_service_principal optional configuration block for credential details for Azure:

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

azure_service_principal optional configuration block for credential details for Azure:

MetastoreDataAccessAzureManagedIdentity

AccessConnectorId string

The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name

databricks_gcp_service_account optional configuration block for creating a Databricks-managed GCP Service Account:

AccessConnectorId string

The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name

databricks_gcp_service_account optional configuration block for creating a Databricks-managed GCP Service Account:

accessConnectorId String

The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name

databricks_gcp_service_account optional configuration block for creating a Databricks-managed GCP Service Account:

accessConnectorId string

The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name

databricks_gcp_service_account optional configuration block for creating a Databricks-managed GCP Service Account:

access_connector_id str

The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name

databricks_gcp_service_account optional configuration block for creating a Databricks-managed GCP Service Account:

accessConnectorId String

The Resource ID of the Azure Databricks Access Connector resource, of the form /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.Databricks/accessConnectors/connector-name

databricks_gcp_service_account optional configuration block for creating a Databricks-managed GCP Service Account:

MetastoreDataAccessAzureServicePrincipal

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

azure_managed_identity optional configuration block for using managed identity as credential details for Azure:

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

azure_managed_identity optional configuration block for using managed identity as credential details for Azure:

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

azure_managed_identity optional configuration block for using managed identity as credential details for Azure:

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

azure_managed_identity optional configuration block for using managed identity as credential details for Azure:

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

azure_managed_identity optional configuration block for using managed identity as credential details for Azure:

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

azure_managed_identity optional configuration block for using managed identity as credential details for Azure:

directoryId String

The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application

MetastoreDataAccessDatabricksGcpServiceAccount

Email string

The email of the GCP service account created, to be granted access to relevant buckets.

Email string

The email of the GCP service account created, to be granted access to relevant buckets.

email String

The email of the GCP service account created, to be granted access to relevant buckets.

email string

The email of the GCP service account created, to be granted access to relevant buckets.

email str

The email of the GCP service account created, to be granted access to relevant buckets.

email String

The email of the GCP service account created, to be granted access to relevant buckets.

MetastoreDataAccessGcpServiceAccountKey

Email string

The email of the GCP service account created, to be granted access to relevant buckets.

PrivateKey string
PrivateKeyId string
Email string

The email of the GCP service account created, to be granted access to relevant buckets.

PrivateKey string
PrivateKeyId string
email String

The email of the GCP service account created, to be granted access to relevant buckets.

privateKey String
privateKeyId String
email string

The email of the GCP service account created, to be granted access to relevant buckets.

privateKey string
privateKeyId string
email str

The email of the GCP service account created, to be granted access to relevant buckets.

private_key str
private_key_id str
email String

The email of the GCP service account created, to be granted access to relevant buckets.

privateKey String
privateKeyId String

Import

-> Note Importing this resource is not currently supported.

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.