{ "name": "databricks", "displayName": "Databricks", "description": "A Pulumi package for creating and managing databricks cloud resources.", "keywords": [ "pulumi", "databricks", "category/infrastructure" ], "homepage": "https://www.pulumi.com", "license": "Apache-2.0", "attribution": "This Pulumi package is based on the [`databricks` Terraform Provider](https://github.com/databricks/terraform-provider-databricks).", "repository": "https://github.com/pulumi/pulumi-databricks", "publisher": "Pulumi", "meta": { "moduleFormat": "(.*)(?:/[^/]*)" }, "language": { "csharp": { "packageReferences": { "Pulumi": "3.*" }, "compatibility": "tfbridge20", "respectSchemaVersion": true }, "go": { "importBasePath": "github.com/pulumi/pulumi-databricks/sdk/go/databricks", "generateResourceContainerTypes": true, "generateExtraInputTypes": true, "respectSchemaVersion": true }, "nodejs": { "packageDescription": "A Pulumi package for creating and managing databricks cloud resources.", "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/databricks/terraform-provider-databricks)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-databricks` repo](https://github.com/pulumi/pulumi-databricks/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-databricks` repo](https://github.com/databricks/terraform-provider-databricks/issues).", "devDependencies": { "@types/mime": "^2.0.0", "@types/node": "^10.0.0" }, "compatibility": "tfbridge20", "disableUnionOutputTypes": true, "respectSchemaVersion": true }, "python": { "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/databricks/terraform-provider-databricks)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-databricks` repo](https://github.com/pulumi/pulumi-databricks/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-databricks` repo](https://github.com/databricks/terraform-provider-databricks/issues).", "compatibility": "tfbridge20", "respectSchemaVersion": true, "pyproject": { "enabled": true } } }, "config": { "variables": { "accountId": { "type": "string" }, "actionsIdTokenRequestToken": { "type": "string" }, "actionsIdTokenRequestUrl": { "type": "string" }, "audience": { "type": "string" }, "authType": { "type": "string" }, "azureClientId": { "type": "string" }, "azureClientSecret": { "type": "string", "secret": true }, "azureEnvironment": { "type": "string" }, "azureLoginAppId": { "type": "string" }, "azureTenantId": { "type": "string" }, "azureUseMsi": { "type": "boolean" }, "azureWorkspaceResourceId": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "cloud": { "type": "string" }, "clusterId": { "type": "string" }, "configFile": { "type": "string" }, "databricksCliPath": { "type": "string" }, "databricksIdTokenFilepath": { "type": "string" }, "debugHeaders": { "type": "boolean" }, "debugTruncateBytes": { "type": "integer" }, "disableOauthRefreshToken": { "type": "boolean" }, "discoveryUrl": { "type": "string" }, "googleCredentials": { "type": "string", "secret": true }, "googleServiceAccount": { "type": "string" }, "host": { "type": "string" }, "httpTimeoutSeconds": { "type": "integer" }, "metadataServiceUrl": { "type": "string", "secret": true }, "oauthCallbackPort": { "type": "integer" }, "oidcTokenEnv": { "type": "string" }, "password": { "type": "string", "secret": true }, "profile": { "type": "string" }, "rateLimit": { "type": "integer" }, "retryTimeoutSeconds": { "type": "integer" }, "scopes": { "type": "array", "items": { "type": "string" } }, "serverlessComputeId": { "type": "string" }, "skipVerify": { "type": "boolean" }, "token": { "type": "string", "secret": true }, "username": { "type": "string" }, "warehouseId": { "type": "string" }, "workspaceId": { "type": "string" } } }, "types": { "databricks:index/AccessControlRuleSetGrantRule:AccessControlRuleSetGrantRule": { "properties": { "principals": { "type": "array", "items": { "type": "string" }, "description": "a list of principals who are granted a role. The following format is supported:\n* `users/{username}` (also exposed as \u003cspan pulumi-lang-nodejs=\"`aclPrincipalId`\" pulumi-lang-dotnet=\"`AclPrincipalId`\" pulumi-lang-go=\"`aclPrincipalId`\" pulumi-lang-python=\"`acl_principal_id`\" pulumi-lang-yaml=\"`aclPrincipalId`\" pulumi-lang-java=\"`aclPrincipalId`\" pulumi-lang-hcl=\"`acl_principal_id`\"\u003e`aclPrincipalId`\u003c/span\u003e attribute of \u003cspan pulumi-lang-nodejs=\"`databricks.User`\" pulumi-lang-dotnet=\"`databricks.User`\" pulumi-lang-go=\"`User`\" pulumi-lang-python=\"`User`\" pulumi-lang-yaml=\"`databricks.User`\" pulumi-lang-java=\"`databricks.User`\" pulumi-lang-hcl=\"`databricks_user`\"\u003e`databricks.User`\u003c/span\u003e resource).\n* `groups/{groupname}` (also exposed as \u003cspan pulumi-lang-nodejs=\"`aclPrincipalId`\" pulumi-lang-dotnet=\"`AclPrincipalId`\" pulumi-lang-go=\"`aclPrincipalId`\" pulumi-lang-python=\"`acl_principal_id`\" pulumi-lang-yaml=\"`aclPrincipalId`\" pulumi-lang-java=\"`aclPrincipalId`\" pulumi-lang-hcl=\"`acl_principal_id`\"\u003e`aclPrincipalId`\u003c/span\u003e attribute of \u003cspan pulumi-lang-nodejs=\"`databricks.Group`\" pulumi-lang-dotnet=\"`databricks.Group`\" pulumi-lang-go=\"`Group`\" pulumi-lang-python=\"`Group`\" pulumi-lang-yaml=\"`databricks.Group`\" pulumi-lang-java=\"`databricks.Group`\" pulumi-lang-hcl=\"`databricks_group`\"\u003e`databricks.Group`\u003c/span\u003e resource).\n* `servicePrincipals/{applicationId}` (also exposed as \u003cspan pulumi-lang-nodejs=\"`aclPrincipalId`\" pulumi-lang-dotnet=\"`AclPrincipalId`\" pulumi-lang-go=\"`aclPrincipalId`\" pulumi-lang-python=\"`acl_principal_id`\" pulumi-lang-yaml=\"`aclPrincipalId`\" pulumi-lang-java=\"`aclPrincipalId`\" pulumi-lang-hcl=\"`acl_principal_id`\"\u003e`aclPrincipalId`\u003c/span\u003e attribute of \u003cspan pulumi-lang-nodejs=\"`databricks.ServicePrincipal`\" pulumi-lang-dotnet=\"`databricks.ServicePrincipal`\" pulumi-lang-go=\"`ServicePrincipal`\" pulumi-lang-python=\"`ServicePrincipal`\" pulumi-lang-yaml=\"`databricks.ServicePrincipal`\" pulumi-lang-java=\"`databricks.ServicePrincipal`\" pulumi-lang-hcl=\"`databricks_service_principal`\"\u003e`databricks.ServicePrincipal`\u003c/span\u003e resource).\n" }, "role": { "type": "string", "description": "Role to be granted. The supported roles are listed below. For more information about these roles, refer to [service principal roles](https://docs.databricks.com/security/auth-authz/access-control/service-principal-acl.html#service-principal-roles), [group roles](https://docs.databricks.com/en/administration-guide/users-groups/groups.html#manage-roles-on-an-account-group-using-the-workspace-admin-settings-page), [marketplace roles](https://docs.databricks.com/en/marketplace/get-started-provider.html#assign-the-marketplace-admin-role) or [budget policy permissions](https://docs.databricks.com/aws/en/admin/usage/budget-policies#manage-budget-policy-permissions), depending on the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e defined:\n* `accounts/{account_id}/ruleSets/default`\n* `roles/marketplace.admin` - Databricks Marketplace administrator.\n* `roles/billing.admin` - Billing administrator.\n* `roles/tagPolicy.creator` - Creator of tag policies.\n* `roles/tagPolicy.manager` - Manager of tag policies.\n* `roles/tagPolicy.assigner` - Assigner of tag policies.\n* `accounts/{account_id}/servicePrincipals/{service_principal_application_id}/ruleSets/default`\n* `roles/servicePrincipal.manager` - Manager of a service principal.\n* `roles/servicePrincipal.user` - User of a service principal.\n* `accounts/{account_id}/groups/{group_id}/ruleSets/default`\n* `roles/group.manager` - Manager of a group.\n* `accounts/{account_id}/budgetPolicies/{budget_policy_id}/ruleSets/default`\n* `roles/budgetPolicy.manager` - Manager of a budget policy.\n* `roles/budgetPolicy.user` - User of a budget policy.\n* `accounts/{account_id}/tagPolicies/{tag_policy_id}/ruleSets/default`\n* `roles/tagPolicy.manager` - Manager of a specific tag policy.\n* `roles/tagPolicy.assigner` - Assigner of a specific tag policy.\n" } }, "type": "object", "required": [ "role" ] }, "databricks:index/AccessControlRuleSetProviderConfig:AccessControlRuleSetProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AccountFederationPolicyOidcPolicy:AccountFederationPolicyOidcPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id\n" }, "issuer": { "type": "string", "description": "The required token issuer, as specified in the 'iss' claim of federated tokens\n" }, "jwksJson": { "type": "string", "description": "The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri \" pulumi-lang-dotnet=\" JwksUri \" pulumi-lang-go=\" jwksUri \" pulumi-lang-python=\" jwks_uri \" pulumi-lang-yaml=\" jwksUri \" pulumi-lang-java=\" jwksUri \" pulumi-lang-hcl=\" jwks_uri \"\u003e jwksUri \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson\n\" pulumi-lang-dotnet=\" JwksJson\n\" pulumi-lang-go=\" jwksJson\n\" pulumi-lang-python=\" jwks_json\n\" pulumi-lang-yaml=\" jwksJson\n\" pulumi-lang-java=\" jwksJson\n\" pulumi-lang-hcl=\" jwks_json\n\"\u003e jwksJson\n\u003c/span\u003eare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys\n" }, "jwksUri": { "type": "string", "description": "URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri\n\" pulumi-lang-dotnet=\" JwksUri\n\" pulumi-lang-go=\" jwksUri\n\" pulumi-lang-python=\" jwks_uri\n\" pulumi-lang-yaml=\" jwksUri\n\" pulumi-lang-java=\" jwksUri\n\" pulumi-lang-hcl=\" jwks_uri\n\"\u003e jwksUri\n\u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson \" pulumi-lang-dotnet=\" JwksJson \" pulumi-lang-go=\" jwksJson \" pulumi-lang-python=\" jwks_json \" pulumi-lang-yaml=\" jwksJson \" pulumi-lang-java=\" jwksJson \" pulumi-lang-hcl=\" jwks_json \"\u003e jwksJson \u003c/span\u003eare both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys\n" }, "subject": { "type": "string", "description": "The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies\n" }, "subjectClaim": { "type": "string", "description": "The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyEgress:AccountNetworkPolicyEgress": { "properties": { "networkAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgressNetworkAccess:AccountNetworkPolicyEgressNetworkAccess", "description": "The access policy enforced for egress traffic to the internet\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyEgressNetworkAccess:AccountNetworkPolicyEgressNetworkAccess": { "properties": { "allowedInternetDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination:AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination" }, "description": "List of internet destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode\n" }, "allowedStorageDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination:AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination" }, "description": "List of storage destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode\n" }, "blockedInternetDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination:AccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination" }, "description": "List of internet destinations that serverless workloads are blocked from accessing.\nThese destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN.\nCurrently supports DNS_NAME type only; IP_RANGE support is planned\n" }, "policyEnforcement": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgressNetworkAccessPolicyEnforcement:AccountNetworkPolicyEgressNetworkAccessPolicyEnforcement", "description": "Optional. When\u003cspan pulumi-lang-nodejs=\" policyEnforcement \" pulumi-lang-dotnet=\" PolicyEnforcement \" pulumi-lang-go=\" policyEnforcement \" pulumi-lang-python=\" policy_enforcement \" pulumi-lang-yaml=\" policyEnforcement \" pulumi-lang-java=\" policyEnforcement \" pulumi-lang-hcl=\" policy_enforcement \"\u003e policyEnforcement \u003c/span\u003eis not provided, we default to ENFORCE_MODE_ALL_SERVICES\n" }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination:AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination": { "properties": { "destination": { "type": "string" }, "internetDestinationType": { "type": "string", "description": "The type of internet destination. Currently only DNS_NAME is supported. Possible values are: `DNS_NAME`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination:AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination": { "properties": { "azureStorageAccount": { "type": "string", "description": "The Azure storage account name\n" }, "azureStorageService": { "type": "string", "description": "The Azure storage service type (blob, dfs, etc.)\n" }, "bucketName": { "type": "string" }, "region": { "type": "string" }, "storageDestinationType": { "type": "string", "description": "The type of storage destination. Possible values are: `AWS_S3`, `AZURE_STORAGE`, `GOOGLE_CLOUD_STORAGE`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination:AccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination": { "properties": { "destination": { "type": "string" }, "internetDestinationType": { "type": "string", "description": "The type of internet destination. Currently only DNS_NAME is supported. Possible values are: `DNS_NAME`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyEgressNetworkAccessPolicyEnforcement:AccountNetworkPolicyEgressNetworkAccessPolicyEnforcement": { "properties": { "dryRunModeProductFilters": { "type": "array", "items": { "type": "string" }, "description": "When empty, it means dry run for all products.\nWhen non-empty, it means dry run for specific products and for the other products, they will run in enforced mode\n" }, "enforcementMode": { "type": "string", "description": "The mode of policy enforcement. ENFORCED blocks traffic that violates policy,\nwhile DRY_RUN only logs violations without blocking. When not specified,\ndefaults to ENFORCED. Possible values are: `DRY_RUN`, `ENFORCED`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngress:AccountNetworkPolicyIngress": { "properties": { "crossWorkspaceAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccess:AccountNetworkPolicyIngressCrossWorkspaceAccess" }, "privateAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccess:AccountNetworkPolicyIngressPrivateAccess", "description": "The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access\n" }, "publicAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccess:AccountNetworkPolicyIngressPublicAccess", "description": "The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccess:AccountNetworkPolicyIngressCrossWorkspaceAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule" } }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule" } }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces", "description": "Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces", "description": "Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRun:AccountNetworkPolicyIngressDryRun": { "properties": { "crossWorkspaceAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccess:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccess" }, "privateAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccess:AccountNetworkPolicyIngressDryRunPrivateAccess", "description": "The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access\n" }, "publicAccess": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccess:AccountNetworkPolicyIngressDryRunPublicAccess", "description": "The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccess:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule" } }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule" } }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces", "description": "Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces", "description": "Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:AccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccess:AccountNetworkPolicyIngressDryRunPrivateAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRule:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRule" } }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRule:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRule" } }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRule:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean" }, "allRegisteredEndpoints": { "type": "boolean" }, "azureWorkspacePrivateLink": { "type": "boolean" }, "endpoints": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints:AccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRule:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean" }, "allRegisteredEndpoints": { "type": "boolean" }, "azureWorkspacePrivateLink": { "type": "boolean" }, "endpoints": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints:AccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccess:AccountNetworkPolicyIngressDryRunPublicAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRule:AccountNetworkPolicyIngressDryRunPublicAccessAllowRule" } }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRule:AccountNetworkPolicyIngressDryRunPublicAccessDenyRule" } }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRule:AccountNetworkPolicyIngressDryRunPublicAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges", "description": "Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges", "description": "Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRule:AccountNetworkPolicyIngressDryRunPublicAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges", "description": "Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges", "description": "Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccess:AccountNetworkPolicyIngressPrivateAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRule:AccountNetworkPolicyIngressPrivateAccessAllowRule" } }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRule:AccountNetworkPolicyIngressPrivateAccessDenyRule" } }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRule:AccountNetworkPolicyIngressPrivateAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication:AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestination:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin:AccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication:AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestination:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin:AccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean" }, "allRegisteredEndpoints": { "type": "boolean" }, "azureWorkspacePrivateLink": { "type": "boolean" }, "endpoints": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints:AccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints:AccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRule:AccountNetworkPolicyIngressPrivateAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication:AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestination:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin:AccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication:AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestination:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin:AccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean" }, "allRegisteredEndpoints": { "type": "boolean" }, "azureWorkspacePrivateLink": { "type": "boolean" }, "endpoints": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints:AccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints:AccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccess:AccountNetworkPolicyIngressPublicAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRule:AccountNetworkPolicyIngressPublicAccessAllowRule" } }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRule:AccountNetworkPolicyIngressPublicAccessDenyRule" } }, "restrictionMode": { "type": "string" } }, "type": "object", "required": [ "restrictionMode" ] }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRule:AccountNetworkPolicyIngressPublicAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication:AccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestination:AccountNetworkPolicyIngressPublicAccessAllowRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleOrigin:AccountNetworkPolicyIngressPublicAccessAllowRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication:AccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity:AccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestination:AccountNetworkPolicyIngressPublicAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleOrigin:AccountNetworkPolicyIngressPublicAccessAllowRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges", "description": "Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges", "description": "Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRule:AccountNetworkPolicyIngressPublicAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication:AccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication" }, "destination": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestination:AccountNetworkPolicyIngressPublicAccessDenyRuleDestination" }, "label": { "type": "string" }, "origin": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleOrigin:AccountNetworkPolicyIngressPublicAccessDenyRuleOrigin" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication:AccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity" }, "description": "Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity:AccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "string" }, "principalType": { "type": "string", "description": "Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestination:AccountNetworkPolicyIngressPublicAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne", "description": "Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi" }, "allDestinations": { "type": "boolean" }, "appsRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime" }, "workspaceApi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi" }, "workspaceUi": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi:AccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleOrigin:AccountNetworkPolicyIngressPublicAccessDenyRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges", "description": "Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges", "description": "Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges:AccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges:AccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/AccountSettingUserPreferenceV2BooleanVal:AccountSettingUserPreferenceV2BooleanVal": { "properties": { "value": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountSettingUserPreferenceV2EffectiveBooleanVal:AccountSettingUserPreferenceV2EffectiveBooleanVal": { "properties": { "value": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountSettingUserPreferenceV2EffectiveStringVal:AccountSettingUserPreferenceV2EffectiveStringVal": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingUserPreferenceV2StringVal:AccountSettingUserPreferenceV2StringVal": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingV2AibiDashboardEmbeddingAccessPolicy:AccountSettingV2AibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ] }, "databricks:index/AccountSettingV2AibiDashboardEmbeddingApprovedDomains:AccountSettingV2AibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountSettingV2AllowedAppsUserApiScopes:AccountSettingV2AllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspace:AccountSettingV2AutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean" }, "enabled": { "type": "boolean" }, "enablementDetails": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:AccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:AccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule" } }, "type": "object" }, "databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime" } }, "type": "object" }, "databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:AccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer" }, "minutes": { "type": "integer" } }, "type": "object" }, "databricks:index/AccountSettingV2BooleanVal:AccountSettingV2BooleanVal": { "properties": { "value": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountSettingV2CollaborationPlatformConnectivity:AccountSettingV2CollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ] }, "databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ] }, "databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveAllowedAppsUserApiScopes:AccountSettingV2EffectiveAllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean" }, "enabled": { "type": "boolean" }, "enablementDetails": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer" }, "minutes": { "type": "integer" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveBooleanVal:AccountSettingV2EffectiveBooleanVal": { "properties": { "value": { "type": "boolean" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveCollaborationPlatformConnectivity:AccountSettingV2EffectiveCollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ] }, "databricks:index/AccountSettingV2EffectiveIntegerVal:AccountSettingV2EffectiveIntegerVal": { "properties": { "value": { "type": "integer" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveOperationalEmailCustomRecipient:AccountSettingV2EffectiveOperationalEmailCustomRecipient": { "properties": { "email": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectivePersonalCompute:AccountSettingV2EffectivePersonalCompute": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingV2EffectiveRestrictWorkspaceAdmins:AccountSettingV2EffectiveRestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ] }, "databricks:index/AccountSettingV2EffectiveStringVal:AccountSettingV2EffectiveStringVal": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingV2IntegerVal:AccountSettingV2IntegerVal": { "properties": { "value": { "type": "integer" } }, "type": "object" }, "databricks:index/AccountSettingV2OperationalEmailCustomRecipient:AccountSettingV2OperationalEmailCustomRecipient": { "properties": { "email": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingV2PersonalCompute:AccountSettingV2PersonalCompute": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/AccountSettingV2RestrictWorkspaceAdmins:AccountSettingV2RestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ] }, "databricks:index/AccountSettingV2StringVal:AccountSettingV2StringVal": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy:AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "Configured embedding policy. Possible values are `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`.\n" } }, "type": "object", "required": [ "accessPolicyType" ] }, "databricks:index/AibiDashboardEmbeddingAccessPolicySettingProviderConfig:AibiDashboardEmbeddingAccessPolicySettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains:AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" }, "description": "the list of approved domains. To allow all subdomains for a given domain, use a wildcard symbol (`*`) before the domain name, i.e., `*.databricks.com` will allow to embed into any site under the `databricks.com`.\n" } }, "type": "object", "required": [ "approvedDomains" ] }, "databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig:AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AlertCondition:AlertCondition": { "properties": { "emptyResultState": { "type": "string", "description": "Alert state if the result is empty (`UNKNOWN`, `OK`, `TRIGGERED`)\n" }, "op": { "type": "string", "description": "Operator used for comparison in alert evaluation. (Enum: `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `EQUAL`, `NOT_EQUAL`, `IS_NULL`)\n" }, "operand": { "$ref": "#/types/databricks:index/AlertConditionOperand:AlertConditionOperand", "description": "Name of the column from the query result to use for comparison in alert evaluation:\n" }, "threshold": { "$ref": "#/types/databricks:index/AlertConditionThreshold:AlertConditionThreshold", "description": "Threshold value used for comparison in alert evaluation:\n" } }, "type": "object", "required": [ "op", "operand" ] }, "databricks:index/AlertConditionOperand:AlertConditionOperand": { "properties": { "column": { "$ref": "#/types/databricks:index/AlertConditionOperandColumn:AlertConditionOperandColumn", "description": "Block describing the column from the query result to use for comparison in alert evaluation:\n" } }, "type": "object", "required": [ "column" ] }, "databricks:index/AlertConditionOperandColumn:AlertConditionOperandColumn": { "properties": { "name": { "type": "string", "description": "Name of the column.\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/AlertConditionThreshold:AlertConditionThreshold": { "properties": { "value": { "$ref": "#/types/databricks:index/AlertConditionThresholdValue:AlertConditionThresholdValue", "description": "actual value used in comparison (one of the attributes is required):\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/AlertConditionThresholdValue:AlertConditionThresholdValue": { "properties": { "boolValue": { "type": "boolean", "description": "boolean value (\u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e) to compare against boolean results.\n" }, "doubleValue": { "type": "number", "description": "double value to compare against integer and double results.\n" }, "stringValue": { "type": "string", "description": "string value to compare against string results.\n" } }, "type": "object" }, "databricks:index/AlertProviderConfig:AlertProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AlertV2EffectiveRunAs:AlertV2EffectiveRunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role\n" }, "userName": { "type": "string", "description": "The email of an active workspace user. Can only set this field to their own email\n" } }, "type": "object" }, "databricks:index/AlertV2Evaluation:AlertV2Evaluation": { "properties": { "comparisonOperator": { "type": "string", "description": "Operator used for comparison in alert evaluation. Possible values are: `EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IS_NOT_NULL`, `IS_NULL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`\n" }, "emptyResultState": { "type": "string", "description": "Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. Possible values are: `ERROR`, `OK`, `TRIGGERED`, `UNKNOWN`\n" }, "lastEvaluatedAt": { "type": "string", "description": "(string) - Timestamp of the last evaluation\n" }, "notification": { "$ref": "#/types/databricks:index/AlertV2EvaluationNotification:AlertV2EvaluationNotification", "description": "User or Notification Destination to notify when alert is triggered\n" }, "source": { "$ref": "#/types/databricks:index/AlertV2EvaluationSource:AlertV2EvaluationSource", "description": "Source column from result to use to evaluate alert\n" }, "state": { "type": "string", "description": "(string) - Latest state of alert evaluation. Possible values are: `ERROR`, `OK`, `TRIGGERED`, `UNKNOWN`\n" }, "threshold": { "$ref": "#/types/databricks:index/AlertV2EvaluationThreshold:AlertV2EvaluationThreshold", "description": "Threshold to user for alert evaluation, can be a column or a value\n" } }, "type": "object", "required": [ "comparisonOperator", "source" ], "language": { "nodejs": { "requiredOutputs": [ "comparisonOperator", "lastEvaluatedAt", "source", "state" ] } } }, "databricks:index/AlertV2EvaluationNotification:AlertV2EvaluationNotification": { "properties": { "effectiveNotifyOnOk": { "type": "boolean" }, "effectiveRetriggerSeconds": { "type": "integer" }, "notifyOnOk": { "type": "boolean", "description": "Whether to notify alert subscribers when alert returns back to normal\n" }, "retriggerSeconds": { "type": "integer", "description": "Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/AlertV2EvaluationNotificationSubscription:AlertV2EvaluationNotificationSubscription" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effectiveNotifyOnOk", "effectiveRetriggerSeconds" ] } } }, "databricks:index/AlertV2EvaluationNotificationSubscription:AlertV2EvaluationNotificationSubscription": { "properties": { "destinationId": { "type": "string" }, "userEmail": { "type": "string" } }, "type": "object" }, "databricks:index/AlertV2EvaluationSource:AlertV2EvaluationSource": { "properties": { "aggregation": { "type": "string", "description": "If not set, the behavior is equivalent to using `First row` in the UI. Possible values are: `AVG`, `COUNT`, `COUNT_DISTINCT`, `MAX`, `MEDIAN`, `MIN`, `STDDEV`, `SUM`\n" }, "display": { "type": "string" }, "name": { "type": "string" } }, "type": "object", "required": [ "name" ] }, "databricks:index/AlertV2EvaluationThreshold:AlertV2EvaluationThreshold": { "properties": { "column": { "$ref": "#/types/databricks:index/AlertV2EvaluationThresholdColumn:AlertV2EvaluationThresholdColumn" }, "value": { "$ref": "#/types/databricks:index/AlertV2EvaluationThresholdValue:AlertV2EvaluationThresholdValue" } }, "type": "object" }, "databricks:index/AlertV2EvaluationThresholdColumn:AlertV2EvaluationThresholdColumn": { "properties": { "aggregation": { "type": "string", "description": "If not set, the behavior is equivalent to using `First row` in the UI. Possible values are: `AVG`, `COUNT`, `COUNT_DISTINCT`, `MAX`, `MEDIAN`, `MIN`, `STDDEV`, `SUM`\n" }, "display": { "type": "string" }, "name": { "type": "string" } }, "type": "object", "required": [ "name" ] }, "databricks:index/AlertV2EvaluationThresholdValue:AlertV2EvaluationThresholdValue": { "properties": { "boolValue": { "type": "boolean" }, "doubleValue": { "type": "number" }, "stringValue": { "type": "string" } }, "type": "object" }, "databricks:index/AlertV2ProviderConfig:AlertV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AlertV2RunAs:AlertV2RunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role\n" }, "userName": { "type": "string", "description": "The email of an active workspace user. Can only set this field to their own email\n" } }, "type": "object" }, "databricks:index/AlertV2Schedule:AlertV2Schedule": { "properties": { "pauseStatus": { "type": "string", "description": "Indicate whether this schedule is paused or not. Possible values are: `PAUSED`, `UNPAUSED`\n" }, "quartzCronSchedule": { "type": "string", "description": "A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html\n" }, "timezoneId": { "type": "string", "description": "A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the\u003cspan pulumi-lang-nodejs=\" quartzCronSchedule \" pulumi-lang-dotnet=\" QuartzCronSchedule \" pulumi-lang-go=\" quartzCronSchedule \" pulumi-lang-python=\" quartz_cron_schedule \" pulumi-lang-yaml=\" quartzCronSchedule \" pulumi-lang-java=\" quartzCronSchedule \" pulumi-lang-hcl=\" quartz_cron_schedule \"\u003e quartzCronSchedule \u003c/span\u003eto determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details\n" } }, "type": "object", "required": [ "quartzCronSchedule", "timezoneId" ] }, "databricks:index/AppActiveDeployment:AppActiveDeployment": { "properties": { "commands": { "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "deploymentArtifacts": { "$ref": "#/types/databricks:index/AppActiveDeploymentDeploymentArtifacts:AppActiveDeploymentDeploymentArtifacts", "description": "attribute\n" }, "deploymentId": { "type": "string", "description": "The unique ID of the deployment.\n" }, "envVars": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppActiveDeploymentEnvVar:AppActiveDeploymentEnvVar" } }, "gitSource": { "$ref": "#/types/databricks:index/AppActiveDeploymentGitSource:AppActiveDeploymentGitSource" }, "mode": { "type": "string", "description": "The deployment mode (`AUTO_SYNC` or `SNAPSHOT`).\n" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "status": { "$ref": "#/types/databricks:index/AppActiveDeploymentStatus:AppActiveDeploymentStatus", "description": "attribute\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createTime", "creator", "deploymentArtifacts", "status", "updateTime" ] } } }, "databricks:index/AppActiveDeploymentDeploymentArtifacts:AppActiveDeploymentDeploymentArtifacts": { "properties": { "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" } }, "type": "object" }, "databricks:index/AppActiveDeploymentEnvVar:AppActiveDeploymentEnvVar": { "properties": { "name": { "type": "string", "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.\n" }, "value": { "type": "string" }, "valueFrom": { "type": "string" } }, "type": "object" }, "databricks:index/AppActiveDeploymentGitSource:AppActiveDeploymentGitSource": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch to grant permission on (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "commit": { "type": "string" }, "gitRepository": { "$ref": "#/types/databricks:index/AppActiveDeploymentGitSourceGitRepository:AppActiveDeploymentGitSourceGitRepository", "description": "Git repository configuration for app deployments (see below). When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).\n" }, "resolvedCommit": { "type": "string" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "tag": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "gitRepository", "resolvedCommit" ] } } }, "databricks:index/AppActiveDeploymentGitSourceGitRepository:AppActiveDeploymentGitSourceGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider. Case insensitive. Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ] }, "databricks:index/AppActiveDeploymentStatus:AppActiveDeploymentStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message", "state" ] } } }, "databricks:index/AppAppStatus:AppAppStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message", "state" ] } } }, "databricks:index/AppComputeStatus:AppComputeStatus": { "properties": { "activeInstances": { "type": "integer" }, "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "activeInstances", "message", "state" ] } } }, "databricks:index/AppGitRepository:AppGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider. Case insensitive. Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ] }, "databricks:index/AppPendingDeployment:AppPendingDeployment": { "properties": { "commands": { "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "deploymentArtifacts": { "$ref": "#/types/databricks:index/AppPendingDeploymentDeploymentArtifacts:AppPendingDeploymentDeploymentArtifacts", "description": "attribute\n" }, "deploymentId": { "type": "string", "description": "The unique ID of the deployment.\n" }, "envVars": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppPendingDeploymentEnvVar:AppPendingDeploymentEnvVar" } }, "gitSource": { "$ref": "#/types/databricks:index/AppPendingDeploymentGitSource:AppPendingDeploymentGitSource" }, "mode": { "type": "string", "description": "The deployment mode (`AUTO_SYNC` or `SNAPSHOT`).\n" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "status": { "$ref": "#/types/databricks:index/AppPendingDeploymentStatus:AppPendingDeploymentStatus", "description": "attribute\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createTime", "creator", "deploymentArtifacts", "status", "updateTime" ] } } }, "databricks:index/AppPendingDeploymentDeploymentArtifacts:AppPendingDeploymentDeploymentArtifacts": { "properties": { "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" } }, "type": "object" }, "databricks:index/AppPendingDeploymentEnvVar:AppPendingDeploymentEnvVar": { "properties": { "name": { "type": "string", "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.\n" }, "value": { "type": "string" }, "valueFrom": { "type": "string" } }, "type": "object" }, "databricks:index/AppPendingDeploymentGitSource:AppPendingDeploymentGitSource": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch to grant permission on (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "commit": { "type": "string" }, "gitRepository": { "$ref": "#/types/databricks:index/AppPendingDeploymentGitSourceGitRepository:AppPendingDeploymentGitSourceGitRepository", "description": "Git repository configuration for app deployments (see below). When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).\n" }, "resolvedCommit": { "type": "string" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "tag": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "gitRepository", "resolvedCommit" ] } } }, "databricks:index/AppPendingDeploymentGitSourceGitRepository:AppPendingDeploymentGitSourceGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider. Case insensitive. Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ] }, "databricks:index/AppPendingDeploymentStatus:AppPendingDeploymentStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message", "state" ] } } }, "databricks:index/AppProviderConfig:AppProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AppResource:AppResource": { "properties": { "app": { "$ref": "#/types/databricks:index/AppResourceApp:AppResourceApp", "description": "attribute - reference to another Databricks App.\n" }, "database": { "$ref": "#/types/databricks:index/AppResourceDatabase:AppResourceDatabase", "description": "attribute\n" }, "description": { "type": "string", "description": "The description of the resource.\n\nExactly one of the following attributes must be provided:\n" }, "experiment": { "$ref": "#/types/databricks:index/AppResourceExperiment:AppResourceExperiment", "description": "attribute\n" }, "genieSpace": { "$ref": "#/types/databricks:index/AppResourceGenieSpace:AppResourceGenieSpace", "description": "attribute\n" }, "job": { "$ref": "#/types/databricks:index/AppResourceJob:AppResourceJob", "description": "attribute\n" }, "name": { "type": "string", "description": "The name of the resource.\n" }, "postgres": { "$ref": "#/types/databricks:index/AppResourcePostgres:AppResourcePostgres", "description": "attribute\n" }, "secret": { "$ref": "#/types/databricks:index/AppResourceSecret:AppResourceSecret", "description": "attribute\n" }, "servingEndpoint": { "$ref": "#/types/databricks:index/AppResourceServingEndpoint:AppResourceServingEndpoint", "description": "attribute\n" }, "sqlWarehouse": { "$ref": "#/types/databricks:index/AppResourceSqlWarehouse:AppResourceSqlWarehouse", "description": "attribute\n" }, "ucSecurable": { "$ref": "#/types/databricks:index/AppResourceUcSecurable:AppResourceUcSecurable", "description": "attribute (see the [API docs](https://docs.databricks.com/api/workspace/apps/create#resources-uc_securable) for full list of supported UC objects)\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/AppResourceApp:AppResourceApp": { "properties": { "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the app. Supported permissions are: `CAN_USE`.\n" } }, "type": "object" }, "databricks:index/AppResourceDatabase:AppResourceDatabase": { "properties": { "databaseName": { "type": "string", "description": "The name of database.\n" }, "instanceName": { "type": "string", "description": "The name of database instance.\n" }, "permission": { "type": "string", "description": "Permission to grant on database. Supported permissions are: `CAN_CONNECT_AND_CREATE`.\n" } }, "type": "object", "required": [ "databaseName", "instanceName", "permission" ] }, "databricks:index/AppResourceExperiment:AppResourceExperiment": { "properties": { "experimentId": { "type": "string", "description": "The ID of the MLflow experiment to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "experimentId", "permission" ] }, "databricks:index/AppResourceGenieSpace:AppResourceGenieSpace": { "properties": { "name": { "type": "string", "description": "The name of Genie Space.\n" }, "permission": { "type": "string", "description": "Permission to grant on Genie Space. Supported permissions are `CAN_MANAGE`, `CAN_EDIT`, `CAN_RUN`, `CAN_VIEW`.\n" }, "spaceId": { "type": "string", "description": "The unique ID of Genie Space.\n" } }, "type": "object", "required": [ "name", "permission", "spaceId" ] }, "databricks:index/AppResourceJob:AppResourceJob": { "properties": { "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "permission": { "type": "string", "description": "Permissions to grant on the Job. Supported permissions are: `CAN_MANAGE`, `IS_OWNER`, `CAN_MANAGE_RUN`, `CAN_VIEW`.\n" } }, "type": "object", "required": [ "id", "permission" ] }, "databricks:index/AppResourcePostgres:AppResourcePostgres": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch to grant permission on (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "database": { "type": "string", "description": "The resource path of a specific database within the branch to grant permission on (e.g. `projects/proj-abc123/branches/branch-xyz789/databases/db-456`). If omitted, permission applies to the branch.\n" }, "permission": { "type": "string", "description": "Permission to grant on the Lakebase Autoscaling branch or database. Supported permissions are: `CAN_CONNECT_AND_CREATE`.\n" } }, "type": "object" }, "databricks:index/AppResourceSecret:AppResourceSecret": { "properties": { "key": { "type": "string", "description": "Key of the secret to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: `READ`, `WRITE`, `MANAGE`.\n" }, "scope": { "type": "string", "description": "Scope of the secret to grant permission on.\n" } }, "type": "object", "required": [ "key", "permission", "scope" ] }, "databricks:index/AppResourceServingEndpoint:AppResourceServingEndpoint": { "properties": { "name": { "type": "string", "description": "Name of the serving endpoint to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the serving endpoint. Supported permissions are: `CAN_MANAGE`, `CAN_QUERY`, `CAN_VIEW`.\n" } }, "type": "object", "required": [ "name", "permission" ] }, "databricks:index/AppResourceSqlWarehouse:AppResourceSqlWarehouse": { "properties": { "id": { "type": "string", "description": "Id of the SQL warehouse to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the SQL warehouse. Supported permissions are: `CAN_MANAGE`, `CAN_USE`, `IS_OWNER`.\n" } }, "type": "object", "required": [ "id", "permission" ] }, "databricks:index/AppResourceUcSecurable:AppResourceUcSecurable": { "properties": { "permission": { "type": "string", "description": "Permission to grant on UC securable. Supported values depend on \u003cspan pulumi-lang-nodejs=\"`securableType`\" pulumi-lang-dotnet=\"`SecurableType`\" pulumi-lang-go=\"`securableType`\" pulumi-lang-python=\"`securable_type`\" pulumi-lang-yaml=\"`securableType`\" pulumi-lang-java=\"`securableType`\" pulumi-lang-hcl=\"`securable_type`\"\u003e`securableType`\u003c/span\u003e: `READ_VOLUME` and `WRITE_VOLUME` for `VOLUME`, `SELECT` and `MODIFY` for `TABLE`, `EXECUTE` for `FUNCTION`, `USE_CONNECTION` for `CONNECTION`.\n" }, "securableFullName": { "type": "string", "description": "The full name of UC securable, i.e. `my-catalog.my-schema.my-volume`.\n" }, "securableKind": { "type": "string" }, "securableType": { "type": "string", "description": "The type of UC securable. Supported values are `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`.\n" } }, "type": "object", "required": [ "permission", "securableFullName", "securableType" ], "language": { "nodejs": { "requiredOutputs": [ "permission", "securableFullName", "securableKind", "securableType" ] } } }, "databricks:index/AppSpaceProviderConfig:AppSpaceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AppSpaceResource:AppSpaceResource": { "properties": { "app": { "$ref": "#/types/databricks:index/AppSpaceResourceApp:AppSpaceResourceApp" }, "database": { "$ref": "#/types/databricks:index/AppSpaceResourceDatabase:AppSpaceResourceDatabase" }, "description": { "type": "string", "description": "The description of the app space\n" }, "experiment": { "$ref": "#/types/databricks:index/AppSpaceResourceExperiment:AppSpaceResourceExperiment" }, "genieSpace": { "$ref": "#/types/databricks:index/AppSpaceResourceGenieSpace:AppSpaceResourceGenieSpace" }, "job": { "$ref": "#/types/databricks:index/AppSpaceResourceJob:AppSpaceResourceJob" }, "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "postgres": { "$ref": "#/types/databricks:index/AppSpaceResourcePostgres:AppSpaceResourcePostgres" }, "secret": { "$ref": "#/types/databricks:index/AppSpaceResourceSecret:AppSpaceResourceSecret" }, "servingEndpoint": { "$ref": "#/types/databricks:index/AppSpaceResourceServingEndpoint:AppSpaceResourceServingEndpoint" }, "sqlWarehouse": { "$ref": "#/types/databricks:index/AppSpaceResourceSqlWarehouse:AppSpaceResourceSqlWarehouse" }, "ucSecurable": { "$ref": "#/types/databricks:index/AppSpaceResourceUcSecurable:AppSpaceResourceUcSecurable" } }, "type": "object", "required": [ "name" ] }, "databricks:index/AppSpaceResourceApp:AppSpaceResourceApp": { "properties": { "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "permission": { "type": "string" } }, "type": "object" }, "databricks:index/AppSpaceResourceDatabase:AppSpaceResourceDatabase": { "properties": { "databaseName": { "type": "string" }, "instanceName": { "type": "string" }, "permission": { "type": "string" } }, "type": "object", "required": [ "databaseName", "instanceName", "permission" ] }, "databricks:index/AppSpaceResourceExperiment:AppSpaceResourceExperiment": { "properties": { "experimentId": { "type": "string" }, "permission": { "type": "string" } }, "type": "object", "required": [ "experimentId", "permission" ] }, "databricks:index/AppSpaceResourceGenieSpace:AppSpaceResourceGenieSpace": { "properties": { "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "permission": { "type": "string" }, "spaceId": { "type": "string" } }, "type": "object", "required": [ "name", "permission", "spaceId" ] }, "databricks:index/AppSpaceResourceJob:AppSpaceResourceJob": { "properties": { "id": { "type": "string", "description": "(string) - The unique identifier of the app space\n" }, "permission": { "type": "string" } }, "type": "object", "required": [ "id", "permission" ] }, "databricks:index/AppSpaceResourcePostgres:AppSpaceResourcePostgres": { "properties": { "branch": { "type": "string" }, "database": { "type": "string" }, "permission": { "type": "string" } }, "type": "object" }, "databricks:index/AppSpaceResourceSecret:AppSpaceResourceSecret": { "properties": { "key": { "type": "string", "description": "Key of the secret to grant permission on\n" }, "permission": { "type": "string" }, "scope": { "type": "string", "description": "Scope of the secret to grant permission on\n" } }, "type": "object", "required": [ "key", "permission", "scope" ] }, "databricks:index/AppSpaceResourceServingEndpoint:AppSpaceResourceServingEndpoint": { "properties": { "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "permission": { "type": "string" } }, "type": "object", "required": [ "name", "permission" ] }, "databricks:index/AppSpaceResourceSqlWarehouse:AppSpaceResourceSqlWarehouse": { "properties": { "id": { "type": "string", "description": "(string) - The unique identifier of the app space\n" }, "permission": { "type": "string" } }, "type": "object", "required": [ "id", "permission" ] }, "databricks:index/AppSpaceResourceUcSecurable:AppSpaceResourceUcSecurable": { "properties": { "permission": { "type": "string" }, "securableFullName": { "type": "string" }, "securableKind": { "type": "string", "description": "(string) - The securable kind from Unity Catalog.\nSee https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind\n" }, "securableType": { "type": "string", "description": "Possible values are: `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`\n" } }, "type": "object", "required": [ "permission", "securableFullName", "securableType" ], "language": { "nodejs": { "requiredOutputs": [ "permission", "securableFullName", "securableKind", "securableType" ] } } }, "databricks:index/AppSpaceStatus:AppSpaceStatus": { "properties": { "message": { "type": "string", "description": "(string) - Message providing context about the current state\n" }, "state": { "type": "string", "description": "(string) - The state of the app space. Possible values are: `SPACE_ACTIVE`, `SPACE_CREATING`, `SPACE_DELETED`, `SPACE_DELETING`, `SPACE_ERROR`, `SPACE_UPDATING`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message", "state" ] } } }, "databricks:index/AppTelemetryExportDestination:AppTelemetryExportDestination": { "properties": { "unityCatalog": { "$ref": "#/types/databricks:index/AppTelemetryExportDestinationUnityCatalog:AppTelemetryExportDestinationUnityCatalog", "description": "attribute - export telemetry to Unity Catalog tables (must already exist and be writable by the app's service principal).\n" } }, "type": "object" }, "databricks:index/AppTelemetryExportDestinationUnityCatalog:AppTelemetryExportDestinationUnityCatalog": { "properties": { "logsTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry logs.\n" }, "metricsTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry metrics.\n" }, "tracesTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry traces (spans).\n" } }, "type": "object", "required": [ "logsTable", "metricsTable", "tracesTable" ] }, "databricks:index/AppsSettingsCustomTemplateManifest:AppsSettingsCustomTemplateManifest": { "properties": { "description": { "type": "string", "description": "The description of the template\n" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "resourceSpecs": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpec:AppsSettingsCustomTemplateManifestResourceSpec" } }, "version": { "type": "integer", "description": "The manifest schema version, for now only 1 is allowed\n" } }, "type": "object", "required": [ "name", "version" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpec:AppsSettingsCustomTemplateManifestResourceSpec": { "properties": { "description": { "type": "string", "description": "The description of the template\n" }, "experimentSpec": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpecExperimentSpec:AppsSettingsCustomTemplateManifestResourceSpecExperimentSpec" }, "jobSpec": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpecJobSpec:AppsSettingsCustomTemplateManifestResourceSpecJobSpec" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "secretSpec": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpecSecretSpec:AppsSettingsCustomTemplateManifestResourceSpecSecretSpec" }, "servingEndpointSpec": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec:AppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec" }, "sqlWarehouseSpec": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec:AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec" }, "ucSecurableSpec": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec:AppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec" } }, "type": "object", "required": [ "name" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpecExperimentSpec:AppsSettingsCustomTemplateManifestResourceSpecExperimentSpec": { "properties": { "permission": { "type": "string" } }, "type": "object", "required": [ "permission" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpecJobSpec:AppsSettingsCustomTemplateManifestResourceSpecJobSpec": { "properties": { "permission": { "type": "string" } }, "type": "object", "required": [ "permission" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpecSecretSpec:AppsSettingsCustomTemplateManifestResourceSpecSecretSpec": { "properties": { "permission": { "type": "string" } }, "type": "object", "required": [ "permission" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec:AppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec": { "properties": { "permission": { "type": "string" } }, "type": "object", "required": [ "permission" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec:AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec": { "properties": { "permission": { "type": "string" } }, "type": "object", "required": [ "permission" ] }, "databricks:index/AppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec:AppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec": { "properties": { "permission": { "type": "string" }, "securableType": { "type": "string", "description": "Possible values are: `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`\n" } }, "type": "object", "required": [ "permission", "securableType" ] }, "databricks:index/AppsSettingsCustomTemplateProviderConfig:AppsSettingsCustomTemplateProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ArtifactAllowlistArtifactMatcher:ArtifactAllowlistArtifactMatcher": { "properties": { "artifact": { "type": "string", "description": "The artifact path or maven coordinate.\n" }, "matchType": { "type": "string", "description": "The pattern matching type of the artifact. Only `PREFIX_MATCH` is supported.\n" } }, "type": "object", "required": [ "artifact", "matchType" ] }, "databricks:index/ArtifactAllowlistProviderConfig:ArtifactAllowlistProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean" }, "enabled": { "type": "boolean" }, "enablementDetails": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetails:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetails" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindow:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindow" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean" } }, "type": "object", "required": [ "enabled" ], "language": { "nodejs": { "requiredOutputs": [ "enabled", "enablementDetails" ] } } }, "databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetails:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean" }, "unavailableForDisabledEntitlement": { "type": "boolean" }, "unavailableForNonEnterpriseTier": { "type": "boolean" } }, "type": "object" }, "databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindow:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule" } }, "type": "object" }, "databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string" }, "frequency": { "type": "string" }, "windowStartTime": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime" } }, "type": "object", "required": [ "dayOfWeek", "frequency" ] }, "databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer" }, "minutes": { "type": "integer" } }, "type": "object", "required": [ "hours", "minutes" ] }, "databricks:index/AutomaticClusterUpdateWorkspaceSettingProviderConfig:AutomaticClusterUpdateWorkspaceSettingProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/BudgetAlertConfiguration:BudgetAlertConfiguration": { "properties": { "actionConfigurations": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetAlertConfigurationActionConfiguration:BudgetAlertConfigurationActionConfiguration" }, "description": "List of action configurations to take when the budget alert is triggered. Consists of the following fields:\n" }, "alertConfigurationId": { "type": "string" }, "quantityThreshold": { "type": "string", "description": "The threshold for the budget alert to determine if it is in a triggered state. The number is evaluated based on \u003cspan pulumi-lang-nodejs=\"`quantityType`\" pulumi-lang-dotnet=\"`QuantityType`\" pulumi-lang-go=\"`quantityType`\" pulumi-lang-python=\"`quantity_type`\" pulumi-lang-yaml=\"`quantityType`\" pulumi-lang-java=\"`quantityType`\" pulumi-lang-hcl=\"`quantity_type`\"\u003e`quantityType`\u003c/span\u003e.\n" }, "quantityType": { "type": "string", "description": "The way to calculate cost for this budget alert. This is what\u003cspan pulumi-lang-nodejs=\" quantityThreshold \" pulumi-lang-dotnet=\" QuantityThreshold \" pulumi-lang-go=\" quantityThreshold \" pulumi-lang-python=\" quantity_threshold \" pulumi-lang-yaml=\" quantityThreshold \" pulumi-lang-java=\" quantityThreshold \" pulumi-lang-hcl=\" quantity_threshold \"\u003e quantityThreshold \u003c/span\u003eis measured in. (Enum: `LIST_PRICE_DOLLARS_USD`)\n" }, "timePeriod": { "type": "string", "description": "The time window of usage data for the budget. (Enum: `MONTH`)\n" }, "triggerType": { "type": "string", "description": "The evaluation method to determine when this budget alert is in a triggered state. (Enum: `CUMULATIVE_SPENDING_EXCEEDED`)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "alertConfigurationId" ] } } }, "databricks:index/BudgetAlertConfigurationActionConfiguration:BudgetAlertConfigurationActionConfiguration": { "properties": { "actionConfigurationId": { "type": "string" }, "actionType": { "type": "string", "description": "The type of action to take when the budget alert is triggered. (Enum: `EMAIL_NOTIFICATION`)\n" }, "target": { "type": "string", "description": "The target of the action. For `EMAIL_NOTIFICATION`, this is the email address to send the notification to.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "actionConfigurationId" ] } } }, "databricks:index/BudgetFilter:BudgetFilter": { "properties": { "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetFilterTag:BudgetFilterTag" }, "description": "List of tags to filter by. Consists of the following fields:\n" }, "workspaceId": { "$ref": "#/types/databricks:index/BudgetFilterWorkspaceId:BudgetFilterWorkspaceId", "description": "Filter by workspace ID (if empty, include usage all usage for this account). Consists of the following fields:\n" } }, "type": "object" }, "databricks:index/BudgetFilterTag:BudgetFilterTag": { "properties": { "key": { "type": "string", "description": "The key of the tag.\n" }, "value": { "$ref": "#/types/databricks:index/BudgetFilterTagValue:BudgetFilterTagValue", "description": "Consists of the following fields:\n" } }, "type": "object" }, "databricks:index/BudgetFilterTagValue:BudgetFilterTagValue": { "properties": { "operator": { "type": "string", "description": "The operator to use for the filter. (Enum: `IN`)\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The values to filter by.\n" } }, "type": "object" }, "databricks:index/BudgetFilterWorkspaceId:BudgetFilterWorkspaceId": { "properties": { "operator": { "type": "string", "description": "The operator to use for the filter. (Enum: `IN`)\n" }, "values": { "type": "array", "items": { "type": "integer" }, "description": "The values to filter by.\n" } }, "type": "object" }, "databricks:index/BudgetPolicyCustomTag:BudgetPolicyCustomTag": { "properties": { "key": { "type": "string", "description": "The key of the tag.\n- Must be unique among all custom tags of the same policy\n- Cannot be “budget-policy-name”, “budget-policy-id” or \"budget-policy-resolution-result\" -\nthese tags are preserved\n" }, "value": { "type": "string", "description": "The value of the tag\n" } }, "type": "object", "required": [ "key" ] }, "databricks:index/CatalogEffectivePredictiveOptimizationFlag:CatalogEffectivePredictiveOptimizationFlag": { "properties": { "inheritedFromName": { "type": "string" }, "inheritedFromType": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "value" ] }, "databricks:index/CatalogManagedEncryptionSettings:CatalogManagedEncryptionSettings": { "properties": { "azureEncryptionSettings": { "$ref": "#/types/databricks:index/CatalogManagedEncryptionSettingsAzureEncryptionSettings:CatalogManagedEncryptionSettingsAzureEncryptionSettings" }, "azureKeyVaultKeyId": { "type": "string" }, "customerManagedKeyId": { "type": "string" } }, "type": "object" }, "databricks:index/CatalogManagedEncryptionSettingsAzureEncryptionSettings:CatalogManagedEncryptionSettingsAzureEncryptionSettings": { "properties": { "azureCmkAccessConnectorId": { "type": "string" }, "azureCmkManagedIdentityId": { "type": "string" }, "azureTenantId": { "type": "string" } }, "type": "object", "required": [ "azureTenantId" ] }, "databricks:index/CatalogProviderConfig:CatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/CatalogProvisioningInfo:CatalogProvisioningInfo": { "properties": { "state": { "type": "string" } }, "type": "object" }, "databricks:index/CatalogWorkspaceBindingProviderConfig:CatalogWorkspaceBindingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "ID of the workspace. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ClusterAutoscale:ClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer", "description": "The maximum number of workers to which the cluster can scale up when overloaded.\u003cspan pulumi-lang-nodejs=\" maxWorkers \" pulumi-lang-dotnet=\" MaxWorkers \" pulumi-lang-go=\" maxWorkers \" pulumi-lang-python=\" max_workers \" pulumi-lang-yaml=\" maxWorkers \" pulumi-lang-java=\" maxWorkers \" pulumi-lang-hcl=\" max_workers \"\u003e maxWorkers \u003c/span\u003emust be strictly greater than min_workers.\n\nTo create a [single node cluster](https://docs.databricks.com/clusters/single-node.html), set \u003cspan pulumi-lang-nodejs=\"`isSingleNode \" pulumi-lang-dotnet=\"`IsSingleNode \" pulumi-lang-go=\"`isSingleNode \" pulumi-lang-python=\"`is_single_node \" pulumi-lang-yaml=\"`isSingleNode \" pulumi-lang-java=\"`isSingleNode \" pulumi-lang-hcl=\"`is_single_node \"\u003e`isSingleNode \u003c/span\u003e= true` and `kind = \"CLASSIC_PREVIEW\"` for the cluster. Single-node clusters are suitable for small, non-distributed workloads like single-node machine learning use-cases.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst smallest = databricks.getNodeType({\n localDisk: true,\n});\nconst latestLts = databricks.getSparkVersion({\n longTermSupport: true,\n});\nconst singleNode = new databricks.Cluster(\"single_node\", {\n clusterName: \"Single Node\",\n sparkVersion: latestLts.then(latestLts =\u003e latestLts.id),\n nodeTypeId: smallest.then(smallest =\u003e smallest.id),\n autoterminationMinutes: 20,\n isSingleNode: true,\n kind: \"CLASSIC_PREVIEW\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsmallest = databricks.get_node_type(local_disk=True)\nlatest_lts = databricks.get_spark_version(long_term_support=True)\nsingle_node = databricks.Cluster(\"single_node\",\n cluster_name=\"Single Node\",\n spark_version=latest_lts.id,\n node_type_id=smallest.id,\n autotermination_minutes=20,\n is_single_node=True,\n kind=\"CLASSIC_PREVIEW\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var smallest = Databricks.GetNodeType.Invoke(new()\n {\n LocalDisk = true,\n });\n\n var latestLts = Databricks.GetSparkVersion.Invoke(new()\n {\n LongTermSupport = true,\n });\n\n var singleNode = new Databricks.Cluster(\"single_node\", new()\n {\n ClusterName = \"Single Node\",\n SparkVersion = latestLts.Apply(getSparkVersionResult =\u003e getSparkVersionResult.Id),\n NodeTypeId = smallest.Apply(getNodeTypeResult =\u003e getNodeTypeResult.Id),\n AutoterminationMinutes = 20,\n IsSingleNode = true,\n Kind = \"CLASSIC_PREVIEW\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsmallest, err := databricks.GetNodeType(ctx, \u0026databricks.GetNodeTypeArgs{\n\t\t\tLocalDisk: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlatestLts, err := databricks.GetSparkVersion(ctx, \u0026databricks.GetSparkVersionArgs{\n\t\t\tLongTermSupport: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewCluster(ctx, \"single_node\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Single Node\"),\n\t\t\tSparkVersion: pulumi.String(pulumi.String(latestLts.Id)),\n\t\t\tNodeTypeId: pulumi.String(pulumi.String(smallest.Id)),\n\t\t\tAutoterminationMinutes: pulumi.Int(20),\n\t\t\tIsSingleNode: pulumi.Bool(true),\n\t\t\tKind: pulumi.String(\"CLASSIC_PREVIEW\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getnodetype\" \"smallest\" {\n local_disk = true\n}\ndata \"databricks_getsparkversion\" \"latestLts\" {\n long_term_support = true\n}\n\nresource \"databricks_cluster\" \"single_node\" {\n cluster_name = \"Single Node\"\n spark_version = data.databricks_getsparkversion.latestLts.id\n node_type_id = data.databricks_getnodetype.smallest.id\n autotermination_minutes = 20\n is_single_node = true\n kind = \"CLASSIC_PREVIEW\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetNodeTypeArgs;\nimport com.pulumi.databricks.inputs.GetSparkVersionArgs;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var smallest = DatabricksFunctions.getNodeType(GetNodeTypeArgs.builder()\n .localDisk(true)\n .build());\n\n final var latestLts = DatabricksFunctions.getSparkVersion(GetSparkVersionArgs.builder()\n .longTermSupport(true)\n .build());\n\n var singleNode = new Cluster(\"singleNode\", ClusterArgs.builder()\n .clusterName(\"Single Node\")\n .sparkVersion(latestLts.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(20)\n .isSingleNode(true)\n .kind(\"CLASSIC_PREVIEW\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n singleNode:\n type: databricks:Cluster\n name: single_node\n properties:\n clusterName: Single Node\n sparkVersion: ${latestLts.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 20\n isSingleNode: true\n kind: CLASSIC_PREVIEW\nvariables:\n smallest:\n fn::invoke:\n function: databricks:getNodeType\n arguments:\n localDisk: true\n latestLts:\n fn::invoke:\n function: databricks:getSparkVersion\n arguments:\n longTermSupport: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "minWorkers": { "type": "integer", "description": "The minimum number of workers to which the cluster can scale down when underutilized. It is also the initial number of workers the cluster will have after creation.\n" } }, "type": "object" }, "databricks:index/ClusterAwsAttributes:ClusterAwsAttributes": { "properties": { "availability": { "type": "string", "description": "Availability type used for all subsequent nodes past the \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e ones. Valid values are `SPOT`, `SPOT_WITH_FALLBACK` and `ON_DEMAND`. Note: If \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e is zero, this availability type will be used for the entire cluster. Backend default value is `SPOT_WITH_FALLBACK` and could change in the future\n" }, "ebsVolumeCount": { "type": "integer", "description": "The number of volumes launched for each instance. You can choose up to 10 volumes. This feature is only enabled for supported node types. Legacy node types cannot specify custom EBS volumes. For node types with no instance store, at least one EBS volume needs to be specified; otherwise, cluster creation will fail. These EBS volumes will be mounted at /ebs0, /ebs1, and etc. Instance store volumes will be mounted at /local_disk0, /local_disk1, and etc. If EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for scratch storage because heterogeneously sized scratch devices can lead to inefficient disk utilization. If no EBS volumes are attached, Databricks will configure Spark to use instance store volumes. If EBS volumes are specified, then the Spark configuration spark.local.dir will be overridden.\n" }, "ebsVolumeIops": { "type": "integer", "description": "If using gp3 volumes, what IOPS to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.\n" }, "ebsVolumeSize": { "type": "integer", "description": "The size of each EBS volume (in GiB) launched for each instance. For general purpose SSD, this value must be within the range 100 - 4096. For throughput optimized HDD, this value must be within the range 500 - 4096. Custom EBS volumes cannot be specified for the legacy node types (memory-optimized and compute-optimized).\n" }, "ebsVolumeThroughput": { "type": "integer", "description": "If using gp3 volumes, what throughput to use for the disk. If this is not set, the maximum performance of a gp2 volume with the same volume size will be used.\n" }, "ebsVolumeType": { "type": "string", "description": "The type of EBS volumes that will be launched with this cluster. Valid values are `GENERAL_PURPOSE_SSD` or `THROUGHPUT_OPTIMIZED_HDD`. Use this option only if you're not picking *Delta Optimized `i3.*`* node types.\n" }, "firstOnDemand": { "type": "integer", "description": "The first \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e nodes of the cluster will be placed on on-demand instances. If this value is greater than 0, the cluster driver node will be placed on an on-demand instance. If this value is greater than or equal to the current cluster size, all nodes will be placed on on-demand instances. If this value is less than the current cluster size, \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e nodes will be placed on on-demand instances, and the remainder will be placed on availability instances. This value does not affect cluster size and cannot be mutated over the lifetime of a cluster. If unspecified, the default value is 0.\n" }, "instanceProfileArn": { "type": "string", "description": "Nodes for this cluster will only be placed on AWS instances with this instance profile. Please see\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eresource documentation for extended examples on adding a valid instance profile using Pulumi.\n" }, "spotBidPricePercent": { "type": "integer", "description": "The max price for AWS spot instances, as a percentage of the corresponding instance type’s on-demand price. For example, if this field is set to 50, and the cluster needs a new `i3.xlarge` spot instance, then the max price is half of the price of on-demand `i3.xlarge` instances. Similarly, if this field is set to 200, the max price is twice the price of on-demand `i3.xlarge` instances. If not specified, the default value is \u003cspan pulumi-lang-nodejs=\"`100`\" pulumi-lang-dotnet=\"`100`\" pulumi-lang-go=\"`100`\" pulumi-lang-python=\"`100`\" pulumi-lang-yaml=\"`100`\" pulumi-lang-java=\"`100`\" pulumi-lang-hcl=\"`100`\"\u003e`100`\u003c/span\u003e. When spot instances are requested for this cluster, only spot instances whose max price percentage matches this field will be considered. For safety, we enforce this field to be no more than \u003cspan pulumi-lang-nodejs=\"`10000`\" pulumi-lang-dotnet=\"`10000`\" pulumi-lang-go=\"`10000`\" pulumi-lang-python=\"`10000`\" pulumi-lang-yaml=\"`10000`\" pulumi-lang-java=\"`10000`\" pulumi-lang-hcl=\"`10000`\"\u003e`10000`\u003c/span\u003e.\n" }, "zoneId": { "type": "string", "description": "Identifier for the availability zone/datacenter in which the cluster resides. This string will be of a form like `us-west-2a`. The provided availability zone must be in the same region as the Databricks deployment. For example, `us-west-2a` is not a valid zone ID if the Databricks deployment resides in the `us-east-1` region. Enable automatic availability zone selection (\"Auto-AZ\"), by setting the value \u003cspan pulumi-lang-nodejs=\"`auto`\" pulumi-lang-dotnet=\"`Auto`\" pulumi-lang-go=\"`auto`\" pulumi-lang-python=\"`auto`\" pulumi-lang-yaml=\"`auto`\" pulumi-lang-java=\"`auto`\" pulumi-lang-hcl=\"`auto`\"\u003e`auto`\u003c/span\u003e. Databricks selects the AZ based on available IPs in the workspace subnets and retries in other availability zones if AWS returns insufficient capacity errors.\n" } }, "type": "object" }, "databricks:index/ClusterAzureAttributes:ClusterAzureAttributes": { "properties": { "availability": { "type": "string", "description": "Availability type used for all subsequent nodes past the \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e ones. Valid values are `SPOT_AZURE`, `SPOT_WITH_FALLBACK_AZURE`, and `ON_DEMAND_AZURE`. Note: If \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e is zero, this availability type will be used for the entire cluster.\n" }, "firstOnDemand": { "type": "integer", "description": "The first \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e nodes of the cluster will be placed on on-demand instances. If this value is greater than 0, the cluster driver node will be placed on an on-demand instance. If this value is greater than or equal to the current cluster size, all nodes will be placed on on-demand instances. If this value is less than the current cluster size, \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e nodes will be placed on on-demand instances, and the remainder will be placed on availability instances. This value does not affect cluster size and cannot be mutated over the lifetime of a cluster.\n" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/ClusterAzureAttributesLogAnalyticsInfo:ClusterAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number", "description": "The max bid price used for Azure spot instances. You can set this to greater than or equal to the current spot price. You can also set this to `-1`, which specifies that the instance cannot be evicted on the basis of price. The price for the instance will be the current price for spot instances or the price for a standard instance.\n" } }, "type": "object" }, "databricks:index/ClusterAzureAttributesLogAnalyticsInfo:ClusterAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/ClusterClusterLogConf:ClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/ClusterClusterLogConfDbfs:ClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/ClusterClusterLogConfS3:ClusterClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/ClusterClusterLogConfVolumes:ClusterClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/ClusterClusterLogConfDbfs:ClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterClusterLogConfS3:ClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string", "description": "Set canned access control list, e.g. `bucket-owner-full-control`. If \u003cspan pulumi-lang-nodejs=\"`cannedCal`\" pulumi-lang-dotnet=\"`CannedCal`\" pulumi-lang-go=\"`cannedCal`\" pulumi-lang-python=\"`canned_cal`\" pulumi-lang-yaml=\"`cannedCal`\" pulumi-lang-java=\"`cannedCal`\" pulumi-lang-hcl=\"`canned_cal`\"\u003e`cannedCal`\u003c/span\u003e is set, the cluster instance profile must have `s3:PutObjectAcl` permission on the destination bucket and prefix. The full list of possible canned ACLs can be found [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). By default, only the object owner gets full control. If you are using a cross-account role for writing data, you may want to set `bucket-owner-full-control` to make bucket owners able to read the logs.\n" }, "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" }, "enableEncryption": { "type": "boolean", "description": "Enable server-side encryption, false by default.\n" }, "encryptionType": { "type": "string", "description": "The encryption type, it could be `sse-s3` or `sse-kms`. It is used only when encryption is enabled, and the default type is `sse-s3`.\n" }, "endpoint": { "type": "string", "description": "S3 endpoint, e.g. \u003chttps://s3-us-west-2.amazonaws.com\u003e. Either \u003cspan pulumi-lang-nodejs=\"`region`\" pulumi-lang-dotnet=\"`Region`\" pulumi-lang-go=\"`region`\" pulumi-lang-python=\"`region`\" pulumi-lang-yaml=\"`region`\" pulumi-lang-java=\"`region`\" pulumi-lang-hcl=\"`region`\"\u003e`region`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e needs to be set. If both are set, the endpoint is used.\n" }, "kmsKey": { "type": "string", "description": "KMS key used if encryption is enabled and encryption type is set to `sse-kms`.\n" }, "region": { "type": "string", "description": "S3 region, e.g. `us-west-2`. Either \u003cspan pulumi-lang-nodejs=\"`region`\" pulumi-lang-dotnet=\"`Region`\" pulumi-lang-go=\"`region`\" pulumi-lang-python=\"`region`\" pulumi-lang-yaml=\"`region`\" pulumi-lang-java=\"`region`\" pulumi-lang-hcl=\"`region`\"\u003e`region`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e must be set. If both are set, the endpoint is used.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterClusterLogConfVolumes:ClusterClusterLogConfVolumes": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterClusterMountInfo:ClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string", "description": "path inside the Spark container.\n\nFor example, you can mount Azure Data Lake Storage container using the following code:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst storageAccount = \"ewfw3ggwegwg\";\nconst storageContainer = \"test\";\nconst withNfs = new databricks.Cluster(\"with_nfs\", {clusterMountInfos: [{\n networkFilesystemInfo: {\n serverAddress: `${storageAccount}.blob.core.windows.net`,\n mountOptions: \"sec=sys,vers=3,nolock,proto=tcp\",\n },\n remoteMountDirPath: `${storageAccount}/${storageContainer}`,\n localMountDirPath: \"/mnt/nfs-test\",\n}]});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nstorage_account = \"ewfw3ggwegwg\"\nstorage_container = \"test\"\nwith_nfs = databricks.Cluster(\"with_nfs\", cluster_mount_infos=[{\n \"network_filesystem_info\": {\n \"server_address\": f\"{storage_account}.blob.core.windows.net\",\n \"mount_options\": \"sec=sys,vers=3,nolock,proto=tcp\",\n },\n \"remote_mount_dir_path\": f\"{storage_account}/{storage_container}\",\n \"local_mount_dir_path\": \"/mnt/nfs-test\",\n}])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var storageAccount = \"ewfw3ggwegwg\";\n\n var storageContainer = \"test\";\n\n var withNfs = new Databricks.Cluster(\"with_nfs\", new()\n {\n ClusterMountInfos = new[]\n {\n new Databricks.Inputs.ClusterClusterMountInfoArgs\n {\n NetworkFilesystemInfo = new Databricks.Inputs.ClusterClusterMountInfoNetworkFilesystemInfoArgs\n {\n ServerAddress = $\"{storageAccount}.blob.core.windows.net\",\n MountOptions = \"sec=sys,vers=3,nolock,proto=tcp\",\n },\n RemoteMountDirPath = $\"{storageAccount}/{storageContainer}\",\n LocalMountDirPath = \"/mnt/nfs-test\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tstorageAccount := \"ewfw3ggwegwg\"\n\t\tstorageContainer := \"test\"\n\t\t_, err := databricks.NewCluster(ctx, \"with_nfs\", \u0026databricks.ClusterArgs{\n\t\t\tClusterMountInfos: databricks.ClusterClusterMountInfoArray{\n\t\t\t\t\u0026databricks.ClusterClusterMountInfoArgs{\n\t\t\t\t\tNetworkFilesystemInfo: \u0026databricks.ClusterClusterMountInfoNetworkFilesystemInfoArgs{\n\t\t\t\t\t\tServerAddress: pulumi.Sprintf(\"%v.blob.core.windows.net\", storageAccount),\n\t\t\t\t\t\tMountOptions: pulumi.String(\"sec=sys,vers=3,nolock,proto=tcp\"),\n\t\t\t\t\t},\n\t\t\t\t\tRemoteMountDirPath: pulumi.Sprintf(\"%v/%v\", storageAccount, storageContainer),\n\t\t\t\t\tLocalMountDirPath: pulumi.String(\"/mnt/nfs-test\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_cluster\" \"with_nfs\" {\n cluster_mount_infos {\n network_filesystem_info = {\n server_address =\"${local.storageAccount}.blob.core.windows.net\"\n mount_options = \"sec=sys,vers=3,nolock,proto=tcp\"\n }\n remote_mount_dir_path =\"${local.storageAccount}/${local.storageContainer}\"\n local_mount_dir_path = \"/mnt/nfs-test\"\n }\n}\nlocals {\n storageAccount = \"ewfw3ggwegwg\"\n}\nlocals {\n storageContainer = \"test\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport com.pulumi.databricks.inputs.ClusterClusterMountInfoArgs;\nimport com.pulumi.databricks.inputs.ClusterClusterMountInfoNetworkFilesystemInfoArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var storageAccount = \"ewfw3ggwegwg\";\n\n final var storageContainer = \"test\";\n\n var withNfs = new Cluster(\"withNfs\", ClusterArgs.builder()\n .clusterMountInfos(ClusterClusterMountInfoArgs.builder()\n .networkFilesystemInfo(ClusterClusterMountInfoNetworkFilesystemInfoArgs.builder()\n .serverAddress(String.format(\"%s.blob.core.windows.net\", storageAccount))\n .mountOptions(\"sec=sys,vers=3,nolock,proto=tcp\")\n .build())\n .remoteMountDirPath(String.format(\"%s/%s\", storageAccount,storageContainer))\n .localMountDirPath(\"/mnt/nfs-test\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n withNfs:\n type: databricks:Cluster\n name: with_nfs\n properties:\n clusterMountInfos:\n - networkFilesystemInfo:\n serverAddress: ${storageAccount}.blob.core.windows.net\n mountOptions: sec=sys,vers=3,nolock,proto=tcp\n remoteMountDirPath: ${storageAccount}/${storageContainer}\n localMountDirPath: /mnt/nfs-test\nvariables:\n storageAccount: ewfw3ggwegwg\n storageContainer: test\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/ClusterClusterMountInfoNetworkFilesystemInfo:ClusterClusterMountInfoNetworkFilesystemInfo", "description": "block specifying connection. It consists of:\n" }, "remoteMountDirPath": { "type": "string", "description": "string specifying path to mount on the remote service.\n" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/ClusterClusterMountInfoNetworkFilesystemInfo:ClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string", "description": "string that will be passed as options passed to the \u003cspan pulumi-lang-nodejs=\"`mount`\" pulumi-lang-dotnet=\"`Mount`\" pulumi-lang-go=\"`mount`\" pulumi-lang-python=\"`mount`\" pulumi-lang-yaml=\"`mount`\" pulumi-lang-java=\"`mount`\" pulumi-lang-hcl=\"`mount`\"\u003e`mount`\u003c/span\u003e command.\n" }, "serverAddress": { "type": "string", "description": "host name.\n" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/ClusterDockerImage:ClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/ClusterDockerImageBasicAuth:ClusterDockerImageBasicAuth", "description": "`basic_auth.username` and `basic_auth.password` for Docker repository. Docker registry credentials are encrypted when they are stored in Databricks internal storage and when they are passed to a registry upon fetching Docker images at cluster launch. For better security, these credentials should be stored in the secret scope and referred using secret path syntax: `{{secrets/scope/key}}`, otherwise other users of the workspace may access them via UI/API.\n\nExample usage with\u003cspan pulumi-lang-nodejs=\" azurermContainerRegistry \" pulumi-lang-dotnet=\" AzurermContainerRegistry \" pulumi-lang-go=\" azurermContainerRegistry \" pulumi-lang-python=\" azurerm_container_registry \" pulumi-lang-yaml=\" azurermContainerRegistry \" pulumi-lang-java=\" azurermContainerRegistry \" pulumi-lang-hcl=\" azurerm_container_registry \"\u003e azurermContainerRegistry \u003c/span\u003eand docker_registry_image, that you can adapt to your specific use-case:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as docker from \"@pulumi/docker\";\n\nconst _this = new docker.RegistryImage(\"this\", {\n build: [{}],\n name: `${thisAzurermContainerRegistry.loginServer}/sample:latest`,\n});\nconst thisCluster = new databricks.Cluster(\"this\", {dockerImage: {\n url: _this.name,\n basicAuth: {\n username: thisAzurermContainerRegistry.adminUsername,\n password: thisAzurermContainerRegistry.adminPassword,\n },\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_docker as docker\n\nthis = docker.RegistryImage(\"this\",\n build=[{}],\n name=f\"{this_azurerm_container_registry['loginServer']}/sample:latest\")\nthis_cluster = databricks.Cluster(\"this\", docker_image={\n \"url\": this.name,\n \"basic_auth\": {\n \"username\": this_azurerm_container_registry[\"adminUsername\"],\n \"password\": this_azurerm_container_registry[\"adminPassword\"],\n },\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Docker = Pulumi.Docker;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Docker.RegistryImage(\"this\", new()\n {\n Build = new[]\n {\n null,\n },\n Name = $\"{thisAzurermContainerRegistry.LoginServer}/sample:latest\",\n });\n\n var thisCluster = new Databricks.Cluster(\"this\", new()\n {\n DockerImage = new Databricks.Inputs.ClusterDockerImageArgs\n {\n Url = @this.Name,\n BasicAuth = new Databricks.Inputs.ClusterDockerImageBasicAuthArgs\n {\n Username = thisAzurermContainerRegistry.AdminUsername,\n Password = thisAzurermContainerRegistry.AdminPassword,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-docker/sdk/v4/go/docker\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := docker.NewRegistryImage(ctx, \"this\", \u0026docker.RegistryImageArgs{\n\t\t\tBuild: docker.RegistryImageBuildArgs{\n\t\t\t\tmap[string]interface{}{},\n\t\t\t},\n\t\t\tName: pulumi.Sprintf(\"%v/sample:latest\", thisAzurermContainerRegistry.LoginServer),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewCluster(ctx, \"this\", \u0026databricks.ClusterArgs{\n\t\t\tDockerImage: \u0026databricks.ClusterDockerImageArgs{\n\t\t\t\tUrl: this.Name,\n\t\t\t\tBasicAuth: \u0026databricks.ClusterDockerImageBasicAuthArgs{\n\t\t\t\t\tUsername: pulumi.Any(thisAzurermContainerRegistry.AdminUsername),\n\t\t\t\t\tPassword: pulumi.Any(thisAzurermContainerRegistry.AdminPassword),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n docker = {\n source = \"pulumi/docker\"\n }\n }\n}\n\nresource \"docker_registryimage\" \"this\" {\n build = [{}]\n name =\"${thisAzurermContainerRegistry.loginServer}/sample:latest\"\n}\nresource \"databricks_cluster\" \"this\" {\n docker_image = {\n url = docker_registryimage.this.name\n basic_auth = {\n username = thisAzurermContainerRegistry.adminUsername\n password = thisAzurermContainerRegistry.adminPassword\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.docker.RegistryImage;\nimport com.pulumi.docker.RegistryImageArgs;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport com.pulumi.databricks.inputs.ClusterDockerImageArgs;\nimport com.pulumi.databricks.inputs.ClusterDockerImageBasicAuthArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new RegistryImage(\"this\", RegistryImageArgs.builder()\n .build(RegistryImageBuildArgs.builder()\n .build())\n .name(String.format(\"%s/sample:latest\", thisAzurermContainerRegistry.loginServer()))\n .build());\n\n var thisCluster = new Cluster(\"thisCluster\", ClusterArgs.builder()\n .dockerImage(ClusterDockerImageArgs.builder()\n .url(this_.name())\n .basicAuth(ClusterDockerImageBasicAuthArgs.builder()\n .username(thisAzurermContainerRegistry.adminUsername())\n .password(thisAzurermContainerRegistry.adminPassword())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: docker:RegistryImage\n properties:\n build:\n - {}\n name: ${thisAzurermContainerRegistry.loginServer}/sample:latest\n thisCluster:\n type: databricks:Cluster\n name: this\n properties:\n dockerImage:\n url: ${this.name}\n basicAuth:\n username: ${thisAzurermContainerRegistry.adminUsername}\n password: ${thisAzurermContainerRegistry.adminPassword}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "url": { "type": "string", "description": "URL for the Docker image\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/ClusterDockerImageBasicAuth:ClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/ClusterDriverNodeTypeFlexibility:ClusterDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" }, "description": "list of alternative node types that will be used if main node type isn't available. Follow the [documentation](https://learn.microsoft.com/en-us/azure/databricks/compute/flexible-node-types#fallback-instance-type-requirements) for requirements on selection of alternative node types.\n" } }, "type": "object" }, "databricks:index/ClusterGcpAttributes:ClusterGcpAttributes": { "properties": { "availability": { "type": "string", "description": "Availability type used for all nodes. Valid values are `PREEMPTIBLE_GCP`, `PREEMPTIBLE_WITH_FALLBACK_GCP` and `ON_DEMAND_GCP`, default: `ON_DEMAND_GCP`.\n" }, "bootDiskSize": { "type": "integer", "description": "Boot disk size in GB\n" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer", "description": "The first \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e nodes of the cluster will be placed on on-demand instances. If this value is greater than 0, the cluster driver node will be placed on an on-demand instance. If this value is greater than or equal to the current cluster size, all nodes will be placed on on-demand instances. If this value is less than the current cluster size, \u003cspan pulumi-lang-nodejs=\"`firstOnDemand`\" pulumi-lang-dotnet=\"`FirstOnDemand`\" pulumi-lang-go=\"`firstOnDemand`\" pulumi-lang-python=\"`first_on_demand`\" pulumi-lang-yaml=\"`firstOnDemand`\" pulumi-lang-java=\"`firstOnDemand`\" pulumi-lang-hcl=\"`first_on_demand`\"\u003e`firstOnDemand`\u003c/span\u003e nodes will be placed on on-demand instances, and the remainder will be placed on availability instances. This value does not affect cluster size and cannot be mutated over the lifetime of a cluster.\n" }, "googleServiceAccount": { "type": "string", "description": "Google Service Account email address that the cluster uses to authenticate with Google Identity. This field is used for authentication with the GCS and BigQuery data sources.\n" }, "localSsdCount": { "type": "integer", "description": "Number of local SSD disks (each is 375GB in size) that will be attached to each node of the cluster.\n" }, "usePreemptibleExecutors": { "type": "boolean", "description": "if we should use preemptible executors ([GCP documentation](https://cloud.google.com/compute/docs/instances/preemptible)). *Warning: this field is deprecated in favor of \u003cspan pulumi-lang-nodejs=\"`availability`\" pulumi-lang-dotnet=\"`Availability`\" pulumi-lang-go=\"`availability`\" pulumi-lang-python=\"`availability`\" pulumi-lang-yaml=\"`availability`\" pulumi-lang-java=\"`availability`\" pulumi-lang-hcl=\"`availability`\"\u003e`availability`\u003c/span\u003e, and will be removed soon.*\n" }, "zoneId": { "type": "string", "description": "Identifier for the availability zone in which the cluster resides. This can be one of the following:\n* `HA` (default): High availability, spread nodes across availability zones for a Databricks deployment region.\n* `AUTO`: Databricks picks an availability zone to schedule the cluster on.\n* name of a GCP availability zone: pick one of the available zones from the [list of available availability zones](https://cloud.google.com/compute/docs/regions-zones#available).\n" } }, "type": "object" }, "databricks:index/ClusterInitScript:ClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/ClusterInitScriptAbfss:ClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/ClusterInitScriptDbfs:ClusterInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/ClusterInitScriptFile:ClusterInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/ClusterInitScriptGcs:ClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/ClusterInitScriptS3:ClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/ClusterInitScriptVolumes:ClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/ClusterInitScriptWorkspace:ClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/ClusterInitScriptAbfss:ClusterInitScriptAbfss": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterInitScriptDbfs:ClusterInitScriptDbfs": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterInitScriptFile:ClusterInitScriptFile": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterInitScriptGcs:ClusterInitScriptGcs": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterInitScriptS3:ClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string", "description": "Set canned access control list, e.g. `bucket-owner-full-control`. If \u003cspan pulumi-lang-nodejs=\"`cannedCal`\" pulumi-lang-dotnet=\"`CannedCal`\" pulumi-lang-go=\"`cannedCal`\" pulumi-lang-python=\"`canned_cal`\" pulumi-lang-yaml=\"`cannedCal`\" pulumi-lang-java=\"`cannedCal`\" pulumi-lang-hcl=\"`canned_cal`\"\u003e`cannedCal`\u003c/span\u003e is set, the cluster instance profile must have `s3:PutObjectAcl` permission on the destination bucket and prefix. The full list of possible canned ACLs can be found [here](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl). By default, only the object owner gets full control. If you are using a cross-account role for writing data, you may want to set `bucket-owner-full-control` to make bucket owners able to read the logs.\n" }, "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" }, "enableEncryption": { "type": "boolean", "description": "Enable server-side encryption, false by default.\n" }, "encryptionType": { "type": "string", "description": "The encryption type, it could be `sse-s3` or `sse-kms`. It is used only when encryption is enabled, and the default type is `sse-s3`.\n" }, "endpoint": { "type": "string", "description": "S3 endpoint, e.g. \u003chttps://s3-us-west-2.amazonaws.com\u003e. Either \u003cspan pulumi-lang-nodejs=\"`region`\" pulumi-lang-dotnet=\"`Region`\" pulumi-lang-go=\"`region`\" pulumi-lang-python=\"`region`\" pulumi-lang-yaml=\"`region`\" pulumi-lang-java=\"`region`\" pulumi-lang-hcl=\"`region`\"\u003e`region`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e needs to be set. If both are set, the endpoint is used.\n" }, "kmsKey": { "type": "string", "description": "KMS key used if encryption is enabled and encryption type is set to `sse-kms`.\n" }, "region": { "type": "string", "description": "S3 region, e.g. `us-west-2`. Either \u003cspan pulumi-lang-nodejs=\"`region`\" pulumi-lang-dotnet=\"`Region`\" pulumi-lang-go=\"`region`\" pulumi-lang-python=\"`region`\" pulumi-lang-yaml=\"`region`\" pulumi-lang-java=\"`region`\" pulumi-lang-hcl=\"`region`\"\u003e`region`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e must be set. If both are set, the endpoint is used.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterInitScriptVolumes:ClusterInitScriptVolumes": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterInitScriptWorkspace:ClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string", "description": "S3 destination, e.g., `s3://my-bucket/some-prefix` You must configure the cluster with an instance profile, and the instance profile must have write access to the destination. You cannot use AWS keys.\n" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/ClusterLibrary:ClusterLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/ClusterLibraryCran:ClusterLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/ClusterLibraryMaven:ClusterLibraryMaven" }, "pypi": { "$ref": "#/types/databricks:index/ClusterLibraryPypi:ClusterLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object" }, "databricks:index/ClusterLibraryCran:ClusterLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/ClusterLibraryMaven:ClusterLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/ClusterLibraryPypi:ClusterLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/ClusterPolicyLibrary:ClusterPolicyLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/ClusterPolicyLibraryCran:ClusterPolicyLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/ClusterPolicyLibraryMaven:ClusterPolicyLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterPolicyLibraryProviderConfig:ClusterPolicyLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/ClusterPolicyLibraryPypi:ClusterPolicyLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/ClusterPolicyLibraryCran:ClusterPolicyLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/ClusterPolicyLibraryMaven:ClusterPolicyLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/ClusterPolicyLibraryProviderConfig:ClusterPolicyLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ClusterPolicyLibraryPypi:ClusterPolicyLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/ClusterPolicyProviderConfig:ClusterPolicyProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ClusterProviderConfig:ClusterProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n\nThe following example demonstrates how to create an autoscaling cluster with [Delta Cache](https://docs.databricks.com/delta/optimizations/delta-cache.html) enabled:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst smallest = databricks.getNodeType({\n localDisk: true,\n});\nconst latestLts = databricks.getSparkVersion({\n longTermSupport: true,\n});\nconst sharedAutoscaling = new databricks.Cluster(\"shared_autoscaling\", {\n clusterName: \"Shared Autoscaling\",\n sparkVersion: latestLts.then(latestLts =\u003e latestLts.id),\n nodeTypeId: smallest.then(smallest =\u003e smallest.id),\n autoterminationMinutes: 20,\n autoscale: {\n minWorkers: 1,\n maxWorkers: 50,\n },\n sparkConf: {\n \"spark.databricks.io.cache.enabled\": \"true\",\n \"spark.databricks.io.cache.maxDiskUsage\": \"50g\",\n \"spark.databricks.io.cache.maxMetaDataCache\": \"1g\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsmallest = databricks.get_node_type(local_disk=True)\nlatest_lts = databricks.get_spark_version(long_term_support=True)\nshared_autoscaling = databricks.Cluster(\"shared_autoscaling\",\n cluster_name=\"Shared Autoscaling\",\n spark_version=latest_lts.id,\n node_type_id=smallest.id,\n autotermination_minutes=20,\n autoscale={\n \"min_workers\": 1,\n \"max_workers\": 50,\n },\n spark_conf={\n \"spark.databricks.io.cache.enabled\": \"true\",\n \"spark.databricks.io.cache.maxDiskUsage\": \"50g\",\n \"spark.databricks.io.cache.maxMetaDataCache\": \"1g\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var smallest = Databricks.GetNodeType.Invoke(new()\n {\n LocalDisk = true,\n });\n\n var latestLts = Databricks.GetSparkVersion.Invoke(new()\n {\n LongTermSupport = true,\n });\n\n var sharedAutoscaling = new Databricks.Cluster(\"shared_autoscaling\", new()\n {\n ClusterName = \"Shared Autoscaling\",\n SparkVersion = latestLts.Apply(getSparkVersionResult =\u003e getSparkVersionResult.Id),\n NodeTypeId = smallest.Apply(getNodeTypeResult =\u003e getNodeTypeResult.Id),\n AutoterminationMinutes = 20,\n Autoscale = new Databricks.Inputs.ClusterAutoscaleArgs\n {\n MinWorkers = 1,\n MaxWorkers = 50,\n },\n SparkConf = \n {\n { \"spark.databricks.io.cache.enabled\", \"true\" },\n { \"spark.databricks.io.cache.maxDiskUsage\", \"50g\" },\n { \"spark.databricks.io.cache.maxMetaDataCache\", \"1g\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsmallest, err := databricks.GetNodeType(ctx, \u0026databricks.GetNodeTypeArgs{\n\t\t\tLocalDisk: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlatestLts, err := databricks.GetSparkVersion(ctx, \u0026databricks.GetSparkVersionArgs{\n\t\t\tLongTermSupport: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewCluster(ctx, \"shared_autoscaling\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Shared Autoscaling\"),\n\t\t\tSparkVersion: pulumi.String(pulumi.String(latestLts.Id)),\n\t\t\tNodeTypeId: pulumi.String(pulumi.String(smallest.Id)),\n\t\t\tAutoterminationMinutes: pulumi.Int(20),\n\t\t\tAutoscale: \u0026databricks.ClusterAutoscaleArgs{\n\t\t\t\tMinWorkers: pulumi.Int(1),\n\t\t\t\tMaxWorkers: pulumi.Int(50),\n\t\t\t},\n\t\t\tSparkConf: pulumi.StringMap{\n\t\t\t\t\"spark.databricks.io.cache.enabled\": pulumi.String(\"true\"),\n\t\t\t\t\"spark.databricks.io.cache.maxDiskUsage\": pulumi.String(\"50g\"),\n\t\t\t\t\"spark.databricks.io.cache.maxMetaDataCache\": pulumi.String(\"1g\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getnodetype\" \"smallest\" {\n local_disk = true\n}\ndata \"databricks_getsparkversion\" \"latestLts\" {\n long_term_support = true\n}\n\nresource \"databricks_cluster\" \"shared_autoscaling\" {\n cluster_name = \"Shared Autoscaling\"\n spark_version = data.databricks_getsparkversion.latestLts.id\n node_type_id = data.databricks_getnodetype.smallest.id\n autotermination_minutes = 20\n autoscale = {\n min_workers = 1\n max_workers = 50\n }\n spark_conf = {\n \"spark.databricks.io.cache.enabled\" = true\n \"spark.databricks.io.cache.maxDiskUsage\" = \"50g\"\n \"spark.databricks.io.cache.maxMetaDataCache\" = \"1g\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetNodeTypeArgs;\nimport com.pulumi.databricks.inputs.GetSparkVersionArgs;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport com.pulumi.databricks.inputs.ClusterAutoscaleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var smallest = DatabricksFunctions.getNodeType(GetNodeTypeArgs.builder()\n .localDisk(true)\n .build());\n\n final var latestLts = DatabricksFunctions.getSparkVersion(GetSparkVersionArgs.builder()\n .longTermSupport(true)\n .build());\n\n var sharedAutoscaling = new Cluster(\"sharedAutoscaling\", ClusterArgs.builder()\n .clusterName(\"Shared Autoscaling\")\n .sparkVersion(latestLts.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(20)\n .autoscale(ClusterAutoscaleArgs.builder()\n .minWorkers(1)\n .maxWorkers(50)\n .build())\n .sparkConf(Map.ofEntries(\n Map.entry(\"spark.databricks.io.cache.enabled\", \"true\"),\n Map.entry(\"spark.databricks.io.cache.maxDiskUsage\", \"50g\"),\n Map.entry(\"spark.databricks.io.cache.maxMetaDataCache\", \"1g\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sharedAutoscaling:\n type: databricks:Cluster\n name: shared_autoscaling\n properties:\n clusterName: Shared Autoscaling\n sparkVersion: ${latestLts.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 20\n autoscale:\n minWorkers: 1\n maxWorkers: 50\n sparkConf:\n spark.databricks.io.cache.enabled: true\n spark.databricks.io.cache.maxDiskUsage: 50g\n spark.databricks.io.cache.maxMetaDataCache: 1g\nvariables:\n smallest:\n fn::invoke:\n function: databricks:getNodeType\n arguments:\n localDisk: true\n latestLts:\n fn::invoke:\n function: databricks:getSparkVersion\n arguments:\n longTermSupport: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ClusterWorkerNodeTypeFlexibility:ClusterWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" }, "description": "list of alternative node types that will be used if main node type isn't available. Follow the [documentation](https://learn.microsoft.com/en-us/azure/databricks/compute/flexible-node-types#fallback-instance-type-requirements) for requirements on selection of alternative node types.\n" } }, "type": "object" }, "databricks:index/ClusterWorkloadType:ClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/ClusterWorkloadTypeClients:ClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/ClusterWorkloadTypeClients:ClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean", "description": "boolean flag defining if it's possible to run Databricks Jobs on this cluster. Default: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst withNfs = new databricks.Cluster(\"with_nfs\", {workloadType: {\n clients: {\n jobs: false,\n notebooks: true,\n },\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nwith_nfs = databricks.Cluster(\"with_nfs\", workload_type={\n \"clients\": {\n \"jobs\": False,\n \"notebooks\": True,\n },\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var withNfs = new Databricks.Cluster(\"with_nfs\", new()\n {\n WorkloadType = new Databricks.Inputs.ClusterWorkloadTypeArgs\n {\n Clients = new Databricks.Inputs.ClusterWorkloadTypeClientsArgs\n {\n Jobs = false,\n Notebooks = true,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewCluster(ctx, \"with_nfs\", \u0026databricks.ClusterArgs{\n\t\t\tWorkloadType: \u0026databricks.ClusterWorkloadTypeArgs{\n\t\t\t\tClients: \u0026databricks.ClusterWorkloadTypeClientsArgs{\n\t\t\t\t\tJobs: pulumi.Bool(false),\n\t\t\t\t\tNotebooks: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_cluster\" \"with_nfs\" {\n workload_type = {\n clients = {\n jobs = false\n notebooks = true\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport com.pulumi.databricks.inputs.ClusterWorkloadTypeArgs;\nimport com.pulumi.databricks.inputs.ClusterWorkloadTypeClientsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var withNfs = new Cluster(\"withNfs\", ClusterArgs.builder()\n .workloadType(ClusterWorkloadTypeArgs.builder()\n .clients(ClusterWorkloadTypeClientsArgs.builder()\n .jobs(false)\n .notebooks(true)\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n withNfs:\n type: databricks:Cluster\n name: with_nfs\n properties:\n workloadType:\n clients:\n jobs: false\n notebooks: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "notebooks": { "type": "boolean", "description": "boolean flag defining if it's possible to run notebooks on this cluster. Default: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e.\n" } }, "type": "object" }, "databricks:index/ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace:ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace": { "properties": { "complianceStandards": { "type": "array", "items": { "type": "string" } }, "isEnabled": { "type": "boolean" } }, "type": "object", "required": [ "complianceStandards", "isEnabled" ] }, "databricks:index/ComplianceSecurityProfileWorkspaceSettingProviderConfig:ComplianceSecurityProfileWorkspaceSettingProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ConnectionProviderConfig:ConnectionProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ConnectionProvisioningInfo:ConnectionProvisioningInfo": { "properties": { "state": { "type": "string" } }, "type": "object" }, "databricks:index/CredentialAwsIamRole:CredentialAwsIamRole": { "properties": { "externalId": { "type": "string" }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS IAM role you want to use to setup the trust policy, of the form `arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF`\n\n\u003cspan pulumi-lang-nodejs=\"`azureManagedIdentity`\" pulumi-lang-dotnet=\"`AzureManagedIdentity`\" pulumi-lang-go=\"`azureManagedIdentity`\" pulumi-lang-python=\"`azure_managed_identity`\" pulumi-lang-yaml=\"`azureManagedIdentity`\" pulumi-lang-java=\"`azureManagedIdentity`\" pulumi-lang-hcl=\"`azure_managed_identity`\"\u003e`azureManagedIdentity`\u003c/span\u003e optional configuration block for using managed identity as credential details for Azure (recommended over \u003cspan pulumi-lang-nodejs=\"`azureServicePrincipal`\" pulumi-lang-dotnet=\"`AzureServicePrincipal`\" pulumi-lang-go=\"`azureServicePrincipal`\" pulumi-lang-python=\"`azure_service_principal`\" pulumi-lang-yaml=\"`azureServicePrincipal`\" pulumi-lang-java=\"`azureServicePrincipal`\" pulumi-lang-hcl=\"`azure_service_principal`\"\u003e`azureServicePrincipal`\u003c/span\u003e):\n" }, "unityCatalogIamArn": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "externalId", "unityCatalogIamArn" ] } } }, "databricks:index/CredentialAzureManagedIdentity:CredentialAzureManagedIdentity": { "properties": { "accessConnectorId": { "type": "string", "description": "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`.\n" }, "credentialId": { "type": "string", "description": "Unique ID of the credential.\n" }, "managedIdentityId": { "type": "string", "description": "The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name`.\n\n\u003cspan pulumi-lang-nodejs=\"`azureServicePrincipal`\" pulumi-lang-dotnet=\"`AzureServicePrincipal`\" pulumi-lang-go=\"`azureServicePrincipal`\" pulumi-lang-python=\"`azure_service_principal`\" pulumi-lang-yaml=\"`azureServicePrincipal`\" pulumi-lang-java=\"`azureServicePrincipal`\" pulumi-lang-hcl=\"`azure_service_principal`\"\u003e`azureServicePrincipal`\u003c/span\u003e optional configuration block to use service principal as credential details for Azure. Only applicable when purpose is `STORAGE` (Legacy):\n" } }, "type": "object", "required": [ "accessConnectorId" ], "language": { "nodejs": { "requiredOutputs": [ "accessConnectorId", "credentialId" ] } } }, "databricks:index/CredentialAzureServicePrincipal:CredentialAzureServicePrincipal": { "properties": { "applicationId": { "type": "string", "description": "The application ID of the application registration within the referenced AAD tenant\n" }, "clientSecret": { "type": "string", "description": "The client secret generated for the above app ID in AAD. **This field is redacted on output**\n\n\u003cspan pulumi-lang-nodejs=\"`databricksGcpServiceAccount`\" pulumi-lang-dotnet=\"`DatabricksGcpServiceAccount`\" pulumi-lang-go=\"`databricksGcpServiceAccount`\" pulumi-lang-python=\"`databricks_gcp_service_account`\" pulumi-lang-yaml=\"`databricksGcpServiceAccount`\" pulumi-lang-java=\"`databricksGcpServiceAccount`\" pulumi-lang-hcl=\"`databricks_gcp_service_account`\"\u003e`databricksGcpServiceAccount`\u003c/span\u003e optional configuration block for creating a Databricks-managed GCP Service Account:\n", "secret": true }, "directoryId": { "type": "string", "description": "The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application\n" } }, "type": "object", "required": [ "applicationId", "clientSecret", "directoryId" ] }, "databricks:index/CredentialDatabricksGcpServiceAccount:CredentialDatabricksGcpServiceAccount": { "properties": { "credentialId": { "type": "string", "description": "Unique ID of the credential.\n" }, "email": { "type": "string", "description": "The email of the GCP service account created, to be granted access to relevant buckets.\n" }, "privateKeyId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "credentialId", "email", "privateKeyId" ] } } }, "databricks:index/CredentialProviderConfig:CredentialProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/CustomAppIntegrationTokenAccessPolicy:CustomAppIntegrationTokenAccessPolicy": { "properties": { "absoluteSessionLifetimeInMinutes": { "type": "integer" }, "accessTokenTtlInMinutes": { "type": "integer", "description": "access token time to live (TTL) in minutes.\n" }, "enableSingleUseRefreshTokens": { "type": "boolean" }, "refreshTokenTtlInMinutes": { "type": "integer", "description": "refresh token TTL in minutes. The TTL of refresh token cannot be lower than TTL of access token.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "absoluteSessionLifetimeInMinutes" ] } } }, "databricks:index/DashboardProviderConfig:DashboardProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DataClassificationCatalogConfigAutoTagConfig:DataClassificationCatalogConfigAutoTagConfig": { "properties": { "autoTaggingMode": { "type": "string", "description": "Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: `AUTO_TAGGING_DISABLED`, `AUTO_TAGGING_ENABLED`\n" }, "classificationTag": { "type": "string", "description": "The Classification Tag. For built-in classes this is a system tag (e.g., \"class.name\",\n\"class.location\"); for custom classes it is a user-defined governance tag key\n" } }, "type": "object", "required": [ "autoTaggingMode", "classificationTag" ] }, "databricks:index/DataClassificationCatalogConfigIncludedSchemas:DataClassificationCatalogConfigIncludedSchemas": { "properties": { "names": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "names" ] }, "databricks:index/DataClassificationCatalogConfigProviderConfig:DataClassificationCatalogConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DataQualityMonitorAnomalyDetectionConfig:DataQualityMonitorAnomalyDetectionConfig": { "properties": { "excludedTableFullNames": { "type": "array", "items": { "type": "string" }, "description": "List of fully qualified table names to exclude from anomaly detection\n" } }, "type": "object" }, "databricks:index/DataQualityMonitorDataProfilingConfig:DataQualityMonitorDataProfilingConfig": { "properties": { "assetsDir": { "type": "string", "description": "Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs\n" }, "baselineTableName": { "type": "string", "description": "Baseline table name.\nBaseline data is used to compute drift from the data in the monitored \u003cspan pulumi-lang-nodejs=\"`tableName`\" pulumi-lang-dotnet=\"`TableName`\" pulumi-lang-go=\"`tableName`\" pulumi-lang-python=\"`table_name`\" pulumi-lang-yaml=\"`tableName`\" pulumi-lang-java=\"`tableName`\" pulumi-lang-hcl=\"`table_name`\"\u003e`tableName`\u003c/span\u003e.\nThe baseline table and the monitored table shall have the same schema\n" }, "customMetrics": { "type": "array", "items": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigCustomMetric:DataQualityMonitorDataProfilingConfigCustomMetric" }, "description": "Custom metrics\n" }, "dashboardId": { "type": "string" }, "driftMetricsTableName": { "type": "string" }, "effectiveWarehouseId": { "type": "string" }, "inferenceLog": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigInferenceLog:DataQualityMonitorDataProfilingConfigInferenceLog", "description": "`Analysis Configuration` for monitoring inference log tables\n" }, "latestMonitorFailureMessage": { "type": "string" }, "monitorVersion": { "type": "integer" }, "monitoredTableName": { "type": "string" }, "notificationSettings": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigNotificationSettings:DataQualityMonitorDataProfilingConfigNotificationSettings", "description": "Field for specifying notification settings\n" }, "outputSchemaId": { "type": "string", "description": "ID of the schema where output tables are created\n" }, "profileMetricsTableName": { "type": "string" }, "schedule": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigSchedule:DataQualityMonitorDataProfilingConfigSchedule", "description": "The cron schedule\n" }, "skipBuiltinDashboard": { "type": "boolean", "description": "Whether to skip creating a default dashboard summarizing data quality metrics\n" }, "slicingExprs": { "type": "array", "items": { "type": "string" }, "description": "List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for \u003cspan pulumi-lang-nodejs=\"`col2 \" pulumi-lang-dotnet=\"`Col2 \" pulumi-lang-go=\"`col2 \" pulumi-lang-python=\"`col_2 \" pulumi-lang-yaml=\"`col2 \" pulumi-lang-java=\"`col2 \" pulumi-lang-hcl=\"`col_2 \"\u003e`col2 \u003c/span\u003e\u003e 10` (True and False), and one slice per unique value in\n\u003cspan pulumi-lang-nodejs=\"`col1`\" pulumi-lang-dotnet=\"`Col1`\" pulumi-lang-go=\"`col1`\" pulumi-lang-python=\"`col1`\" pulumi-lang-yaml=\"`col1`\" pulumi-lang-java=\"`col1`\" pulumi-lang-hcl=\"`col1`\"\u003e`col1`\u003c/span\u003e. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices\n" }, "snapshot": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigSnapshot:DataQualityMonitorDataProfilingConfigSnapshot", "description": "`Analysis Configuration` for monitoring snapshot tables\n" }, "status": { "type": "string" }, "timeSeries": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigTimeSeries:DataQualityMonitorDataProfilingConfigTimeSeries", "description": "`Analysis Configuration` for monitoring time series tables\n" }, "warehouseId": { "type": "string", "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used\n" } }, "type": "object", "required": [ "outputSchemaId" ], "language": { "nodejs": { "requiredOutputs": [ "dashboardId", "driftMetricsTableName", "effectiveWarehouseId", "latestMonitorFailureMessage", "monitorVersion", "monitoredTableName", "outputSchemaId", "profileMetricsTableName", "status" ] } } }, "databricks:index/DataQualityMonitorDataProfilingConfigCustomMetric:DataQualityMonitorDataProfilingConfigCustomMetric": { "properties": { "definition": { "type": "string", "description": "Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)\n" }, "inputColumns": { "type": "array", "items": { "type": "string" }, "description": "A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns\n" }, "name": { "type": "string", "description": "Name of the metric in the output tables\n" }, "outputDataType": { "type": "string", "description": "The output type of the custom metric\n" }, "type": { "type": "string", "description": "The type of the custom metric. Possible values are: `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE`, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED`, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT`\n" } }, "type": "object", "required": [ "definition", "inputColumns", "name", "outputDataType", "type" ] }, "databricks:index/DataQualityMonitorDataProfilingConfigInferenceLog:DataQualityMonitorDataProfilingConfigInferenceLog": { "properties": { "granularities": { "type": "array", "items": { "type": "string" } }, "labelColumn": { "type": "string", "description": "Column for the label\n" }, "modelIdColumn": { "type": "string", "description": "Column for the model identifier\n" }, "predictionColumn": { "type": "string", "description": "Column for the prediction\n" }, "problemType": { "type": "string", "description": "Problem type the model aims to solve. Possible values are: `INFERENCE_PROBLEM_TYPE_CLASSIFICATION`, `INFERENCE_PROBLEM_TYPE_REGRESSION`\n" }, "timestampColumn": { "type": "string" } }, "type": "object", "required": [ "granularities", "modelIdColumn", "predictionColumn", "problemType", "timestampColumn" ] }, "databricks:index/DataQualityMonitorDataProfilingConfigNotificationSettings:DataQualityMonitorDataProfilingConfigNotificationSettings": { "properties": { "onFailure": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure:DataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure", "description": "Destinations to send notifications on failure/timeout\n" } }, "type": "object" }, "databricks:index/DataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure:DataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" }, "description": "The list of email addresses to send the notification to. A maximum of 5 email addresses is supported\n" } }, "type": "object" }, "databricks:index/DataQualityMonitorDataProfilingConfigSchedule:DataQualityMonitorDataProfilingConfigSchedule": { "properties": { "pauseStatus": { "type": "string" }, "quartzCronExpression": { "type": "string", "description": "The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)\n" }, "timezoneId": { "type": "string", "description": "A Java timezone id. The schedule for a job will be resolved with respect to this timezone.\nSee `Java TimeZone \u003chttp://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html\u003e`_ for details.\nThe timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression\n" } }, "type": "object", "required": [ "quartzCronExpression", "timezoneId" ], "language": { "nodejs": { "requiredOutputs": [ "pauseStatus", "quartzCronExpression", "timezoneId" ] } } }, "databricks:index/DataQualityMonitorDataProfilingConfigSnapshot:DataQualityMonitorDataProfilingConfigSnapshot": { "type": "object" }, "databricks:index/DataQualityMonitorDataProfilingConfigTimeSeries:DataQualityMonitorDataProfilingConfigTimeSeries": { "properties": { "granularities": { "type": "array", "items": { "type": "string" } }, "timestampColumn": { "type": "string" } }, "type": "object", "required": [ "granularities", "timestampColumn" ] }, "databricks:index/DataQualityMonitorProviderConfig:DataQualityMonitorProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DataQualityRefreshProviderConfig:DataQualityRefreshProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DatabaseDatabaseCatalogProviderConfig:DatabaseDatabaseCatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DatabaseInstanceChildInstanceRef:DatabaseInstanceChildInstanceRef": { "properties": { "branchTime": { "type": "string", "description": "Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "effectiveLsn": { "type": "string", "description": "(string) - For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "lsn": { "type": "string", "description": "User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effectiveLsn", "lsn", "uid" ] } } }, "databricks:index/DatabaseInstanceCustomTag:DatabaseInstanceCustomTag": { "properties": { "key": { "type": "string", "description": "The key of the custom tag\n" }, "value": { "type": "string", "description": "The value of the custom tag\n" } }, "type": "object" }, "databricks:index/DatabaseInstanceEffectiveCustomTag:DatabaseInstanceEffectiveCustomTag": { "properties": { "key": { "type": "string", "description": "The key of the custom tag\n" }, "value": { "type": "string", "description": "The value of the custom tag\n" } }, "type": "object" }, "databricks:index/DatabaseInstanceParentInstanceRef:DatabaseInstanceParentInstanceRef": { "properties": { "branchTime": { "type": "string", "description": "Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "effectiveLsn": { "type": "string", "description": "(string) - For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "lsn": { "type": "string", "description": "User-specified WAL LSN of the ref database instance.\n\nInput: For specifying the WAL LSN to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effectiveLsn", "lsn", "uid" ] } } }, "databricks:index/DatabaseInstanceProviderConfig:DatabaseInstanceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatus": { "properties": { "continuousUpdateStatus": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus" }, "detailedState": { "type": "string", "description": "(string) - The state of the synced table. Possible values are: `SYNCED_TABLED_OFFLINE`, `SYNCED_TABLE_OFFLINE_FAILED`, `SYNCED_TABLE_ONLINE`, `SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE`, `SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE`, `SYNCED_TABLE_ONLINE_PIPELINE_FAILED`, `SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE`, `SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES`, `SYNCED_TABLE_PROVISIONING`, `SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT`, `SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES`\n" }, "failedStatus": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus" }, "lastSync": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync:DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync", "description": "(SyncedTablePosition) - Summary of the last successful synchronization from source to destination.\n" }, "message": { "type": "string", "description": "(string) - A text description of the current state of the synced table\n" }, "pipelineId": { "type": "string", "description": "(string) - ID of the associated pipeline. The pipeline ID may have been provided by the client\n(in the case of bin packing), or generated by the server (when creating a new pipeline)\n" }, "provisioningStatus": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus" }, "triggeredUpdateStatus": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "detailedState", "lastSync", "message", "pipelineId" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress:DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress", "description": "(SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state\n" }, "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "initialPipelineSyncProgress", "lastProcessedCommitVersion", "timestamp" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress:DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "lastProcessedCommitVersion", "timestamp" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync:DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync": { "properties": { "deltaTableSyncInfo": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo:DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo", "description": "(DeltaTableSyncInfo)\n" }, "syncEndTimestamp": { "type": "string", "description": "(string) - The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table\n" }, "syncStartTimestamp": { "type": "string", "description": "(string) - The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deltaTableSyncInfo", "syncEndTimestamp", "syncStartTimestamp" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo:DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo": { "properties": { "deltaCommitTimestamp": { "type": "string", "description": "(string) - The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table\n" }, "deltaCommitVersion": { "type": "integer", "description": "(integer) - The Delta Lake commit version that was last successfully synced\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deltaCommitTimestamp", "deltaCommitVersion" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress:DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress", "description": "(SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "initialPipelineSyncProgress" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress:DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" }, "triggeredUpdateProgress": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress:DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress", "description": "(SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "lastProcessedCommitVersion", "timestamp", "triggeredUpdateProgress" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress:DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableProviderConfig:DatabaseSyncedDatabaseTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableSpec:DatabaseSyncedDatabaseTableSpec": { "properties": { "createDatabaseObjectsIfMissing": { "type": "boolean", "description": "If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist\n" }, "existingPipelineId": { "type": "string", "description": "At most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n\nIf\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eis defined, the synced table will be bin packed into the existing pipeline\nreferenced. This avoids creating a new pipeline and allows sharing existing compute.\nIn this case, the\u003cspan pulumi-lang-nodejs=\" schedulingPolicy \" pulumi-lang-dotnet=\" SchedulingPolicy \" pulumi-lang-go=\" schedulingPolicy \" pulumi-lang-python=\" scheduling_policy \" pulumi-lang-yaml=\" schedulingPolicy \" pulumi-lang-java=\" schedulingPolicy \" pulumi-lang-hcl=\" scheduling_policy \"\u003e schedulingPolicy \u003c/span\u003eof this synced table must match the scheduling policy of the existing pipeline\n" }, "newPipelineSpec": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableSpecNewPipelineSpec:DatabaseSyncedDatabaseTableSpecNewPipelineSpec", "description": "At most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n\nIf\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eis defined, a new pipeline is created for this synced table. The location pointed to is used\nto store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta\ntables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table\nonly requires read permissions\n" }, "primaryKeyColumns": { "type": "array", "items": { "type": "string" }, "description": "Primary Key columns to be used for data insert/update in the destination\n" }, "schedulingPolicy": { "type": "string", "description": "Scheduling policy of the underlying pipeline. Possible values are: `CONTINUOUS`, `SNAPSHOT`, `TRIGGERED`\n" }, "sourceTableFullName": { "type": "string", "description": "Three-part (catalog, schema, table) name of the source Delta table\n" }, "timeseriesKey": { "type": "string", "description": "Time series key to deduplicate (tie-break) rows with the same primary key\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createDatabaseObjectsIfMissing", "existingPipelineId", "newPipelineSpec" ] } } }, "databricks:index/DatabaseSyncedDatabaseTableSpecNewPipelineSpec:DatabaseSyncedDatabaseTableSpecNewPipelineSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "Budget policy to set on the newly created pipeline\n" }, "storageCatalog": { "type": "string", "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables\n" }, "storageSchema": { "type": "string", "description": "This field needs to be specified if the destination catalog is a managed postgres catalog.\n\nUC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables\n" } }, "type": "object" }, "databricks:index/DbfsFileProviderConfig:DbfsFileProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DefaultNamespaceSettingNamespace:DefaultNamespaceSettingNamespace": { "properties": { "value": { "type": "string", "description": "The value for the setting.\n" } }, "type": "object" }, "databricks:index/DefaultNamespaceSettingProviderConfig:DefaultNamespaceSettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DirectoryProviderConfig:DirectoryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DisableLegacyAccessSettingDisableLegacyAccess:DisableLegacyAccessSettingDisableLegacyAccess": { "properties": { "value": { "type": "boolean", "description": "The boolean value for the setting.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/DisableLegacyAccessSettingProviderConfig:DisableLegacyAccessSettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DisableLegacyDbfsSettingDisableLegacyDbfs:DisableLegacyDbfsSettingDisableLegacyDbfs": { "properties": { "value": { "type": "boolean", "description": "The boolean value for the setting.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/DisableLegacyDbfsSettingProviderConfig:DisableLegacyDbfsSettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DisableLegacyFeaturesSettingDisableLegacyFeatures:DisableLegacyFeaturesSettingDisableLegacyFeatures": { "properties": { "value": { "type": "boolean", "description": "The boolean value for the setting.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/DisableLegacyFeaturesSettingProviderConfig:DisableLegacyFeaturesSettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "deprecationMessage": "workspace_id is ignored for account-only resources." } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssets:DisasterRecoveryFailoverGroupUnityCatalogAssets": { "properties": { "catalogs": { "type": "array", "items": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog:DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog" }, "description": "UC catalogs to replicate\n" }, "dataReplicationWorkspaceSet": { "type": "string", "description": "The workspace set whose workspaces will be used for data replication\nof all UC catalogs' underlying storage\n" }, "locationMappings": { "type": "array", "items": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping:DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping" }, "description": "Location mappings - storage URI per region for each location\n" } }, "type": "object", "required": [ "catalogs", "dataReplicationWorkspaceSet" ] }, "databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog:DisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog": { "properties": { "name": { "type": "string", "description": "(string) - Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping:DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping": { "properties": { "name": { "type": "string", "description": "(string) - Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" }, "uriByRegions": { "type": "array", "items": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion:DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion" }, "description": "URI for each region. Each entry maps a region name to a storage URI\n" } }, "type": "object", "required": [ "name", "uriByRegions" ] }, "databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion:DisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion": { "properties": { "region": { "type": "string", "description": "The region name\n" }, "uri": { "type": "string", "description": "The storage URI for this region\n" } }, "type": "object", "required": [ "region", "uri" ] }, "databricks:index/DisasterRecoveryFailoverGroupWorkspaceSet:DisasterRecoveryFailoverGroupWorkspaceSet": { "properties": { "name": { "type": "string", "description": "(string) - Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" }, "replicateWorkspaceAssets": { "type": "boolean", "description": "Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.\nRequires all workspaces in the set to be Mission Critical tier\n" }, "stableUrlNames": { "type": "array", "items": { "type": "string" }, "description": "Resource names of stable URLs associated with this workspace set.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.\nThe referenced stable URLs must already exist (via CreateStableUrl)\n" }, "workspaceIds": { "type": "array", "items": { "type": "string" }, "description": "Workspace IDs in this set. The system derives and validates regions.\nEA: exactly 2 workspaces (one per region)\n" } }, "type": "object", "required": [ "name", "replicateWorkspaceAssets", "workspaceIds" ] }, "databricks:index/EndpointAzurePrivateEndpointInfo:EndpointAzurePrivateEndpointInfo": { "properties": { "privateEndpointName": { "type": "string", "description": "The name of the Private Endpoint in the Azure subscription\n" }, "privateEndpointResourceGuid": { "type": "string", "description": "The GUID of the Private Endpoint resource in the Azure subscription.\nThis is assigned by Azure when the user sets up the Private Endpoint\n" }, "privateEndpointResourceId": { "type": "string", "description": "(string) - The full resource ID of the Private Endpoint\n" }, "privateLinkServiceId": { "type": "string", "description": "(string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to\n" } }, "type": "object", "required": [ "privateEndpointName", "privateEndpointResourceGuid" ], "language": { "nodejs": { "requiredOutputs": [ "privateEndpointName", "privateEndpointResourceGuid", "privateEndpointResourceId", "privateLinkServiceId" ] } } }, "databricks:index/EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace:EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace": { "properties": { "isEnabled": { "type": "boolean" } }, "type": "object", "required": [ "isEnabled" ] }, "databricks:index/EnhancedSecurityMonitoringWorkspaceSettingProviderConfig:EnhancedSecurityMonitoringWorkspaceSettingProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/EntitlementsProviderConfig:EntitlementsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/EntityTagAssignmentProviderConfig:EntityTagAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig:EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/EnvironmentsWorkspaceBaseEnvironmentProviderConfig:EnvironmentsWorkspaceBaseEnvironmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ExternalLocationEffectiveFileEventQueue:ExternalLocationEffectiveFileEventQueue": { "properties": { "managedAqs": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueueManagedAqs:ExternalLocationEffectiveFileEventQueueManagedAqs", "description": "Configuration for managed Azure Queue Storage queue.\n" }, "managedPubsub": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueueManagedPubsub:ExternalLocationEffectiveFileEventQueueManagedPubsub", "description": "Configuration for managed Google Cloud Pub/Sub queue.\n" }, "managedSqs": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueueManagedSqs:ExternalLocationEffectiveFileEventQueueManagedSqs", "description": "Configuration for managed Amazon SQS queue.\n" }, "providedAqs": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueueProvidedAqs:ExternalLocationEffectiveFileEventQueueProvidedAqs", "description": "Configuration for provided Azure Storage Queue.\n" }, "providedPubsub": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueueProvidedPubsub:ExternalLocationEffectiveFileEventQueueProvidedPubsub", "description": "Configuration for provided Google Cloud Pub/Sub queue.\n" }, "providedSqs": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueueProvidedSqs:ExternalLocationEffectiveFileEventQueueProvidedSqs", "description": "Configuration for provided Amazon SQS queue.\n" } }, "type": "object" }, "databricks:index/ExternalLocationEffectiveFileEventQueueManagedAqs:ExternalLocationEffectiveFileEventQueueManagedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string", "description": "The name of the Azure resource group.\n" }, "subscriptionId": { "type": "string", "description": "The Azure subscription ID.\n" } }, "type": "object" }, "databricks:index/ExternalLocationEffectiveFileEventQueueManagedPubsub:ExternalLocationEffectiveFileEventQueueManagedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string", "description": "The name of the subscription.\n" } }, "type": "object" }, "databricks:index/ExternalLocationEffectiveFileEventQueueManagedSqs:ExternalLocationEffectiveFileEventQueueManagedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" } }, "type": "object" }, "databricks:index/ExternalLocationEffectiveFileEventQueueProvidedAqs:ExternalLocationEffectiveFileEventQueueProvidedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string", "description": "The name of the Azure resource group.\n" }, "subscriptionId": { "type": "string", "description": "The Azure subscription ID.\n" } }, "type": "object" }, "databricks:index/ExternalLocationEffectiveFileEventQueueProvidedPubsub:ExternalLocationEffectiveFileEventQueueProvidedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string", "description": "The name of the subscription.\n" } }, "type": "object" }, "databricks:index/ExternalLocationEffectiveFileEventQueueProvidedSqs:ExternalLocationEffectiveFileEventQueueProvidedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" } }, "type": "object" }, "databricks:index/ExternalLocationEncryptionDetails:ExternalLocationEncryptionDetails": { "properties": { "sseEncryptionDetails": { "$ref": "#/types/databricks:index/ExternalLocationEncryptionDetailsSseEncryptionDetails:ExternalLocationEncryptionDetailsSseEncryptionDetails", "description": "a block describing server-Side Encryption properties for clients communicating with AWS S3. Consists of the following attributes:\n" } }, "type": "object" }, "databricks:index/ExternalLocationEncryptionDetailsSseEncryptionDetails:ExternalLocationEncryptionDetailsSseEncryptionDetails": { "properties": { "algorithm": { "type": "string", "description": "Encryption algorithm value. Sets the value of the `x-amz-server-side-encryption` header in S3 request.\n" }, "awsKmsKeyArn": { "type": "string", "description": "Optional ARN of the SSE-KMS key used with the S3 location, when `algorithm = \"SSE-KMS\"`. Sets the value of the `x-amz-server-side-encryption-aws-kms-key-id` header.\n" } }, "type": "object" }, "databricks:index/ExternalLocationFileEventQueue:ExternalLocationFileEventQueue": { "properties": { "managedAqs": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueueManagedAqs:ExternalLocationFileEventQueueManagedAqs", "description": "Configuration for managed Azure Queue Storage queue.\n" }, "managedPubsub": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueueManagedPubsub:ExternalLocationFileEventQueueManagedPubsub", "description": "Configuration for managed Google Cloud Pub/Sub queue.\n" }, "managedSqs": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueueManagedSqs:ExternalLocationFileEventQueueManagedSqs", "description": "Configuration for managed Amazon SQS queue.\n" }, "providedAqs": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueueProvidedAqs:ExternalLocationFileEventQueueProvidedAqs", "description": "Configuration for provided Azure Storage Queue.\n" }, "providedPubsub": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueueProvidedPubsub:ExternalLocationFileEventQueueProvidedPubsub", "description": "Configuration for provided Google Cloud Pub/Sub queue.\n" }, "providedSqs": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueueProvidedSqs:ExternalLocationFileEventQueueProvidedSqs", "description": "Configuration for provided Amazon SQS queue.\n" } }, "type": "object" }, "databricks:index/ExternalLocationFileEventQueueManagedAqs:ExternalLocationFileEventQueueManagedAqs": { "properties": { "managedResourceId": { "type": "string", "description": "The ID of the managed resource.\n" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string", "description": "The name of the Azure resource group.\n" }, "subscriptionId": { "type": "string", "description": "The Azure subscription ID.\n" } }, "type": "object", "required": [ "resourceGroup", "subscriptionId" ], "language": { "nodejs": { "requiredOutputs": [ "managedResourceId", "resourceGroup", "subscriptionId" ] } } }, "databricks:index/ExternalLocationFileEventQueueManagedPubsub:ExternalLocationFileEventQueueManagedPubsub": { "properties": { "managedResourceId": { "type": "string", "description": "The ID of the managed resource.\n" }, "subscriptionName": { "type": "string", "description": "The name of the subscription.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "managedResourceId" ] } } }, "databricks:index/ExternalLocationFileEventQueueManagedSqs:ExternalLocationFileEventQueueManagedSqs": { "properties": { "managedResourceId": { "type": "string", "description": "The ID of the managed resource.\n" }, "queueUrl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "managedResourceId" ] } } }, "databricks:index/ExternalLocationFileEventQueueProvidedAqs:ExternalLocationFileEventQueueProvidedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string", "description": "The URL of the queue.\n" }, "resourceGroup": { "type": "string", "description": "The name of the Azure resource group.\n" }, "subscriptionId": { "type": "string", "description": "The Azure subscription ID.\n" } }, "type": "object", "required": [ "queueUrl" ], "language": { "nodejs": { "requiredOutputs": [ "managedResourceId", "queueUrl" ] } } }, "databricks:index/ExternalLocationFileEventQueueProvidedPubsub:ExternalLocationFileEventQueueProvidedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string", "description": "The name of the subscription.\n" } }, "type": "object", "required": [ "subscriptionName" ], "language": { "nodejs": { "requiredOutputs": [ "managedResourceId", "subscriptionName" ] } } }, "databricks:index/ExternalLocationFileEventQueueProvidedSqs:ExternalLocationFileEventQueueProvidedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string", "description": "The URL of the SQS queue.\n" } }, "type": "object", "required": [ "queueUrl" ], "language": { "nodejs": { "requiredOutputs": [ "managedResourceId", "queueUrl" ] } } }, "databricks:index/ExternalLocationProviderConfig:ExternalLocationProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ExternalMetadataProviderConfig:ExternalMetadataProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/FeatureEngineeringFeatureEntity:FeatureEngineeringFeatureEntity": { "properties": { "name": { "type": "string", "description": "(string) - Name of the feature, extracted from the full three-part name (catalog.schema.name)\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/FeatureEngineeringFeatureFunction:FeatureEngineeringFeatureFunction": { "properties": { "aggregationFunction": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunction:FeatureEngineeringFeatureFunctionAggregationFunction", "description": "An aggregation function applied over a time window\n" }, "columnSelection": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionColumnSelection:FeatureEngineeringFeatureFunctionColumnSelection", "description": "Selects the latest value of a single column in a data source\n" }, "extraParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionExtraParameter:FeatureEngineeringFeatureFunctionExtraParameter" }, "description": "Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nExtra parameters for parameterized functions\n" }, "functionType": { "type": "string", "description": "Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nThe type of the function. Possible values are: `APPROX_COUNT_DISTINCT`, `APPROX_PERCENTILE`, `AVG`, `COUNT`, `FIRST`, `LAST`, `MAX`, `MIN`, `STDDEV_POP`, `STDDEV_SAMP`, `SUM`, `VAR_POP`, `VAR_SAMP`\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunction:FeatureEngineeringFeatureFunctionAggregationFunction": { "properties": { "approxCountDistinct": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct:FeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct" }, "approxPercentile": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile:FeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile" }, "avg": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionAvg:FeatureEngineeringFeatureFunctionAggregationFunctionAvg" }, "countFunction": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionCountFunction:FeatureEngineeringFeatureFunctionAggregationFunctionCountFunction" }, "first": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionFirst:FeatureEngineeringFeatureFunctionAggregationFunctionFirst" }, "last": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionLast:FeatureEngineeringFeatureFunctionAggregationFunctionLast" }, "max": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionMax:FeatureEngineeringFeatureFunctionAggregationFunctionMax" }, "min": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionMin:FeatureEngineeringFeatureFunctionAggregationFunctionMin" }, "stddevPop": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionStddevPop:FeatureEngineeringFeatureFunctionAggregationFunctionStddevPop" }, "stddevSamp": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp:FeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp" }, "sum": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionSum:FeatureEngineeringFeatureFunctionAggregationFunctionSum" }, "timeWindow": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow", "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed\n" }, "varPop": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionVarPop:FeatureEngineeringFeatureFunctionAggregationFunctionVarPop" }, "varSamp": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionVarSamp:FeatureEngineeringFeatureFunctionAggregationFunctionVarSamp" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct:FeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct": { "properties": { "input": { "type": "string" }, "relativeSd": { "type": "number", "description": "The maximum relative standard deviation allowed (default defined by Spark)\n" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile:FeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile": { "properties": { "accuracy": { "type": "integer", "description": "The accuracy parameter (higher is more accurate but slower)\n" }, "input": { "type": "string" }, "percentile": { "type": "number", "description": "The percentile value to compute (between 0 and 1)\n" } }, "type": "object", "required": [ "input", "percentile" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionAvg:FeatureEngineeringFeatureFunctionAggregationFunctionAvg": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionCountFunction:FeatureEngineeringFeatureFunctionAggregationFunctionCountFunction": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionFirst:FeatureEngineeringFeatureFunctionAggregationFunctionFirst": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionLast:FeatureEngineeringFeatureFunctionAggregationFunctionLast": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionMax:FeatureEngineeringFeatureFunctionAggregationFunctionMax": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionMin:FeatureEngineeringFeatureFunctionAggregationFunctionMin": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionStddevPop:FeatureEngineeringFeatureFunctionAggregationFunctionStddevPop": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp:FeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionSum:FeatureEngineeringFeatureFunctionAggregationFunctionSum": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow": { "properties": { "continuous": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous" }, "rolling": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling" }, "sliding": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding" }, "tumbling": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous": { "properties": { "offset": { "type": "string", "description": "The offset of the continuous window (must be non-positive)\n" }, "windowDuration": { "type": "string" } }, "type": "object", "required": [ "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling": { "properties": { "delay": { "type": "string", "description": "The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time\n" }, "windowDuration": { "type": "string" } }, "type": "object", "required": [ "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding": { "properties": { "slideDuration": { "type": "string", "description": "The slide duration (interval by which windows advance, must be positive and less than duration)\n" }, "windowDuration": { "type": "string" } }, "type": "object", "required": [ "slideDuration", "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling:FeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling": { "properties": { "windowDuration": { "type": "string" } }, "type": "object", "required": [ "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionVarPop:FeatureEngineeringFeatureFunctionAggregationFunctionVarPop": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionAggregationFunctionVarSamp:FeatureEngineeringFeatureFunctionAggregationFunctionVarSamp": { "properties": { "input": { "type": "string" } }, "type": "object", "required": [ "input" ] }, "databricks:index/FeatureEngineeringFeatureFunctionColumnSelection:FeatureEngineeringFeatureFunctionColumnSelection": { "properties": { "column": { "type": "string", "description": "Column name from source to select as the feature value\n" } }, "type": "object", "required": [ "column" ] }, "databricks:index/FeatureEngineeringFeatureFunctionExtraParameter:FeatureEngineeringFeatureFunctionExtraParameter": { "properties": { "key": { "type": "string", "description": "The name of the parameter\n" }, "value": { "type": "string", "description": "The value of the parameter\n" } }, "type": "object", "required": [ "key", "value" ] }, "databricks:index/FeatureEngineeringFeatureLineageContext:FeatureEngineeringFeatureLineageContext": { "properties": { "jobContext": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureLineageContextJobContext:FeatureEngineeringFeatureLineageContextJobContext", "description": "Job context information including job ID and run ID\n" }, "notebookId": { "type": "integer", "description": "The notebook ID where this API was invoked\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureLineageContextJobContext:FeatureEngineeringFeatureLineageContextJobContext": { "properties": { "jobId": { "type": "integer", "description": "The job ID where this API invoked\n" }, "jobRunId": { "type": "integer", "description": "The job run ID where this API was invoked\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureProviderConfig:FeatureEngineeringFeatureProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/FeatureEngineeringFeatureSource:FeatureEngineeringFeatureSource": { "properties": { "deltaTableSource": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceDeltaTableSource:FeatureEngineeringFeatureSourceDeltaTableSource", "description": "A Delta table data source\n" }, "kafkaSource": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceKafkaSource:FeatureEngineeringFeatureSourceKafkaSource", "description": "A Kafka stream data source\n" }, "requestSource": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceRequestSource:FeatureEngineeringFeatureSourceRequestSource", "description": "A request-time data source\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureSourceDeltaTableSource:FeatureEngineeringFeatureSourceDeltaTableSource": { "properties": { "dataframeSchema": { "type": "string", "description": "Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colA\"\" pulumi-lang-dotnet=\"\"ColA\"\" pulumi-lang-go=\"\"colA\"\" pulumi-lang-python=\"\"col_a\"\" pulumi-lang-yaml=\"\"colA\"\" pulumi-lang-java=\"\"colA\"\" pulumi-lang-hcl=\"\"col_a\"\"\u003e\"colA\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colC\"\" pulumi-lang-dotnet=\"\"ColC\"\" pulumi-lang-go=\"\"colC\"\" pulumi-lang-python=\"\"col_c\"\" pulumi-lang-yaml=\"\"colC\"\" pulumi-lang-java=\"\"colC\"\" pulumi-lang-hcl=\"\"col_c\"\"\u003e\"colC\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}\n" }, "entityColumns": { "type": "array", "items": { "type": "string" }, "description": "Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table\n" }, "filterCondition": { "type": "string", "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value\n" }, "timeseriesColumn": { "type": "string", "description": "Column recording time, used for point-in-time joins, backfills, and aggregations\n" }, "transformationSql": { "type": "string", "description": "A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC \" pulumi-lang-dotnet=\" ColC \" pulumi-lang-go=\" colC \" pulumi-lang-python=\" col_c \" pulumi-lang-yaml=\" colC \" pulumi-lang-java=\" colC \" pulumi-lang-hcl=\" col_c \"\u003e colC \u003c/span\u003eFROM x.y.z WHERE\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e\u003e 0\" would have \u003cspan pulumi-lang-nodejs=\"`transformationSql`\" pulumi-lang-dotnet=\"`TransformationSql`\" pulumi-lang-go=\"`transformationSql`\" pulumi-lang-python=\"`transformation_sql`\" pulumi-lang-yaml=\"`transformationSql`\" pulumi-lang-java=\"`transformationSql`\" pulumi-lang-hcl=\"`transformation_sql`\"\u003e`transformationSql`\u003c/span\u003e \"*,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC\"\" pulumi-lang-dotnet=\" ColC\"\" pulumi-lang-go=\" colC\"\" pulumi-lang-python=\" col_c\"\" pulumi-lang-yaml=\" colC\"\" pulumi-lang-java=\" colC\"\" pulumi-lang-hcl=\" col_c\"\"\u003e colC\"\u003c/span\u003e)\nIf\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis not provided, all columns of the delta table are present in the DataSource dataframe\n" } }, "type": "object", "required": [ "fullName" ] }, "databricks:index/FeatureEngineeringFeatureSourceKafkaSource:FeatureEngineeringFeatureSourceKafkaSource": { "properties": { "entityColumnIdentifiers": { "type": "array", "items": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier:FeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier" }, "description": "Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity column identifiers of the Kafka source\n" }, "filterCondition": { "type": "string", "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation\n" }, "name": { "type": "string", "description": "(string) - Name of the feature, extracted from the full three-part name (catalog.schema.name)\n" }, "timeseriesColumnIdentifier": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier:FeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier", "description": "Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column identifier of the Kafka source\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/FeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier:FeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier": { "properties": { "variantExprPath": { "type": "string", "description": "String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip\n" } }, "type": "object", "required": [ "variantExprPath" ] }, "databricks:index/FeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier:FeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier": { "properties": { "variantExprPath": { "type": "string", "description": "String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip\n" } }, "type": "object", "required": [ "variantExprPath" ] }, "databricks:index/FeatureEngineeringFeatureSourceRequestSource:FeatureEngineeringFeatureSourceRequestSource": { "properties": { "flatSchema": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceRequestSourceFlatSchema:FeatureEngineeringFeatureSourceRequestSourceFlatSchema", "description": "A flat schema with scalar-typed fields only\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureSourceRequestSourceFlatSchema:FeatureEngineeringFeatureSourceRequestSourceFlatSchema": { "properties": { "fields": { "type": "array", "items": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSourceRequestSourceFlatSchemaField:FeatureEngineeringFeatureSourceRequestSourceFlatSchemaField" }, "description": "The list of fields in this schema\n" } }, "type": "object", "required": [ "fields" ] }, "databricks:index/FeatureEngineeringFeatureSourceRequestSourceFlatSchemaField:FeatureEngineeringFeatureSourceRequestSourceFlatSchemaField": { "properties": { "dataType": { "type": "string", "description": "The scalar data type of the field. Possible values are: `BINARY`, `BOOLEAN`, `DATE`, `DECIMAL`, `DOUBLE`, `FLOAT`, `INTEGER`, `LONG`, `SHORT`, `STRING`, `TIMESTAMP`\n" }, "name": { "type": "string", "description": "(string) - Name of the feature, extracted from the full three-part name (catalog.schema.name)\n" } }, "type": "object", "required": [ "dataType", "name" ] }, "databricks:index/FeatureEngineeringFeatureTimeWindow:FeatureEngineeringFeatureTimeWindow": { "properties": { "continuous": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindowContinuous:FeatureEngineeringFeatureTimeWindowContinuous" }, "rolling": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindowRolling:FeatureEngineeringFeatureTimeWindowRolling" }, "sliding": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindowSliding:FeatureEngineeringFeatureTimeWindowSliding" }, "tumbling": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindowTumbling:FeatureEngineeringFeatureTimeWindowTumbling" } }, "type": "object" }, "databricks:index/FeatureEngineeringFeatureTimeWindowContinuous:FeatureEngineeringFeatureTimeWindowContinuous": { "properties": { "offset": { "type": "string", "description": "The offset of the continuous window (must be non-positive)\n" }, "windowDuration": { "type": "string" } }, "type": "object", "required": [ "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureTimeWindowRolling:FeatureEngineeringFeatureTimeWindowRolling": { "properties": { "delay": { "type": "string", "description": "The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time\n" }, "windowDuration": { "type": "string" } }, "type": "object", "required": [ "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureTimeWindowSliding:FeatureEngineeringFeatureTimeWindowSliding": { "properties": { "slideDuration": { "type": "string", "description": "The slide duration (interval by which windows advance, must be positive and less than duration)\n" }, "windowDuration": { "type": "string" } }, "type": "object", "required": [ "slideDuration", "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureTimeWindowTumbling:FeatureEngineeringFeatureTimeWindowTumbling": { "properties": { "windowDuration": { "type": "string" } }, "type": "object", "required": [ "windowDuration" ] }, "databricks:index/FeatureEngineeringFeatureTimeseriesColumn:FeatureEngineeringFeatureTimeseriesColumn": { "properties": { "name": { "type": "string", "description": "(string) - Name of the feature, extracted from the full three-part name (catalog.schema.name)\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/FeatureEngineeringKafkaConfigAuthConfig:FeatureEngineeringKafkaConfigAuthConfig": { "properties": { "mtlsConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfig:FeatureEngineeringKafkaConfigAuthConfigMtlsConfig", "description": "Mutual-TLS authentication. See MtlsConfig\n" }, "ucServiceCredentialName": { "type": "string", "description": "Name of the Unity Catalog service credential. This value will be set under the option databricks.serviceCredential\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfig:FeatureEngineeringKafkaConfigAuthConfigMtlsConfig": { "properties": { "disableHostnameVerification": { "type": "boolean", "description": "Set to true only when the broker certificate's SAN intentionally does not match\nthe connection endpoint — for example when reaching the cluster through a\nPrivateLink endpoint whose DNS name is not in the broker certificate. Skipping\nthe hostname check removes a defense against man-in-the-middle attacks; do not\nenable casually. mTLS client authentication is unaffected by this option.\n\nSee the Apache Kafka SSL security guide for background on this check:\nhttps://kafka.apache.org/42/security/encryption-and-authentication-using-ssl/#host-name-verification\n" }, "keyPasswordRef": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef:FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef", "description": "Secret-scope reference for the private key password. Often the same value as the\nkeystore password (keytool's default), but provided as a separate field because\nApache Kafka requires it as a distinct option (kafka.ssl.key.password)\n" }, "keystoreLocation": { "type": "string", "description": "Unity Catalog volume path to the JKS keystore file containing the client certificate\nand private key. e.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/client.jks\". The\nmaterialization compute must have read permission on this volume\n" }, "keystorePasswordRef": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef:FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef", "description": "Secret-scope reference for the JKS keystore password\n" }, "truststoreLocation": { "type": "string", "description": "Unity Catalog volume path to the JKS truststore file containing the CA certificate(s)\ntrusted to verify the Kafka broker's server certificate.\ne.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/truststore.jks\"\n" }, "truststorePasswordRef": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef:FeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef", "description": "Secret-scope reference for the JKS truststore password\n" } }, "type": "object", "required": [ "keyPasswordRef", "keystoreLocation", "keystorePasswordRef", "truststoreLocation", "truststorePasswordRef" ] }, "databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef:FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef": { "properties": { "key": { "type": "string", "description": "The key within the scope\n" }, "scope": { "type": "string", "description": "The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ] }, "databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef:FeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef": { "properties": { "key": { "type": "string", "description": "The key within the scope\n" }, "scope": { "type": "string", "description": "The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ] }, "databricks:index/FeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef:FeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef": { "properties": { "key": { "type": "string", "description": "The key within the scope\n" }, "scope": { "type": "string", "description": "The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ] }, "databricks:index/FeatureEngineeringKafkaConfigBackfillSource:FeatureEngineeringKafkaConfigBackfillSource": { "properties": { "deltaTableName": { "type": "string", "description": "The full three-part name (catalog, schema, name) of the Delta table containing the historical data to backfill\n" }, "deltaTableSource": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource:FeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource", "description": "Deprecated: Use\u003cspan pulumi-lang-nodejs=\" deltaTableName \" pulumi-lang-dotnet=\" DeltaTableName \" pulumi-lang-go=\" deltaTableName \" pulumi-lang-python=\" delta_table_name \" pulumi-lang-yaml=\" deltaTableName \" pulumi-lang-java=\" deltaTableName \" pulumi-lang-hcl=\" delta_table_name \"\u003e deltaTableName \u003c/span\u003einstead. Kept for backwards compatibility.\nThe Delta table source containing the historical data to backfill.\nOnly the delta table name is used for backfill, other fields are ignored\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource:FeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource": { "properties": { "dataframeSchema": { "type": "string", "description": "Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colA\"\" pulumi-lang-dotnet=\"\"ColA\"\" pulumi-lang-go=\"\"colA\"\" pulumi-lang-python=\"\"col_a\"\" pulumi-lang-yaml=\"\"colA\"\" pulumi-lang-java=\"\"colA\"\" pulumi-lang-hcl=\"\"col_a\"\"\u003e\"colA\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colC\"\" pulumi-lang-dotnet=\"\"ColC\"\" pulumi-lang-go=\"\"colC\"\" pulumi-lang-python=\"\"col_c\"\" pulumi-lang-yaml=\"\"colC\"\" pulumi-lang-java=\"\"colC\"\" pulumi-lang-hcl=\"\"col_c\"\"\u003e\"colC\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}\n" }, "entityColumns": { "type": "array", "items": { "type": "string" }, "description": "Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table\n" }, "filterCondition": { "type": "string", "description": "Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections\n" }, "fullName": { "type": "string", "description": "The full three-part (catalog, schema, table) name of the Delta table\n" }, "timeseriesColumn": { "type": "string", "description": "Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table\n" }, "transformationSql": { "type": "string", "description": "A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC \" pulumi-lang-dotnet=\" ColC \" pulumi-lang-go=\" colC \" pulumi-lang-python=\" col_c \" pulumi-lang-yaml=\" colC \" pulumi-lang-java=\" colC \" pulumi-lang-hcl=\" col_c \"\u003e colC \u003c/span\u003eFROM x.y.z WHERE\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e\u003e 0\" would have \u003cspan pulumi-lang-nodejs=\"`transformationSql`\" pulumi-lang-dotnet=\"`TransformationSql`\" pulumi-lang-go=\"`transformationSql`\" pulumi-lang-python=\"`transformation_sql`\" pulumi-lang-yaml=\"`transformationSql`\" pulumi-lang-java=\"`transformationSql`\" pulumi-lang-hcl=\"`transformation_sql`\"\u003e`transformationSql`\u003c/span\u003e \"*,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC\"\" pulumi-lang-dotnet=\" ColC\"\" pulumi-lang-go=\" colC\"\" pulumi-lang-python=\" col_c\"\" pulumi-lang-yaml=\" colC\"\" pulumi-lang-java=\" colC\"\" pulumi-lang-hcl=\" col_c\"\"\u003e colC\"\u003c/span\u003e)\nIf\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis not provided, all columns of the delta table are present in the DataSource dataframe\n" } }, "type": "object", "required": [ "fullName" ] }, "databricks:index/FeatureEngineeringKafkaConfigKeySchema:FeatureEngineeringKafkaConfigKeySchema": { "properties": { "jsonSchema": { "type": "string", "description": "Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/)\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringKafkaConfigProviderConfig:FeatureEngineeringKafkaConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/FeatureEngineeringKafkaConfigSubscriptionMode:FeatureEngineeringKafkaConfigSubscriptionMode": { "properties": { "assign": { "type": "string", "description": "A JSON string that contains the specific topic-partitions to consume from.\nFor example, for '{\"topicA\":[0,1],\"topicB\":[2,4]}', topicA's 0'th and 1st partitions will be consumed from\n" }, "subscribe": { "type": "string", "description": "A comma-separated list of Kafka topics to read from. For example, 'topicA,topicB,topicC'\n" }, "subscribePattern": { "type": "string", "description": "A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringKafkaConfigValueSchema:FeatureEngineeringKafkaConfigValueSchema": { "properties": { "jsonSchema": { "type": "string", "description": "Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/)\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringMaterializedFeatureCronScheduleTrigger:FeatureEngineeringMaterializedFeatureCronScheduleTrigger": { "properties": { "cronExpression": { "type": "string", "description": "The cron expression defining the schedule (e.g., \"0 0 * * *\" for daily at midnight)\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringMaterializedFeatureOfflineStoreConfig:FeatureEngineeringMaterializedFeatureOfflineStoreConfig": { "properties": { "catalogName": { "type": "string" }, "schemaName": { "type": "string" }, "tableNamePrefix": { "type": "string" } }, "type": "object", "required": [ "catalogName", "schemaName", "tableNamePrefix" ] }, "databricks:index/FeatureEngineeringMaterializedFeatureOnlineStoreConfig:FeatureEngineeringMaterializedFeatureOnlineStoreConfig": { "properties": { "catalogName": { "type": "string" }, "onlineStoreName": { "type": "string", "description": "The name of the target online store\n" }, "schemaName": { "type": "string" }, "tableNamePrefix": { "type": "string" } }, "type": "object", "required": [ "catalogName", "onlineStoreName", "schemaName", "tableNamePrefix" ] }, "databricks:index/FeatureEngineeringMaterializedFeatureProviderConfig:FeatureEngineeringMaterializedFeatureProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/FeatureEngineeringMaterializedFeatureStreamingMode:FeatureEngineeringMaterializedFeatureStreamingMode": { "properties": { "mode": { "type": "string", "description": "The type of streaming mode used by the materialization pipeline. Possible values are: `STREAMING_MODE_TYPE_MBM`, `STREAMING_MODE_TYPE_RTM`\n" } }, "type": "object" }, "databricks:index/FeatureEngineeringMaterializedFeatureTableTrigger:FeatureEngineeringMaterializedFeatureTableTrigger": { "type": "object" }, "databricks:index/FileProviderConfig:FileProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GitCredentialProviderConfig:GitCredentialProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GlobalInitScriptProviderConfig:GlobalInitScriptProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GrantProviderConfig:GrantProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GrantsGrant:GrantsGrant": { "properties": { "principal": { "type": "string" }, "privileges": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "principal", "privileges" ] }, "databricks:index/GrantsProviderConfig:GrantsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GroupInstanceProfileProviderConfig:GroupInstanceProfileProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GroupMemberProviderConfig:GroupMemberProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GroupProviderConfig:GroupProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/GroupRoleProviderConfig:GroupRoleProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/InstancePoolAwsAttributes:InstancePoolAwsAttributes": { "properties": { "availability": { "type": "string", "description": "(String) Availability type used for all instances in the pool. Only `ON_DEMAND` and `SPOT` are supported.\n", "willReplaceOnChanges": true }, "instanceProfileArn": { "type": "string", "description": "Nodes belonging to the pool will only be placed on AWS instances with this instance profile. Please see\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eresource documentation for extended examples on adding a valid instance profile using Pulumi.\n", "willReplaceOnChanges": true }, "spotBidPricePercent": { "type": "integer", "description": "(Integer) The max price for AWS spot instances, as a percentage of the corresponding instance type's on-demand price. For example, if this field is set to 50, and the instance pool needs a new i3.xlarge spot instance, then the max price is half of the price of on-demand i3.xlarge instances. Similarly, if this field is set to 200, the max price is twice the price of on-demand i3.xlarge instances. If not specified, the *default value is 100*. When spot instances are requested for this instance pool, only spot instances whose max price percentage matches this field are considered. *For safety, this field cannot be greater than 10000.*\n", "willReplaceOnChanges": true }, "zoneId": { "type": "string", "description": "(String) Identifier for the availability zone/datacenter in which the instance pool resides. This string is of the form like `\"us-west-2a\"`. The provided availability zone must be in the same region as the Databricks deployment. For example, `\"us-west-2a\"` is not a valid zone ID if the Databricks deployment resides in the `\"us-east-1\"` region. If not specified, a default zone is used. You can find the list of available zones as well as the default value by using the [List Zones API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistavailablezones).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "zoneId" ] } } }, "databricks:index/InstancePoolAzureAttributes:InstancePoolAzureAttributes": { "properties": { "availability": { "type": "string", "description": "Availability type used for all nodes. Valid values are `SPOT_AZURE` and `ON_DEMAND_AZURE`.\n", "willReplaceOnChanges": true }, "spotBidMaxPrice": { "type": "number", "description": "The max bid price used for Azure spot instances. You can set this to greater than or equal to the current spot price. You can also set this to `-1`, which specifies that the instance cannot be evicted on the basis of price. The price for the instance will be the current price for spot instances or the price for a standard instance.\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/InstancePoolDiskSpec:InstancePoolDiskSpec": { "properties": { "diskCount": { "type": "integer", "description": "(Integer) The number of disks to attach to each instance. This feature is only enabled for supported node types. Users can choose up to the limit of the disks supported by the node type. For node types with no local disk, at least one disk needs to be specified.\n" }, "diskSize": { "type": "integer", "description": "(Integer) The size of each disk (in GiB) to attach.\n" }, "diskType": { "$ref": "#/types/databricks:index/InstancePoolDiskSpecDiskType:InstancePoolDiskSpecDiskType" } }, "type": "object" }, "databricks:index/InstancePoolDiskSpecDiskType:InstancePoolDiskSpecDiskType": { "properties": { "azureDiskVolumeType": { "type": "string", "willReplaceOnChanges": true }, "ebsVolumeType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/InstancePoolGcpAttributes:InstancePoolGcpAttributes": { "properties": { "gcpAvailability": { "type": "string", "description": "Availability type used for all nodes. Valid values are `PREEMPTIBLE_GCP`, `PREEMPTIBLE_WITH_FALLBACK_GCP` and `ON_DEMAND_GCP`, default: `ON_DEMAND_GCP`.\n", "willReplaceOnChanges": true }, "localSsdCount": { "type": "integer", "description": "Number of local SSD disks (each is 375GB in size) that will be attached to each node of the cluster.\n", "willReplaceOnChanges": true }, "zoneId": { "type": "string", "description": "Identifier for the availability zone/datacenter in which the cluster resides. This string will be of a form like `us-central1-a`. The provided availability zone must be in the same region as the Databricks workspace.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "localSsdCount", "zoneId" ] } } }, "databricks:index/InstancePoolInstancePoolFleetAttributes:InstancePoolInstancePoolFleetAttributes": { "properties": { "fleetOnDemandOption": { "$ref": "#/types/databricks:index/InstancePoolInstancePoolFleetAttributesFleetOnDemandOption:InstancePoolInstancePoolFleetAttributesFleetOnDemandOption", "willReplaceOnChanges": true }, "fleetSpotOption": { "$ref": "#/types/databricks:index/InstancePoolInstancePoolFleetAttributesFleetSpotOption:InstancePoolInstancePoolFleetAttributesFleetSpotOption", "willReplaceOnChanges": true }, "launchTemplateOverrides": { "type": "array", "items": { "$ref": "#/types/databricks:index/InstancePoolInstancePoolFleetAttributesLaunchTemplateOverride:InstancePoolInstancePoolFleetAttributesLaunchTemplateOverride" }, "willReplaceOnChanges": true } }, "type": "object", "required": [ "launchTemplateOverrides" ] }, "databricks:index/InstancePoolInstancePoolFleetAttributesFleetOnDemandOption:InstancePoolInstancePoolFleetAttributesFleetOnDemandOption": { "properties": { "allocationStrategy": { "type": "string", "willReplaceOnChanges": true }, "instancePoolsToUseCount": { "type": "integer" } }, "type": "object", "required": [ "allocationStrategy" ] }, "databricks:index/InstancePoolInstancePoolFleetAttributesFleetSpotOption:InstancePoolInstancePoolFleetAttributesFleetSpotOption": { "properties": { "allocationStrategy": { "type": "string", "willReplaceOnChanges": true }, "instancePoolsToUseCount": { "type": "integer" } }, "type": "object", "required": [ "allocationStrategy" ] }, "databricks:index/InstancePoolInstancePoolFleetAttributesLaunchTemplateOverride:InstancePoolInstancePoolFleetAttributesLaunchTemplateOverride": { "properties": { "availabilityZone": { "type": "string", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "availabilityZone", "instanceType" ] }, "databricks:index/InstancePoolNodeTypeFlexibility:InstancePoolNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" }, "description": "list of alternative node types that will be used if main node type isn't available. Follow the [documentation](https://learn.microsoft.com/en-us/azure/databricks/compute/flexible-node-types#fallback-instance-type-requirements) for requirements on selection of alternative node types.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "alternateNodeTypeIds" ] }, "databricks:index/InstancePoolPreloadedDockerImage:InstancePoolPreloadedDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/InstancePoolPreloadedDockerImageBasicAuth:InstancePoolPreloadedDockerImageBasicAuth", "description": "`basic_auth.username` and `basic_auth.password` for Docker repository. Docker registry credentials are encrypted when they are stored in Databricks internal storage and when they are passed to a registry upon fetching Docker images at cluster launch. For better security, these credentials should be stored in the secret scope and referred using secret path syntax: `{{secrets/scope/key}}`, otherwise other users of the workspace may access them via UI/API.\n\nExample usage with\u003cspan pulumi-lang-nodejs=\" azurermContainerRegistry \" pulumi-lang-dotnet=\" AzurermContainerRegistry \" pulumi-lang-go=\" azurermContainerRegistry \" pulumi-lang-python=\" azurerm_container_registry \" pulumi-lang-yaml=\" azurermContainerRegistry \" pulumi-lang-java=\" azurermContainerRegistry \" pulumi-lang-hcl=\" azurerm_container_registry \"\u003e azurermContainerRegistry \u003c/span\u003eand docker_registry_image, that you can adapt to your specific use-case:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as docker from \"@pulumi/docker\";\n\nconst _this = new docker.RegistryImage(\"this\", {\n build: [{}],\n name: `${thisAzurermContainerRegistry.loginServer}/sample:latest`,\n});\nconst thisInstancePool = new databricks.InstancePool(\"this\", {preloadedDockerImages: [{\n url: _this.name,\n basicAuth: {\n username: thisAzurermContainerRegistry.adminUsername,\n password: thisAzurermContainerRegistry.adminPassword,\n },\n}]});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_docker as docker\n\nthis = docker.RegistryImage(\"this\",\n build=[{}],\n name=f\"{this_azurerm_container_registry['loginServer']}/sample:latest\")\nthis_instance_pool = databricks.InstancePool(\"this\", preloaded_docker_images=[{\n \"url\": this.name,\n \"basic_auth\": {\n \"username\": this_azurerm_container_registry[\"adminUsername\"],\n \"password\": this_azurerm_container_registry[\"adminPassword\"],\n },\n}])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Docker = Pulumi.Docker;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Docker.RegistryImage(\"this\", new()\n {\n Build = new[]\n {\n null,\n },\n Name = $\"{thisAzurermContainerRegistry.LoginServer}/sample:latest\",\n });\n\n var thisInstancePool = new Databricks.InstancePool(\"this\", new()\n {\n PreloadedDockerImages = new[]\n {\n new Databricks.Inputs.InstancePoolPreloadedDockerImageArgs\n {\n Url = @this.Name,\n BasicAuth = new Databricks.Inputs.InstancePoolPreloadedDockerImageBasicAuthArgs\n {\n Username = thisAzurermContainerRegistry.AdminUsername,\n Password = thisAzurermContainerRegistry.AdminPassword,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-docker/sdk/v4/go/docker\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := docker.NewRegistryImage(ctx, \"this\", \u0026docker.RegistryImageArgs{\n\t\t\tBuild: docker.RegistryImageBuildArgs{\n\t\t\t\tmap[string]interface{}{},\n\t\t\t},\n\t\t\tName: pulumi.Sprintf(\"%v/sample:latest\", thisAzurermContainerRegistry.LoginServer),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewInstancePool(ctx, \"this\", \u0026databricks.InstancePoolArgs{\n\t\t\tPreloadedDockerImages: databricks.InstancePoolPreloadedDockerImageArray{\n\t\t\t\t\u0026databricks.InstancePoolPreloadedDockerImageArgs{\n\t\t\t\t\tUrl: this.Name,\n\t\t\t\t\tBasicAuth: \u0026databricks.InstancePoolPreloadedDockerImageBasicAuthArgs{\n\t\t\t\t\t\tUsername: pulumi.Any(thisAzurermContainerRegistry.AdminUsername),\n\t\t\t\t\t\tPassword: pulumi.Any(thisAzurermContainerRegistry.AdminPassword),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n docker = {\n source = \"pulumi/docker\"\n }\n }\n}\n\nresource \"docker_registryimage\" \"this\" {\n build = [{}]\n name =\"${thisAzurermContainerRegistry.loginServer}/sample:latest\"\n}\nresource \"databricks_instancepool\" \"this\" {\n preloaded_docker_images {\n url = docker_registryimage.this.name\n basic_auth = {\n username = thisAzurermContainerRegistry.adminUsername\n password = thisAzurermContainerRegistry.adminPassword\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.docker.RegistryImage;\nimport com.pulumi.docker.RegistryImageArgs;\nimport com.pulumi.databricks.InstancePool;\nimport com.pulumi.databricks.InstancePoolArgs;\nimport com.pulumi.databricks.inputs.InstancePoolPreloadedDockerImageArgs;\nimport com.pulumi.databricks.inputs.InstancePoolPreloadedDockerImageBasicAuthArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new RegistryImage(\"this\", RegistryImageArgs.builder()\n .build(RegistryImageBuildArgs.builder()\n .build())\n .name(String.format(\"%s/sample:latest\", thisAzurermContainerRegistry.loginServer()))\n .build());\n\n var thisInstancePool = new InstancePool(\"thisInstancePool\", InstancePoolArgs.builder()\n .preloadedDockerImages(InstancePoolPreloadedDockerImageArgs.builder()\n .url(this_.name())\n .basicAuth(InstancePoolPreloadedDockerImageBasicAuthArgs.builder()\n .username(thisAzurermContainerRegistry.adminUsername())\n .password(thisAzurermContainerRegistry.adminPassword())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: docker:RegistryImage\n properties:\n build:\n - {}\n name: ${thisAzurermContainerRegistry.loginServer}/sample:latest\n thisInstancePool:\n type: databricks:InstancePool\n name: this\n properties:\n preloadedDockerImages:\n - url: ${this.name}\n basicAuth:\n username: ${thisAzurermContainerRegistry.adminUsername}\n password: ${thisAzurermContainerRegistry.adminPassword}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n", "willReplaceOnChanges": true }, "url": { "type": "string", "description": "URL for the Docker image\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "url" ] }, "databricks:index/InstancePoolPreloadedDockerImageBasicAuth:InstancePoolPreloadedDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true, "willReplaceOnChanges": true }, "username": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/InstancePoolProviderConfig:InstancePoolProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/InstanceProfileProviderConfig:InstanceProfileProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/IpAccessListProviderConfig:IpAccessListProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobContinuous:JobContinuous": { "properties": { "pauseStatus": { "type": "string", "description": "Indicate whether this continuous job is paused or not. Either `PAUSED` or `UNPAUSED`. When the \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e field is omitted in the block, the server will default to using `UNPAUSED` as a value for \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e.\n" }, "taskRetryMode": { "type": "string", "description": "Controls task level retry behaviour. Allowed values are:\n* `NEVER` (default): The failed task will not be retried.\n* `ON_FAILURE`: Retry a failed task if at least one other task in the job is still running its first attempt. When this condition is no longer met or the retry limit is reached, the job run is cancelled and a new run is started.\n" } }, "type": "object" }, "databricks:index/JobDbtTask:JobDbtTask": { "properties": { "catalog": { "type": "string", "description": "The name of the catalog to use inside Unity Catalog.\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "(Array) Series of dbt commands to execute in sequence. Every command must start with \"dbt\".\n" }, "profilesDirectory": { "type": "string", "description": "The relative path to the directory in the repository specified by \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e where dbt should look in for the `profiles.yml` file. If not specified, defaults to the repository's root directory. Equivalent to passing `--profile-dir` to a dbt command.\n" }, "projectDirectory": { "type": "string", "description": "The path where dbt should look for `dbt_project.yml`. Equivalent to passing `--project-dir` to the dbt CLI.\n* If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `GIT`: Relative path to the directory in the repository specified in the \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block. Defaults to the repository's root directory when not specified.\n* If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `WORKSPACE`: Absolute path to the folder in the workspace.\n" }, "schema": { "type": "string", "description": "The name of the schema dbt should run in. Defaults to \u003cspan pulumi-lang-nodejs=\"`default`\" pulumi-lang-dotnet=\"`Default`\" pulumi-lang-go=\"`default`\" pulumi-lang-python=\"`default`\" pulumi-lang-yaml=\"`default`\" pulumi-lang-java=\"`default`\" pulumi-lang-hcl=\"`default`\"\u003e`default`\u003c/span\u003e.\n" }, "source": { "type": "string", "description": "The source of the project. Possible values are `WORKSPACE` and `GIT`. Defaults to `GIT` if a \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block is present in the job definition.\n" }, "warehouseId": { "type": "string", "description": "The ID of the SQL warehouse that dbt should execute against.\n\nYou also need to include a \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block to configure the repository that contains the dbt project.\n" } }, "type": "object", "required": [ "commands" ] }, "databricks:index/JobDeployment:JobDeployment": { "properties": { "deploymentId": { "type": "string" }, "kind": { "type": "string" }, "metadataFilePath": { "type": "string" }, "versionId": { "type": "string" } }, "type": "object", "required": [ "kind" ] }, "databricks:index/JobEmailNotifications:JobEmailNotifications": { "properties": { "noAlertForSkippedRuns": { "type": "boolean", "description": "(Bool) don't send alert for skipped runs. (It's recommended to use the corresponding setting in the \u003cspan pulumi-lang-nodejs=\"`notificationSettings`\" pulumi-lang-dotnet=\"`NotificationSettings`\" pulumi-lang-go=\"`notificationSettings`\" pulumi-lang-python=\"`notification_settings`\" pulumi-lang-yaml=\"`notificationSettings`\" pulumi-lang-java=\"`notificationSettings`\" pulumi-lang-hcl=\"`notification_settings`\"\u003e`notificationSettings`\u003c/span\u003e configuration block).\n" }, "onDurationWarningThresholdExceededs": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the \u003cspan pulumi-lang-nodejs=\"`health`\" pulumi-lang-dotnet=\"`Health`\" pulumi-lang-go=\"`health`\" pulumi-lang-python=\"`health`\" pulumi-lang-yaml=\"`health`\" pulumi-lang-java=\"`health`\" pulumi-lang-hcl=\"`health`\"\u003e`health`\u003c/span\u003e block.\n" }, "onFailures": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run fails.\n" }, "onStarts": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run starts.\n" }, "onStreamingBacklogExceededs": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when any streaming backlog thresholds are exceeded for any stream.\n\nThe following parameter is only available for the job level configuration.\n" }, "onSuccesses": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run completes successfully.\n" } }, "type": "object" }, "databricks:index/JobEnvironment:JobEnvironment": { "properties": { "environmentKey": { "type": "string", "description": "an unique identifier of the Environment. It will be referenced from \u003cspan pulumi-lang-nodejs=\"`environmentKey`\" pulumi-lang-dotnet=\"`EnvironmentKey`\" pulumi-lang-go=\"`environmentKey`\" pulumi-lang-python=\"`environment_key`\" pulumi-lang-yaml=\"`environmentKey`\" pulumi-lang-java=\"`environmentKey`\" pulumi-lang-hcl=\"`environment_key`\"\u003e`environmentKey`\u003c/span\u003e attribute of corresponding task.\n" }, "spec": { "$ref": "#/types/databricks:index/JobEnvironmentSpec:JobEnvironmentSpec", "description": "block describing the Environment. Consists of following attributes:\n" } }, "type": "object", "required": [ "environmentKey" ] }, "databricks:index/JobEnvironmentSpec:JobEnvironmentSpec": { "properties": { "baseEnvironment": { "type": "string" }, "client": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" }, "description": "List of pip dependencies, as supported by the version of pip in this environment. Each dependency is a pip requirement file line. See [API docs](https://docs.databricks.com/api/workspace/jobs/create#environments-spec-dependencies) for more information.\n\n" }, "environmentVersion": { "type": "string", "description": "client version used by the environment. Each version comes with a specific Python version and a set of Python packages.\n" }, "javaDependencies": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobGitSource:JobGitSource": { "properties": { "branch": { "type": "string", "description": "name of the Git branch to use. Conflicts with \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`commit`\" pulumi-lang-dotnet=\"`Commit`\" pulumi-lang-go=\"`commit`\" pulumi-lang-python=\"`commit`\" pulumi-lang-yaml=\"`commit`\" pulumi-lang-java=\"`commit`\" pulumi-lang-hcl=\"`commit`\"\u003e`commit`\u003c/span\u003e.\n" }, "commit": { "type": "string", "description": "hash of Git commit to use. Conflicts with \u003cspan pulumi-lang-nodejs=\"`branch`\" pulumi-lang-dotnet=\"`Branch`\" pulumi-lang-go=\"`branch`\" pulumi-lang-python=\"`branch`\" pulumi-lang-yaml=\"`branch`\" pulumi-lang-java=\"`branch`\" pulumi-lang-hcl=\"`branch`\"\u003e`branch`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`tag`\" pulumi-lang-dotnet=\"`Tag`\" pulumi-lang-go=\"`tag`\" pulumi-lang-python=\"`tag`\" pulumi-lang-yaml=\"`tag`\" pulumi-lang-java=\"`tag`\" pulumi-lang-hcl=\"`tag`\"\u003e`tag`\u003c/span\u003e.\n" }, "gitSnapshot": { "$ref": "#/types/databricks:index/JobGitSourceGitSnapshot:JobGitSourceGitSnapshot" }, "jobSource": { "$ref": "#/types/databricks:index/JobGitSourceJobSource:JobGitSourceJobSource" }, "provider": { "type": "string", "description": "case insensitive name of the Git provider. Following values are supported right now (could be a subject for change, consult [Repos API documentation](https://docs.databricks.com/dev-tools/api/latest/repos.html)): `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`.\n" }, "sparseCheckout": { "$ref": "#/types/databricks:index/JobGitSourceSparseCheckout:JobGitSourceSparseCheckout" }, "tag": { "type": "string", "description": "name of the Git branch to use. Conflicts with \u003cspan pulumi-lang-nodejs=\"`branch`\" pulumi-lang-dotnet=\"`Branch`\" pulumi-lang-go=\"`branch`\" pulumi-lang-python=\"`branch`\" pulumi-lang-yaml=\"`branch`\" pulumi-lang-java=\"`branch`\" pulumi-lang-hcl=\"`branch`\"\u003e`branch`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`commit`\" pulumi-lang-dotnet=\"`Commit`\" pulumi-lang-go=\"`commit`\" pulumi-lang-python=\"`commit`\" pulumi-lang-yaml=\"`commit`\" pulumi-lang-java=\"`commit`\" pulumi-lang-hcl=\"`commit`\"\u003e`commit`\u003c/span\u003e.\n" }, "url": { "type": "string", "description": "URL of the Git repository to use.\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/JobGitSourceGitSnapshot:JobGitSourceGitSnapshot": { "properties": { "usedCommit": { "type": "string" } }, "type": "object" }, "databricks:index/JobGitSourceJobSource:JobGitSourceJobSource": { "properties": { "dirtyState": { "type": "string" }, "importFromGitBranch": { "type": "string" }, "jobConfigPath": { "type": "string" } }, "type": "object", "required": [ "importFromGitBranch", "jobConfigPath" ] }, "databricks:index/JobGitSourceSparseCheckout:JobGitSourceSparseCheckout": { "properties": { "patterns": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobHealth:JobHealth": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobHealthRule:JobHealthRule" }, "description": "list of rules that are represented as objects with the following attributes:\n" } }, "type": "object", "required": [ "rules" ] }, "databricks:index/JobHealthRule:JobHealthRule": { "properties": { "metric": { "type": "string", "description": "string specifying the metric to check, like `RUN_DURATION_SECONDS`, `STREAMING_BACKLOG_FILES`, etc. - check the [Jobs REST API documentation](https://docs.databricks.com/api/workspace/jobs/create#health-rules-metric) for the full list of supported metrics.\n" }, "op": { "type": "string", "description": "string specifying the operation used to evaluate the given metric. The only supported operation is `GREATER_THAN`.\n" }, "value": { "type": "integer", "description": "integer value used to compare to the given metric.\n" } }, "type": "object", "required": [ "metric", "op", "value" ] }, "databricks:index/JobJobCluster:JobJobCluster": { "properties": { "jobClusterKey": { "type": "string", "description": "Identifier that can be referenced in \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block, so that cluster is shared between tasks\n" }, "newCluster": { "$ref": "#/types/databricks:index/JobJobClusterNewCluster:JobJobClusterNewCluster", "description": "Block with almost the same set of parameters as for\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eresource, except following (check the [REST API documentation for full list of supported parameters](https://docs.databricks.com/api/workspace/jobs/create#job_clusters-new_cluster)):\n" } }, "type": "object", "required": [ "jobClusterKey", "newCluster" ] }, "databricks:index/JobJobClusterNewCluster:JobJobClusterNewCluster": { "properties": { "__applyPolicyDefaultValuesAllowLists": { "type": "array", "items": { "type": "string" } }, "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterAutoscale:JobJobClusterNewClusterAutoscale" }, "awsAttributes": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterAwsAttributes:JobJobClusterNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterAzureAttributes:JobJobClusterNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterClusterLogConf:JobJobClusterNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterClusterMountInfo:JobJobClusterNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterDockerImage:JobJobClusterNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterDriverNodeTypeFlexibility:JobJobClusterNewClusterDriverNodeTypeFlexibility" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterGcpAttributes:JobJobClusterNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "willReplaceOnChanges": true }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScript:JobJobClusterNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "isSingleNode": { "type": "boolean" }, "kind": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterLibrary:JobJobClusterNewClusterLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterProviderConfig:JobJobClusterNewClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterWorkerNodeTypeFlexibility:JobJobClusterNewClusterWorkerNodeTypeFlexibility" }, "workloadType": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterWorkloadType:JobJobClusterNewClusterWorkloadType", "description": "isn't supported\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "providerConfig" ] } } }, "databricks:index/JobJobClusterNewClusterAutoscale:JobJobClusterNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterAwsAttributes:JobJobClusterNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterAzureAttributes:JobJobClusterNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterAzureAttributesLogAnalyticsInfo:JobJobClusterNewClusterAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterAzureAttributesLogAnalyticsInfo:JobJobClusterNewClusterAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterClusterLogConf:JobJobClusterNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterClusterLogConfDbfs:JobJobClusterNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterClusterLogConfS3:JobJobClusterNewClusterClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterClusterLogConfVolumes:JobJobClusterNewClusterClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterClusterLogConfDbfs:JobJobClusterNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterClusterLogConfS3:JobJobClusterNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterClusterLogConfVolumes:JobJobClusterNewClusterClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterClusterMountInfo:JobJobClusterNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo:JobJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/JobJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo:JobJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/JobJobClusterNewClusterDockerImage:JobJobClusterNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterDockerImageBasicAuth:JobJobClusterNewClusterDockerImageBasicAuth" }, "url": { "type": "string", "description": "URL of the job on the given workspace\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/JobJobClusterNewClusterDockerImageBasicAuth:JobJobClusterNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/JobJobClusterNewClusterDriverNodeTypeFlexibility:JobJobClusterNewClusterDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterGcpAttributes:JobJobClusterNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterInitScript:JobJobClusterNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptAbfss:JobJobClusterNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptDbfs:JobJobClusterNewClusterInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptFile:JobJobClusterNewClusterInitScriptFile", "description": "block consisting of single string fields:\n" }, "gcs": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptGcs:JobJobClusterNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptS3:JobJobClusterNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptVolumes:JobJobClusterNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterInitScriptWorkspace:JobJobClusterNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterInitScriptAbfss:JobJobClusterNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterInitScriptDbfs:JobJobClusterNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterInitScriptFile:JobJobClusterNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterInitScriptGcs:JobJobClusterNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterInitScriptS3:JobJobClusterNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterInitScriptVolumes:JobJobClusterNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterInitScriptWorkspace:JobJobClusterNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobJobClusterNewClusterLibrary:JobJobClusterNewClusterLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterLibraryCran:JobJobClusterNewClusterLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterLibraryMaven:JobJobClusterNewClusterLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterLibraryProviderConfig:JobJobClusterNewClusterLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterLibraryPypi:JobJobClusterNewClusterLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobJobClusterNewClusterLibraryCran:JobJobClusterNewClusterLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobJobClusterNewClusterLibraryMaven:JobJobClusterNewClusterLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobJobClusterNewClusterLibraryProviderConfig:JobJobClusterNewClusterLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobJobClusterNewClusterLibraryPypi:JobJobClusterNewClusterLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobJobClusterNewClusterProviderConfig:JobJobClusterNewClusterProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobJobClusterNewClusterWorkerNodeTypeFlexibility:JobJobClusterNewClusterWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobJobClusterNewClusterWorkloadType:JobJobClusterNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/JobJobClusterNewClusterWorkloadTypeClients:JobJobClusterNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/JobJobClusterNewClusterWorkloadTypeClients:JobJobClusterNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/JobLibrary:JobLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobLibraryCran:JobLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobLibraryMaven:JobLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobLibraryProviderConfig:JobLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobLibraryPypi:JobLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobLibraryCran:JobLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobLibraryMaven:JobLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobLibraryProviderConfig:JobLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobLibraryPypi:JobLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobNewCluster:JobNewCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/JobNewClusterAutoscale:JobNewClusterAutoscale" }, "awsAttributes": { "$ref": "#/types/databricks:index/JobNewClusterAwsAttributes:JobNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/JobNewClusterAzureAttributes:JobNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/JobNewClusterClusterLogConf:JobNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobNewClusterClusterMountInfo:JobNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/JobNewClusterDockerImage:JobNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobNewClusterDriverNodeTypeFlexibility:JobNewClusterDriverNodeTypeFlexibility" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/JobNewClusterGcpAttributes:JobNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "willReplaceOnChanges": true }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobNewClusterInitScript:JobNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "isSingleNode": { "type": "boolean" }, "kind": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobNewClusterLibrary:JobNewClusterLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/JobNewClusterProviderConfig:JobNewClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobNewClusterWorkerNodeTypeFlexibility:JobNewClusterWorkerNodeTypeFlexibility" }, "workloadType": { "$ref": "#/types/databricks:index/JobNewClusterWorkloadType:JobNewClusterWorkloadType", "description": "isn't supported\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "providerConfig" ] } } }, "databricks:index/JobNewClusterAutoscale:JobNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/JobNewClusterAwsAttributes:JobNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobNewClusterAzureAttributes:JobNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/JobNewClusterAzureAttributesLogAnalyticsInfo:JobNewClusterAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/JobNewClusterAzureAttributesLogAnalyticsInfo:JobNewClusterAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/JobNewClusterClusterLogConf:JobNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/JobNewClusterClusterLogConfDbfs:JobNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/JobNewClusterClusterLogConfS3:JobNewClusterClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/JobNewClusterClusterLogConfVolumes:JobNewClusterClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/JobNewClusterClusterLogConfDbfs:JobNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterClusterLogConfS3:JobNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterClusterLogConfVolumes:JobNewClusterClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterClusterMountInfo:JobNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/JobNewClusterClusterMountInfoNetworkFilesystemInfo:JobNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/JobNewClusterClusterMountInfoNetworkFilesystemInfo:JobNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/JobNewClusterDockerImage:JobNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/JobNewClusterDockerImageBasicAuth:JobNewClusterDockerImageBasicAuth" }, "url": { "type": "string", "description": "URL of the job on the given workspace\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/JobNewClusterDockerImageBasicAuth:JobNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/JobNewClusterDriverNodeTypeFlexibility:JobNewClusterDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobNewClusterGcpAttributes:JobNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobNewClusterInitScript:JobNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptAbfss:JobNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptDbfs:JobNewClusterInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptFile:JobNewClusterInitScriptFile", "description": "block consisting of single string fields:\n" }, "gcs": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptGcs:JobNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptS3:JobNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptVolumes:JobNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/JobNewClusterInitScriptWorkspace:JobNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/JobNewClusterInitScriptAbfss:JobNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterInitScriptDbfs:JobNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterInitScriptFile:JobNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterInitScriptGcs:JobNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterInitScriptS3:JobNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterInitScriptVolumes:JobNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterInitScriptWorkspace:JobNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobNewClusterLibrary:JobNewClusterLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobNewClusterLibraryCran:JobNewClusterLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobNewClusterLibraryMaven:JobNewClusterLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobNewClusterLibraryProviderConfig:JobNewClusterLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobNewClusterLibraryPypi:JobNewClusterLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobNewClusterLibraryCran:JobNewClusterLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobNewClusterLibraryMaven:JobNewClusterLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobNewClusterLibraryProviderConfig:JobNewClusterLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobNewClusterLibraryPypi:JobNewClusterLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobNewClusterProviderConfig:JobNewClusterProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobNewClusterWorkerNodeTypeFlexibility:JobNewClusterWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobNewClusterWorkloadType:JobNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/JobNewClusterWorkloadTypeClients:JobNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/JobNewClusterWorkloadTypeClients:JobNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/JobNotebookTask:JobNotebookTask": { "properties": { "baseParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Base parameters to be used for each run of this job. If the run is initiated by a call to run-now with parameters specified, the two parameters maps will be merged. If the same key is specified in\u003cspan pulumi-lang-nodejs=\" baseParameters \" pulumi-lang-dotnet=\" BaseParameters \" pulumi-lang-go=\" baseParameters \" pulumi-lang-python=\" base_parameters \" pulumi-lang-yaml=\" baseParameters \" pulumi-lang-java=\" baseParameters \" pulumi-lang-hcl=\" base_parameters \"\u003e baseParameters \u003c/span\u003eand in run-now, the value from run-now will be used. If the notebook takes a parameter that is not specified in the job's\u003cspan pulumi-lang-nodejs=\" baseParameters \" pulumi-lang-dotnet=\" BaseParameters \" pulumi-lang-go=\" baseParameters \" pulumi-lang-python=\" base_parameters \" pulumi-lang-yaml=\" baseParameters \" pulumi-lang-java=\" baseParameters \" pulumi-lang-hcl=\" base_parameters \"\u003e baseParameters \u003c/span\u003eor the run-now override parameters, the default value from the notebook will be used. Retrieve these parameters in a notebook using `dbutils.widgets.get`.\n" }, "notebookPath": { "type": "string", "description": "The path of the\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto be run in the Databricks workspace or remote repository. For notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash. For notebooks stored in a remote repository, the path must be relative. This field is required.\n" }, "source": { "type": "string", "description": "Location type of the notebook, can only be `WORKSPACE` or `GIT`. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository defined in \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e. If the value is empty, the task will use `GIT` if \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e is defined and `WORKSPACE` otherwise.\n" }, "warehouseId": { "type": "string", "description": "ID of the (the databricks_sql_endpoint) that will be used to execute the task with SQL notebook.\n" } }, "type": "object", "required": [ "notebookPath" ] }, "databricks:index/JobNotificationSettings:JobNotificationSettings": { "properties": { "noAlertForCanceledRuns": { "type": "boolean", "description": "(Bool) don't send alert for cancelled runs.\n\nThe following parameter is only available on task level.\n" }, "noAlertForSkippedRuns": { "type": "boolean", "description": "(Bool) don't send alert for skipped runs.\n" } }, "type": "object" }, "databricks:index/JobParameter:JobParameter": { "properties": { "default": { "type": "string", "description": "Default value of the parameter.\n\n*You can use this block only together with \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e blocks, not with the legacy tasks specification!*\n" }, "name": { "type": "string", "description": "The name of the defined parameter. May only contain alphanumeric characters, `_`, `-`, and `.`.\n" } }, "type": "object", "required": [ "default", "name" ] }, "databricks:index/JobPipelineTask:JobPipelineTask": { "properties": { "fullRefresh": { "type": "boolean", "description": "(Bool) Specifies if there should be full refresh of the pipeline.\n\n\u003e The following configuration blocks are only supported inside a \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block\n" }, "pipelineId": { "type": "string", "description": "The pipeline's unique ID.\n" } }, "type": "object", "required": [ "pipelineId" ] }, "databricks:index/JobProviderConfig:JobProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobPythonWheelTask:JobPythonWheelTask": { "properties": { "entryPoint": { "type": "string", "description": "Python function as entry point for the task\n" }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Named parameters for the task\n" }, "packageName": { "type": "string", "description": "Name of Python package\n" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Parameters for the task\n" } }, "type": "object" }, "databricks:index/JobQueue:JobQueue": { "properties": { "enabled": { "type": "boolean", "description": "If true, enable queueing for the job.\n" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/JobRunAs:JobRunAs": { "properties": { "groupName": { "type": "string" }, "servicePrincipalName": { "type": "string", "description": "The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.\n\nExample:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Job(\"this\", {runAs: {\n servicePrincipalName: \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\",\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Job(\"this\", run_as={\n \"service_principal_name\": \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\",\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Job(\"this\", new()\n {\n RunAs = new Databricks.Inputs.JobRunAsArgs\n {\n ServicePrincipalName = \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewJob(ctx, \"this\", \u0026databricks.JobArgs{\n\t\t\tRunAs: \u0026databricks.JobRunAsArgs{\n\t\t\t\tServicePrincipalName: pulumi.String(\"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_job\" \"this\" {\n run_as = {\n service_principal_name = \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Job;\nimport com.pulumi.databricks.JobArgs;\nimport com.pulumi.databricks.inputs.JobRunAsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Job(\"this\", JobArgs.builder()\n .runAs(JobRunAsArgs.builder()\n .servicePrincipalName(\"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Job\n properties:\n runAs:\n servicePrincipalName: 8d23ae77-912e-4a19-81e4-b9c3f5cc9349\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "userName": { "type": "string", "description": "The email of an active workspace user. Non-admin users can only set this field to their own email.\n" } }, "type": "object" }, "databricks:index/JobRunJobTask:JobRunJobTask": { "properties": { "jobId": { "type": "integer", "description": "(String) ID of the job\n" }, "jobParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Job parameters for the task\n" } }, "type": "object", "required": [ "jobId" ] }, "databricks:index/JobSchedule:JobSchedule": { "properties": { "pauseStatus": { "type": "string", "description": "Indicate whether this schedule is paused or not. Either `PAUSED` or `UNPAUSED`. When the \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e field is omitted and a schedule is provided, the server will default to using `UNPAUSED` as a value for \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e.\n" }, "quartzCronExpression": { "type": "string", "description": "A [Cron expression using Quartz syntax](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) that describes the schedule for a job. This field is required.\n" }, "timezoneId": { "type": "string", "description": "A Java timezone ID. The schedule for a job will be resolved with respect to this timezone. See Java TimeZone for details. This field is required.\n" } }, "type": "object", "required": [ "quartzCronExpression", "timezoneId" ] }, "databricks:index/JobSparkJarTask:JobSparkJarTask": { "properties": { "jarUri": { "type": "string" }, "mainClassName": { "type": "string", "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. The code should use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job will fail.\n" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Parameters passed to the main method.\n" } }, "type": "object" }, "databricks:index/JobSparkPythonTask:JobSparkPythonTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Command line parameters passed to the Python file.\n" }, "pythonFile": { "type": "string", "description": "The URI of the Python file to be executed. Cloud file URIs (e.g. `s3:/`, `abfss:/`, `gs:/`), workspace paths and remote repository are supported. For Python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.\n" }, "source": { "type": "string", "description": "Location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local Databricks workspace or cloud location (if the\u003cspan pulumi-lang-nodejs=\" pythonFile \" pulumi-lang-dotnet=\" PythonFile \" pulumi-lang-go=\" pythonFile \" pulumi-lang-python=\" python_file \" pulumi-lang-yaml=\" pythonFile \" pulumi-lang-java=\" pythonFile \" pulumi-lang-hcl=\" python_file \"\u003e pythonFile \u003c/span\u003ehas a URI format). When set to `GIT`, the Python file will be retrieved from a Git repository defined in \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e.\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\n* `GIT`: The Python file is located in a remote Git repository.\n" } }, "type": "object", "required": [ "pythonFile" ] }, "databricks:index/JobSparkSubmitTask:JobSparkSubmitTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Command-line parameters passed to spark submit.\n" } }, "type": "object" }, "databricks:index/JobTask:JobTask": { "properties": { "alertTask": { "$ref": "#/types/databricks:index/JobTaskAlertTask:JobTaskAlertTask" }, "cleanRoomsNotebookTask": { "$ref": "#/types/databricks:index/JobTaskCleanRoomsNotebookTask:JobTaskCleanRoomsNotebookTask" }, "compute": { "$ref": "#/types/databricks:index/JobTaskCompute:JobTaskCompute", "description": "Task level compute configuration. This block is documented below.\n\n\u003e If no \u003cspan pulumi-lang-nodejs=\"`jobClusterKey`\" pulumi-lang-dotnet=\"`JobClusterKey`\" pulumi-lang-go=\"`jobClusterKey`\" pulumi-lang-python=\"`job_cluster_key`\" pulumi-lang-yaml=\"`jobClusterKey`\" pulumi-lang-java=\"`jobClusterKey`\" pulumi-lang-hcl=\"`job_cluster_key`\"\u003e`jobClusterKey`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`existingClusterId`\" pulumi-lang-dotnet=\"`ExistingClusterId`\" pulumi-lang-go=\"`existingClusterId`\" pulumi-lang-python=\"`existing_cluster_id`\" pulumi-lang-yaml=\"`existingClusterId`\" pulumi-lang-java=\"`existingClusterId`\" pulumi-lang-hcl=\"`existing_cluster_id`\"\u003e`existingClusterId`\u003c/span\u003e, or \u003cspan pulumi-lang-nodejs=\"`newCluster`\" pulumi-lang-dotnet=\"`NewCluster`\" pulumi-lang-go=\"`newCluster`\" pulumi-lang-python=\"`new_cluster`\" pulumi-lang-yaml=\"`newCluster`\" pulumi-lang-java=\"`newCluster`\" pulumi-lang-hcl=\"`new_cluster`\"\u003e`newCluster`\u003c/span\u003e were specified in task definition, then task will executed using serverless compute.\n" }, "conditionTask": { "$ref": "#/types/databricks:index/JobTaskConditionTask:JobTaskConditionTask" }, "dashboardTask": { "$ref": "#/types/databricks:index/JobTaskDashboardTask:JobTaskDashboardTask" }, "dbtCloudTask": { "$ref": "#/types/databricks:index/JobTaskDbtCloudTask:JobTaskDbtCloudTask" }, "dbtPlatformTask": { "$ref": "#/types/databricks:index/JobTaskDbtPlatformTask:JobTaskDbtPlatformTask" }, "dbtTask": { "$ref": "#/types/databricks:index/JobTaskDbtTask:JobTaskDbtTask" }, "dependsOns": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskDependsOn:JobTaskDependsOn" }, "description": "block specifying dependency(-ies) for a given task.\n" }, "description": { "type": "string", "description": "description for this task.\n" }, "disableAutoOptimization": { "type": "boolean", "description": "A flag to disable auto optimization in serverless tasks.\n" }, "disabled": { "type": "boolean" }, "emailNotifications": { "$ref": "#/types/databricks:index/JobTaskEmailNotifications:JobTaskEmailNotifications", "description": "An optional block to specify a set of email addresses notified when this task begins, completes or fails. The default behavior is to not send any emails. This block is documented below.\n" }, "environmentKey": { "type": "string", "description": "identifier of an \u003cspan pulumi-lang-nodejs=\"`environment`\" pulumi-lang-dotnet=\"`Environment`\" pulumi-lang-go=\"`environment`\" pulumi-lang-python=\"`environment`\" pulumi-lang-yaml=\"`environment`\" pulumi-lang-java=\"`environment`\" pulumi-lang-hcl=\"`environment`\"\u003e`environment`\u003c/span\u003e block that is used to specify libraries. Required for some tasks (\u003cspan pulumi-lang-nodejs=\"`sparkPythonTask`\" pulumi-lang-dotnet=\"`SparkPythonTask`\" pulumi-lang-go=\"`sparkPythonTask`\" pulumi-lang-python=\"`spark_python_task`\" pulumi-lang-yaml=\"`sparkPythonTask`\" pulumi-lang-java=\"`sparkPythonTask`\" pulumi-lang-hcl=\"`spark_python_task`\"\u003e`sparkPythonTask`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`pythonWheelTask`\" pulumi-lang-dotnet=\"`PythonWheelTask`\" pulumi-lang-go=\"`pythonWheelTask`\" pulumi-lang-python=\"`python_wheel_task`\" pulumi-lang-yaml=\"`pythonWheelTask`\" pulumi-lang-java=\"`pythonWheelTask`\" pulumi-lang-hcl=\"`python_wheel_task`\"\u003e`pythonWheelTask`\u003c/span\u003e, ...) running on serverless compute.\n" }, "existingClusterId": { "type": "string", "description": "Identifier of the interactive cluster to run job on. *Note: running tasks on interactive clusters may lead to increased costs!*\n" }, "forEachTask": { "$ref": "#/types/databricks:index/JobTaskForEachTask:JobTaskForEachTask" }, "genAiComputeTask": { "$ref": "#/types/databricks:index/JobTaskGenAiComputeTask:JobTaskGenAiComputeTask" }, "health": { "$ref": "#/types/databricks:index/JobTaskHealth:JobTaskHealth", "description": "block described below that specifies health conditions for a given task.\n" }, "jobClusterKey": { "type": "string", "description": "Identifier of the Job cluster specified in the \u003cspan pulumi-lang-nodejs=\"`jobCluster`\" pulumi-lang-dotnet=\"`JobCluster`\" pulumi-lang-go=\"`jobCluster`\" pulumi-lang-python=\"`job_cluster`\" pulumi-lang-yaml=\"`jobCluster`\" pulumi-lang-java=\"`jobCluster`\" pulumi-lang-hcl=\"`job_cluster`\"\u003e`jobCluster`\u003c/span\u003e block.\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskLibrary:JobTaskLibrary" }, "description": "(Set) An optional list of libraries to be installed on the cluster that will execute the job.\n" }, "maxRetries": { "type": "integer", "description": "(Integer) An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with a `FAILED` or `INTERNAL_ERROR` lifecycle state. The value -1 means to retry indefinitely and the value 0 means to never retry. The default behavior is to never retry. A run can have the following lifecycle state: `PENDING`, `RUNNING`, `TERMINATING`, `TERMINATED`, `SKIPPED` or `INTERNAL_ERROR`.\n" }, "minRetryIntervalMillis": { "type": "integer", "description": "(Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.\n" }, "newCluster": { "$ref": "#/types/databricks:index/JobTaskNewCluster:JobTaskNewCluster", "description": "Task will run on a dedicated cluster. See\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003edocumentation for specification. *Some parameters, such as \u003cspan pulumi-lang-nodejs=\"`autoterminationMinutes`\" pulumi-lang-dotnet=\"`AutoterminationMinutes`\" pulumi-lang-go=\"`autoterminationMinutes`\" pulumi-lang-python=\"`autotermination_minutes`\" pulumi-lang-yaml=\"`autoterminationMinutes`\" pulumi-lang-java=\"`autoterminationMinutes`\" pulumi-lang-hcl=\"`autotermination_minutes`\"\u003e`autoterminationMinutes`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`isPinned`\" pulumi-lang-dotnet=\"`IsPinned`\" pulumi-lang-go=\"`isPinned`\" pulumi-lang-python=\"`is_pinned`\" pulumi-lang-yaml=\"`isPinned`\" pulumi-lang-java=\"`isPinned`\" pulumi-lang-hcl=\"`is_pinned`\"\u003e`isPinned`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`workloadType`\" pulumi-lang-dotnet=\"`WorkloadType`\" pulumi-lang-go=\"`workloadType`\" pulumi-lang-python=\"`workload_type`\" pulumi-lang-yaml=\"`workloadType`\" pulumi-lang-java=\"`workloadType`\" pulumi-lang-hcl=\"`workload_type`\"\u003e`workloadType`\u003c/span\u003e aren't supported!*\n" }, "notebookTask": { "$ref": "#/types/databricks:index/JobTaskNotebookTask:JobTaskNotebookTask" }, "notificationSettings": { "$ref": "#/types/databricks:index/JobTaskNotificationSettings:JobTaskNotificationSettings", "description": "An optional block controlling the notification settings on the job level documented below.\n" }, "pipelineTask": { "$ref": "#/types/databricks:index/JobTaskPipelineTask:JobTaskPipelineTask" }, "powerBiTask": { "$ref": "#/types/databricks:index/JobTaskPowerBiTask:JobTaskPowerBiTask" }, "pythonOperatorTask": { "$ref": "#/types/databricks:index/JobTaskPythonOperatorTask:JobTaskPythonOperatorTask" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/JobTaskPythonWheelTask:JobTaskPythonWheelTask" }, "retryOnTimeout": { "type": "boolean", "description": "(Bool) An optional policy to specify whether to retry a job when it times out. The default behavior is to not retry on timeout.\n" }, "runIf": { "type": "string", "description": "An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. One of `ALL_SUCCESS`, `AT_LEAST_ONE_SUCCESS`, `NONE_FAILED`, `ALL_DONE`, `AT_LEAST_ONE_FAILED` or `ALL_FAILED`. When omitted, defaults to `ALL_SUCCESS`.\n" }, "runJobTask": { "$ref": "#/types/databricks:index/JobTaskRunJobTask:JobTaskRunJobTask" }, "sparkJarTask": { "$ref": "#/types/databricks:index/JobTaskSparkJarTask:JobTaskSparkJarTask" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/JobTaskSparkPythonTask:JobTaskSparkPythonTask" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/JobTaskSparkSubmitTask:JobTaskSparkSubmitTask" }, "sqlTask": { "$ref": "#/types/databricks:index/JobTaskSqlTask:JobTaskSqlTask" }, "taskKey": { "type": "string", "description": "string specifying an unique key for a given task.\n* `*_task` - (Required) one of the specific task blocks described below:\n" }, "timeoutSeconds": { "type": "integer", "description": "(Integer) An optional timeout applied to each run of this job. The default behavior is to have no timeout.\n" }, "webhookNotifications": { "$ref": "#/types/databricks:index/JobTaskWebhookNotifications:JobTaskWebhookNotifications", "description": "(List) An optional set of system destinations (for example, webhook destinations or Slack) to be notified when runs of this task begins, completes or fails. The default behavior is to not send any notifications. This field is a block and is documented below.\n" } }, "type": "object", "required": [ "taskKey" ], "language": { "nodejs": { "requiredOutputs": [ "retryOnTimeout", "taskKey" ] } } }, "databricks:index/JobTaskAlertTask:JobTaskAlertTask": { "properties": { "alertId": { "type": "string", "description": "(String) identifier of the Databricks Alert (databricks_alert).\n" }, "subscribers": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskAlertTaskSubscriber:JobTaskAlertTaskSubscriber" }, "description": "The list of subscribers to send the snapshot of the dashboard to.\n" }, "warehouseId": { "type": "string" }, "workspacePath": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskAlertTaskSubscriber:JobTaskAlertTaskSubscriber": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskCleanRoomsNotebookTask:JobTaskCleanRoomsNotebookTask": { "properties": { "cleanRoomName": { "type": "string", "description": "The clean room that the notebook belongs to.\n" }, "etag": { "type": "string", "description": "Checksum to validate the freshness of the notebook resource.\n" }, "notebookBaseParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Base parameters to be used for the clean room notebook job.\n" }, "notebookName": { "type": "string", "description": "Name of the notebook being run.\n" } }, "type": "object", "required": [ "cleanRoomName", "notebookName" ] }, "databricks:index/JobTaskCompute:JobTaskCompute": { "properties": { "hardwareAccelerator": { "type": "string", "description": "Hardware accelerator configuration for Serverless GPU workloads. Supported values are:\n* `GPU_1xA10`: GPU_1xA10: Single A10 GPU configuration.\n* `GPU_8xH100`: GPU_8xH100: 8x H100 GPU configuration.\n" } }, "type": "object" }, "databricks:index/JobTaskConditionTask:JobTaskConditionTask": { "properties": { "left": { "type": "string", "description": "The left operand of the condition task. It could be a string value, job state, or a parameter reference.\n" }, "op": { "type": "string", "description": "The string specifying the operation used to compare operands. Currently, following operators are supported: `EQUAL_TO`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`. (Check the [API docs](https://docs.databricks.com/api/workspace/jobs/create) for the latest information).\n\nThis task does not require a cluster to execute and does not support retries or notifications.\n" }, "right": { "type": "string", "description": "The right operand of the condition task. It could be a string value, job state, or parameter reference.\n" } }, "type": "object", "required": [ "left", "op", "right" ] }, "databricks:index/JobTaskDashboardTask:JobTaskDashboardTask": { "properties": { "dashboardId": { "type": "string", "description": "The identifier of the dashboard to refresh\n" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "subscription": { "$ref": "#/types/databricks:index/JobTaskDashboardTaskSubscription:JobTaskDashboardTaskSubscription", "description": "Represents a subscription configuration for scheduled dashboard snapshots.\n" }, "warehouseId": { "type": "string", "description": "The warehouse id to execute the dashboard with for the schedule. If not specified, will use the default warehouse of dashboard\n" } }, "type": "object" }, "databricks:index/JobTaskDashboardTaskSubscription:JobTaskDashboardTaskSubscription": { "properties": { "customSubject": { "type": "string", "description": "Allows users to specify a custom subject line on the email sent to subscribers.\n" }, "paused": { "type": "boolean", "description": "When true, the subscription will not send emails.\n" }, "subscribers": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskDashboardTaskSubscriptionSubscriber:JobTaskDashboardTaskSubscriptionSubscriber" }, "description": "The list of subscribers to send the snapshot of the dashboard to.\n" } }, "type": "object" }, "databricks:index/JobTaskDashboardTaskSubscriptionSubscriber:JobTaskDashboardTaskSubscriptionSubscriber": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string", "description": "A snapshot of the dashboard will be sent to the user's email when the \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e field is present.\n" } }, "type": "object" }, "databricks:index/JobTaskDbtCloudTask:JobTaskDbtCloudTask": { "properties": { "connectionResourceName": { "type": "string", "description": "The resource name of the UC connection to authenticate from Databricks to Power BI\n" }, "dbtCloudJobId": { "type": "integer" } }, "type": "object" }, "databricks:index/JobTaskDbtPlatformTask:JobTaskDbtPlatformTask": { "properties": { "connectionResourceName": { "type": "string", "description": "The resource name of the UC connection to authenticate from Databricks to Power BI\n" }, "dbtPlatformJobId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskDbtTask:JobTaskDbtTask": { "properties": { "catalog": { "type": "string", "description": "The name of the catalog to use inside Unity Catalog.\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "(Array) Series of dbt commands to execute in sequence. Every command must start with \"dbt\".\n" }, "profilesDirectory": { "type": "string", "description": "The relative path to the directory in the repository specified by \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e where dbt should look in for the `profiles.yml` file. If not specified, defaults to the repository's root directory. Equivalent to passing `--profile-dir` to a dbt command.\n" }, "projectDirectory": { "type": "string", "description": "The path where dbt should look for `dbt_project.yml`. Equivalent to passing `--project-dir` to the dbt CLI.\n* If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `GIT`: Relative path to the directory in the repository specified in the \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block. Defaults to the repository's root directory when not specified.\n* If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `WORKSPACE`: Absolute path to the folder in the workspace.\n" }, "schema": { "type": "string", "description": "The name of the schema dbt should run in. Defaults to \u003cspan pulumi-lang-nodejs=\"`default`\" pulumi-lang-dotnet=\"`Default`\" pulumi-lang-go=\"`default`\" pulumi-lang-python=\"`default`\" pulumi-lang-yaml=\"`default`\" pulumi-lang-java=\"`default`\" pulumi-lang-hcl=\"`default`\"\u003e`default`\u003c/span\u003e.\n" }, "source": { "type": "string", "description": "The source of the project. Possible values are `WORKSPACE` and `GIT`. Defaults to `GIT` if a \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block is present in the job definition.\n" }, "warehouseId": { "type": "string", "description": "The ID of the SQL warehouse that dbt should execute against.\n\nYou also need to include a \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block to configure the repository that contains the dbt project.\n" } }, "type": "object", "required": [ "commands" ] }, "databricks:index/JobTaskDependsOn:JobTaskDependsOn": { "properties": { "outcome": { "type": "string", "description": "Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run. Possible values are `\"true\"` or `\"false\"`.\n\n\u003e Similar to the tasks themselves, each dependency inside the task need to be declared in alphabetical order with respect to\u003cspan pulumi-lang-nodejs=\" taskKey \" pulumi-lang-dotnet=\" TaskKey \" pulumi-lang-go=\" taskKey \" pulumi-lang-python=\" task_key \" pulumi-lang-yaml=\" taskKey \" pulumi-lang-java=\" taskKey \" pulumi-lang-hcl=\" task_key \"\u003e taskKey \u003c/span\u003ein order to get consistent Pulumi diffs.\n" }, "taskKey": { "type": "string", "description": "The name of the task this task depends on.\n" } }, "type": "object", "required": [ "taskKey" ] }, "databricks:index/JobTaskEmailNotifications:JobTaskEmailNotifications": { "properties": { "noAlertForSkippedRuns": { "type": "boolean", "description": "(Bool) don't send alert for skipped runs. (It's recommended to use the corresponding setting in the \u003cspan pulumi-lang-nodejs=\"`notificationSettings`\" pulumi-lang-dotnet=\"`NotificationSettings`\" pulumi-lang-go=\"`notificationSettings`\" pulumi-lang-python=\"`notification_settings`\" pulumi-lang-yaml=\"`notificationSettings`\" pulumi-lang-java=\"`notificationSettings`\" pulumi-lang-hcl=\"`notification_settings`\"\u003e`notificationSettings`\u003c/span\u003e configuration block).\n" }, "onDurationWarningThresholdExceededs": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the \u003cspan pulumi-lang-nodejs=\"`health`\" pulumi-lang-dotnet=\"`Health`\" pulumi-lang-go=\"`health`\" pulumi-lang-python=\"`health`\" pulumi-lang-yaml=\"`health`\" pulumi-lang-java=\"`health`\" pulumi-lang-hcl=\"`health`\"\u003e`health`\u003c/span\u003e block.\n" }, "onFailures": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run fails.\n" }, "onStarts": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run starts.\n" }, "onStreamingBacklogExceededs": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when any streaming backlog thresholds are exceeded for any stream.\n\nThe following parameter is only available for the job level configuration.\n" }, "onSuccesses": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run completes successfully.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTask:JobTaskForEachTask": { "properties": { "concurrency": { "type": "integer", "description": "Controls the number of active iteration task runs. Default is 20, maximum allowed is 100.\n" }, "inputs": { "type": "string", "description": "(String) Array for task to iterate on. This can be a JSON string or a reference to an array parameter.\n" }, "task": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTask:JobTaskForEachTaskTask", "description": "Task to run against the \u003cspan pulumi-lang-nodejs=\"`inputs`\" pulumi-lang-dotnet=\"`Inputs`\" pulumi-lang-go=\"`inputs`\" pulumi-lang-python=\"`inputs`\" pulumi-lang-yaml=\"`inputs`\" pulumi-lang-java=\"`inputs`\" pulumi-lang-hcl=\"`inputs`\"\u003e`inputs`\u003c/span\u003e list.\n" } }, "type": "object", "required": [ "inputs", "task" ] }, "databricks:index/JobTaskForEachTaskTask:JobTaskForEachTaskTask": { "properties": { "alertTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskAlertTask:JobTaskForEachTaskTaskAlertTask" }, "cleanRoomsNotebookTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskCleanRoomsNotebookTask:JobTaskForEachTaskTaskCleanRoomsNotebookTask" }, "compute": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskCompute:JobTaskForEachTaskTaskCompute", "description": "Task level compute configuration. This block is documented below.\n\n\u003e If no \u003cspan pulumi-lang-nodejs=\"`jobClusterKey`\" pulumi-lang-dotnet=\"`JobClusterKey`\" pulumi-lang-go=\"`jobClusterKey`\" pulumi-lang-python=\"`job_cluster_key`\" pulumi-lang-yaml=\"`jobClusterKey`\" pulumi-lang-java=\"`jobClusterKey`\" pulumi-lang-hcl=\"`job_cluster_key`\"\u003e`jobClusterKey`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`existingClusterId`\" pulumi-lang-dotnet=\"`ExistingClusterId`\" pulumi-lang-go=\"`existingClusterId`\" pulumi-lang-python=\"`existing_cluster_id`\" pulumi-lang-yaml=\"`existingClusterId`\" pulumi-lang-java=\"`existingClusterId`\" pulumi-lang-hcl=\"`existing_cluster_id`\"\u003e`existingClusterId`\u003c/span\u003e, or \u003cspan pulumi-lang-nodejs=\"`newCluster`\" pulumi-lang-dotnet=\"`NewCluster`\" pulumi-lang-go=\"`newCluster`\" pulumi-lang-python=\"`new_cluster`\" pulumi-lang-yaml=\"`newCluster`\" pulumi-lang-java=\"`newCluster`\" pulumi-lang-hcl=\"`new_cluster`\"\u003e`newCluster`\u003c/span\u003e were specified in task definition, then task will executed using serverless compute.\n" }, "conditionTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskConditionTask:JobTaskForEachTaskTaskConditionTask" }, "dashboardTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDashboardTask:JobTaskForEachTaskTaskDashboardTask" }, "dbtCloudTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDbtCloudTask:JobTaskForEachTaskTaskDbtCloudTask" }, "dbtPlatformTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDbtPlatformTask:JobTaskForEachTaskTaskDbtPlatformTask" }, "dbtTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDbtTask:JobTaskForEachTaskTaskDbtTask" }, "dependsOns": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDependsOn:JobTaskForEachTaskTaskDependsOn" }, "description": "block specifying dependency(-ies) for a given task.\n" }, "description": { "type": "string", "description": "description for this task.\n" }, "disableAutoOptimization": { "type": "boolean", "description": "A flag to disable auto optimization in serverless tasks.\n" }, "disabled": { "type": "boolean" }, "emailNotifications": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskEmailNotifications:JobTaskForEachTaskTaskEmailNotifications", "description": "An optional block to specify a set of email addresses notified when this task begins, completes or fails. The default behavior is to not send any emails. This block is documented below.\n" }, "environmentKey": { "type": "string", "description": "identifier of an \u003cspan pulumi-lang-nodejs=\"`environment`\" pulumi-lang-dotnet=\"`Environment`\" pulumi-lang-go=\"`environment`\" pulumi-lang-python=\"`environment`\" pulumi-lang-yaml=\"`environment`\" pulumi-lang-java=\"`environment`\" pulumi-lang-hcl=\"`environment`\"\u003e`environment`\u003c/span\u003e block that is used to specify libraries. Required for some tasks (\u003cspan pulumi-lang-nodejs=\"`sparkPythonTask`\" pulumi-lang-dotnet=\"`SparkPythonTask`\" pulumi-lang-go=\"`sparkPythonTask`\" pulumi-lang-python=\"`spark_python_task`\" pulumi-lang-yaml=\"`sparkPythonTask`\" pulumi-lang-java=\"`sparkPythonTask`\" pulumi-lang-hcl=\"`spark_python_task`\"\u003e`sparkPythonTask`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`pythonWheelTask`\" pulumi-lang-dotnet=\"`PythonWheelTask`\" pulumi-lang-go=\"`pythonWheelTask`\" pulumi-lang-python=\"`python_wheel_task`\" pulumi-lang-yaml=\"`pythonWheelTask`\" pulumi-lang-java=\"`pythonWheelTask`\" pulumi-lang-hcl=\"`python_wheel_task`\"\u003e`pythonWheelTask`\u003c/span\u003e, ...) running on serverless compute.\n" }, "existingClusterId": { "type": "string", "description": "Identifier of the interactive cluster to run job on. *Note: running tasks on interactive clusters may lead to increased costs!*\n" }, "genAiComputeTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskGenAiComputeTask:JobTaskForEachTaskTaskGenAiComputeTask" }, "health": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskHealth:JobTaskForEachTaskTaskHealth", "description": "block described below that specifies health conditions for a given task.\n" }, "jobClusterKey": { "type": "string", "description": "Identifier of the Job cluster specified in the \u003cspan pulumi-lang-nodejs=\"`jobCluster`\" pulumi-lang-dotnet=\"`JobCluster`\" pulumi-lang-go=\"`jobCluster`\" pulumi-lang-python=\"`job_cluster`\" pulumi-lang-yaml=\"`jobCluster`\" pulumi-lang-java=\"`jobCluster`\" pulumi-lang-hcl=\"`job_cluster`\"\u003e`jobCluster`\u003c/span\u003e block.\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskLibrary:JobTaskForEachTaskTaskLibrary" }, "description": "(Set) An optional list of libraries to be installed on the cluster that will execute the job.\n" }, "maxRetries": { "type": "integer", "description": "(Integer) An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with a `FAILED` or `INTERNAL_ERROR` lifecycle state. The value -1 means to retry indefinitely and the value 0 means to never retry. The default behavior is to never retry. A run can have the following lifecycle state: `PENDING`, `RUNNING`, `TERMINATING`, `TERMINATED`, `SKIPPED` or `INTERNAL_ERROR`.\n" }, "minRetryIntervalMillis": { "type": "integer", "description": "(Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.\n" }, "newCluster": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewCluster:JobTaskForEachTaskTaskNewCluster", "description": "Task will run on a dedicated cluster. See\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003edocumentation for specification. *Some parameters, such as \u003cspan pulumi-lang-nodejs=\"`autoterminationMinutes`\" pulumi-lang-dotnet=\"`AutoterminationMinutes`\" pulumi-lang-go=\"`autoterminationMinutes`\" pulumi-lang-python=\"`autotermination_minutes`\" pulumi-lang-yaml=\"`autoterminationMinutes`\" pulumi-lang-java=\"`autoterminationMinutes`\" pulumi-lang-hcl=\"`autotermination_minutes`\"\u003e`autoterminationMinutes`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`isPinned`\" pulumi-lang-dotnet=\"`IsPinned`\" pulumi-lang-go=\"`isPinned`\" pulumi-lang-python=\"`is_pinned`\" pulumi-lang-yaml=\"`isPinned`\" pulumi-lang-java=\"`isPinned`\" pulumi-lang-hcl=\"`is_pinned`\"\u003e`isPinned`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`workloadType`\" pulumi-lang-dotnet=\"`WorkloadType`\" pulumi-lang-go=\"`workloadType`\" pulumi-lang-python=\"`workload_type`\" pulumi-lang-yaml=\"`workloadType`\" pulumi-lang-java=\"`workloadType`\" pulumi-lang-hcl=\"`workload_type`\"\u003e`workloadType`\u003c/span\u003e aren't supported!*\n" }, "notebookTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNotebookTask:JobTaskForEachTaskTaskNotebookTask" }, "notificationSettings": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNotificationSettings:JobTaskForEachTaskTaskNotificationSettings", "description": "An optional block controlling the notification settings on the job level documented below.\n" }, "pipelineTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPipelineTask:JobTaskForEachTaskTaskPipelineTask" }, "powerBiTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPowerBiTask:JobTaskForEachTaskTaskPowerBiTask" }, "pythonOperatorTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPythonOperatorTask:JobTaskForEachTaskTaskPythonOperatorTask" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPythonWheelTask:JobTaskForEachTaskTaskPythonWheelTask" }, "retryOnTimeout": { "type": "boolean", "description": "(Bool) An optional policy to specify whether to retry a job when it times out. The default behavior is to not retry on timeout.\n" }, "runIf": { "type": "string", "description": "An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. One of `ALL_SUCCESS`, `AT_LEAST_ONE_SUCCESS`, `NONE_FAILED`, `ALL_DONE`, `AT_LEAST_ONE_FAILED` or `ALL_FAILED`. When omitted, defaults to `ALL_SUCCESS`.\n" }, "runJobTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskRunJobTask:JobTaskForEachTaskTaskRunJobTask" }, "sparkJarTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSparkJarTask:JobTaskForEachTaskTaskSparkJarTask" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSparkPythonTask:JobTaskForEachTaskTaskSparkPythonTask" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSparkSubmitTask:JobTaskForEachTaskTaskSparkSubmitTask" }, "sqlTask": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTask:JobTaskForEachTaskTaskSqlTask" }, "taskKey": { "type": "string", "description": "string specifying an unique key for a given task.\n* `*_task` - (Required) one of the specific task blocks described below:\n" }, "timeoutSeconds": { "type": "integer", "description": "(Integer) An optional timeout applied to each run of this job. The default behavior is to have no timeout.\n" }, "webhookNotifications": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskWebhookNotifications:JobTaskForEachTaskTaskWebhookNotifications", "description": "(List) An optional set of system destinations (for example, webhook destinations or Slack) to be notified when runs of this task begins, completes or fails. The default behavior is to not send any notifications. This field is a block and is documented below.\n" } }, "type": "object", "required": [ "taskKey" ], "language": { "nodejs": { "requiredOutputs": [ "retryOnTimeout", "taskKey" ] } } }, "databricks:index/JobTaskForEachTaskTaskAlertTask:JobTaskForEachTaskTaskAlertTask": { "properties": { "alertId": { "type": "string", "description": "(String) identifier of the Databricks Alert (databricks_alert).\n" }, "subscribers": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskAlertTaskSubscriber:JobTaskForEachTaskTaskAlertTaskSubscriber" }, "description": "The list of subscribers to send the snapshot of the dashboard to.\n" }, "warehouseId": { "type": "string" }, "workspacePath": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskAlertTaskSubscriber:JobTaskForEachTaskTaskAlertTaskSubscriber": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskCleanRoomsNotebookTask:JobTaskForEachTaskTaskCleanRoomsNotebookTask": { "properties": { "cleanRoomName": { "type": "string", "description": "The clean room that the notebook belongs to.\n" }, "etag": { "type": "string", "description": "Checksum to validate the freshness of the notebook resource.\n" }, "notebookBaseParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Base parameters to be used for the clean room notebook job.\n" }, "notebookName": { "type": "string", "description": "Name of the notebook being run.\n" } }, "type": "object", "required": [ "cleanRoomName", "notebookName" ] }, "databricks:index/JobTaskForEachTaskTaskCompute:JobTaskForEachTaskTaskCompute": { "properties": { "hardwareAccelerator": { "type": "string", "description": "Hardware accelerator configuration for Serverless GPU workloads. Supported values are:\n* `GPU_1xA10`: GPU_1xA10: Single A10 GPU configuration.\n* `GPU_8xH100`: GPU_8xH100: 8x H100 GPU configuration.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskConditionTask:JobTaskForEachTaskTaskConditionTask": { "properties": { "left": { "type": "string", "description": "The left operand of the condition task. It could be a string value, job state, or a parameter reference.\n" }, "op": { "type": "string", "description": "The string specifying the operation used to compare operands. Currently, following operators are supported: `EQUAL_TO`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`. (Check the [API docs](https://docs.databricks.com/api/workspace/jobs/create) for the latest information).\n\nThis task does not require a cluster to execute and does not support retries or notifications.\n" }, "right": { "type": "string", "description": "The right operand of the condition task. It could be a string value, job state, or parameter reference.\n" } }, "type": "object", "required": [ "left", "op", "right" ] }, "databricks:index/JobTaskForEachTaskTaskDashboardTask:JobTaskForEachTaskTaskDashboardTask": { "properties": { "dashboardId": { "type": "string", "description": "The identifier of the dashboard to refresh\n" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "subscription": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDashboardTaskSubscription:JobTaskForEachTaskTaskDashboardTaskSubscription", "description": "Represents a subscription configuration for scheduled dashboard snapshots.\n" }, "warehouseId": { "type": "string", "description": "The warehouse id to execute the dashboard with for the schedule. If not specified, will use the default warehouse of dashboard\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskDashboardTaskSubscription:JobTaskForEachTaskTaskDashboardTaskSubscription": { "properties": { "customSubject": { "type": "string", "description": "Allows users to specify a custom subject line on the email sent to subscribers.\n" }, "paused": { "type": "boolean", "description": "When true, the subscription will not send emails.\n" }, "subscribers": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber:JobTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber" }, "description": "The list of subscribers to send the snapshot of the dashboard to.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber:JobTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string", "description": "A snapshot of the dashboard will be sent to the user's email when the \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e field is present.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskDbtCloudTask:JobTaskForEachTaskTaskDbtCloudTask": { "properties": { "connectionResourceName": { "type": "string", "description": "The resource name of the UC connection to authenticate from Databricks to Power BI\n" }, "dbtCloudJobId": { "type": "integer" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskDbtPlatformTask:JobTaskForEachTaskTaskDbtPlatformTask": { "properties": { "connectionResourceName": { "type": "string", "description": "The resource name of the UC connection to authenticate from Databricks to Power BI\n" }, "dbtPlatformJobId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskDbtTask:JobTaskForEachTaskTaskDbtTask": { "properties": { "catalog": { "type": "string", "description": "The name of the catalog to use inside Unity Catalog.\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "(Array) Series of dbt commands to execute in sequence. Every command must start with \"dbt\".\n" }, "profilesDirectory": { "type": "string", "description": "The relative path to the directory in the repository specified by \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e where dbt should look in for the `profiles.yml` file. If not specified, defaults to the repository's root directory. Equivalent to passing `--profile-dir` to a dbt command.\n" }, "projectDirectory": { "type": "string", "description": "The path where dbt should look for `dbt_project.yml`. Equivalent to passing `--project-dir` to the dbt CLI.\n* If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `GIT`: Relative path to the directory in the repository specified in the \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block. Defaults to the repository's root directory when not specified.\n* If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `WORKSPACE`: Absolute path to the folder in the workspace.\n" }, "schema": { "type": "string", "description": "The name of the schema dbt should run in. Defaults to \u003cspan pulumi-lang-nodejs=\"`default`\" pulumi-lang-dotnet=\"`Default`\" pulumi-lang-go=\"`default`\" pulumi-lang-python=\"`default`\" pulumi-lang-yaml=\"`default`\" pulumi-lang-java=\"`default`\" pulumi-lang-hcl=\"`default`\"\u003e`default`\u003c/span\u003e.\n" }, "source": { "type": "string", "description": "The source of the project. Possible values are `WORKSPACE` and `GIT`. Defaults to `GIT` if a \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block is present in the job definition.\n" }, "warehouseId": { "type": "string", "description": "The ID of the SQL warehouse that dbt should execute against.\n\nYou also need to include a \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block to configure the repository that contains the dbt project.\n" } }, "type": "object", "required": [ "commands" ] }, "databricks:index/JobTaskForEachTaskTaskDependsOn:JobTaskForEachTaskTaskDependsOn": { "properties": { "outcome": { "type": "string", "description": "Can only be specified on condition task dependencies. The outcome of the dependent task that must be met for this task to run. Possible values are `\"true\"` or `\"false\"`.\n\n\u003e Similar to the tasks themselves, each dependency inside the task need to be declared in alphabetical order with respect to\u003cspan pulumi-lang-nodejs=\" taskKey \" pulumi-lang-dotnet=\" TaskKey \" pulumi-lang-go=\" taskKey \" pulumi-lang-python=\" task_key \" pulumi-lang-yaml=\" taskKey \" pulumi-lang-java=\" taskKey \" pulumi-lang-hcl=\" task_key \"\u003e taskKey \u003c/span\u003ein order to get consistent Pulumi diffs.\n" }, "taskKey": { "type": "string", "description": "The name of the task this task depends on.\n" } }, "type": "object", "required": [ "taskKey" ] }, "databricks:index/JobTaskForEachTaskTaskEmailNotifications:JobTaskForEachTaskTaskEmailNotifications": { "properties": { "noAlertForSkippedRuns": { "type": "boolean", "description": "(Bool) don't send alert for skipped runs. (It's recommended to use the corresponding setting in the \u003cspan pulumi-lang-nodejs=\"`notificationSettings`\" pulumi-lang-dotnet=\"`NotificationSettings`\" pulumi-lang-go=\"`notificationSettings`\" pulumi-lang-python=\"`notification_settings`\" pulumi-lang-yaml=\"`notificationSettings`\" pulumi-lang-java=\"`notificationSettings`\" pulumi-lang-hcl=\"`notification_settings`\"\u003e`notificationSettings`\u003c/span\u003e configuration block).\n" }, "onDurationWarningThresholdExceededs": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the \u003cspan pulumi-lang-nodejs=\"`health`\" pulumi-lang-dotnet=\"`Health`\" pulumi-lang-go=\"`health`\" pulumi-lang-python=\"`health`\" pulumi-lang-yaml=\"`health`\" pulumi-lang-java=\"`health`\" pulumi-lang-hcl=\"`health`\"\u003e`health`\u003c/span\u003e block.\n" }, "onFailures": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run fails.\n" }, "onStarts": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run starts.\n" }, "onStreamingBacklogExceededs": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when any streaming backlog thresholds are exceeded for any stream.\n\nThe following parameter is only available for the job level configuration.\n" }, "onSuccesses": { "type": "array", "items": { "type": "string" }, "description": "(List) list of emails to notify when the run completes successfully.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskGenAiComputeTask:JobTaskForEachTaskTaskGenAiComputeTask": { "properties": { "command": { "type": "string" }, "compute": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskGenAiComputeTaskCompute:JobTaskForEachTaskTaskGenAiComputeTaskCompute", "description": "Task level compute configuration. This block is documented below.\n\n\u003e If no \u003cspan pulumi-lang-nodejs=\"`jobClusterKey`\" pulumi-lang-dotnet=\"`JobClusterKey`\" pulumi-lang-go=\"`jobClusterKey`\" pulumi-lang-python=\"`job_cluster_key`\" pulumi-lang-yaml=\"`jobClusterKey`\" pulumi-lang-java=\"`jobClusterKey`\" pulumi-lang-hcl=\"`job_cluster_key`\"\u003e`jobClusterKey`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`existingClusterId`\" pulumi-lang-dotnet=\"`ExistingClusterId`\" pulumi-lang-go=\"`existingClusterId`\" pulumi-lang-python=\"`existing_cluster_id`\" pulumi-lang-yaml=\"`existingClusterId`\" pulumi-lang-java=\"`existingClusterId`\" pulumi-lang-hcl=\"`existing_cluster_id`\"\u003e`existingClusterId`\u003c/span\u003e, or \u003cspan pulumi-lang-nodejs=\"`newCluster`\" pulumi-lang-dotnet=\"`NewCluster`\" pulumi-lang-go=\"`newCluster`\" pulumi-lang-python=\"`new_cluster`\" pulumi-lang-yaml=\"`newCluster`\" pulumi-lang-java=\"`newCluster`\" pulumi-lang-hcl=\"`new_cluster`\"\u003e`newCluster`\u003c/span\u003e were specified in task definition, then task will executed using serverless compute.\n" }, "dlRuntimeImage": { "type": "string" }, "mlflowExperimentName": { "type": "string" }, "source": { "type": "string" }, "trainingScriptPath": { "type": "string" }, "yamlParameters": { "type": "string" }, "yamlParametersFilePath": { "type": "string" } }, "type": "object", "required": [ "dlRuntimeImage" ] }, "databricks:index/JobTaskForEachTaskTaskGenAiComputeTaskCompute:JobTaskForEachTaskTaskGenAiComputeTaskCompute": { "properties": { "gpuNodePoolId": { "type": "string" }, "gpuType": { "type": "string" }, "numGpus": { "type": "integer" } }, "type": "object", "required": [ "numGpus" ] }, "databricks:index/JobTaskForEachTaskTaskHealth:JobTaskForEachTaskTaskHealth": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskHealthRule:JobTaskForEachTaskTaskHealthRule" }, "description": "list of rules that are represented as objects with the following attributes:\n" } }, "type": "object", "required": [ "rules" ] }, "databricks:index/JobTaskForEachTaskTaskHealthRule:JobTaskForEachTaskTaskHealthRule": { "properties": { "metric": { "type": "string", "description": "string specifying the metric to check, like `RUN_DURATION_SECONDS`, `STREAMING_BACKLOG_FILES`, etc. - check the [Jobs REST API documentation](https://docs.databricks.com/api/workspace/jobs/create#health-rules-metric) for the full list of supported metrics.\n" }, "op": { "type": "string", "description": "string specifying the operation used to evaluate the given metric. The only supported operation is `GREATER_THAN`.\n" }, "value": { "type": "integer", "description": "integer value used to compare to the given metric.\n" } }, "type": "object", "required": [ "metric", "op", "value" ] }, "databricks:index/JobTaskForEachTaskTaskLibrary:JobTaskForEachTaskTaskLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskLibraryCran:JobTaskForEachTaskTaskLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskLibraryMaven:JobTaskForEachTaskTaskLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskLibraryProviderConfig:JobTaskForEachTaskTaskLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskLibraryPypi:JobTaskForEachTaskTaskLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobTaskForEachTaskTaskLibraryCran:JobTaskForEachTaskTaskLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskForEachTaskTaskLibraryMaven:JobTaskForEachTaskTaskLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobTaskForEachTaskTaskLibraryProviderConfig:JobTaskForEachTaskTaskLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobTaskForEachTaskTaskLibraryPypi:JobTaskForEachTaskTaskLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskForEachTaskTaskNewCluster:JobTaskForEachTaskTaskNewCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterAutoscale:JobTaskForEachTaskTaskNewClusterAutoscale" }, "awsAttributes": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterAwsAttributes:JobTaskForEachTaskTaskNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterAzureAttributes:JobTaskForEachTaskTaskNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConf:JobTaskForEachTaskTaskNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterClusterMountInfo:JobTaskForEachTaskTaskNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterDockerImage:JobTaskForEachTaskTaskNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterDriverNodeTypeFlexibility:JobTaskForEachTaskTaskNewClusterDriverNodeTypeFlexibility" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterGcpAttributes:JobTaskForEachTaskTaskNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "willReplaceOnChanges": true }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScript:JobTaskForEachTaskTaskNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "isSingleNode": { "type": "boolean" }, "kind": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterLibrary:JobTaskForEachTaskTaskNewClusterLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterProviderConfig:JobTaskForEachTaskTaskNewClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterWorkerNodeTypeFlexibility:JobTaskForEachTaskTaskNewClusterWorkerNodeTypeFlexibility" }, "workloadType": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterWorkloadType:JobTaskForEachTaskTaskNewClusterWorkloadType", "description": "isn't supported\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "providerConfig" ] } } }, "databricks:index/JobTaskForEachTaskTaskNewClusterAutoscale:JobTaskForEachTaskTaskNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterAwsAttributes:JobTaskForEachTaskTaskNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterAzureAttributes:JobTaskForEachTaskTaskNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterAzureAttributesLogAnalyticsInfo:JobTaskForEachTaskTaskNewClusterAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterAzureAttributesLogAnalyticsInfo:JobTaskForEachTaskTaskNewClusterAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConf:JobTaskForEachTaskTaskNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConfDbfs:JobTaskForEachTaskTaskNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConfS3:JobTaskForEachTaskTaskNewClusterClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConfVolumes:JobTaskForEachTaskTaskNewClusterClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConfDbfs:JobTaskForEachTaskTaskNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConfS3:JobTaskForEachTaskTaskNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterClusterLogConfVolumes:JobTaskForEachTaskTaskNewClusterClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterClusterMountInfo:JobTaskForEachTaskTaskNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo:JobTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo:JobTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterDockerImage:JobTaskForEachTaskTaskNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterDockerImageBasicAuth:JobTaskForEachTaskTaskNewClusterDockerImageBasicAuth" }, "url": { "type": "string", "description": "URL of the job on the given workspace\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterDockerImageBasicAuth:JobTaskForEachTaskTaskNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterDriverNodeTypeFlexibility:JobTaskForEachTaskTaskNewClusterDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterGcpAttributes:JobTaskForEachTaskTaskNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScript:JobTaskForEachTaskTaskNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptAbfss:JobTaskForEachTaskTaskNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptDbfs:JobTaskForEachTaskTaskNewClusterInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptFile:JobTaskForEachTaskTaskNewClusterInitScriptFile", "description": "block consisting of single string fields:\n" }, "gcs": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptGcs:JobTaskForEachTaskTaskNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptS3:JobTaskForEachTaskTaskNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptVolumes:JobTaskForEachTaskTaskNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptWorkspace:JobTaskForEachTaskTaskNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptAbfss:JobTaskForEachTaskTaskNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptDbfs:JobTaskForEachTaskTaskNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptFile:JobTaskForEachTaskTaskNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptGcs:JobTaskForEachTaskTaskNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptS3:JobTaskForEachTaskTaskNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptVolumes:JobTaskForEachTaskTaskNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterInitScriptWorkspace:JobTaskForEachTaskTaskNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterLibrary:JobTaskForEachTaskTaskNewClusterLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterLibraryCran:JobTaskForEachTaskTaskNewClusterLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterLibraryMaven:JobTaskForEachTaskTaskNewClusterLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterLibraryProviderConfig:JobTaskForEachTaskTaskNewClusterLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterLibraryPypi:JobTaskForEachTaskTaskNewClusterLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobTaskForEachTaskTaskNewClusterLibraryCran:JobTaskForEachTaskTaskNewClusterLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterLibraryMaven:JobTaskForEachTaskTaskNewClusterLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterLibraryProviderConfig:JobTaskForEachTaskTaskNewClusterLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobTaskForEachTaskTaskNewClusterLibraryPypi:JobTaskForEachTaskTaskNewClusterLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterProviderConfig:JobTaskForEachTaskTaskNewClusterProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobTaskForEachTaskTaskNewClusterWorkerNodeTypeFlexibility:JobTaskForEachTaskTaskNewClusterWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNewClusterWorkloadType:JobTaskForEachTaskTaskNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskNewClusterWorkloadTypeClients:JobTaskForEachTaskTaskNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/JobTaskForEachTaskTaskNewClusterWorkloadTypeClients:JobTaskForEachTaskTaskNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskNotebookTask:JobTaskForEachTaskTaskNotebookTask": { "properties": { "baseParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Base parameters to be used for each run of this job. If the run is initiated by a call to run-now with parameters specified, the two parameters maps will be merged. If the same key is specified in\u003cspan pulumi-lang-nodejs=\" baseParameters \" pulumi-lang-dotnet=\" BaseParameters \" pulumi-lang-go=\" baseParameters \" pulumi-lang-python=\" base_parameters \" pulumi-lang-yaml=\" baseParameters \" pulumi-lang-java=\" baseParameters \" pulumi-lang-hcl=\" base_parameters \"\u003e baseParameters \u003c/span\u003eand in run-now, the value from run-now will be used. If the notebook takes a parameter that is not specified in the job's\u003cspan pulumi-lang-nodejs=\" baseParameters \" pulumi-lang-dotnet=\" BaseParameters \" pulumi-lang-go=\" baseParameters \" pulumi-lang-python=\" base_parameters \" pulumi-lang-yaml=\" baseParameters \" pulumi-lang-java=\" baseParameters \" pulumi-lang-hcl=\" base_parameters \"\u003e baseParameters \u003c/span\u003eor the run-now override parameters, the default value from the notebook will be used. Retrieve these parameters in a notebook using `dbutils.widgets.get`.\n" }, "notebookPath": { "type": "string", "description": "The path of the\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto be run in the Databricks workspace or remote repository. For notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash. For notebooks stored in a remote repository, the path must be relative. This field is required.\n" }, "source": { "type": "string", "description": "Location type of the notebook, can only be `WORKSPACE` or `GIT`. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository defined in \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e. If the value is empty, the task will use `GIT` if \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e is defined and `WORKSPACE` otherwise.\n" }, "warehouseId": { "type": "string", "description": "ID of the (the databricks_sql_endpoint) that will be used to execute the task with SQL notebook.\n" } }, "type": "object", "required": [ "notebookPath" ] }, "databricks:index/JobTaskForEachTaskTaskNotificationSettings:JobTaskForEachTaskTaskNotificationSettings": { "properties": { "alertOnLastAttempt": { "type": "boolean", "description": "(Bool) do not send notifications to recipients specified in \u003cspan pulumi-lang-nodejs=\"`onStart`\" pulumi-lang-dotnet=\"`OnStart`\" pulumi-lang-go=\"`onStart`\" pulumi-lang-python=\"`on_start`\" pulumi-lang-yaml=\"`onStart`\" pulumi-lang-java=\"`onStart`\" pulumi-lang-hcl=\"`on_start`\"\u003e`onStart`\u003c/span\u003e for the retried runs and do not send notifications to recipients specified in \u003cspan pulumi-lang-nodejs=\"`onFailure`\" pulumi-lang-dotnet=\"`OnFailure`\" pulumi-lang-go=\"`onFailure`\" pulumi-lang-python=\"`on_failure`\" pulumi-lang-yaml=\"`onFailure`\" pulumi-lang-java=\"`onFailure`\" pulumi-lang-hcl=\"`on_failure`\"\u003e`onFailure`\u003c/span\u003e until the last retry of the run.\n" }, "noAlertForCanceledRuns": { "type": "boolean", "description": "(Bool) don't send alert for cancelled runs.\n\nThe following parameter is only available on task level.\n" }, "noAlertForSkippedRuns": { "type": "boolean", "description": "(Bool) don't send alert for skipped runs.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskPipelineTask:JobTaskForEachTaskTaskPipelineTask": { "properties": { "fullRefresh": { "type": "boolean", "description": "(Bool) Specifies if there should be full refresh of the pipeline.\n\n\u003e The following configuration blocks are only supported inside a \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block\n" }, "fullRefreshSelections": { "type": "array", "items": { "type": "string" } }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "pipelineId": { "type": "string", "description": "The pipeline's unique ID.\n" }, "refreshFlowSelections": { "type": "array", "items": { "type": "string" } }, "refreshSelections": { "type": "array", "items": { "type": "string" } }, "resetCheckpointSelections": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "pipelineId" ] }, "databricks:index/JobTaskForEachTaskTaskPowerBiTask:JobTaskForEachTaskTaskPowerBiTask": { "properties": { "connectionResourceName": { "type": "string", "description": "The resource name of the UC connection to authenticate from Databricks to Power BI\n" }, "powerBiModel": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPowerBiTaskPowerBiModel:JobTaskForEachTaskTaskPowerBiTaskPowerBiModel", "description": "The semantic model to update. Block consists of following fields:\n" }, "refreshAfterUpdate": { "type": "boolean", "description": "Whether the model should be refreshed after the update. Default is false\n" }, "tables": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPowerBiTaskTable:JobTaskForEachTaskTaskPowerBiTaskTable" }, "description": "The tables to be exported to Power BI. Block consists of following fields:\n" }, "warehouseId": { "type": "string", "description": "The SQL warehouse ID to use as the Power BI data source\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskPowerBiTaskPowerBiModel:JobTaskForEachTaskTaskPowerBiTaskPowerBiModel": { "properties": { "authenticationMethod": { "type": "string", "description": "How the published Power BI model authenticates to Databricks\n" }, "modelName": { "type": "string", "description": "The name of the Power BI model\n" }, "overwriteExisting": { "type": "boolean", "description": "Whether to overwrite existing Power BI models. Default is false\n" }, "storageMode": { "type": "string", "description": "The default storage mode of the Power BI model\n" }, "workspaceName": { "type": "string", "description": "The name of the Power BI workspace of the model\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskPowerBiTaskTable:JobTaskForEachTaskTaskPowerBiTaskTable": { "properties": { "catalog": { "type": "string", "description": "The catalog name in Databricks\n" }, "name": { "type": "string", "description": "The table name in Databricks. If empty, all tables under the schema are selected.\n" }, "schema": { "type": "string", "description": "The schema name in Databricks\n" }, "storageMode": { "type": "string", "description": "The Power BI storage mode of the table\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskPythonOperatorTask:JobTaskForEachTaskTaskPythonOperatorTask": { "properties": { "main": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskPythonOperatorTaskParameter:JobTaskForEachTaskTaskPythonOperatorTaskParameter" } } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskPythonOperatorTaskParameter:JobTaskForEachTaskTaskPythonOperatorTaskParameter": { "properties": { "name": { "type": "string", "description": "An optional name for the job. The default value is Untitled.\n" }, "value": { "type": "string", "description": "integer value used to compare to the given metric.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskPythonWheelTask:JobTaskForEachTaskTaskPythonWheelTask": { "properties": { "entryPoint": { "type": "string", "description": "Python function as entry point for the task\n" }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Named parameters for the task\n" }, "packageName": { "type": "string", "description": "Name of Python package\n" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Parameters for the task\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskRunJobTask:JobTaskForEachTaskTaskRunJobTask": { "properties": { "dbtCommands": { "type": "array", "items": { "type": "string" } }, "jarParams": { "type": "array", "items": { "type": "string" } }, "jobId": { "type": "integer", "description": "(String) ID of the job\n" }, "jobParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Job parameters for the task\n" }, "notebookParams": { "type": "object", "additionalProperties": { "type": "string" } }, "pipelineParams": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskRunJobTaskPipelineParams:JobTaskForEachTaskTaskRunJobTaskPipelineParams" }, "pythonNamedParams": { "type": "object", "additionalProperties": { "type": "string" } }, "pythonParams": { "type": "array", "items": { "type": "string" } }, "sparkSubmitParams": { "type": "array", "items": { "type": "string" } }, "sqlParams": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "jobId" ] }, "databricks:index/JobTaskForEachTaskTaskRunJobTaskPipelineParams:JobTaskForEachTaskTaskRunJobTaskPipelineParams": { "properties": { "fullRefresh": { "type": "boolean", "description": "(Bool) Specifies if there should be full refresh of the pipeline.\n\n\u003e The following configuration blocks are only supported inside a \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block\n" }, "fullRefreshSelections": { "type": "array", "items": { "type": "string" } }, "refreshFlowSelections": { "type": "array", "items": { "type": "string" } }, "refreshSelections": { "type": "array", "items": { "type": "string" } }, "resetCheckpointSelections": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskSparkJarTask:JobTaskForEachTaskTaskSparkJarTask": { "properties": { "jarUri": { "type": "string" }, "mainClassName": { "type": "string", "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. The code should use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job will fail.\n" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Parameters passed to the main method.\n" }, "runAsRepl": { "type": "boolean" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskSparkPythonTask:JobTaskForEachTaskTaskSparkPythonTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Command line parameters passed to the Python file.\n" }, "pythonFile": { "type": "string", "description": "The URI of the Python file to be executed. Cloud file URIs (e.g. `s3:/`, `abfss:/`, `gs:/`), workspace paths and remote repository are supported. For Python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.\n" }, "source": { "type": "string", "description": "Location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local Databricks workspace or cloud location (if the\u003cspan pulumi-lang-nodejs=\" pythonFile \" pulumi-lang-dotnet=\" PythonFile \" pulumi-lang-go=\" pythonFile \" pulumi-lang-python=\" python_file \" pulumi-lang-yaml=\" pythonFile \" pulumi-lang-java=\" pythonFile \" pulumi-lang-hcl=\" python_file \"\u003e pythonFile \u003c/span\u003ehas a URI format). When set to `GIT`, the Python file will be retrieved from a Git repository defined in \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e.\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\n* `GIT`: The Python file is located in a remote Git repository.\n" } }, "type": "object", "required": [ "pythonFile" ] }, "databricks:index/JobTaskForEachTaskTaskSparkSubmitTask:JobTaskForEachTaskTaskSparkSubmitTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Command-line parameters passed to spark submit.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskSqlTask:JobTaskForEachTaskTaskSqlTask": { "properties": { "alert": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTaskAlert:JobTaskForEachTaskTaskSqlTaskAlert", "description": "block consisting of following fields:\n" }, "dashboard": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTaskDashboard:JobTaskForEachTaskTaskSqlTaskDashboard", "description": "block consisting of following fields:\n" }, "file": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTaskFile:JobTaskForEachTaskTaskSqlTaskFile", "description": "block consisting of single string fields:\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) parameters to be used for each run of this task. The SQL alert task does not support custom parameters.\n" }, "query": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTaskQuery:JobTaskForEachTaskTaskSqlTaskQuery", "description": "block consisting of single string field: \u003cspan pulumi-lang-nodejs=\"`queryId`\" pulumi-lang-dotnet=\"`QueryId`\" pulumi-lang-go=\"`queryId`\" pulumi-lang-python=\"`query_id`\" pulumi-lang-yaml=\"`queryId`\" pulumi-lang-java=\"`queryId`\" pulumi-lang-hcl=\"`query_id`\"\u003e`queryId`\u003c/span\u003e - identifier of the Databricks Query (databricks_query).\n" }, "warehouseId": { "type": "string", "description": "ID of the (the databricks_sql_endpoint) that will be used to execute the task. Only Serverless \u0026 Pro warehouses are supported right now.\n" } }, "type": "object", "required": [ "warehouseId" ] }, "databricks:index/JobTaskForEachTaskTaskSqlTaskAlert:JobTaskForEachTaskTaskSqlTaskAlert": { "properties": { "alertId": { "type": "string", "description": "(String) identifier of the Databricks Alert (databricks_alert).\n" }, "pauseSubscriptions": { "type": "boolean", "description": "flag that specifies if subscriptions are paused or not.\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTaskAlertSubscription:JobTaskForEachTaskTaskSqlTaskAlertSubscription" }, "description": "a list of subscription blocks consisting out of one of the required fields: \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e for user emails or \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e - for Alert destination's identifier.\n" } }, "type": "object", "required": [ "alertId" ] }, "databricks:index/JobTaskForEachTaskTaskSqlTaskAlertSubscription:JobTaskForEachTaskTaskSqlTaskAlertSubscription": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskSqlTaskDashboard:JobTaskForEachTaskTaskSqlTaskDashboard": { "properties": { "customSubject": { "type": "string", "description": "string specifying a custom subject of email sent.\n" }, "dashboardId": { "type": "string", "description": "(String) identifier of the Databricks SQL Dashboard databricks_sql_dashboard.\n" }, "pauseSubscriptions": { "type": "boolean", "description": "flag that specifies if subscriptions are paused or not.\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskSqlTaskDashboardSubscription:JobTaskForEachTaskTaskSqlTaskDashboardSubscription" }, "description": "a list of subscription blocks consisting out of one of the required fields: \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e for user emails or \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e - for Alert destination's identifier.\n" } }, "type": "object", "required": [ "dashboardId" ] }, "databricks:index/JobTaskForEachTaskTaskSqlTaskDashboardSubscription:JobTaskForEachTaskTaskSqlTaskDashboardSubscription": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskSqlTaskFile:JobTaskForEachTaskTaskSqlTaskFile": { "properties": { "path": { "type": "string", "description": "If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `GIT`: Relative path to the file in the repository specified in the \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block with SQL commands to execute. If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `WORKSPACE`: Absolute path to the file in the workspace with SQL commands to execute.\n\nExample\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sqlAggregationJob = new databricks.Job(\"sql_aggregation_job\", {\n name: \"Example SQL Job\",\n tasks: [\n {\n taskKey: \"run_agg_query\",\n sqlTask: {\n warehouseId: sqlJobWarehouse.id,\n query: {\n queryId: aggQuery.id,\n },\n },\n },\n {\n taskKey: \"run_dashboard\",\n sqlTask: {\n warehouseId: sqlJobWarehouse.id,\n dashboard: {\n dashboardId: dash.id,\n subscriptions: [{\n userName: \"user@domain.com\",\n }],\n },\n },\n },\n {\n taskKey: \"run_alert\",\n sqlTask: {\n warehouseId: sqlJobWarehouse.id,\n alert: {\n alertId: alert.id,\n subscriptions: [{\n userName: \"user@domain.com\",\n }],\n },\n },\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsql_aggregation_job = databricks.Job(\"sql_aggregation_job\",\n name=\"Example SQL Job\",\n tasks=[\n {\n \"task_key\": \"run_agg_query\",\n \"sql_task\": {\n \"warehouse_id\": sql_job_warehouse[\"id\"],\n \"query\": {\n \"query_id\": agg_query[\"id\"],\n },\n },\n },\n {\n \"task_key\": \"run_dashboard\",\n \"sql_task\": {\n \"warehouse_id\": sql_job_warehouse[\"id\"],\n \"dashboard\": {\n \"dashboard_id\": dash[\"id\"],\n \"subscriptions\": [{\n \"user_name\": \"user@domain.com\",\n }],\n },\n },\n },\n {\n \"task_key\": \"run_alert\",\n \"sql_task\": {\n \"warehouse_id\": sql_job_warehouse[\"id\"],\n \"alert\": {\n \"alert_id\": alert[\"id\"],\n \"subscriptions\": [{\n \"user_name\": \"user@domain.com\",\n }],\n },\n },\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sqlAggregationJob = new Databricks.Job(\"sql_aggregation_job\", new()\n {\n Name = \"Example SQL Job\",\n Tasks = new[]\n {\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"run_agg_query\",\n SqlTask = new Databricks.Inputs.JobTaskSqlTaskArgs\n {\n WarehouseId = sqlJobWarehouse.Id,\n Query = new Databricks.Inputs.JobTaskSqlTaskQueryArgs\n {\n QueryId = aggQuery.Id,\n },\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"run_dashboard\",\n SqlTask = new Databricks.Inputs.JobTaskSqlTaskArgs\n {\n WarehouseId = sqlJobWarehouse.Id,\n Dashboard = new Databricks.Inputs.JobTaskSqlTaskDashboardArgs\n {\n DashboardId = dash.Id,\n Subscriptions = new[]\n {\n new Databricks.Inputs.JobTaskSqlTaskDashboardSubscriptionArgs\n {\n UserName = \"user@domain.com\",\n },\n },\n },\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"run_alert\",\n SqlTask = new Databricks.Inputs.JobTaskSqlTaskArgs\n {\n WarehouseId = sqlJobWarehouse.Id,\n Alert = new Databricks.Inputs.JobTaskSqlTaskAlertArgs\n {\n AlertId = alert.Id,\n Subscriptions = new[]\n {\n new Databricks.Inputs.JobTaskSqlTaskAlertSubscriptionArgs\n {\n UserName = \"user@domain.com\",\n },\n },\n },\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewJob(ctx, \"sql_aggregation_job\", \u0026databricks.JobArgs{\n\t\t\tName: pulumi.String(\"Example SQL Job\"),\n\t\t\tTasks: databricks.JobTaskArray{\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"run_agg_query\"),\n\t\t\t\t\tSqlTask: \u0026databricks.JobTaskSqlTaskArgs{\n\t\t\t\t\t\tWarehouseId: pulumi.Any(sqlJobWarehouse.Id),\n\t\t\t\t\t\tQuery: \u0026databricks.JobTaskSqlTaskQueryArgs{\n\t\t\t\t\t\t\tQueryId: pulumi.Any(aggQuery.Id),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"run_dashboard\"),\n\t\t\t\t\tSqlTask: \u0026databricks.JobTaskSqlTaskArgs{\n\t\t\t\t\t\tWarehouseId: pulumi.Any(sqlJobWarehouse.Id),\n\t\t\t\t\t\tDashboard: \u0026databricks.JobTaskSqlTaskDashboardArgs{\n\t\t\t\t\t\t\tDashboardId: pulumi.Any(dash.Id),\n\t\t\t\t\t\t\tSubscriptions: databricks.JobTaskSqlTaskDashboardSubscriptionArray{\n\t\t\t\t\t\t\t\t\u0026databricks.JobTaskSqlTaskDashboardSubscriptionArgs{\n\t\t\t\t\t\t\t\t\tUserName: pulumi.String(\"user@domain.com\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"run_alert\"),\n\t\t\t\t\tSqlTask: \u0026databricks.JobTaskSqlTaskArgs{\n\t\t\t\t\t\tWarehouseId: pulumi.Any(sqlJobWarehouse.Id),\n\t\t\t\t\t\tAlert: \u0026databricks.JobTaskSqlTaskAlertArgs{\n\t\t\t\t\t\t\tAlertId: pulumi.Any(alert.Id),\n\t\t\t\t\t\t\tSubscriptions: databricks.JobTaskSqlTaskAlertSubscriptionArray{\n\t\t\t\t\t\t\t\t\u0026databricks.JobTaskSqlTaskAlertSubscriptionArgs{\n\t\t\t\t\t\t\t\t\tUserName: pulumi.String(\"user@domain.com\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_job\" \"sql_aggregation_job\" {\n name = \"Example SQL Job\"\n tasks {\n task_key = \"run_agg_query\"\n sql_task = {\n warehouse_id = sqlJobWarehouse.id\n query = {\n query_id = aggQuery.id\n }\n }\n }\n tasks {\n task_key = \"run_dashboard\"\n sql_task = {\n warehouse_id = sqlJobWarehouse.id\n dashboard = {\n dashboard_id = dash.id\n subscriptions = [{\n \"userName\" = \"user@domain.com\"\n }]\n }\n }\n }\n tasks {\n task_key = \"run_alert\"\n sql_task = {\n warehouse_id = sqlJobWarehouse.id\n alert = {\n alert_id = alert.id\n subscriptions = [{\n \"userName\" = \"user@domain.com\"\n }]\n }\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Job;\nimport com.pulumi.databricks.JobArgs;\nimport com.pulumi.databricks.inputs.JobTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskQueryArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskDashboardArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskAlertArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sqlAggregationJob = new Job(\"sqlAggregationJob\", JobArgs.builder()\n .name(\"Example SQL Job\")\n .tasks( \n JobTaskArgs.builder()\n .taskKey(\"run_agg_query\")\n .sqlTask(JobTaskSqlTaskArgs.builder()\n .warehouseId(sqlJobWarehouse.id())\n .query(JobTaskSqlTaskQueryArgs.builder()\n .queryId(aggQuery.id())\n .build())\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"run_dashboard\")\n .sqlTask(JobTaskSqlTaskArgs.builder()\n .warehouseId(sqlJobWarehouse.id())\n .dashboard(JobTaskSqlTaskDashboardArgs.builder()\n .dashboardId(dash.id())\n .subscriptions(JobTaskSqlTaskDashboardSubscriptionArgs.builder()\n .userName(\"user@domain.com\")\n .build())\n .build())\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"run_alert\")\n .sqlTask(JobTaskSqlTaskArgs.builder()\n .warehouseId(sqlJobWarehouse.id())\n .alert(JobTaskSqlTaskAlertArgs.builder()\n .alertId(alert.id())\n .subscriptions(JobTaskSqlTaskAlertSubscriptionArgs.builder()\n .userName(\"user@domain.com\")\n .build())\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sqlAggregationJob:\n type: databricks:Job\n name: sql_aggregation_job\n properties:\n name: Example SQL Job\n tasks:\n - taskKey: run_agg_query\n sqlTask:\n warehouseId: ${sqlJobWarehouse.id}\n query:\n queryId: ${aggQuery.id}\n - taskKey: run_dashboard\n sqlTask:\n warehouseId: ${sqlJobWarehouse.id}\n dashboard:\n dashboardId: ${dash.id}\n subscriptions:\n - userName: user@domain.com\n - taskKey: run_alert\n sqlTask:\n warehouseId: ${sqlJobWarehouse.id}\n alert:\n alertId: ${alert.id}\n subscriptions:\n - userName: user@domain.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "source": { "type": "string", "description": "The source of the project. Possible values are `WORKSPACE` and `GIT`.\n" } }, "type": "object", "required": [ "path" ] }, "databricks:index/JobTaskForEachTaskTaskSqlTaskQuery:JobTaskForEachTaskTaskSqlTaskQuery": { "properties": { "queryId": { "type": "string" } }, "type": "object", "required": [ "queryId" ] }, "databricks:index/JobTaskForEachTaskTaskWebhookNotifications:JobTaskForEachTaskTaskWebhookNotifications": { "properties": { "onDurationWarningThresholdExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded:JobTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded" }, "description": "(List) list of notification IDs to call when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the \u003cspan pulumi-lang-nodejs=\"`health`\" pulumi-lang-dotnet=\"`Health`\" pulumi-lang-go=\"`health`\" pulumi-lang-python=\"`health`\" pulumi-lang-yaml=\"`health`\" pulumi-lang-java=\"`health`\" pulumi-lang-hcl=\"`health`\"\u003e`health`\u003c/span\u003e block.\n" }, "onFailures": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnFailure:JobTaskForEachTaskTaskWebhookNotificationsOnFailure" }, "description": "(List) list of notification IDs to call when the run fails. A maximum of 3 destinations can be specified.\n" }, "onStarts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnStart:JobTaskForEachTaskTaskWebhookNotificationsOnStart" }, "description": "(List) list of notification IDs to call when the run starts. A maximum of 3 destinations can be specified.\n" }, "onStreamingBacklogExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded:JobTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded" }, "description": "(List) list of notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\n\nNote that the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e is not to be confused with the name of the alert destination. The \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e can be retrieved through the API or the URL of Databricks UI `https://\u003cworkspace host\u003e/sql/destinations/\u003cnotification id\u003e?o=\u003cworkspace id\u003e`\n\nExample\n\n" }, "onSuccesses": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnSuccess:JobTaskForEachTaskTaskWebhookNotificationsOnSuccess" }, "description": "(List) list of notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified.\n" } }, "type": "object" }, "databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded:JobTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnFailure:JobTaskForEachTaskTaskWebhookNotificationsOnFailure": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnStart:JobTaskForEachTaskTaskWebhookNotificationsOnStart": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded:JobTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskForEachTaskTaskWebhookNotificationsOnSuccess:JobTaskForEachTaskTaskWebhookNotificationsOnSuccess": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskGenAiComputeTask:JobTaskGenAiComputeTask": { "properties": { "command": { "type": "string" }, "compute": { "$ref": "#/types/databricks:index/JobTaskGenAiComputeTaskCompute:JobTaskGenAiComputeTaskCompute", "description": "Task level compute configuration. This block is documented below.\n\n\u003e If no \u003cspan pulumi-lang-nodejs=\"`jobClusterKey`\" pulumi-lang-dotnet=\"`JobClusterKey`\" pulumi-lang-go=\"`jobClusterKey`\" pulumi-lang-python=\"`job_cluster_key`\" pulumi-lang-yaml=\"`jobClusterKey`\" pulumi-lang-java=\"`jobClusterKey`\" pulumi-lang-hcl=\"`job_cluster_key`\"\u003e`jobClusterKey`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`existingClusterId`\" pulumi-lang-dotnet=\"`ExistingClusterId`\" pulumi-lang-go=\"`existingClusterId`\" pulumi-lang-python=\"`existing_cluster_id`\" pulumi-lang-yaml=\"`existingClusterId`\" pulumi-lang-java=\"`existingClusterId`\" pulumi-lang-hcl=\"`existing_cluster_id`\"\u003e`existingClusterId`\u003c/span\u003e, or \u003cspan pulumi-lang-nodejs=\"`newCluster`\" pulumi-lang-dotnet=\"`NewCluster`\" pulumi-lang-go=\"`newCluster`\" pulumi-lang-python=\"`new_cluster`\" pulumi-lang-yaml=\"`newCluster`\" pulumi-lang-java=\"`newCluster`\" pulumi-lang-hcl=\"`new_cluster`\"\u003e`newCluster`\u003c/span\u003e were specified in task definition, then task will executed using serverless compute.\n" }, "dlRuntimeImage": { "type": "string" }, "mlflowExperimentName": { "type": "string" }, "source": { "type": "string" }, "trainingScriptPath": { "type": "string" }, "yamlParameters": { "type": "string" }, "yamlParametersFilePath": { "type": "string" } }, "type": "object", "required": [ "dlRuntimeImage" ] }, "databricks:index/JobTaskGenAiComputeTaskCompute:JobTaskGenAiComputeTaskCompute": { "properties": { "gpuNodePoolId": { "type": "string" }, "gpuType": { "type": "string" }, "numGpus": { "type": "integer" } }, "type": "object", "required": [ "numGpus" ] }, "databricks:index/JobTaskHealth:JobTaskHealth": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskHealthRule:JobTaskHealthRule" }, "description": "list of rules that are represented as objects with the following attributes:\n" } }, "type": "object", "required": [ "rules" ] }, "databricks:index/JobTaskHealthRule:JobTaskHealthRule": { "properties": { "metric": { "type": "string", "description": "string specifying the metric to check, like `RUN_DURATION_SECONDS`, `STREAMING_BACKLOG_FILES`, etc. - check the [Jobs REST API documentation](https://docs.databricks.com/api/workspace/jobs/create#health-rules-metric) for the full list of supported metrics.\n" }, "op": { "type": "string", "description": "string specifying the operation used to evaluate the given metric. The only supported operation is `GREATER_THAN`.\n" }, "value": { "type": "integer", "description": "integer value used to compare to the given metric.\n" } }, "type": "object", "required": [ "metric", "op", "value" ] }, "databricks:index/JobTaskLibrary:JobTaskLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobTaskLibraryCran:JobTaskLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobTaskLibraryMaven:JobTaskLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobTaskLibraryProviderConfig:JobTaskLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobTaskLibraryPypi:JobTaskLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobTaskLibraryCran:JobTaskLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskLibraryMaven:JobTaskLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobTaskLibraryProviderConfig:JobTaskLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobTaskLibraryPypi:JobTaskLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskNewCluster:JobTaskNewCluster": { "properties": { "__applyPolicyDefaultValuesAllowLists": { "type": "array", "items": { "type": "string" } }, "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/JobTaskNewClusterAutoscale:JobTaskNewClusterAutoscale" }, "awsAttributes": { "$ref": "#/types/databricks:index/JobTaskNewClusterAwsAttributes:JobTaskNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/JobTaskNewClusterAzureAttributes:JobTaskNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/JobTaskNewClusterClusterLogConf:JobTaskNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskNewClusterClusterMountInfo:JobTaskNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/JobTaskNewClusterDockerImage:JobTaskNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobTaskNewClusterDriverNodeTypeFlexibility:JobTaskNewClusterDriverNodeTypeFlexibility" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/JobTaskNewClusterGcpAttributes:JobTaskNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "willReplaceOnChanges": true }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScript:JobTaskNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "isSingleNode": { "type": "boolean" }, "kind": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskNewClusterLibrary:JobTaskNewClusterLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/JobTaskNewClusterProviderConfig:JobTaskNewClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/JobTaskNewClusterWorkerNodeTypeFlexibility:JobTaskNewClusterWorkerNodeTypeFlexibility" }, "workloadType": { "$ref": "#/types/databricks:index/JobTaskNewClusterWorkloadType:JobTaskNewClusterWorkloadType", "description": "isn't supported\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "providerConfig" ] } } }, "databricks:index/JobTaskNewClusterAutoscale:JobTaskNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/JobTaskNewClusterAwsAttributes:JobTaskNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskNewClusterAzureAttributes:JobTaskNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/JobTaskNewClusterAzureAttributesLogAnalyticsInfo:JobTaskNewClusterAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/JobTaskNewClusterAzureAttributesLogAnalyticsInfo:JobTaskNewClusterAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskNewClusterClusterLogConf:JobTaskNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/JobTaskNewClusterClusterLogConfDbfs:JobTaskNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/JobTaskNewClusterClusterLogConfS3:JobTaskNewClusterClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/JobTaskNewClusterClusterLogConfVolumes:JobTaskNewClusterClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/JobTaskNewClusterClusterLogConfDbfs:JobTaskNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterClusterLogConfS3:JobTaskNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterClusterLogConfVolumes:JobTaskNewClusterClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterClusterMountInfo:JobTaskNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/JobTaskNewClusterClusterMountInfoNetworkFilesystemInfo:JobTaskNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/JobTaskNewClusterClusterMountInfoNetworkFilesystemInfo:JobTaskNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/JobTaskNewClusterDockerImage:JobTaskNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/JobTaskNewClusterDockerImageBasicAuth:JobTaskNewClusterDockerImageBasicAuth" }, "url": { "type": "string", "description": "URL of the job on the given workspace\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/JobTaskNewClusterDockerImageBasicAuth:JobTaskNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/JobTaskNewClusterDriverNodeTypeFlexibility:JobTaskNewClusterDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobTaskNewClusterGcpAttributes:JobTaskNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskNewClusterInitScript:JobTaskNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptAbfss:JobTaskNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptDbfs:JobTaskNewClusterInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptFile:JobTaskNewClusterInitScriptFile", "description": "block consisting of single string fields:\n" }, "gcs": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptGcs:JobTaskNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptS3:JobTaskNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptVolumes:JobTaskNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/JobTaskNewClusterInitScriptWorkspace:JobTaskNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/JobTaskNewClusterInitScriptAbfss:JobTaskNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterInitScriptDbfs:JobTaskNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterInitScriptFile:JobTaskNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterInitScriptGcs:JobTaskNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterInitScriptS3:JobTaskNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterInitScriptVolumes:JobTaskNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterInitScriptWorkspace:JobTaskNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/JobTaskNewClusterLibrary:JobTaskNewClusterLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/JobTaskNewClusterLibraryCran:JobTaskNewClusterLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/JobTaskNewClusterLibraryMaven:JobTaskNewClusterLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/JobTaskNewClusterLibraryProviderConfig:JobTaskNewClusterLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/JobTaskNewClusterLibraryPypi:JobTaskNewClusterLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "providerConfig" ] } } }, "databricks:index/JobTaskNewClusterLibraryCran:JobTaskNewClusterLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskNewClusterLibraryMaven:JobTaskNewClusterLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/JobTaskNewClusterLibraryProviderConfig:JobTaskNewClusterLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobTaskNewClusterLibraryPypi:JobTaskNewClusterLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/JobTaskNewClusterProviderConfig:JobTaskNewClusterProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/JobTaskNewClusterWorkerNodeTypeFlexibility:JobTaskNewClusterWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobTaskNewClusterWorkloadType:JobTaskNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/JobTaskNewClusterWorkloadTypeClients:JobTaskNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/JobTaskNewClusterWorkloadTypeClients:JobTaskNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/JobTaskNotebookTask:JobTaskNotebookTask": { "properties": { "baseParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Base parameters to be used for each run of this job. If the run is initiated by a call to run-now with parameters specified, the two parameters maps will be merged. If the same key is specified in\u003cspan pulumi-lang-nodejs=\" baseParameters \" pulumi-lang-dotnet=\" BaseParameters \" pulumi-lang-go=\" baseParameters \" pulumi-lang-python=\" base_parameters \" pulumi-lang-yaml=\" baseParameters \" pulumi-lang-java=\" baseParameters \" pulumi-lang-hcl=\" base_parameters \"\u003e baseParameters \u003c/span\u003eand in run-now, the value from run-now will be used. If the notebook takes a parameter that is not specified in the job's\u003cspan pulumi-lang-nodejs=\" baseParameters \" pulumi-lang-dotnet=\" BaseParameters \" pulumi-lang-go=\" baseParameters \" pulumi-lang-python=\" base_parameters \" pulumi-lang-yaml=\" baseParameters \" pulumi-lang-java=\" baseParameters \" pulumi-lang-hcl=\" base_parameters \"\u003e baseParameters \u003c/span\u003eor the run-now override parameters, the default value from the notebook will be used. Retrieve these parameters in a notebook using `dbutils.widgets.get`.\n" }, "notebookPath": { "type": "string", "description": "The path of the\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto be run in the Databricks workspace or remote repository. For notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash. For notebooks stored in a remote repository, the path must be relative. This field is required.\n" }, "source": { "type": "string", "description": "Location type of the notebook, can only be `WORKSPACE` or `GIT`. When set to `WORKSPACE`, the notebook will be retrieved from the local Databricks workspace. When set to `GIT`, the notebook will be retrieved from a Git repository defined in \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e. If the value is empty, the task will use `GIT` if \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e is defined and `WORKSPACE` otherwise.\n" }, "warehouseId": { "type": "string", "description": "ID of the (the databricks_sql_endpoint) that will be used to execute the task with SQL notebook.\n" } }, "type": "object", "required": [ "notebookPath" ] }, "databricks:index/JobTaskNotificationSettings:JobTaskNotificationSettings": { "properties": { "alertOnLastAttempt": { "type": "boolean", "description": "(Bool) do not send notifications to recipients specified in \u003cspan pulumi-lang-nodejs=\"`onStart`\" pulumi-lang-dotnet=\"`OnStart`\" pulumi-lang-go=\"`onStart`\" pulumi-lang-python=\"`on_start`\" pulumi-lang-yaml=\"`onStart`\" pulumi-lang-java=\"`onStart`\" pulumi-lang-hcl=\"`on_start`\"\u003e`onStart`\u003c/span\u003e for the retried runs and do not send notifications to recipients specified in \u003cspan pulumi-lang-nodejs=\"`onFailure`\" pulumi-lang-dotnet=\"`OnFailure`\" pulumi-lang-go=\"`onFailure`\" pulumi-lang-python=\"`on_failure`\" pulumi-lang-yaml=\"`onFailure`\" pulumi-lang-java=\"`onFailure`\" pulumi-lang-hcl=\"`on_failure`\"\u003e`onFailure`\u003c/span\u003e until the last retry of the run.\n" }, "noAlertForCanceledRuns": { "type": "boolean", "description": "(Bool) don't send alert for cancelled runs.\n\nThe following parameter is only available on task level.\n" }, "noAlertForSkippedRuns": { "type": "boolean", "description": "(Bool) don't send alert for skipped runs.\n" } }, "type": "object" }, "databricks:index/JobTaskPipelineTask:JobTaskPipelineTask": { "properties": { "fullRefresh": { "type": "boolean", "description": "(Bool) Specifies if there should be full refresh of the pipeline.\n\n\u003e The following configuration blocks are only supported inside a \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block\n" }, "fullRefreshSelections": { "type": "array", "items": { "type": "string" } }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "pipelineId": { "type": "string", "description": "The pipeline's unique ID.\n" }, "refreshFlowSelections": { "type": "array", "items": { "type": "string" } }, "refreshSelections": { "type": "array", "items": { "type": "string" } }, "resetCheckpointSelections": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "pipelineId" ] }, "databricks:index/JobTaskPowerBiTask:JobTaskPowerBiTask": { "properties": { "connectionResourceName": { "type": "string", "description": "The resource name of the UC connection to authenticate from Databricks to Power BI\n" }, "powerBiModel": { "$ref": "#/types/databricks:index/JobTaskPowerBiTaskPowerBiModel:JobTaskPowerBiTaskPowerBiModel", "description": "The semantic model to update. Block consists of following fields:\n" }, "refreshAfterUpdate": { "type": "boolean", "description": "Whether the model should be refreshed after the update. Default is false\n" }, "tables": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskPowerBiTaskTable:JobTaskPowerBiTaskTable" }, "description": "The tables to be exported to Power BI. Block consists of following fields:\n" }, "warehouseId": { "type": "string", "description": "The SQL warehouse ID to use as the Power BI data source\n" } }, "type": "object" }, "databricks:index/JobTaskPowerBiTaskPowerBiModel:JobTaskPowerBiTaskPowerBiModel": { "properties": { "authenticationMethod": { "type": "string", "description": "How the published Power BI model authenticates to Databricks\n" }, "modelName": { "type": "string", "description": "The name of the Power BI model\n" }, "overwriteExisting": { "type": "boolean", "description": "Whether to overwrite existing Power BI models. Default is false\n" }, "storageMode": { "type": "string", "description": "The default storage mode of the Power BI model\n" }, "workspaceName": { "type": "string", "description": "The name of the Power BI workspace of the model\n" } }, "type": "object" }, "databricks:index/JobTaskPowerBiTaskTable:JobTaskPowerBiTaskTable": { "properties": { "catalog": { "type": "string", "description": "The catalog name in Databricks\n" }, "name": { "type": "string", "description": "The table name in Databricks. If empty, all tables under the schema are selected.\n" }, "schema": { "type": "string", "description": "The schema name in Databricks\n" }, "storageMode": { "type": "string", "description": "The Power BI storage mode of the table\n" } }, "type": "object" }, "databricks:index/JobTaskPythonOperatorTask:JobTaskPythonOperatorTask": { "properties": { "main": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskPythonOperatorTaskParameter:JobTaskPythonOperatorTaskParameter" } } }, "type": "object" }, "databricks:index/JobTaskPythonOperatorTaskParameter:JobTaskPythonOperatorTaskParameter": { "properties": { "name": { "type": "string", "description": "An optional name for the job. The default value is Untitled.\n" }, "value": { "type": "string", "description": "integer value used to compare to the given metric.\n" } }, "type": "object" }, "databricks:index/JobTaskPythonWheelTask:JobTaskPythonWheelTask": { "properties": { "entryPoint": { "type": "string", "description": "Python function as entry point for the task\n" }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Named parameters for the task\n" }, "packageName": { "type": "string", "description": "Name of Python package\n" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Parameters for the task\n" } }, "type": "object" }, "databricks:index/JobTaskRunJobTask:JobTaskRunJobTask": { "properties": { "dbtCommands": { "type": "array", "items": { "type": "string" } }, "jarParams": { "type": "array", "items": { "type": "string" } }, "jobId": { "type": "integer", "description": "(String) ID of the job\n" }, "jobParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Job parameters for the task\n" }, "notebookParams": { "type": "object", "additionalProperties": { "type": "string" } }, "pipelineParams": { "$ref": "#/types/databricks:index/JobTaskRunJobTaskPipelineParams:JobTaskRunJobTaskPipelineParams" }, "pythonNamedParams": { "type": "object", "additionalProperties": { "type": "string" } }, "pythonParams": { "type": "array", "items": { "type": "string" } }, "sparkSubmitParams": { "type": "array", "items": { "type": "string" } }, "sqlParams": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "jobId" ] }, "databricks:index/JobTaskRunJobTaskPipelineParams:JobTaskRunJobTaskPipelineParams": { "properties": { "fullRefresh": { "type": "boolean", "description": "(Bool) Specifies if there should be full refresh of the pipeline.\n\n\u003e The following configuration blocks are only supported inside a \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block\n" }, "fullRefreshSelections": { "type": "array", "items": { "type": "string" } }, "refreshFlowSelections": { "type": "array", "items": { "type": "string" } }, "refreshSelections": { "type": "array", "items": { "type": "string" } }, "resetCheckpointSelections": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/JobTaskSparkJarTask:JobTaskSparkJarTask": { "properties": { "jarUri": { "type": "string" }, "mainClassName": { "type": "string", "description": "The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. The code should use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job will fail.\n" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Parameters passed to the main method.\n" }, "runAsRepl": { "type": "boolean" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "runAsRepl" ] } } }, "databricks:index/JobTaskSparkPythonTask:JobTaskSparkPythonTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Command line parameters passed to the Python file.\n" }, "pythonFile": { "type": "string", "description": "The URI of the Python file to be executed. Cloud file URIs (e.g. `s3:/`, `abfss:/`, `gs:/`), workspace paths and remote repository are supported. For Python files stored in the Databricks workspace, the path must be absolute and begin with `/`. For files stored in a remote repository, the path must be relative. This field is required.\n" }, "source": { "type": "string", "description": "Location type of the Python file. When set to `WORKSPACE` or not specified, the file will be retrieved from the local Databricks workspace or cloud location (if the\u003cspan pulumi-lang-nodejs=\" pythonFile \" pulumi-lang-dotnet=\" PythonFile \" pulumi-lang-go=\" pythonFile \" pulumi-lang-python=\" python_file \" pulumi-lang-yaml=\" pythonFile \" pulumi-lang-java=\" pythonFile \" pulumi-lang-hcl=\" python_file \"\u003e pythonFile \u003c/span\u003ehas a URI format). When set to `GIT`, the Python file will be retrieved from a Git repository defined in \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e.\n* `WORKSPACE`: The Python file is located in a Databricks workspace or at a cloud filesystem URI.\n* `GIT`: The Python file is located in a remote Git repository.\n" } }, "type": "object", "required": [ "pythonFile" ] }, "databricks:index/JobTaskSparkSubmitTask:JobTaskSparkSubmitTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" }, "description": "(List) Command-line parameters passed to spark submit.\n" } }, "type": "object" }, "databricks:index/JobTaskSqlTask:JobTaskSqlTask": { "properties": { "alert": { "$ref": "#/types/databricks:index/JobTaskSqlTaskAlert:JobTaskSqlTaskAlert", "description": "block consisting of following fields:\n" }, "dashboard": { "$ref": "#/types/databricks:index/JobTaskSqlTaskDashboard:JobTaskSqlTaskDashboard", "description": "block consisting of following fields:\n" }, "file": { "$ref": "#/types/databricks:index/JobTaskSqlTaskFile:JobTaskSqlTaskFile", "description": "block consisting of single string fields:\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) parameters to be used for each run of this task. The SQL alert task does not support custom parameters.\n" }, "query": { "$ref": "#/types/databricks:index/JobTaskSqlTaskQuery:JobTaskSqlTaskQuery", "description": "block consisting of single string field: \u003cspan pulumi-lang-nodejs=\"`queryId`\" pulumi-lang-dotnet=\"`QueryId`\" pulumi-lang-go=\"`queryId`\" pulumi-lang-python=\"`query_id`\" pulumi-lang-yaml=\"`queryId`\" pulumi-lang-java=\"`queryId`\" pulumi-lang-hcl=\"`query_id`\"\u003e`queryId`\u003c/span\u003e - identifier of the Databricks Query (databricks_query).\n" }, "warehouseId": { "type": "string", "description": "ID of the (the databricks_sql_endpoint) that will be used to execute the task. Only Serverless \u0026 Pro warehouses are supported right now.\n" } }, "type": "object", "required": [ "warehouseId" ] }, "databricks:index/JobTaskSqlTaskAlert:JobTaskSqlTaskAlert": { "properties": { "alertId": { "type": "string", "description": "(String) identifier of the Databricks Alert (databricks_alert).\n" }, "pauseSubscriptions": { "type": "boolean", "description": "flag that specifies if subscriptions are paused or not.\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskSqlTaskAlertSubscription:JobTaskSqlTaskAlertSubscription" }, "description": "a list of subscription blocks consisting out of one of the required fields: \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e for user emails or \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e - for Alert destination's identifier.\n" } }, "type": "object", "required": [ "alertId" ] }, "databricks:index/JobTaskSqlTaskAlertSubscription:JobTaskSqlTaskAlertSubscription": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskSqlTaskDashboard:JobTaskSqlTaskDashboard": { "properties": { "customSubject": { "type": "string", "description": "string specifying a custom subject of email sent.\n" }, "dashboardId": { "type": "string", "description": "(String) identifier of the Databricks SQL Dashboard databricks_sql_dashboard.\n" }, "pauseSubscriptions": { "type": "boolean", "description": "flag that specifies if subscriptions are paused or not.\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskSqlTaskDashboardSubscription:JobTaskSqlTaskDashboardSubscription" }, "description": "a list of subscription blocks consisting out of one of the required fields: \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e for user emails or \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e - for Alert destination's identifier.\n" } }, "type": "object", "required": [ "dashboardId" ] }, "databricks:index/JobTaskSqlTaskDashboardSubscription:JobTaskSqlTaskDashboardSubscription": { "properties": { "destinationId": { "type": "string", "description": "A snapshot of the dashboard will be sent to the destination when the \u003cspan pulumi-lang-nodejs=\"`destinationId`\" pulumi-lang-dotnet=\"`DestinationId`\" pulumi-lang-go=\"`destinationId`\" pulumi-lang-python=\"`destination_id`\" pulumi-lang-yaml=\"`destinationId`\" pulumi-lang-java=\"`destinationId`\" pulumi-lang-hcl=\"`destination_id`\"\u003e`destinationId`\u003c/span\u003e field is present.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/JobTaskSqlTaskFile:JobTaskSqlTaskFile": { "properties": { "path": { "type": "string", "description": "If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `GIT`: Relative path to the file in the repository specified in the \u003cspan pulumi-lang-nodejs=\"`gitSource`\" pulumi-lang-dotnet=\"`GitSource`\" pulumi-lang-go=\"`gitSource`\" pulumi-lang-python=\"`git_source`\" pulumi-lang-yaml=\"`gitSource`\" pulumi-lang-java=\"`gitSource`\" pulumi-lang-hcl=\"`git_source`\"\u003e`gitSource`\u003c/span\u003e block with SQL commands to execute. If \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is `WORKSPACE`: Absolute path to the file in the workspace with SQL commands to execute.\n\nExample\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sqlAggregationJob = new databricks.Job(\"sql_aggregation_job\", {\n name: \"Example SQL Job\",\n tasks: [\n {\n taskKey: \"run_agg_query\",\n sqlTask: {\n warehouseId: sqlJobWarehouse.id,\n query: {\n queryId: aggQuery.id,\n },\n },\n },\n {\n taskKey: \"run_dashboard\",\n sqlTask: {\n warehouseId: sqlJobWarehouse.id,\n dashboard: {\n dashboardId: dash.id,\n subscriptions: [{\n userName: \"user@domain.com\",\n }],\n },\n },\n },\n {\n taskKey: \"run_alert\",\n sqlTask: {\n warehouseId: sqlJobWarehouse.id,\n alert: {\n alertId: alert.id,\n subscriptions: [{\n userName: \"user@domain.com\",\n }],\n },\n },\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsql_aggregation_job = databricks.Job(\"sql_aggregation_job\",\n name=\"Example SQL Job\",\n tasks=[\n {\n \"task_key\": \"run_agg_query\",\n \"sql_task\": {\n \"warehouse_id\": sql_job_warehouse[\"id\"],\n \"query\": {\n \"query_id\": agg_query[\"id\"],\n },\n },\n },\n {\n \"task_key\": \"run_dashboard\",\n \"sql_task\": {\n \"warehouse_id\": sql_job_warehouse[\"id\"],\n \"dashboard\": {\n \"dashboard_id\": dash[\"id\"],\n \"subscriptions\": [{\n \"user_name\": \"user@domain.com\",\n }],\n },\n },\n },\n {\n \"task_key\": \"run_alert\",\n \"sql_task\": {\n \"warehouse_id\": sql_job_warehouse[\"id\"],\n \"alert\": {\n \"alert_id\": alert[\"id\"],\n \"subscriptions\": [{\n \"user_name\": \"user@domain.com\",\n }],\n },\n },\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sqlAggregationJob = new Databricks.Job(\"sql_aggregation_job\", new()\n {\n Name = \"Example SQL Job\",\n Tasks = new[]\n {\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"run_agg_query\",\n SqlTask = new Databricks.Inputs.JobTaskSqlTaskArgs\n {\n WarehouseId = sqlJobWarehouse.Id,\n Query = new Databricks.Inputs.JobTaskSqlTaskQueryArgs\n {\n QueryId = aggQuery.Id,\n },\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"run_dashboard\",\n SqlTask = new Databricks.Inputs.JobTaskSqlTaskArgs\n {\n WarehouseId = sqlJobWarehouse.Id,\n Dashboard = new Databricks.Inputs.JobTaskSqlTaskDashboardArgs\n {\n DashboardId = dash.Id,\n Subscriptions = new[]\n {\n new Databricks.Inputs.JobTaskSqlTaskDashboardSubscriptionArgs\n {\n UserName = \"user@domain.com\",\n },\n },\n },\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"run_alert\",\n SqlTask = new Databricks.Inputs.JobTaskSqlTaskArgs\n {\n WarehouseId = sqlJobWarehouse.Id,\n Alert = new Databricks.Inputs.JobTaskSqlTaskAlertArgs\n {\n AlertId = alert.Id,\n Subscriptions = new[]\n {\n new Databricks.Inputs.JobTaskSqlTaskAlertSubscriptionArgs\n {\n UserName = \"user@domain.com\",\n },\n },\n },\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewJob(ctx, \"sql_aggregation_job\", \u0026databricks.JobArgs{\n\t\t\tName: pulumi.String(\"Example SQL Job\"),\n\t\t\tTasks: databricks.JobTaskArray{\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"run_agg_query\"),\n\t\t\t\t\tSqlTask: \u0026databricks.JobTaskSqlTaskArgs{\n\t\t\t\t\t\tWarehouseId: pulumi.Any(sqlJobWarehouse.Id),\n\t\t\t\t\t\tQuery: \u0026databricks.JobTaskSqlTaskQueryArgs{\n\t\t\t\t\t\t\tQueryId: pulumi.Any(aggQuery.Id),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"run_dashboard\"),\n\t\t\t\t\tSqlTask: \u0026databricks.JobTaskSqlTaskArgs{\n\t\t\t\t\t\tWarehouseId: pulumi.Any(sqlJobWarehouse.Id),\n\t\t\t\t\t\tDashboard: \u0026databricks.JobTaskSqlTaskDashboardArgs{\n\t\t\t\t\t\t\tDashboardId: pulumi.Any(dash.Id),\n\t\t\t\t\t\t\tSubscriptions: databricks.JobTaskSqlTaskDashboardSubscriptionArray{\n\t\t\t\t\t\t\t\t\u0026databricks.JobTaskSqlTaskDashboardSubscriptionArgs{\n\t\t\t\t\t\t\t\t\tUserName: pulumi.String(\"user@domain.com\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"run_alert\"),\n\t\t\t\t\tSqlTask: \u0026databricks.JobTaskSqlTaskArgs{\n\t\t\t\t\t\tWarehouseId: pulumi.Any(sqlJobWarehouse.Id),\n\t\t\t\t\t\tAlert: \u0026databricks.JobTaskSqlTaskAlertArgs{\n\t\t\t\t\t\t\tAlertId: pulumi.Any(alert.Id),\n\t\t\t\t\t\t\tSubscriptions: databricks.JobTaskSqlTaskAlertSubscriptionArray{\n\t\t\t\t\t\t\t\t\u0026databricks.JobTaskSqlTaskAlertSubscriptionArgs{\n\t\t\t\t\t\t\t\t\tUserName: pulumi.String(\"user@domain.com\"),\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_job\" \"sql_aggregation_job\" {\n name = \"Example SQL Job\"\n tasks {\n task_key = \"run_agg_query\"\n sql_task = {\n warehouse_id = sqlJobWarehouse.id\n query = {\n query_id = aggQuery.id\n }\n }\n }\n tasks {\n task_key = \"run_dashboard\"\n sql_task = {\n warehouse_id = sqlJobWarehouse.id\n dashboard = {\n dashboard_id = dash.id\n subscriptions = [{\n \"userName\" = \"user@domain.com\"\n }]\n }\n }\n }\n tasks {\n task_key = \"run_alert\"\n sql_task = {\n warehouse_id = sqlJobWarehouse.id\n alert = {\n alert_id = alert.id\n subscriptions = [{\n \"userName\" = \"user@domain.com\"\n }]\n }\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Job;\nimport com.pulumi.databricks.JobArgs;\nimport com.pulumi.databricks.inputs.JobTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskQueryArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskDashboardArgs;\nimport com.pulumi.databricks.inputs.JobTaskSqlTaskAlertArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sqlAggregationJob = new Job(\"sqlAggregationJob\", JobArgs.builder()\n .name(\"Example SQL Job\")\n .tasks( \n JobTaskArgs.builder()\n .taskKey(\"run_agg_query\")\n .sqlTask(JobTaskSqlTaskArgs.builder()\n .warehouseId(sqlJobWarehouse.id())\n .query(JobTaskSqlTaskQueryArgs.builder()\n .queryId(aggQuery.id())\n .build())\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"run_dashboard\")\n .sqlTask(JobTaskSqlTaskArgs.builder()\n .warehouseId(sqlJobWarehouse.id())\n .dashboard(JobTaskSqlTaskDashboardArgs.builder()\n .dashboardId(dash.id())\n .subscriptions(JobTaskSqlTaskDashboardSubscriptionArgs.builder()\n .userName(\"user@domain.com\")\n .build())\n .build())\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"run_alert\")\n .sqlTask(JobTaskSqlTaskArgs.builder()\n .warehouseId(sqlJobWarehouse.id())\n .alert(JobTaskSqlTaskAlertArgs.builder()\n .alertId(alert.id())\n .subscriptions(JobTaskSqlTaskAlertSubscriptionArgs.builder()\n .userName(\"user@domain.com\")\n .build())\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sqlAggregationJob:\n type: databricks:Job\n name: sql_aggregation_job\n properties:\n name: Example SQL Job\n tasks:\n - taskKey: run_agg_query\n sqlTask:\n warehouseId: ${sqlJobWarehouse.id}\n query:\n queryId: ${aggQuery.id}\n - taskKey: run_dashboard\n sqlTask:\n warehouseId: ${sqlJobWarehouse.id}\n dashboard:\n dashboardId: ${dash.id}\n subscriptions:\n - userName: user@domain.com\n - taskKey: run_alert\n sqlTask:\n warehouseId: ${sqlJobWarehouse.id}\n alert:\n alertId: ${alert.id}\n subscriptions:\n - userName: user@domain.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "source": { "type": "string", "description": "The source of the project. Possible values are `WORKSPACE` and `GIT`.\n" } }, "type": "object", "required": [ "path" ] }, "databricks:index/JobTaskSqlTaskQuery:JobTaskSqlTaskQuery": { "properties": { "queryId": { "type": "string" } }, "type": "object", "required": [ "queryId" ] }, "databricks:index/JobTaskWebhookNotifications:JobTaskWebhookNotifications": { "properties": { "onDurationWarningThresholdExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskWebhookNotificationsOnDurationWarningThresholdExceeded:JobTaskWebhookNotificationsOnDurationWarningThresholdExceeded" }, "description": "(List) list of notification IDs to call when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the \u003cspan pulumi-lang-nodejs=\"`health`\" pulumi-lang-dotnet=\"`Health`\" pulumi-lang-go=\"`health`\" pulumi-lang-python=\"`health`\" pulumi-lang-yaml=\"`health`\" pulumi-lang-java=\"`health`\" pulumi-lang-hcl=\"`health`\"\u003e`health`\u003c/span\u003e block.\n" }, "onFailures": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskWebhookNotificationsOnFailure:JobTaskWebhookNotificationsOnFailure" }, "description": "(List) list of notification IDs to call when the run fails. A maximum of 3 destinations can be specified.\n" }, "onStarts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskWebhookNotificationsOnStart:JobTaskWebhookNotificationsOnStart" }, "description": "(List) list of notification IDs to call when the run starts. A maximum of 3 destinations can be specified.\n" }, "onStreamingBacklogExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskWebhookNotificationsOnStreamingBacklogExceeded:JobTaskWebhookNotificationsOnStreamingBacklogExceeded" }, "description": "(List) list of notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\n\nNote that the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e is not to be confused with the name of the alert destination. The \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e can be retrieved through the API or the URL of Databricks UI `https://\u003cworkspace host\u003e/sql/destinations/\u003cnotification id\u003e?o=\u003cworkspace id\u003e`\n\nExample\n\n" }, "onSuccesses": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTaskWebhookNotificationsOnSuccess:JobTaskWebhookNotificationsOnSuccess" }, "description": "(List) list of notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified.\n" } }, "type": "object" }, "databricks:index/JobTaskWebhookNotificationsOnDurationWarningThresholdExceeded:JobTaskWebhookNotificationsOnDurationWarningThresholdExceeded": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskWebhookNotificationsOnFailure:JobTaskWebhookNotificationsOnFailure": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskWebhookNotificationsOnStart:JobTaskWebhookNotificationsOnStart": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskWebhookNotificationsOnStreamingBacklogExceeded:JobTaskWebhookNotificationsOnStreamingBacklogExceeded": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTaskWebhookNotificationsOnSuccess:JobTaskWebhookNotificationsOnSuccess": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobTrigger:JobTrigger": { "properties": { "fileArrival": { "$ref": "#/types/databricks:index/JobTriggerFileArrival:JobTriggerFileArrival", "description": "configuration block to define a trigger for [File Arrival events](https://learn.microsoft.com/en-us/azure/databricks/workflows/jobs/file-arrival-triggers) consisting of following attributes:\n" }, "model": { "$ref": "#/types/databricks:index/JobTriggerModel:JobTriggerModel" }, "pauseStatus": { "type": "string", "description": "Indicate whether this trigger is paused or not. Either `PAUSED` or `UNPAUSED`. When the \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e field is omitted in the block, the server will default to using `UNPAUSED` as a value for \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e.\n" }, "periodic": { "$ref": "#/types/databricks:index/JobTriggerPeriodic:JobTriggerPeriodic", "description": "configuration block to define a trigger for Periodic Triggers consisting of the following attributes:\n" }, "tableUpdate": { "$ref": "#/types/databricks:index/JobTriggerTableUpdate:JobTriggerTableUpdate", "description": "configuration block to define a trigger for [Table Updates](https://docs.databricks.com/aws/en/jobs/trigger-table-update) consisting of following attributes:\n" } }, "type": "object" }, "databricks:index/JobTriggerFileArrival:JobTriggerFileArrival": { "properties": { "minTimeBetweenTriggersSeconds": { "type": "integer", "description": "If set, the trigger starts a run only after the specified amount of time passed since the last time the trigger fired. The minimum allowed value is 60 seconds.\n" }, "url": { "type": "string", "description": "URL to be monitored for file arrivals. The path must point to the root or a subpath of the external location. Please note that the URL must have a trailing slash character (`/`).\n" }, "waitAfterLastChangeSeconds": { "type": "integer", "description": "If set, the trigger starts a run only after no file activity has occurred for the specified amount of time. This makes it possible to wait for a batch of incoming files to arrive before triggering a run. The minimum allowed value is 60 seconds.\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/JobTriggerModel:JobTriggerModel": { "properties": { "aliases": { "type": "array", "items": { "type": "string" } }, "condition": { "type": "string", "description": "The table(s) condition based on which to trigger a job run. Possible values are `ANY_UPDATED`, `ALL_UPDATED`.\n" }, "minTimeBetweenTriggersSeconds": { "type": "integer" }, "securableName": { "type": "string" }, "waitAfterLastChangeSeconds": { "type": "integer" } }, "type": "object", "required": [ "condition" ] }, "databricks:index/JobTriggerPeriodic:JobTriggerPeriodic": { "properties": { "interval": { "type": "integer", "description": "Specifies the interval at which the job should run.\n" }, "unit": { "type": "string", "description": "The unit of time for the interval. Possible values are: `DAYS`, `HOURS`, `WEEKS`.\n" } }, "type": "object", "required": [ "interval", "unit" ] }, "databricks:index/JobTriggerTableUpdate:JobTriggerTableUpdate": { "properties": { "condition": { "type": "string", "description": "The table(s) condition based on which to trigger a job run. Possible values are `ANY_UPDATED`, `ALL_UPDATED`.\n" }, "minTimeBetweenTriggersSeconds": { "type": "integer", "description": "If set, the trigger starts a run only after the specified amount of time passed since the last time the trigger fired. The minimum allowed value is 60 seconds.\n" }, "tableNames": { "type": "array", "items": { "type": "string" }, "description": "A non-empty list of tables to monitor for changes. The table name must be in the format `catalog_name.schema_name.table_name`.\n" }, "waitAfterLastChangeSeconds": { "type": "integer", "description": "If set, the trigger starts a run only after no file activity has occurred for the specified amount of time. This makes it possible to wait for a batch of incoming files to arrive before triggering a run. The minimum allowed value is 60 seconds.\n" } }, "type": "object", "required": [ "tableNames" ] }, "databricks:index/JobWebhookNotifications:JobWebhookNotifications": { "properties": { "onDurationWarningThresholdExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobWebhookNotificationsOnDurationWarningThresholdExceeded:JobWebhookNotificationsOnDurationWarningThresholdExceeded" }, "description": "(List) list of notification IDs to call when the duration of a run exceeds the threshold specified by the `RUN_DURATION_SECONDS` metric in the \u003cspan pulumi-lang-nodejs=\"`health`\" pulumi-lang-dotnet=\"`Health`\" pulumi-lang-go=\"`health`\" pulumi-lang-python=\"`health`\" pulumi-lang-yaml=\"`health`\" pulumi-lang-java=\"`health`\" pulumi-lang-hcl=\"`health`\"\u003e`health`\u003c/span\u003e block.\n" }, "onFailures": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobWebhookNotificationsOnFailure:JobWebhookNotificationsOnFailure" }, "description": "(List) list of notification IDs to call when the run fails. A maximum of 3 destinations can be specified.\n" }, "onStarts": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobWebhookNotificationsOnStart:JobWebhookNotificationsOnStart" }, "description": "(List) list of notification IDs to call when the run starts. A maximum of 3 destinations can be specified.\n" }, "onStreamingBacklogExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobWebhookNotificationsOnStreamingBacklogExceeded:JobWebhookNotificationsOnStreamingBacklogExceeded" }, "description": "(List) list of notification IDs to call when any streaming backlog thresholds are exceeded for any stream.\n\nNote that the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e is not to be confused with the name of the alert destination. The \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e can be retrieved through the API or the URL of Databricks UI `https://\u003cworkspace host\u003e/sql/destinations/\u003cnotification id\u003e?o=\u003cworkspace id\u003e`\n\nExample\n\n" }, "onSuccesses": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobWebhookNotificationsOnSuccess:JobWebhookNotificationsOnSuccess" }, "description": "(List) list of notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified.\n" } }, "type": "object" }, "databricks:index/JobWebhookNotificationsOnDurationWarningThresholdExceeded:JobWebhookNotificationsOnDurationWarningThresholdExceeded": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobWebhookNotificationsOnFailure:JobWebhookNotificationsOnFailure": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobWebhookNotificationsOnStart:JobWebhookNotificationsOnStart": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobWebhookNotificationsOnStreamingBacklogExceeded:JobWebhookNotificationsOnStreamingBacklogExceeded": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/JobWebhookNotificationsOnSuccess:JobWebhookNotificationsOnSuccess": { "properties": { "id": { "type": "string", "description": "ID of the job\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/KnowledgeAssistantKnowledgeSourceFileTable:KnowledgeAssistantKnowledgeSourceFileTable": { "properties": { "fileCol": { "type": "string", "description": "The name of the column containing BINARY file content to be indexed\n" }, "tableName": { "type": "string", "description": "Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}\n" } }, "type": "object", "required": [ "fileCol", "tableName" ] }, "databricks:index/KnowledgeAssistantKnowledgeSourceFiles:KnowledgeAssistantKnowledgeSourceFiles": { "properties": { "path": { "type": "string", "description": "A UC volume path that includes a list of files\n" } }, "type": "object", "required": [ "path" ] }, "databricks:index/KnowledgeAssistantKnowledgeSourceIndex:KnowledgeAssistantKnowledgeSourceIndex": { "properties": { "docUriCol": { "type": "string", "description": "The column that specifies a link or reference to where the information came from\n" }, "indexName": { "type": "string", "description": "Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}\n" }, "textCol": { "type": "string", "description": "The column that includes the document text for retrieval\n" } }, "type": "object", "required": [ "docUriCol", "indexName", "textCol" ] }, "databricks:index/KnowledgeAssistantKnowledgeSourceProviderConfig:KnowledgeAssistantKnowledgeSourceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/KnowledgeAssistantProviderConfig:KnowledgeAssistantProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/LakehouseMonitorCustomMetric:LakehouseMonitorCustomMetric": { "properties": { "definition": { "type": "string", "description": "[create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)\n" }, "inputColumns": { "type": "array", "items": { "type": "string" }, "description": "Columns on the monitored table to apply the custom metrics to.\n" }, "name": { "type": "string", "description": "Name of the custom metric.\n" }, "outputDataType": { "type": "string", "description": "The output type of the custom metric.\n" }, "type": { "type": "string", "description": "The type of the custom metric.\n" } }, "type": "object", "required": [ "definition", "inputColumns", "name", "outputDataType", "type" ] }, "databricks:index/LakehouseMonitorDataClassificationConfig:LakehouseMonitorDataClassificationConfig": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "databricks:index/LakehouseMonitorInferenceLog:LakehouseMonitorInferenceLog": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "List of granularities to use when aggregating data into time windows based on their timestamp.\n" }, "labelCol": { "type": "string", "description": "Column of the model label\n" }, "modelIdCol": { "type": "string", "description": "Column of the model id or version\n" }, "predictionCol": { "type": "string", "description": "Column of the model prediction\n" }, "predictionProbaCol": { "type": "string", "description": "Column of the model prediction probabilities\n" }, "problemType": { "type": "string", "description": "Problem type the model aims to solve. Either `PROBLEM_TYPE_CLASSIFICATION` or `PROBLEM_TYPE_REGRESSION`\n" }, "timestampCol": { "type": "string", "description": "Column of the timestamp of predictions\n" } }, "type": "object", "required": [ "granularities", "modelIdCol", "predictionCol", "problemType", "timestampCol" ] }, "databricks:index/LakehouseMonitorNotifications:LakehouseMonitorNotifications": { "properties": { "onFailure": { "$ref": "#/types/databricks:index/LakehouseMonitorNotificationsOnFailure:LakehouseMonitorNotificationsOnFailure", "description": "who to send notifications to on monitor failure.\n" }, "onNewClassificationTagDetected": { "$ref": "#/types/databricks:index/LakehouseMonitorNotificationsOnNewClassificationTagDetected:LakehouseMonitorNotificationsOnNewClassificationTagDetected", "description": "Who to send notifications to when new data classification tags are detected.\n" } }, "type": "object" }, "databricks:index/LakehouseMonitorNotificationsOnFailure:LakehouseMonitorNotificationsOnFailure": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/LakehouseMonitorNotificationsOnNewClassificationTagDetected:LakehouseMonitorNotificationsOnNewClassificationTagDetected": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/LakehouseMonitorProviderConfig:LakehouseMonitorProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/LakehouseMonitorSchedule:LakehouseMonitorSchedule": { "properties": { "pauseStatus": { "type": "string", "description": "optional string field that indicates whether a schedule is paused (`PAUSED`) or not (`UNPAUSED`).\n" }, "quartzCronExpression": { "type": "string", "description": "string expression that determines when to run the monitor. See [Quartz documentation](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for examples.\n" }, "timezoneId": { "type": "string", "description": "string with timezone id (e.g., `PST`) in which to evaluate the Quartz expression.\n" } }, "type": "object", "required": [ "quartzCronExpression", "timezoneId" ], "language": { "nodejs": { "requiredOutputs": [ "pauseStatus", "quartzCronExpression", "timezoneId" ] } } }, "databricks:index/LakehouseMonitorSnapshot:LakehouseMonitorSnapshot": { "type": "object" }, "databricks:index/LakehouseMonitorTimeSeries:LakehouseMonitorTimeSeries": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "List of granularities to use when aggregating data into time windows based on their timestamp.\n" }, "timestampCol": { "type": "string", "description": "Column of the timestamp of predictions\n" } }, "type": "object", "required": [ "granularities", "timestampCol" ] }, "databricks:index/LibraryCran:LibraryCran": { "properties": { "package": { "type": "string", "description": "The name of the CRAN package to install.\n" }, "repo": { "type": "string", "description": "The repository where the package can be found. If not specified, the default CRAN repo is used.\n" } }, "type": "object", "required": [ "package" ] }, "databricks:index/LibraryMaven:LibraryMaven": { "properties": { "coordinates": { "type": "string", "description": "Gradle-style Maven coordinates. For example: `org.jsoup:jsoup:1.7.2`.\n" }, "exclusions": { "type": "array", "items": { "type": "string" }, "description": "List of dependencies to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`. See [Maven dependency exclusions](https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html) for more information.\n" }, "repo": { "type": "string", "description": "Maven repository to install the Maven package from. If omitted, both Maven Central Repository and Spark Packages are searched.\n" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/LibraryProviderConfig:LibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID that the resource belongs to. This workspace must be part of the account that the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ] }, "databricks:index/LibraryPypi:LibraryPypi": { "properties": { "package": { "type": "string", "description": "The name of the PyPI package to install. An optional exact version specification is also supported. For example: \u003cspan pulumi-lang-nodejs=\"`simplejson`\" pulumi-lang-dotnet=\"`Simplejson`\" pulumi-lang-go=\"`simplejson`\" pulumi-lang-python=\"`simplejson`\" pulumi-lang-yaml=\"`simplejson`\" pulumi-lang-java=\"`simplejson`\" pulumi-lang-hcl=\"`simplejson`\"\u003e`simplejson`\u003c/span\u003e or `simplejson==3.8.0`.\n" }, "repo": { "type": "string", "description": "The repository where the package can be found. If not specified, the default pip index is used.\n" } }, "type": "object", "required": [ "package" ] }, "databricks:index/MaterializedFeaturesFeatureTagProviderConfig:MaterializedFeaturesFeatureTagProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MetastoreAssignmentProviderConfig:MetastoreAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MetastoreDataAccessAwsIamRole:MetastoreDataAccessAwsIamRole": { "properties": { "externalId": { "type": "string" }, "roleArn": { "type": "string", "willReplaceOnChanges": true }, "unityCatalogIamArn": { "type": "string" } }, "type": "object", "required": [ "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "externalId", "roleArn", "unityCatalogIamArn" ] } } }, "databricks:index/MetastoreDataAccessAzureManagedIdentity:MetastoreDataAccessAzureManagedIdentity": { "properties": { "accessConnectorId": { "type": "string", "willReplaceOnChanges": true }, "credentialId": { "type": "string" }, "managedIdentityId": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "accessConnectorId" ], "language": { "nodejs": { "requiredOutputs": [ "accessConnectorId", "credentialId" ] } } }, "databricks:index/MetastoreDataAccessAzureServicePrincipal:MetastoreDataAccessAzureServicePrincipal": { "properties": { "applicationId": { "type": "string", "willReplaceOnChanges": true }, "clientSecret": { "type": "string", "secret": true, "willReplaceOnChanges": true }, "directoryId": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "applicationId", "clientSecret", "directoryId" ] }, "databricks:index/MetastoreDataAccessCloudflareApiToken:MetastoreDataAccessCloudflareApiToken": { "properties": { "accessKeyId": { "type": "string", "willReplaceOnChanges": true }, "accountId": { "type": "string", "willReplaceOnChanges": true }, "secretAccessKey": { "type": "string", "secret": true, "willReplaceOnChanges": true } }, "type": "object", "required": [ "accessKeyId", "accountId", "secretAccessKey" ] }, "databricks:index/MetastoreDataAccessDatabricksGcpServiceAccount:MetastoreDataAccessDatabricksGcpServiceAccount": { "properties": { "credentialId": { "type": "string" }, "email": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "credentialId", "email" ] } } }, "databricks:index/MetastoreDataAccessGcpServiceAccountKey:MetastoreDataAccessGcpServiceAccountKey": { "properties": { "email": { "type": "string", "willReplaceOnChanges": true }, "privateKey": { "type": "string", "secret": true, "willReplaceOnChanges": true }, "privateKeyId": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "email", "privateKey", "privateKeyId" ] }, "databricks:index/MetastoreDataAccessProviderConfig:MetastoreDataAccessProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MetastoreProviderConfig:MetastoreProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MetastoreProviderProviderConfig:MetastoreProviderProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MlflowExperimentProviderConfig:MlflowExperimentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MlflowExperimentTag:MlflowExperimentTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/MlflowModelProviderConfig:MlflowModelProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MlflowModelTag:MlflowModelTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/MlflowWebhookHttpUrlSpec:MlflowWebhookHttpUrlSpec": { "properties": { "authorization": { "type": "string", "description": "Value of the authorization header that should be sent in the request sent by the wehbook. It should be of the form `\u003cauth type\u003e \u003ccredentials\u003e`, e.g. `Bearer \u003caccess_token\u003e`. If set to an empty string, no authorization header will be included in the request.\n" }, "enableSslVerification": { "type": "boolean", "description": "Enable/disable SSL certificate validation. Default is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e. For self-signed certificates, this field must be \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e AND the destination server must disable certificate validation as well. For security purposes, it is encouraged to perform secret validation with the HMAC-encoded portion of the payload and acknowledge the risk associated with disabling hostname validation whereby it becomes more likely that requests can be maliciously routed to an unintended host.\n" }, "secret": { "type": "string", "description": "Shared secret required for HMAC encoding payload. The HMAC-encoded payload will be sent in the header as `X-Databricks-Signature:\u003cspan pulumi-lang-nodejs=\" encodedPayload`\" pulumi-lang-dotnet=\" EncodedPayload`\" pulumi-lang-go=\" encodedPayload`\" pulumi-lang-python=\" encoded_payload`\" pulumi-lang-yaml=\" encodedPayload`\" pulumi-lang-java=\" encodedPayload`\" pulumi-lang-hcl=\" encoded_payload`\"\u003e encodedPayload`\u003c/span\u003e.\n", "secret": true }, "url": { "type": "string", "description": "External HTTPS URL called on event trigger (by using a POST request). Structure of payload depends on the event type, refer to [documentation](https://docs.databricks.com/applications/mlflow/model-registry-webhooks.html) for more details.\n" } }, "type": "object", "required": [ "url" ] }, "databricks:index/MlflowWebhookJobSpec:MlflowWebhookJobSpec": { "properties": { "accessToken": { "type": "string", "description": "The personal access token used to authorize webhook's job runs.\n", "secret": true }, "jobId": { "type": "string", "description": "ID of the Databricks job that the webhook runs.\n" }, "workspaceUrl": { "type": "string", "description": "URL of the workspace containing the job that this webhook runs. If not specified, the job’s workspace URL is assumed to be the same as the workspace where the webhook is created.\n" } }, "type": "object", "required": [ "accessToken", "jobId" ] }, "databricks:index/MlflowWebhookProviderConfig:MlflowWebhookProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ModelServingAiGateway:ModelServingAiGateway": { "properties": { "fallbackConfig": { "$ref": "#/types/databricks:index/ModelServingAiGatewayFallbackConfig:ModelServingAiGatewayFallbackConfig", "description": "block with configuration for traffic fallback which auto fallbacks to other served entities if the request to a served entity fails with certain error codes, to increase availability.\n" }, "guardrails": { "$ref": "#/types/databricks:index/ModelServingAiGatewayGuardrails:ModelServingAiGatewayGuardrails", "description": "Block with configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. Consists of the following attributes:\n" }, "inferenceTableConfig": { "$ref": "#/types/databricks:index/ModelServingAiGatewayInferenceTableConfig:ModelServingAiGatewayInferenceTableConfig", "description": "Block describing the configuration of usage tracking. Consists of the following attributes:\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingAiGatewayRateLimit:ModelServingAiGatewayRateLimit" }, "description": "Block describing rate limits for AI gateway. For details see the description of \u003cspan pulumi-lang-nodejs=\"`rateLimits`\" pulumi-lang-dotnet=\"`RateLimits`\" pulumi-lang-go=\"`rateLimits`\" pulumi-lang-python=\"`rate_limits`\" pulumi-lang-yaml=\"`rateLimits`\" pulumi-lang-java=\"`rateLimits`\" pulumi-lang-hcl=\"`rate_limits`\"\u003e`rateLimits`\u003c/span\u003e block above.\n" }, "usageTrackingConfig": { "$ref": "#/types/databricks:index/ModelServingAiGatewayUsageTrackingConfig:ModelServingAiGatewayUsageTrackingConfig", "description": "Block with configuration for payload logging using inference tables. For details see the description of \u003cspan pulumi-lang-nodejs=\"`autoCaptureConfig`\" pulumi-lang-dotnet=\"`AutoCaptureConfig`\" pulumi-lang-go=\"`autoCaptureConfig`\" pulumi-lang-python=\"`auto_capture_config`\" pulumi-lang-yaml=\"`autoCaptureConfig`\" pulumi-lang-java=\"`autoCaptureConfig`\" pulumi-lang-hcl=\"`auto_capture_config`\"\u003e`autoCaptureConfig`\u003c/span\u003e block above.\n" } }, "type": "object" }, "databricks:index/ModelServingAiGatewayFallbackConfig:ModelServingAiGatewayFallbackConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable traffic fallback. When a served entity in the serving endpoint returns specific error codes (e.g. 500), the request will automatically be round-robin attempted with other served entities in the same endpoint, following the order of served entity list, until a successful response is returned.\n" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/ModelServingAiGatewayGuardrails:ModelServingAiGatewayGuardrails": { "properties": { "input": { "$ref": "#/types/databricks:index/ModelServingAiGatewayGuardrailsInput:ModelServingAiGatewayGuardrailsInput", "description": "A block with configuration for input guardrail filters:\n" }, "output": { "$ref": "#/types/databricks:index/ModelServingAiGatewayGuardrailsOutput:ModelServingAiGatewayGuardrailsOutput", "description": "A block with configuration for output guardrail filters. Has the same structure as \u003cspan pulumi-lang-nodejs=\"`input`\" pulumi-lang-dotnet=\"`Input`\" pulumi-lang-go=\"`input`\" pulumi-lang-python=\"`input`\" pulumi-lang-yaml=\"`input`\" pulumi-lang-java=\"`input`\" pulumi-lang-hcl=\"`input`\"\u003e`input`\u003c/span\u003e block.\n" } }, "type": "object" }, "databricks:index/ModelServingAiGatewayGuardrailsInput:ModelServingAiGatewayGuardrailsInput": { "properties": { "invalidKeywords": { "type": "array", "items": { "type": "string" }, "description": "List of invalid keywords. AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.\n", "deprecationMessage": "Please use 'pii' and 'safety' instead." }, "pii": { "$ref": "#/types/databricks:index/ModelServingAiGatewayGuardrailsInputPii:ModelServingAiGatewayGuardrailsInputPii", "description": "Block with configuration for guardrail PII filter:\n" }, "safety": { "type": "boolean", "description": "the boolean flag that indicates whether the safety filter is enabled.\n" }, "validTopics": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics.\n", "deprecationMessage": "Please use 'pii' and 'safety' instead." } }, "type": "object" }, "databricks:index/ModelServingAiGatewayGuardrailsInputPii:ModelServingAiGatewayGuardrailsInputPii": { "properties": { "behavior": { "type": "string", "description": "a string that describes the behavior for PII filter. Currently only `BLOCK` value is supported.\n" } }, "type": "object" }, "databricks:index/ModelServingAiGatewayGuardrailsOutput:ModelServingAiGatewayGuardrailsOutput": { "properties": { "invalidKeywords": { "type": "array", "items": { "type": "string" }, "description": "List of invalid keywords. AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.\n", "deprecationMessage": "Please use 'pii' and 'safety' instead." }, "pii": { "$ref": "#/types/databricks:index/ModelServingAiGatewayGuardrailsOutputPii:ModelServingAiGatewayGuardrailsOutputPii", "description": "Block with configuration for guardrail PII filter:\n" }, "safety": { "type": "boolean", "description": "the boolean flag that indicates whether the safety filter is enabled.\n" }, "validTopics": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics.\n", "deprecationMessage": "Please use 'pii' and 'safety' instead." } }, "type": "object" }, "databricks:index/ModelServingAiGatewayGuardrailsOutputPii:ModelServingAiGatewayGuardrailsOutputPii": { "properties": { "behavior": { "type": "string", "description": "a string that describes the behavior for PII filter. Currently only `BLOCK` value is supported.\n" } }, "type": "object" }, "databricks:index/ModelServingAiGatewayInferenceTableConfig:ModelServingAiGatewayInferenceTableConfig": { "properties": { "catalogName": { "type": "string", "description": "The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if it was already set.\n" }, "enabled": { "type": "boolean", "description": "boolean flag specifying if usage tracking is enabled.\n" }, "schemaName": { "type": "string", "description": "The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if it was already set.\n" }, "tableNamePrefix": { "type": "string", "description": "The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if it was already set.\n" } }, "type": "object" }, "databricks:index/ModelServingAiGatewayRateLimit:ModelServingAiGatewayRateLimit": { "properties": { "calls": { "type": "integer", "description": "Used to specify how many calls are allowed for a key within the renewal_period.\n" }, "key": { "type": "string", "description": "Key field for a serving endpoint rate limit. Currently, \u003cspan pulumi-lang-nodejs=\"`user`\" pulumi-lang-dotnet=\"`User`\" pulumi-lang-go=\"`user`\" pulumi-lang-python=\"`user`\" pulumi-lang-yaml=\"`user`\" pulumi-lang-java=\"`user`\" pulumi-lang-hcl=\"`user`\"\u003e`user`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`userGroup`\" pulumi-lang-dotnet=\"`UserGroup`\" pulumi-lang-go=\"`userGroup`\" pulumi-lang-python=\"`user_group`\" pulumi-lang-yaml=\"`userGroup`\" pulumi-lang-java=\"`userGroup`\" pulumi-lang-hcl=\"`user_group`\"\u003e`userGroup`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`servicePrincipal`\" pulumi-lang-dotnet=\"`ServicePrincipal`\" pulumi-lang-go=\"`servicePrincipal`\" pulumi-lang-python=\"`service_principal`\" pulumi-lang-yaml=\"`servicePrincipal`\" pulumi-lang-java=\"`servicePrincipal`\" pulumi-lang-hcl=\"`service_principal`\"\u003e`servicePrincipal`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e are supported, with \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e being the default if not specified.\n" }, "principal": { "type": "string", "description": "Principal field for a user, user group, or service principal to apply rate limiting to. Accepts a user email, group name, or service principal application ID.\n" }, "renewalPeriod": { "type": "string", "description": "Renewal period field for a serving endpoint rate limit. Currently, only \u003cspan pulumi-lang-nodejs=\"`minute`\" pulumi-lang-dotnet=\"`Minute`\" pulumi-lang-go=\"`minute`\" pulumi-lang-python=\"`minute`\" pulumi-lang-yaml=\"`minute`\" pulumi-lang-java=\"`minute`\" pulumi-lang-hcl=\"`minute`\"\u003e`minute`\u003c/span\u003e is supported.\n" }, "tokens": { "type": "integer", "description": "Specifies how many tokens are allowed for a key within the renewal_period.\n" } }, "type": "object", "required": [ "renewalPeriod" ] }, "databricks:index/ModelServingAiGatewayUsageTrackingConfig:ModelServingAiGatewayUsageTrackingConfig": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "databricks:index/ModelServingConfig:ModelServingConfig": { "properties": { "autoCaptureConfig": { "$ref": "#/types/databricks:index/ModelServingConfigAutoCaptureConfig:ModelServingConfigAutoCaptureConfig", "description": "Configuration for Inference Tables which automatically logs requests and responses to Unity Catalog.\n" }, "servedEntities": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntity:ModelServingConfigServedEntity" }, "description": "A list of served entities for the endpoint to serve. A serving endpoint can have up to 10 served entities.\n" }, "servedModels": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingConfigServedModel:ModelServingConfigServedModel" }, "description": "Each block represents a served model for the endpoint to serve. A model serving endpoint can have up to 10 served models.\n", "deprecationMessage": "Please use 'config.served_entities' instead of 'config.served_models'." }, "trafficConfig": { "$ref": "#/types/databricks:index/ModelServingConfigTrafficConfig:ModelServingConfigTrafficConfig", "description": "A single block represents the traffic split configuration amongst the served models.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "trafficConfig" ] } } }, "databricks:index/ModelServingConfigAutoCaptureConfig:ModelServingConfigAutoCaptureConfig": { "properties": { "catalogName": { "type": "string", "description": "The name of the catalog in Unity Catalog. NOTE: On update, you cannot change the catalog name if it was already set.\n", "willReplaceOnChanges": true }, "enabled": { "type": "boolean", "description": "If inference tables are enabled or not. NOTE: If you have already disabled payload logging once, you cannot enable it again.\n" }, "schemaName": { "type": "string", "description": "The name of the schema in Unity Catalog. NOTE: On update, you cannot change the schema name if it was already set.\n", "willReplaceOnChanges": true }, "tableNamePrefix": { "type": "string", "description": "The prefix of the table in Unity Catalog. NOTE: On update, you cannot change the prefix name if it was already set.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled", "tableNamePrefix" ] } } }, "databricks:index/ModelServingConfigServedEntity:ModelServingConfigServedEntity": { "properties": { "burstScalingEnabled": { "type": "boolean" }, "entityName": { "type": "string", "description": "The name of the entity to be served. The entity may be a model in the Databricks Model Registry, a model in the Unity Catalog (UC), or a function of type `FEATURE_SPEC` in the UC. If it is a UC object, the full name of the object should be given in the form of `catalog_name.schema_name.model_name`.\n" }, "entityVersion": { "type": "string", "description": "The version of the model in Databricks Model Registry to be served or empty if the entity is a `FEATURE_SPEC`.\n" }, "environmentVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "An object containing a set of optional, user-specified environment variable key-value pairs used for serving this entity. Note: this is an experimental feature and is subject to change. Example entity environment variables that refer to Databricks secrets: ```{\"OPENAI_API_KEY\": \"{{secrets/my_scope/my_key}}\", \"DATABRICKS_TOKEN\": \"{{secrets/my_scope2/my_key2}}\"}```\n" }, "externalModel": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModel:ModelServingConfigServedEntityExternalModel", "description": "The external model to be served. NOTE: Only one of \u003cspan pulumi-lang-nodejs=\"`externalModel`\" pulumi-lang-dotnet=\"`ExternalModel`\" pulumi-lang-go=\"`externalModel`\" pulumi-lang-python=\"`external_model`\" pulumi-lang-yaml=\"`externalModel`\" pulumi-lang-java=\"`externalModel`\" pulumi-lang-hcl=\"`external_model`\"\u003e`externalModel`\u003c/span\u003e and (\u003cspan pulumi-lang-nodejs=\"`entityName`\" pulumi-lang-dotnet=\"`EntityName`\" pulumi-lang-go=\"`entityName`\" pulumi-lang-python=\"`entity_name`\" pulumi-lang-yaml=\"`entityName`\" pulumi-lang-java=\"`entityName`\" pulumi-lang-hcl=\"`entity_name`\"\u003e`entityName`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`entityVersion`\" pulumi-lang-dotnet=\"`EntityVersion`\" pulumi-lang-go=\"`entityVersion`\" pulumi-lang-python=\"`entity_version`\" pulumi-lang-yaml=\"`entityVersion`\" pulumi-lang-java=\"`entityVersion`\" pulumi-lang-hcl=\"`entity_version`\"\u003e`entityVersion`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`workloadSize`\" pulumi-lang-dotnet=\"`WorkloadSize`\" pulumi-lang-go=\"`workloadSize`\" pulumi-lang-python=\"`workload_size`\" pulumi-lang-yaml=\"`workloadSize`\" pulumi-lang-java=\"`workloadSize`\" pulumi-lang-hcl=\"`workload_size`\"\u003e`workloadSize`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`workloadType`\" pulumi-lang-dotnet=\"`WorkloadType`\" pulumi-lang-go=\"`workloadType`\" pulumi-lang-python=\"`workload_type`\" pulumi-lang-yaml=\"`workloadType`\" pulumi-lang-java=\"`workloadType`\" pulumi-lang-hcl=\"`workload_type`\"\u003e`workloadType`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`scaleToZeroEnabled`\" pulumi-lang-dotnet=\"`ScaleToZeroEnabled`\" pulumi-lang-go=\"`scaleToZeroEnabled`\" pulumi-lang-python=\"`scale_to_zero_enabled`\" pulumi-lang-yaml=\"`scaleToZeroEnabled`\" pulumi-lang-java=\"`scaleToZeroEnabled`\" pulumi-lang-hcl=\"`scale_to_zero_enabled`\"\u003e`scaleToZeroEnabled`\u003c/span\u003e) can be specified with the latter set being used for custom model serving for a Databricks registered model. When an \u003cspan pulumi-lang-nodejs=\"`externalModel`\" pulumi-lang-dotnet=\"`ExternalModel`\" pulumi-lang-go=\"`externalModel`\" pulumi-lang-python=\"`external_model`\" pulumi-lang-yaml=\"`externalModel`\" pulumi-lang-java=\"`externalModel`\" pulumi-lang-hcl=\"`external_model`\"\u003e`externalModel`\u003c/span\u003e is present, the served entities list can only have one \u003cspan pulumi-lang-nodejs=\"`servedEntity`\" pulumi-lang-dotnet=\"`ServedEntity`\" pulumi-lang-go=\"`servedEntity`\" pulumi-lang-python=\"`served_entity`\" pulumi-lang-yaml=\"`servedEntity`\" pulumi-lang-java=\"`servedEntity`\" pulumi-lang-hcl=\"`served_entity`\"\u003e`servedEntity`\u003c/span\u003e object. An existing endpoint with \u003cspan pulumi-lang-nodejs=\"`externalModel`\" pulumi-lang-dotnet=\"`ExternalModel`\" pulumi-lang-go=\"`externalModel`\" pulumi-lang-python=\"`external_model`\" pulumi-lang-yaml=\"`externalModel`\" pulumi-lang-java=\"`externalModel`\" pulumi-lang-hcl=\"`external_model`\"\u003e`externalModel`\u003c/span\u003e can not be updated to an endpoint without \u003cspan pulumi-lang-nodejs=\"`externalModel`\" pulumi-lang-dotnet=\"`ExternalModel`\" pulumi-lang-go=\"`externalModel`\" pulumi-lang-python=\"`external_model`\" pulumi-lang-yaml=\"`externalModel`\" pulumi-lang-java=\"`externalModel`\" pulumi-lang-hcl=\"`external_model`\"\u003e`externalModel`\u003c/span\u003e. If the endpoint is created without \u003cspan pulumi-lang-nodejs=\"`externalModel`\" pulumi-lang-dotnet=\"`ExternalModel`\" pulumi-lang-go=\"`externalModel`\" pulumi-lang-python=\"`external_model`\" pulumi-lang-yaml=\"`externalModel`\" pulumi-lang-java=\"`externalModel`\" pulumi-lang-hcl=\"`external_model`\"\u003e`externalModel`\u003c/span\u003e, users cannot update it to add \u003cspan pulumi-lang-nodejs=\"`externalModel`\" pulumi-lang-dotnet=\"`ExternalModel`\" pulumi-lang-go=\"`externalModel`\" pulumi-lang-python=\"`external_model`\" pulumi-lang-yaml=\"`externalModel`\" pulumi-lang-java=\"`externalModel`\" pulumi-lang-hcl=\"`external_model`\"\u003e`externalModel`\u003c/span\u003e later.\n" }, "instanceProfileArn": { "type": "string", "description": "ARN of the instance profile that the served entity uses to access AWS resources.\n" }, "maxProvisionedConcurrency": { "type": "integer", "description": "The maximum provisioned concurrency that the endpoint can scale up to. Conflicts with \u003cspan pulumi-lang-nodejs=\"`workloadSize`\" pulumi-lang-dotnet=\"`WorkloadSize`\" pulumi-lang-go=\"`workloadSize`\" pulumi-lang-python=\"`workload_size`\" pulumi-lang-yaml=\"`workloadSize`\" pulumi-lang-java=\"`workloadSize`\" pulumi-lang-hcl=\"`workload_size`\"\u003e`workloadSize`\u003c/span\u003e.\n" }, "maxProvisionedThroughput": { "type": "integer", "description": "The maximum tokens per second that the endpoint can scale up to.\n" }, "minProvisionedConcurrency": { "type": "integer", "description": "The minimum provisioned concurrency that the endpoint can scale down to. Conflicts with \u003cspan pulumi-lang-nodejs=\"`workloadSize`\" pulumi-lang-dotnet=\"`WorkloadSize`\" pulumi-lang-go=\"`workloadSize`\" pulumi-lang-python=\"`workload_size`\" pulumi-lang-yaml=\"`workloadSize`\" pulumi-lang-java=\"`workloadSize`\" pulumi-lang-hcl=\"`workload_size`\"\u003e`workloadSize`\u003c/span\u003e.\n" }, "minProvisionedThroughput": { "type": "integer", "description": "The minimum tokens per second that the endpoint can scale down to.\n" }, "name": { "type": "string", "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field defaults to `external_model.name`, with '.' and ':' replaced with '-', and if not specified for other entities, it defaults to -.\n" }, "provisionedModelUnits": { "type": "integer" }, "scaleToZeroEnabled": { "type": "boolean", "description": "Whether the compute resources for the served entity should scale down to zero.\n" }, "workloadSize": { "type": "string", "description": "The workload size of the served entity. The workload size corresponds to a range of provisioned concurrency that the compute autoscales between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are `Small` (4 - 4 provisioned concurrency), `Medium` (8 - 16 provisioned concurrency), and `Large` (16 - 64 provisioned concurrency). If `scale-to-zero` is enabled, the lower bound of the provisioned concurrency for each workload size is 0. Conflicts with \u003cspan pulumi-lang-nodejs=\"`minProvisionedConcurrency`\" pulumi-lang-dotnet=\"`MinProvisionedConcurrency`\" pulumi-lang-go=\"`minProvisionedConcurrency`\" pulumi-lang-python=\"`min_provisioned_concurrency`\" pulumi-lang-yaml=\"`minProvisionedConcurrency`\" pulumi-lang-java=\"`minProvisionedConcurrency`\" pulumi-lang-hcl=\"`min_provisioned_concurrency`\"\u003e`minProvisionedConcurrency`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`maxProvisionedConcurrency`\" pulumi-lang-dotnet=\"`MaxProvisionedConcurrency`\" pulumi-lang-go=\"`maxProvisionedConcurrency`\" pulumi-lang-python=\"`max_provisioned_concurrency`\" pulumi-lang-yaml=\"`maxProvisionedConcurrency`\" pulumi-lang-java=\"`maxProvisionedConcurrency`\" pulumi-lang-hcl=\"`max_provisioned_concurrency`\"\u003e`maxProvisionedConcurrency`\u003c/span\u003e.\n" }, "workloadType": { "type": "string", "description": "The workload type of the served entity. The workload type selects which type of compute to use in the endpoint. The default value for this parameter is `CPU`. For deep learning workloads, GPU acceleration is available by selecting workload types like `GPU_SMALL` and others. See the available [GPU types](https://docs.databricks.com/machine-learning/model-serving/create-manage-serving-endpoints.html#gpu-workload-types).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "workloadType" ] } } }, "databricks:index/ModelServingConfigServedEntityExternalModel:ModelServingConfigServedEntityExternalModel": { "properties": { "ai21labsConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelAi21labsConfig:ModelServingConfigServedEntityExternalModelAi21labsConfig", "description": "AI21Labs Config\n" }, "amazonBedrockConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelAmazonBedrockConfig:ModelServingConfigServedEntityExternalModelAmazonBedrockConfig", "description": "Amazon Bedrock Config\n" }, "anthropicConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelAnthropicConfig:ModelServingConfigServedEntityExternalModelAnthropicConfig", "description": "Anthropic Config\n" }, "cohereConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelCohereConfig:ModelServingConfigServedEntityExternalModelCohereConfig", "description": "Cohere Config\n" }, "customProviderConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelCustomProviderConfig:ModelServingConfigServedEntityExternalModelCustomProviderConfig", "description": "Custom Provider Config. Only required if the provider is 'custom'.\n" }, "databricksModelServingConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelDatabricksModelServingConfig:ModelServingConfigServedEntityExternalModelDatabricksModelServingConfig", "description": "Databricks Model Serving Config\n" }, "googleCloudVertexAiConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelGoogleCloudVertexAiConfig:ModelServingConfigServedEntityExternalModelGoogleCloudVertexAiConfig", "description": "Google Cloud Vertex AI Config.\n" }, "name": { "type": "string", "description": "The name of the external model.\n" }, "openaiConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelOpenaiConfig:ModelServingConfigServedEntityExternalModelOpenaiConfig", "description": "OpenAI Config\n" }, "palmConfig": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelPalmConfig:ModelServingConfigServedEntityExternalModelPalmConfig", "description": "PaLM Config\n" }, "provider": { "type": "string", "description": "The name of the provider for the external model. Currently, the supported providers are \u003cspan pulumi-lang-nodejs=\"`ai21labs`\" pulumi-lang-dotnet=\"`Ai21labs`\" pulumi-lang-go=\"`ai21labs`\" pulumi-lang-python=\"`ai21labs`\" pulumi-lang-yaml=\"`ai21labs`\" pulumi-lang-java=\"`ai21labs`\" pulumi-lang-hcl=\"`ai21labs`\"\u003e`ai21labs`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`anthropic`\" pulumi-lang-dotnet=\"`Anthropic`\" pulumi-lang-go=\"`anthropic`\" pulumi-lang-python=\"`anthropic`\" pulumi-lang-yaml=\"`anthropic`\" pulumi-lang-java=\"`anthropic`\" pulumi-lang-hcl=\"`anthropic`\"\u003e`anthropic`\u003c/span\u003e, `amazon-bedrock`, \u003cspan pulumi-lang-nodejs=\"`cohere`\" pulumi-lang-dotnet=\"`Cohere`\" pulumi-lang-go=\"`cohere`\" pulumi-lang-python=\"`cohere`\" pulumi-lang-yaml=\"`cohere`\" pulumi-lang-java=\"`cohere`\" pulumi-lang-hcl=\"`cohere`\"\u003e`cohere`\u003c/span\u003e, `databricks-model-serving`, `google-cloud-vertex-ai`, \u003cspan pulumi-lang-nodejs=\"`openai`\" pulumi-lang-dotnet=\"`Openai`\" pulumi-lang-go=\"`openai`\" pulumi-lang-python=\"`openai`\" pulumi-lang-yaml=\"`openai`\" pulumi-lang-java=\"`openai`\" pulumi-lang-hcl=\"`openai`\"\u003e`openai`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`palm`\" pulumi-lang-dotnet=\"`Palm`\" pulumi-lang-go=\"`palm`\" pulumi-lang-python=\"`palm`\" pulumi-lang-yaml=\"`palm`\" pulumi-lang-java=\"`palm`\" pulumi-lang-hcl=\"`palm`\"\u003e`palm`\u003c/span\u003e.\n" }, "task": { "type": "string", "description": "The task type of the external model.\n" } }, "type": "object", "required": [ "name", "provider", "task" ] }, "databricks:index/ModelServingConfigServedEntityExternalModelAi21labsConfig:ModelServingConfigServedEntityExternalModelAi21labsConfig": { "properties": { "ai21labsApiKey": { "type": "string", "description": "The Databricks secret key reference for an AI21Labs API key.\n" }, "ai21labsApiKeyPlaintext": { "type": "string", "description": "An AI21 Labs API key provided as a plaintext string.\n", "secret": true } }, "type": "object" }, "databricks:index/ModelServingConfigServedEntityExternalModelAmazonBedrockConfig:ModelServingConfigServedEntityExternalModelAmazonBedrockConfig": { "properties": { "awsAccessKeyId": { "type": "string", "description": "The Databricks secret key reference for an AWS Access Key ID with permissions to interact with Bedrock services.\n" }, "awsAccessKeyIdPlaintext": { "type": "string", "description": "An AWS access key ID with permissions to interact with Bedrock services provided as a plaintext string.\n", "secret": true }, "awsRegion": { "type": "string", "description": "The AWS region to use. Bedrock has to be enabled there.\n" }, "awsSecretAccessKey": { "type": "string", "description": "The Databricks secret key reference for an AWS Secret Access Key paired with the access key ID, with permissions to interact with Bedrock services.\n" }, "awsSecretAccessKeyPlaintext": { "type": "string", "description": "An AWS secret access key paired with the access key ID, with permissions to interact with Bedrock services provided as a plaintext string.\n", "secret": true }, "bedrockProvider": { "type": "string", "description": "The underlying provider in Amazon Bedrock. Supported values (case insensitive) include: `Anthropic`, `Cohere`, `AI21Labs`, `Amazon`.\n" }, "instanceProfileArn": { "type": "string" } }, "type": "object", "required": [ "awsRegion", "bedrockProvider" ] }, "databricks:index/ModelServingConfigServedEntityExternalModelAnthropicConfig:ModelServingConfigServedEntityExternalModelAnthropicConfig": { "properties": { "anthropicApiKey": { "type": "string", "description": "The Databricks secret key reference for an Anthropic API key.\n" }, "anthropicApiKeyPlaintext": { "type": "string", "description": "The Anthropic API key provided as a plaintext string.\n", "secret": true } }, "type": "object" }, "databricks:index/ModelServingConfigServedEntityExternalModelCohereConfig:ModelServingConfigServedEntityExternalModelCohereConfig": { "properties": { "cohereApiBase": { "type": "string" }, "cohereApiKey": { "type": "string", "description": "The Databricks secret key reference for a Cohere API key.\n" }, "cohereApiKeyPlaintext": { "type": "string", "description": "The Cohere API key provided as a plaintext string.\n", "secret": true } }, "type": "object" }, "databricks:index/ModelServingConfigServedEntityExternalModelCustomProviderConfig:ModelServingConfigServedEntityExternalModelCustomProviderConfig": { "properties": { "apiKeyAuth": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth:ModelServingConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth", "description": "API key authentication for the custom provider API. Conflicts with \u003cspan pulumi-lang-nodejs=\"`bearerTokenAuth`\" pulumi-lang-dotnet=\"`BearerTokenAuth`\" pulumi-lang-go=\"`bearerTokenAuth`\" pulumi-lang-python=\"`bearer_token_auth`\" pulumi-lang-yaml=\"`bearerTokenAuth`\" pulumi-lang-java=\"`bearerTokenAuth`\" pulumi-lang-hcl=\"`bearer_token_auth`\"\u003e`bearerTokenAuth`\u003c/span\u003e.\n" }, "bearerTokenAuth": { "$ref": "#/types/databricks:index/ModelServingConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth:ModelServingConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth", "description": "bearer token authentication for the custom provider API. Conflicts with \u003cspan pulumi-lang-nodejs=\"`apiKeyAuth`\" pulumi-lang-dotnet=\"`ApiKeyAuth`\" pulumi-lang-go=\"`apiKeyAuth`\" pulumi-lang-python=\"`api_key_auth`\" pulumi-lang-yaml=\"`apiKeyAuth`\" pulumi-lang-java=\"`apiKeyAuth`\" pulumi-lang-hcl=\"`api_key_auth`\"\u003e`apiKeyAuth`\u003c/span\u003e.\n" }, "customProviderUrl": { "type": "string", "description": "URL of the custom provider API.\n" } }, "type": "object", "required": [ "customProviderUrl" ] }, "databricks:index/ModelServingConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth:ModelServingConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth": { "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "valuePlaintext": { "type": "string", "description": "The API Key provided as a plaintext string.\n", "secret": true } }, "type": "object", "required": [ "key" ] }, "databricks:index/ModelServingConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth:ModelServingConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth": { "properties": { "token": { "type": "string", "description": "The Databricks secret key reference for a token.\n" }, "tokenPlaintext": { "type": "string", "description": "The token provided as a plaintext string.\n", "secret": true } }, "type": "object" }, "databricks:index/ModelServingConfigServedEntityExternalModelDatabricksModelServingConfig:ModelServingConfigServedEntityExternalModelDatabricksModelServingConfig": { "properties": { "databricksApiToken": { "type": "string", "description": "The Databricks secret key reference for a Databricks API token that corresponds to a user or service principal with Can Query access to the model serving endpoint pointed to by this external model.\n" }, "databricksApiTokenPlaintext": { "type": "string", "description": "The Databricks API token that corresponds to a user or service principal with Can Query access to the model serving endpoint pointed to by this external model provided as a plaintext string.\n", "secret": true }, "databricksWorkspaceUrl": { "type": "string", "description": "The URL of the Databricks workspace containing the model serving endpoint pointed to by this external model.\n" } }, "type": "object", "required": [ "databricksWorkspaceUrl" ] }, "databricks:index/ModelServingConfigServedEntityExternalModelGoogleCloudVertexAiConfig:ModelServingConfigServedEntityExternalModelGoogleCloudVertexAiConfig": { "properties": { "privateKey": { "type": "string", "description": "The Databricks secret key reference for a private key for the service account that has access to the Google Cloud Vertex AI Service.\n" }, "privateKeyPlaintext": { "type": "string", "description": "The private key for the service account that has access to the Google Cloud Vertex AI Service is provided as a plaintext secret.\n", "secret": true }, "projectId": { "type": "string", "description": "This is the Google Cloud project id that the service account is associated with.\n" }, "region": { "type": "string", "description": "This is the region for the Google Cloud Vertex AI Service.\n" } }, "type": "object", "required": [ "projectId", "region" ] }, "databricks:index/ModelServingConfigServedEntityExternalModelOpenaiConfig:ModelServingConfigServedEntityExternalModelOpenaiConfig": { "properties": { "microsoftEntraClientId": { "type": "string", "description": "This field is only required for Azure AD OpenAI and is the Microsoft Entra Client ID.\n" }, "microsoftEntraClientSecret": { "type": "string", "description": "The Databricks secret key reference for a client secret used for Microsoft Entra ID authentication.\n" }, "microsoftEntraClientSecretPlaintext": { "type": "string", "description": "The client secret used for Microsoft Entra ID authentication provided as a plaintext string.\n", "secret": true }, "microsoftEntraTenantId": { "type": "string", "description": "This field is only required for Azure AD OpenAI and is the Microsoft Entra Tenant ID.\n" }, "openaiApiBase": { "type": "string", "description": "This is the base URL for the OpenAI API (default: \"\u003chttps://api.openai.com/v1\u003e\"). For Azure OpenAI, this field is required and is the base URL for the Azure OpenAI API service provided by Azure.\n" }, "openaiApiKey": { "type": "string", "description": "The Databricks secret key reference for an OpenAI or Azure OpenAI API key.\n" }, "openaiApiKeyPlaintext": { "type": "string", "description": "The OpenAI API key using the OpenAI or Azure service provided as a plaintext string.\n", "secret": true }, "openaiApiType": { "type": "string", "description": "This is an optional field to specify the type of OpenAI API to use. For Azure OpenAI, this field is required, and this parameter represents the preferred security access validation protocol. For access token validation, use \u003cspan pulumi-lang-nodejs=\"`azure`\" pulumi-lang-dotnet=\"`Azure`\" pulumi-lang-go=\"`azure`\" pulumi-lang-python=\"`azure`\" pulumi-lang-yaml=\"`azure`\" pulumi-lang-java=\"`azure`\" pulumi-lang-hcl=\"`azure`\"\u003e`azure`\u003c/span\u003e. For authentication using Azure Active Directory (Azure AD) use, \u003cspan pulumi-lang-nodejs=\"`azuread`\" pulumi-lang-dotnet=\"`Azuread`\" pulumi-lang-go=\"`azuread`\" pulumi-lang-python=\"`azuread`\" pulumi-lang-yaml=\"`azuread`\" pulumi-lang-java=\"`azuread`\" pulumi-lang-hcl=\"`azuread`\"\u003e`azuread`\u003c/span\u003e.\n" }, "openaiApiVersion": { "type": "string", "description": "This is an optional field to specify the OpenAI API version. For Azure OpenAI, this field is required and is the version of the Azure OpenAI service to utilize, specified by a date.\n" }, "openaiDeploymentName": { "type": "string", "description": "This field is only required for Azure OpenAI and is the name of the deployment resource for the Azure OpenAI service.\n" }, "openaiOrganization": { "type": "string", "description": "This is an optional field to specify the organization in OpenAI or Azure OpenAI.\n" } }, "type": "object" }, "databricks:index/ModelServingConfigServedEntityExternalModelPalmConfig:ModelServingConfigServedEntityExternalModelPalmConfig": { "properties": { "palmApiKey": { "type": "string", "description": "The Databricks secret key reference for a PaLM API key.\n" }, "palmApiKeyPlaintext": { "type": "string", "description": "The PaLM API key provided as a plaintext string.\n", "secret": true } }, "type": "object" }, "databricks:index/ModelServingConfigServedModel:ModelServingConfigServedModel": { "properties": { "burstScalingEnabled": { "type": "boolean" }, "environmentVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "a map of environment variable names/values that will be used for serving this model. Environment variables may refer to Databricks secrets using the standard syntax: `{{secrets/secret_scope/secret_key}}`.\n" }, "instanceProfileArn": { "type": "string", "description": "ARN of the instance profile that the served model will use to access AWS resources.\n" }, "maxProvisionedConcurrency": { "type": "integer", "description": "The maximum provisioned concurrency that the endpoint can scale up to. Conflicts with \u003cspan pulumi-lang-nodejs=\"`workloadSize`\" pulumi-lang-dotnet=\"`WorkloadSize`\" pulumi-lang-go=\"`workloadSize`\" pulumi-lang-python=\"`workload_size`\" pulumi-lang-yaml=\"`workloadSize`\" pulumi-lang-java=\"`workloadSize`\" pulumi-lang-hcl=\"`workload_size`\"\u003e`workloadSize`\u003c/span\u003e.\n" }, "maxProvisionedThroughput": { "type": "integer", "description": "The maximum tokens per second that the endpoint can scale up to.\n" }, "minProvisionedConcurrency": { "type": "integer", "description": "The minimum provisioned concurrency that the endpoint can scale down to. Conflicts with \u003cspan pulumi-lang-nodejs=\"`workloadSize`\" pulumi-lang-dotnet=\"`WorkloadSize`\" pulumi-lang-go=\"`workloadSize`\" pulumi-lang-python=\"`workload_size`\" pulumi-lang-yaml=\"`workloadSize`\" pulumi-lang-java=\"`workloadSize`\" pulumi-lang-hcl=\"`workload_size`\"\u003e`workloadSize`\u003c/span\u003e.\n" }, "minProvisionedThroughput": { "type": "integer", "description": "The minimum tokens per second that the endpoint can scale down to.\n" }, "modelName": { "type": "string", "description": "The name of the model in Databricks Model Registry to be served.\n" }, "modelVersion": { "type": "string", "description": "The version of the model in Databricks Model Registry to be served.\n" }, "name": { "type": "string", "description": "The name of a served model. It must be unique across an endpoint. If not specified, this field will default to `modelname-modelversion`. A served model name can consist of alphanumeric characters, dashes, and underscores.\n" }, "provisionedModelUnits": { "type": "integer" }, "scaleToZeroEnabled": { "type": "boolean", "description": "Whether the compute resources for the served model should scale down to zero. If `scale-to-zero` is enabled, the lower bound of the provisioned concurrency for each workload size will be 0. The default value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e.\n" }, "workloadSize": { "type": "string", "description": "The workload size of the served model. The workload size corresponds to a range of provisioned concurrency that the compute will autoscale between. A single unit of provisioned concurrency can process one request at a time. Valid workload sizes are `Small` (4 - 4 provisioned concurrency), `Medium` (8 - 16 provisioned concurrency), and `Large` (16 - 64 provisioned concurrency).\n" }, "workloadType": { "type": "string", "description": "The workload type of the served model. The workload type selects which type of compute to use in the endpoint. For deep learning workloads, GPU acceleration is available by selecting workload types like `GPU_SMALL` and others. See the documentation for all options. The default value is `CPU`.\n" } }, "type": "object", "required": [ "modelName", "modelVersion" ], "language": { "nodejs": { "requiredOutputs": [ "modelName", "modelVersion", "name", "workloadType" ] } } }, "databricks:index/ModelServingConfigTrafficConfig:ModelServingConfigTrafficConfig": { "properties": { "routes": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingConfigTrafficConfigRoute:ModelServingConfigTrafficConfigRoute" }, "description": "Each block represents a route that defines traffic to each served entity. Each \u003cspan pulumi-lang-nodejs=\"`servedEntity`\" pulumi-lang-dotnet=\"`ServedEntity`\" pulumi-lang-go=\"`servedEntity`\" pulumi-lang-python=\"`served_entity`\" pulumi-lang-yaml=\"`servedEntity`\" pulumi-lang-java=\"`servedEntity`\" pulumi-lang-hcl=\"`served_entity`\"\u003e`servedEntity`\u003c/span\u003e block needs to have a corresponding \u003cspan pulumi-lang-nodejs=\"`routes`\" pulumi-lang-dotnet=\"`Routes`\" pulumi-lang-go=\"`routes`\" pulumi-lang-python=\"`routes`\" pulumi-lang-yaml=\"`routes`\" pulumi-lang-java=\"`routes`\" pulumi-lang-hcl=\"`routes`\"\u003e`routes`\u003c/span\u003e block.\n" } }, "type": "object" }, "databricks:index/ModelServingConfigTrafficConfigRoute:ModelServingConfigTrafficConfigRoute": { "properties": { "servedEntityName": { "type": "string", "description": "The name of the served entity this route configures traffic for. This needs to match the name of a \u003cspan pulumi-lang-nodejs=\"`servedEntity`\" pulumi-lang-dotnet=\"`ServedEntity`\" pulumi-lang-go=\"`servedEntity`\" pulumi-lang-python=\"`served_entity`\" pulumi-lang-yaml=\"`servedEntity`\" pulumi-lang-java=\"`servedEntity`\" pulumi-lang-hcl=\"`served_entity`\"\u003e`servedEntity`\u003c/span\u003e block.\n" }, "servedModelName": { "type": "string" }, "trafficPercentage": { "type": "integer", "description": "The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive.\n" } }, "type": "object", "required": [ "trafficPercentage" ] }, "databricks:index/ModelServingEmailNotifications:ModelServingEmailNotifications": { "properties": { "onUpdateFailures": { "type": "array", "items": { "type": "string" }, "description": "a list of email addresses to be notified when an endpoint fails to update its configuration or state.\n" }, "onUpdateSuccesses": { "type": "array", "items": { "type": "string" }, "description": "a list of email addresses to be notified when an endpoint successfully updates its configuration or state.\n" } }, "type": "object" }, "databricks:index/ModelServingProviderConfig:ModelServingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ModelServingProvisionedThroughputAiGateway:ModelServingProvisionedThroughputAiGateway": { "properties": { "fallbackConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayFallbackConfig:ModelServingProvisionedThroughputAiGatewayFallbackConfig" }, "guardrails": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrails:ModelServingProvisionedThroughputAiGatewayGuardrails", "description": "Block with configuration for AI Guardrails to prevent unwanted data and unsafe data in requests and responses. Consists of the following attributes:\n" }, "inferenceTableConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayInferenceTableConfig:ModelServingProvisionedThroughputAiGatewayInferenceTableConfig", "description": "Block describing the configuration of usage tracking. Consists of the following attributes:\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayRateLimit:ModelServingProvisionedThroughputAiGatewayRateLimit" }, "description": "Block describing rate limits for AI gateway. For details see the description of \u003cspan pulumi-lang-nodejs=\"`rateLimits`\" pulumi-lang-dotnet=\"`RateLimits`\" pulumi-lang-go=\"`rateLimits`\" pulumi-lang-python=\"`rate_limits`\" pulumi-lang-yaml=\"`rateLimits`\" pulumi-lang-java=\"`rateLimits`\" pulumi-lang-hcl=\"`rate_limits`\"\u003e`rateLimits`\u003c/span\u003e block above.\n" }, "usageTrackingConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayUsageTrackingConfig:ModelServingProvisionedThroughputAiGatewayUsageTrackingConfig", "description": "Block with configuration for payload logging using inference tables. For details see the description of \u003cspan pulumi-lang-nodejs=\"`autoCaptureConfig`\" pulumi-lang-dotnet=\"`AutoCaptureConfig`\" pulumi-lang-go=\"`autoCaptureConfig`\" pulumi-lang-python=\"`auto_capture_config`\" pulumi-lang-yaml=\"`autoCaptureConfig`\" pulumi-lang-java=\"`autoCaptureConfig`\" pulumi-lang-hcl=\"`auto_capture_config`\"\u003e`autoCaptureConfig`\u003c/span\u003e block above.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "usageTrackingConfig" ] } } }, "databricks:index/ModelServingProvisionedThroughputAiGatewayFallbackConfig:ModelServingProvisionedThroughputAiGatewayFallbackConfig": { "properties": { "enabled": { "type": "boolean", "description": "boolean flag specifying if usage tracking is enabled.\n" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrails:ModelServingProvisionedThroughputAiGatewayGuardrails": { "properties": { "input": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsInput:ModelServingProvisionedThroughputAiGatewayGuardrailsInput", "description": "A block with configuration for input guardrail filters:\n" }, "output": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsOutput:ModelServingProvisionedThroughputAiGatewayGuardrailsOutput", "description": "A block with configuration for output guardrail filters. Has the same structure as \u003cspan pulumi-lang-nodejs=\"`input`\" pulumi-lang-dotnet=\"`Input`\" pulumi-lang-go=\"`input`\" pulumi-lang-python=\"`input`\" pulumi-lang-yaml=\"`input`\" pulumi-lang-java=\"`input`\" pulumi-lang-hcl=\"`input`\"\u003e`input`\u003c/span\u003e block.\n" } }, "type": "object" }, "databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsInput:ModelServingProvisionedThroughputAiGatewayGuardrailsInput": { "properties": { "invalidKeywords": { "type": "array", "items": { "type": "string" }, "description": "List of invalid keywords. AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.\n" }, "pii": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsInputPii:ModelServingProvisionedThroughputAiGatewayGuardrailsInputPii", "description": "Block with configuration for guardrail PII filter:\n" }, "safety": { "type": "boolean", "description": "the boolean flag that indicates whether the safety filter is enabled.\n" }, "validTopics": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "pii" ] } } }, "databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsInputPii:ModelServingProvisionedThroughputAiGatewayGuardrailsInputPii": { "properties": { "behavior": { "type": "string", "description": "a string that describes the behavior for PII filter. Currently only `BLOCK` value is supported.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "behavior" ] } } }, "databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsOutput:ModelServingProvisionedThroughputAiGatewayGuardrailsOutput": { "properties": { "invalidKeywords": { "type": "array", "items": { "type": "string" }, "description": "List of invalid keywords. AI guardrail uses keyword or string matching to decide if the keyword exists in the request or response content.\n" }, "pii": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsOutputPii:ModelServingProvisionedThroughputAiGatewayGuardrailsOutputPii", "description": "Block with configuration for guardrail PII filter:\n" }, "safety": { "type": "boolean", "description": "the boolean flag that indicates whether the safety filter is enabled.\n" }, "validTopics": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed topics. Given a chat request, this guardrail flags the request if its topic is not in the allowed topics.\n" } }, "type": "object" }, "databricks:index/ModelServingProvisionedThroughputAiGatewayGuardrailsOutputPii:ModelServingProvisionedThroughputAiGatewayGuardrailsOutputPii": { "properties": { "behavior": { "type": "string", "description": "a string that describes the behavior for PII filter. Currently only `BLOCK` value is supported.\n" } }, "type": "object" }, "databricks:index/ModelServingProvisionedThroughputAiGatewayInferenceTableConfig:ModelServingProvisionedThroughputAiGatewayInferenceTableConfig": { "properties": { "catalogName": { "type": "string" }, "enabled": { "type": "boolean", "description": "boolean flag specifying if usage tracking is enabled.\n" }, "schemaName": { "type": "string" }, "tableNamePrefix": { "type": "string" } }, "type": "object" }, "databricks:index/ModelServingProvisionedThroughputAiGatewayRateLimit:ModelServingProvisionedThroughputAiGatewayRateLimit": { "properties": { "calls": { "type": "integer" }, "key": { "type": "string", "description": "The key field for a tag.\n" }, "principal": { "type": "string" }, "renewalPeriod": { "type": "string" }, "tokens": { "type": "integer" } }, "type": "object", "required": [ "renewalPeriod" ] }, "databricks:index/ModelServingProvisionedThroughputAiGatewayUsageTrackingConfig:ModelServingProvisionedThroughputAiGatewayUsageTrackingConfig": { "properties": { "enabled": { "type": "boolean", "description": "boolean flag specifying if usage tracking is enabled.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "enabled" ] } } }, "databricks:index/ModelServingProvisionedThroughputConfig:ModelServingProvisionedThroughputConfig": { "properties": { "servedEntities": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputConfigServedEntity:ModelServingProvisionedThroughputConfigServedEntity" }, "description": "A list of served entities for the endpoint to serve.\n" }, "trafficConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputConfigTrafficConfig:ModelServingProvisionedThroughputConfigTrafficConfig", "description": "A single block represents the traffic split configuration amongst the served models.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "trafficConfig" ] } } }, "databricks:index/ModelServingProvisionedThroughputConfigServedEntity:ModelServingProvisionedThroughputConfigServedEntity": { "properties": { "burstScalingEnabled": { "type": "boolean" }, "entityName": { "type": "string", "description": "The full path of the UC model to be served, given in the form of `catalog_name.schema_name.model_name`.\n" }, "entityVersion": { "type": "string", "description": "The version of the model in UC to be served.\n" }, "name": { "type": "string", "description": "The name of a served entity. It must be unique across an endpoint. A served entity name can consist of alphanumeric characters, dashes, and underscores. If not specified for an external model, this field will be created from the \u003cspan pulumi-lang-nodejs=\"`entityName`\" pulumi-lang-dotnet=\"`EntityName`\" pulumi-lang-go=\"`entityName`\" pulumi-lang-python=\"`entity_name`\" pulumi-lang-yaml=\"`entityName`\" pulumi-lang-java=\"`entityName`\" pulumi-lang-hcl=\"`entity_name`\"\u003e`entityName`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`entityVersion`\" pulumi-lang-dotnet=\"`EntityVersion`\" pulumi-lang-go=\"`entityVersion`\" pulumi-lang-python=\"`entity_version`\" pulumi-lang-yaml=\"`entityVersion`\" pulumi-lang-java=\"`entityVersion`\" pulumi-lang-hcl=\"`entity_version`\"\u003e`entityVersion`\u003c/span\u003e\n" }, "provisionedModelUnits": { "type": "integer", "description": "The number of model units to be provisioned.\n" } }, "type": "object", "required": [ "entityName", "entityVersion", "provisionedModelUnits" ], "language": { "nodejs": { "requiredOutputs": [ "entityName", "entityVersion", "name", "provisionedModelUnits" ] } } }, "databricks:index/ModelServingProvisionedThroughputConfigTrafficConfig:ModelServingProvisionedThroughputConfigTrafficConfig": { "properties": { "routes": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputConfigTrafficConfigRoute:ModelServingProvisionedThroughputConfigTrafficConfigRoute" }, "description": "Each block represents a route that defines traffic to each served entity. Each \u003cspan pulumi-lang-nodejs=\"`servedEntity`\" pulumi-lang-dotnet=\"`ServedEntity`\" pulumi-lang-go=\"`servedEntity`\" pulumi-lang-python=\"`served_entity`\" pulumi-lang-yaml=\"`servedEntity`\" pulumi-lang-java=\"`servedEntity`\" pulumi-lang-hcl=\"`served_entity`\"\u003e`servedEntity`\u003c/span\u003e block needs to have a corresponding \u003cspan pulumi-lang-nodejs=\"`routes`\" pulumi-lang-dotnet=\"`Routes`\" pulumi-lang-go=\"`routes`\" pulumi-lang-python=\"`routes`\" pulumi-lang-yaml=\"`routes`\" pulumi-lang-java=\"`routes`\" pulumi-lang-hcl=\"`routes`\"\u003e`routes`\u003c/span\u003e block.\n" } }, "type": "object" }, "databricks:index/ModelServingProvisionedThroughputConfigTrafficConfigRoute:ModelServingProvisionedThroughputConfigTrafficConfigRoute": { "properties": { "servedEntityName": { "type": "string", "description": "The name of the served entity this route configures traffic for. This needs to match the name of a \u003cspan pulumi-lang-nodejs=\"`servedEntity`\" pulumi-lang-dotnet=\"`ServedEntity`\" pulumi-lang-go=\"`servedEntity`\" pulumi-lang-python=\"`served_entity`\" pulumi-lang-yaml=\"`servedEntity`\" pulumi-lang-java=\"`servedEntity`\" pulumi-lang-hcl=\"`served_entity`\"\u003e`servedEntity`\u003c/span\u003e block.\n" }, "servedModelName": { "type": "string" }, "trafficPercentage": { "type": "integer", "description": "The percentage of endpoint traffic to send to this route. It must be an integer between 0 and 100 inclusive.\n" } }, "type": "object", "required": [ "trafficPercentage" ] }, "databricks:index/ModelServingProvisionedThroughputEmailNotifications:ModelServingProvisionedThroughputEmailNotifications": { "properties": { "onUpdateFailures": { "type": "array", "items": { "type": "string" }, "description": "a list of email addresses to be notified when an endpoint fails to update its configuration or state.\n" }, "onUpdateSuccesses": { "type": "array", "items": { "type": "string" }, "description": "a list of email addresses to be notified when an endpoint successfully updates its configuration or state.\n" } }, "type": "object" }, "databricks:index/ModelServingProvisionedThroughputProviderConfig:ModelServingProvisionedThroughputProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ModelServingProvisionedThroughputTag:ModelServingProvisionedThroughputTag": { "properties": { "key": { "type": "string", "description": "The key field for a tag.\n" }, "value": { "type": "string", "description": "The value field for a tag.\n" } }, "type": "object", "required": [ "key" ] }, "databricks:index/ModelServingRateLimit:ModelServingRateLimit": { "properties": { "calls": { "type": "integer", "description": "Used to specify how many calls are allowed for a key within the renewal_period.\n" }, "key": { "type": "string", "description": "Key field for a serving endpoint rate limit. Currently, \u003cspan pulumi-lang-nodejs=\"`user`\" pulumi-lang-dotnet=\"`User`\" pulumi-lang-go=\"`user`\" pulumi-lang-python=\"`user`\" pulumi-lang-yaml=\"`user`\" pulumi-lang-java=\"`user`\" pulumi-lang-hcl=\"`user`\"\u003e`user`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`userGroup`\" pulumi-lang-dotnet=\"`UserGroup`\" pulumi-lang-go=\"`userGroup`\" pulumi-lang-python=\"`user_group`\" pulumi-lang-yaml=\"`userGroup`\" pulumi-lang-java=\"`userGroup`\" pulumi-lang-hcl=\"`user_group`\"\u003e`userGroup`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`servicePrincipal`\" pulumi-lang-dotnet=\"`ServicePrincipal`\" pulumi-lang-go=\"`servicePrincipal`\" pulumi-lang-python=\"`service_principal`\" pulumi-lang-yaml=\"`servicePrincipal`\" pulumi-lang-java=\"`servicePrincipal`\" pulumi-lang-hcl=\"`service_principal`\"\u003e`servicePrincipal`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e are supported, with \u003cspan pulumi-lang-nodejs=\"`endpoint`\" pulumi-lang-dotnet=\"`Endpoint`\" pulumi-lang-go=\"`endpoint`\" pulumi-lang-python=\"`endpoint`\" pulumi-lang-yaml=\"`endpoint`\" pulumi-lang-java=\"`endpoint`\" pulumi-lang-hcl=\"`endpoint`\"\u003e`endpoint`\u003c/span\u003e being the default if not specified.\n" }, "renewalPeriod": { "type": "string", "description": "Renewal period field for a serving endpoint rate limit. Currently, only \u003cspan pulumi-lang-nodejs=\"`minute`\" pulumi-lang-dotnet=\"`Minute`\" pulumi-lang-go=\"`minute`\" pulumi-lang-python=\"`minute`\" pulumi-lang-yaml=\"`minute`\" pulumi-lang-java=\"`minute`\" pulumi-lang-hcl=\"`minute`\"\u003e`minute`\u003c/span\u003e is supported.\n" } }, "type": "object", "required": [ "calls", "renewalPeriod" ] }, "databricks:index/ModelServingTag:ModelServingTag": { "properties": { "key": { "type": "string", "description": "The key field for a tag.\n" }, "value": { "type": "string", "description": "The value field for a tag.\n" } }, "type": "object", "required": [ "key" ] }, "databricks:index/MountAbfs:MountAbfs": { "properties": { "clientId": { "type": "string", "willReplaceOnChanges": true }, "clientSecretKey": { "type": "string", "willReplaceOnChanges": true }, "clientSecretScope": { "type": "string", "willReplaceOnChanges": true }, "containerName": { "type": "string", "willReplaceOnChanges": true }, "directory": { "type": "string", "willReplaceOnChanges": true }, "initializeFileSystem": { "type": "boolean", "willReplaceOnChanges": true }, "storageAccountName": { "type": "string", "willReplaceOnChanges": true }, "tenantId": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "clientId", "clientSecretKey", "clientSecretScope", "initializeFileSystem" ], "language": { "nodejs": { "requiredOutputs": [ "clientId", "clientSecretKey", "clientSecretScope", "containerName", "initializeFileSystem", "storageAccountName", "tenantId" ] } } }, "databricks:index/MountAdl:MountAdl": { "properties": { "clientId": { "type": "string", "willReplaceOnChanges": true }, "clientSecretKey": { "type": "string", "willReplaceOnChanges": true }, "clientSecretScope": { "type": "string", "willReplaceOnChanges": true }, "directory": { "type": "string", "willReplaceOnChanges": true }, "sparkConfPrefix": { "type": "string", "willReplaceOnChanges": true }, "storageResourceName": { "type": "string", "willReplaceOnChanges": true }, "tenantId": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "clientId", "clientSecretKey", "clientSecretScope" ], "language": { "nodejs": { "requiredOutputs": [ "clientId", "clientSecretKey", "clientSecretScope", "storageResourceName", "tenantId" ] } } }, "databricks:index/MountGs:MountGs": { "properties": { "bucketName": { "type": "string", "willReplaceOnChanges": true }, "serviceAccount": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucketName" ] }, "databricks:index/MountProviderConfig:MountProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/MountS3:MountS3": { "properties": { "bucketName": { "type": "string", "willReplaceOnChanges": true }, "instanceProfile": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucketName" ] }, "databricks:index/MountWasb:MountWasb": { "properties": { "authType": { "type": "string", "willReplaceOnChanges": true }, "containerName": { "type": "string", "willReplaceOnChanges": true }, "directory": { "type": "string", "willReplaceOnChanges": true }, "storageAccountName": { "type": "string", "willReplaceOnChanges": true }, "tokenSecretKey": { "type": "string", "willReplaceOnChanges": true }, "tokenSecretScope": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "authType", "tokenSecretKey", "tokenSecretScope" ], "language": { "nodejs": { "requiredOutputs": [ "authType", "containerName", "storageAccountName", "tokenSecretKey", "tokenSecretScope" ] } } }, "databricks:index/MwsCustomerManagedKeysAwsKeyInfo:MwsCustomerManagedKeysAwsKeyInfo": { "properties": { "keyAlias": { "type": "string", "description": "The AWS KMS key alias.\n", "willReplaceOnChanges": true }, "keyArn": { "type": "string", "description": "The AWS KMS key's Amazon Resource Name (ARN).\n", "willReplaceOnChanges": true }, "keyRegion": { "type": "string", "description": "(Computed) The AWS region in which KMS key is deployed to. This is not required.\n" } }, "type": "object", "required": [ "keyArn" ], "language": { "nodejs": { "requiredOutputs": [ "keyArn", "keyRegion" ] } } }, "databricks:index/MwsCustomerManagedKeysGcpKeyInfo:MwsCustomerManagedKeysGcpKeyInfo": { "properties": { "kmsKeyId": { "type": "string", "description": "The GCP KMS key's resource name.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "kmsKeyId" ] }, "databricks:index/MwsNccPrivateEndpointRuleGcpEndpoint:MwsNccPrivateEndpointRuleGcpEndpoint": { "properties": { "pscEndpointUri": { "type": "string" }, "serviceAttachment": { "type": "string" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfig:MwsNetworkConnectivityConfigEgressConfig": { "properties": { "defaultRules": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfigDefaultRules:MwsNetworkConnectivityConfigEgressConfigDefaultRules", "description": "block describing network connectivity rules that are applied by default without resource specific configurations. Consists of the following fields:\n" }, "targetRules": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfigTargetRules:MwsNetworkConnectivityConfigEgressConfigTargetRules", "description": "block describing network connectivity rules that configured for each destinations. These rules override default rules. Consists of the following fields:\n" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfigDefaultRules:MwsNetworkConnectivityConfigEgressConfigDefaultRules": { "properties": { "awsStableIpRule": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule:MwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule", "description": "(AWS only) - block with information about stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace. Consists of the following fields:\n" }, "azureServiceEndpointRule": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule:MwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule", "description": "(Azure only) - block with information about stable Azure service endpoints. You can configure the firewall of your Azure resources to allow traffic from your Databricks serverless compute resources. Consists of the following fields:\n" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule:MwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "list of IP CIDR blocks.\n" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule:MwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule": { "properties": { "subnets": { "type": "array", "items": { "type": "string" }, "description": "list of subnets from which Databricks network traffic originates when accessing your Azure resources.\n" }, "targetRegion": { "type": "string", "description": "the Azure region in which this service endpoint rule applies.\n" }, "targetServices": { "type": "array", "items": { "type": "string" }, "description": "the Azure services to which this service endpoint rule applies to.\n" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfigTargetRules:MwsNetworkConnectivityConfigEgressConfigTargetRules": { "properties": { "awsPrivateEndpointRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule:MwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule" }, "description": "(AWS only) - list containing information about configure AWS Private Endpoints.\n" }, "azurePrivateEndpointRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule:MwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule" }, "description": "(Azure only) - list containing information about configure Azure Private Endpoints.\n" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule:MwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule": { "properties": { "accountId": { "type": "string" }, "connectionState": { "type": "string" }, "creationTime": { "type": "integer", "description": "time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean" }, "deactivatedAt": { "type": "integer" }, "domainNames": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "endpointService": { "type": "string" }, "errorMessage": { "type": "string" }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account\n" }, "resourceNames": { "type": "array", "items": { "type": "string" } }, "ruleId": { "type": "string" }, "updatedTime": { "type": "integer", "description": "time in epoch milliseconds when this object was updated.\n" }, "vpcEndpointId": { "type": "string" } }, "type": "object" }, "databricks:index/MwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule:MwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule": { "properties": { "connectionState": { "type": "string" }, "creationTime": { "type": "integer", "description": "time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean" }, "deactivatedAt": { "type": "integer" }, "domainNames": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string" }, "errorMessage": { "type": "string" }, "groupId": { "type": "string" }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account\n" }, "resourceId": { "type": "string" }, "ruleId": { "type": "string" }, "updatedTime": { "type": "integer", "description": "time in epoch milliseconds when this object was updated.\n" } }, "type": "object" }, "databricks:index/MwsNetworksErrorMessage:MwsNetworksErrorMessage": { "properties": { "errorMessage": { "type": "string" }, "errorType": { "type": "string" } }, "type": "object" }, "databricks:index/MwsNetworksGcpNetworkInfo:MwsNetworksGcpNetworkInfo": { "properties": { "networkProjectId": { "type": "string", "description": "The Google Cloud project ID of the VPC network.\n", "willReplaceOnChanges": true }, "podIpRangeName": { "type": "string", "deprecationMessage": "gcp_network_info.pod_ip_range_name is deprecated and will be removed in a future release. For more information, review the documentation at https://registry.terraform.io/providers/databricks/databricks/1.117.0/docs/guides/gcp-workspace#creating-a-vpc" }, "serviceIpRangeName": { "type": "string", "deprecationMessage": "gcp_network_info.service_ip_range_name is deprecated and will be removed in a future release. For more information, review the documentation at https://registry.terraform.io/providers/databricks/databricks/1.117.0/docs/guides/gcp-workspace#creating-a-vpc" }, "subnetId": { "type": "string", "description": "The ID of the subnet associated with this network.\n", "willReplaceOnChanges": true }, "subnetRegion": { "type": "string", "description": "The Google Cloud region of the workspace data plane. For example, `us-east4`.\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "The ID of the VPC associated with this network. VPC IDs can be used in multiple network configurations.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "networkProjectId", "subnetId", "subnetRegion", "vpcId" ] }, "databricks:index/MwsNetworksVpcEndpoints:MwsNetworksVpcEndpoints": { "properties": { "dataplaneRelays": { "type": "array", "items": { "type": "string" } }, "restApis": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "dataplaneRelays", "restApis" ] }, "databricks:index/MwsVpcEndpointGcpVpcEndpointInfo:MwsVpcEndpointGcpVpcEndpointInfo": { "properties": { "endpointRegion": { "type": "string", "description": "Region of the PSC endpoint.\n", "willReplaceOnChanges": true }, "projectId": { "type": "string", "description": "The Google Cloud project ID of the VPC network where the PSC connection resides.\n", "willReplaceOnChanges": true }, "pscConnectionId": { "type": "string", "description": "The unique ID of this PSC connection.\n" }, "pscEndpointName": { "type": "string", "description": "The name of the PSC endpoint in the Google Cloud project.\n", "willReplaceOnChanges": true }, "serviceAttachmentId": { "type": "string", "description": "The service attachment this PSC connection connects to.\n" } }, "type": "object", "required": [ "endpointRegion", "projectId", "pscEndpointName" ], "language": { "nodejs": { "requiredOutputs": [ "endpointRegion", "projectId", "pscConnectionId", "pscEndpointName", "serviceAttachmentId" ] } } }, "databricks:index/MwsWorkspacesCloudResourceContainer:MwsWorkspacesCloudResourceContainer": { "properties": { "gcp": { "$ref": "#/types/databricks:index/MwsWorkspacesCloudResourceContainerGcp:MwsWorkspacesCloudResourceContainerGcp", "description": "A block that consists of the following field:\n" } }, "type": "object", "required": [ "gcp" ] }, "databricks:index/MwsWorkspacesCloudResourceContainerGcp:MwsWorkspacesCloudResourceContainerGcp": { "properties": { "projectId": { "type": "string", "description": "The Google Cloud project ID, which the workspace uses to instantiate cloud resources for your workspace.\n" } }, "type": "object", "required": [ "projectId" ] }, "databricks:index/MwsWorkspacesExternalCustomerInfo:MwsWorkspacesExternalCustomerInfo": { "properties": { "authoritativeUserEmail": { "type": "string" }, "authoritativeUserFullName": { "type": "string" }, "customerName": { "type": "string" } }, "type": "object", "required": [ "authoritativeUserEmail", "authoritativeUserFullName", "customerName" ] }, "databricks:index/MwsWorkspacesGcpManagedNetworkConfig:MwsWorkspacesGcpManagedNetworkConfig": { "properties": { "gkeClusterPodIpRange": { "type": "string", "deprecationMessage": "gcp_managed_network_config.gke_cluster_pod_ip_range is deprecated and will be removed in a future release. For more information, review the documentation at https://registry.terraform.io/providers/databricks/databricks/1.117.0/docs/guides/gcp-workspace#creating-a-databricks-workspace" }, "gkeClusterServiceIpRange": { "type": "string", "deprecationMessage": "gcp_managed_network_config.gke_cluster_service_ip_range is deprecated and will be removed in a future release. For more information, review the documentation at https://registry.terraform.io/providers/databricks/databricks/1.117.0/docs/guides/gcp-workspace#creating-a-databricks-workspace" }, "subnetCidr": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "subnetCidr" ] }, "databricks:index/MwsWorkspacesGkeConfig:MwsWorkspacesGkeConfig": { "properties": { "connectivityType": { "type": "string" }, "masterIpRange": { "type": "string" } }, "type": "object" }, "databricks:index/MwsWorkspacesToken:MwsWorkspacesToken": { "properties": { "comment": { "type": "string", "description": "Comment, that will appear in \"User Settings / Access Tokens\" page on Workspace UI. By default it's \"Pulumi PAT\".\n" }, "lifetimeSeconds": { "type": "integer", "description": "Token expiry lifetime. By default its 2592000 (30 days).\n" }, "tokenId": { "type": "string" }, "tokenValue": { "type": "string", "secret": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "tokenId", "tokenValue" ] } } }, "databricks:index/NotebookProviderConfig:NotebookProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/NotificationDestinationConfig:NotificationDestinationConfig": { "properties": { "email": { "$ref": "#/types/databricks:index/NotificationDestinationConfigEmail:NotificationDestinationConfigEmail", "description": "The email configuration of the Notification Destination. It must contain the following:\n", "willReplaceOnChanges": true }, "genericWebhook": { "$ref": "#/types/databricks:index/NotificationDestinationConfigGenericWebhook:NotificationDestinationConfigGenericWebhook", "description": "The Generic Webhook configuration of the Notification Destination. It must contain the following:\n", "willReplaceOnChanges": true }, "microsoftTeams": { "$ref": "#/types/databricks:index/NotificationDestinationConfigMicrosoftTeams:NotificationDestinationConfigMicrosoftTeams", "description": "The Microsoft Teams configuration of the Notification Destination. It must contain the following:\n", "willReplaceOnChanges": true }, "pagerduty": { "$ref": "#/types/databricks:index/NotificationDestinationConfigPagerduty:NotificationDestinationConfigPagerduty", "description": "The PagerDuty configuration of the Notification Destination. It must contain the following:\n", "willReplaceOnChanges": true }, "slack": { "$ref": "#/types/databricks:index/NotificationDestinationConfigSlack:NotificationDestinationConfigSlack", "description": "The Slack configuration of the Notification Destination. It must contain the following:\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/NotificationDestinationConfigEmail:NotificationDestinationConfigEmail": { "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "The list of email addresses to send notifications to.\n" } }, "type": "object" }, "databricks:index/NotificationDestinationConfigGenericWebhook:NotificationDestinationConfigGenericWebhook": { "properties": { "password": { "type": "string", "description": "The password for basic authentication.\n", "secret": true }, "passwordSet": { "type": "boolean" }, "url": { "type": "string", "description": "The Generic Webhook URL.\n", "secret": true }, "urlSet": { "type": "boolean" }, "username": { "type": "string", "description": "The username for basic authentication.\n", "secret": true }, "usernameSet": { "type": "boolean" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "passwordSet", "urlSet", "usernameSet" ] } } }, "databricks:index/NotificationDestinationConfigMicrosoftTeams:NotificationDestinationConfigMicrosoftTeams": { "properties": { "appId": { "type": "string", "description": "App ID for Microsoft Teams App.\n", "secret": true }, "appIdSet": { "type": "boolean" }, "authSecret": { "type": "string", "description": "Secret for Microsoft Teams App authentication.\n", "secret": true }, "authSecretSet": { "type": "boolean" }, "channelUrl": { "type": "string", "description": "Channel URL for Microsoft Teams App.\n", "secret": true }, "channelUrlSet": { "type": "boolean" }, "tenantId": { "type": "string", "description": "Tenant ID for Microsoft Teams App.\n", "secret": true }, "tenantIdSet": { "type": "boolean" }, "url": { "type": "string", "description": "The Microsoft Teams webhook URL.\n", "secret": true }, "urlSet": { "type": "boolean" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "urlSet" ] } } }, "databricks:index/NotificationDestinationConfigPagerduty:NotificationDestinationConfigPagerduty": { "properties": { "integrationKey": { "type": "string", "description": "The PagerDuty integration key.\n", "secret": true }, "integrationKeySet": { "type": "boolean" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "integrationKeySet" ] } } }, "databricks:index/NotificationDestinationConfigSlack:NotificationDestinationConfigSlack": { "properties": { "channelId": { "type": "string", "description": "Slack channel ID for notifications.\n", "secret": true }, "channelIdSet": { "type": "boolean" }, "oauthToken": { "type": "string", "description": "OAuth token for Slack authentication.\n", "secret": true }, "oauthTokenSet": { "type": "boolean" }, "url": { "type": "string", "description": "The Slack webhook URL.\n", "secret": true }, "urlSet": { "type": "boolean" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "channelIdSet", "oauthTokenSet", "urlSet" ] } } }, "databricks:index/NotificationDestinationProviderConfig:NotificationDestinationProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n\n\u003e **NOTE** If the type of notification destination is changed, the existing notification destination will be deleted and a new notification destination will be created with the new type.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/OboTokenProviderConfig:OboTokenProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/OnlineStoreProviderConfig:OnlineStoreProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/OnlineTableProviderConfig:OnlineTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/OnlineTableSpec:OnlineTableSpec": { "properties": { "performFullCopy": { "type": "boolean", "description": "Whether to create a full-copy pipeline -- a pipeline that stops after creates a full copy of the source table upon initialization and does not process any change data feeds (CDFs) afterwards. The pipeline can still be manually triggered afterwards, but it always perform a full copy of the source table and there are no incremental updates. This mode is useful for syncing views or tables without CDFs to online tables. Note that the full-copy pipeline only supports \"triggered\" scheduling policy.\n", "willReplaceOnChanges": true }, "pipelineId": { "type": "string", "description": "ID of the associated Delta Live Table pipeline.\n" }, "primaryKeyColumns": { "type": "array", "items": { "type": "string" }, "description": "list of the columns comprising the primary key.\n", "willReplaceOnChanges": true }, "runContinuously": { "$ref": "#/types/databricks:index/OnlineTableSpecRunContinuously:OnlineTableSpecRunContinuously", "description": "empty block that specifies that pipeline runs continuously after generating the initial data. Conflicts with \u003cspan pulumi-lang-nodejs=\"`runTriggered`\" pulumi-lang-dotnet=\"`RunTriggered`\" pulumi-lang-go=\"`runTriggered`\" pulumi-lang-python=\"`run_triggered`\" pulumi-lang-yaml=\"`runTriggered`\" pulumi-lang-java=\"`runTriggered`\" pulumi-lang-hcl=\"`run_triggered`\"\u003e`runTriggered`\u003c/span\u003e.\n", "willReplaceOnChanges": true }, "runTriggered": { "$ref": "#/types/databricks:index/OnlineTableSpecRunTriggered:OnlineTableSpecRunTriggered", "description": "empty block that specifies that pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).\n", "willReplaceOnChanges": true }, "sourceTableFullName": { "type": "string", "description": "full name of the source table.\n", "willReplaceOnChanges": true }, "timeseriesKey": { "type": "string", "description": "Time series key to deduplicate (tie-break) rows with the same primary key.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "pipelineId" ] } } }, "databricks:index/OnlineTableSpecRunContinuously:OnlineTableSpecRunContinuously": { "type": "object" }, "databricks:index/OnlineTableSpecRunTriggered:OnlineTableSpecRunTriggered": { "type": "object" }, "databricks:index/OnlineTableStatus:OnlineTableStatus": { "properties": { "continuousUpdateStatus": { "$ref": "#/types/databricks:index/OnlineTableStatusContinuousUpdateStatus:OnlineTableStatusContinuousUpdateStatus" }, "detailedState": { "type": "string", "description": "The state of the online table.\n" }, "failedStatus": { "$ref": "#/types/databricks:index/OnlineTableStatusFailedStatus:OnlineTableStatusFailedStatus" }, "message": { "type": "string", "description": "A text description of the current state of the online table.\n" }, "provisioningStatus": { "$ref": "#/types/databricks:index/OnlineTableStatusProvisioningStatus:OnlineTableStatusProvisioningStatus" }, "triggeredUpdateStatus": { "$ref": "#/types/databricks:index/OnlineTableStatusTriggeredUpdateStatus:OnlineTableStatusTriggeredUpdateStatus" } }, "type": "object" }, "databricks:index/OnlineTableStatusContinuousUpdateStatus:OnlineTableStatusContinuousUpdateStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/OnlineTableStatusContinuousUpdateStatusInitialPipelineSyncProgress:OnlineTableStatusContinuousUpdateStatusInitialPipelineSyncProgress" }, "lastProcessedCommitVersion": { "type": "integer" }, "timestamp": { "type": "string" } }, "type": "object" }, "databricks:index/OnlineTableStatusContinuousUpdateStatusInitialPipelineSyncProgress:OnlineTableStatusContinuousUpdateStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number" }, "latestVersionCurrentlyProcessing": { "type": "integer" }, "syncProgressCompletion": { "type": "number" }, "syncedRowCount": { "type": "integer" }, "totalRowCount": { "type": "integer" } }, "type": "object" }, "databricks:index/OnlineTableStatusFailedStatus:OnlineTableStatusFailedStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer" }, "timestamp": { "type": "string" } }, "type": "object" }, "databricks:index/OnlineTableStatusProvisioningStatus:OnlineTableStatusProvisioningStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/OnlineTableStatusProvisioningStatusInitialPipelineSyncProgress:OnlineTableStatusProvisioningStatusInitialPipelineSyncProgress" } }, "type": "object" }, "databricks:index/OnlineTableStatusProvisioningStatusInitialPipelineSyncProgress:OnlineTableStatusProvisioningStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number" }, "latestVersionCurrentlyProcessing": { "type": "integer" }, "syncProgressCompletion": { "type": "number" }, "syncedRowCount": { "type": "integer" }, "totalRowCount": { "type": "integer" } }, "type": "object" }, "databricks:index/OnlineTableStatusTriggeredUpdateStatus:OnlineTableStatusTriggeredUpdateStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer" }, "timestamp": { "type": "string" }, "triggeredUpdateProgress": { "$ref": "#/types/databricks:index/OnlineTableStatusTriggeredUpdateStatusTriggeredUpdateProgress:OnlineTableStatusTriggeredUpdateStatusTriggeredUpdateProgress" } }, "type": "object" }, "databricks:index/OnlineTableStatusTriggeredUpdateStatusTriggeredUpdateProgress:OnlineTableStatusTriggeredUpdateStatusTriggeredUpdateProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number" }, "latestVersionCurrentlyProcessing": { "type": "integer" }, "syncProgressCompletion": { "type": "number" }, "syncedRowCount": { "type": "integer" }, "totalRowCount": { "type": "integer" } }, "type": "object" }, "databricks:index/PermissionAssignmentProviderConfig:PermissionAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PermissionsAccessControl:PermissionsAccessControl": { "properties": { "groupName": { "type": "string", "description": "name of the group. We recommend setting permissions on groups.\n" }, "permissionLevel": { "type": "string", "description": "permission level according to specific resource. See examples above for the reference.\n\nExactly one of the below arguments is required:\n" }, "servicePrincipalName": { "type": "string", "description": "Application ID (**not service principal name!**) of the service_principal.\n" }, "userName": { "type": "string", "description": "name of the user.\n" } }, "type": "object" }, "databricks:index/PermissionsProviderConfig:PermissionsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PipelineCluster:PipelineCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/PipelineClusterAutoscale:PipelineClusterAutoscale" }, "awsAttributes": { "$ref": "#/types/databricks:index/PipelineClusterAwsAttributes:PipelineClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/PipelineClusterAzureAttributes:PipelineClusterAzureAttributes" }, "clusterLogConf": { "$ref": "#/types/databricks:index/PipelineClusterClusterLogConf:PipelineClusterClusterLogConf" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeId": { "type": "string" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/PipelineClusterGcpAttributes:PipelineClusterGcpAttributes" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineClusterInitScript:PipelineClusterInitScript" } }, "instancePoolId": { "type": "string" }, "label": { "type": "string" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "driverNodeTypeId", "enableLocalDiskEncryption", "nodeTypeId" ] } } }, "databricks:index/PipelineClusterAutoscale:PipelineClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" }, "mode": { "type": "string" } }, "type": "object", "required": [ "maxWorkers", "minWorkers" ] }, "databricks:index/PipelineClusterAwsAttributes:PipelineClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineClusterAzureAttributes:PipelineClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/PipelineClusterAzureAttributesLogAnalyticsInfo:PipelineClusterAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/PipelineClusterAzureAttributesLogAnalyticsInfo:PipelineClusterAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineClusterClusterLogConf:PipelineClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/PipelineClusterClusterLogConfDbfs:PipelineClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/PipelineClusterClusterLogConfS3:PipelineClusterClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/PipelineClusterClusterLogConfVolumes:PipelineClusterClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/PipelineClusterClusterLogConfDbfs:PipelineClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterClusterLogConfS3:PipelineClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterClusterLogConfVolumes:PipelineClusterClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterGcpAttributes:PipelineClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineClusterInitScript:PipelineClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptAbfss:PipelineClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptDbfs:PipelineClusterInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptFile:PipelineClusterInitScriptFile", "description": "specifies path to a file in Databricks Workspace to include as source. Actual path is specified as \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e attribute inside the block.\n" }, "gcs": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptGcs:PipelineClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptS3:PipelineClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptVolumes:PipelineClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/PipelineClusterInitScriptWorkspace:PipelineClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/PipelineClusterInitScriptAbfss:PipelineClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterInitScriptDbfs:PipelineClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterInitScriptFile:PipelineClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterInitScriptGcs:PipelineClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterInitScriptS3:PipelineClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterInitScriptVolumes:PipelineClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineClusterInitScriptWorkspace:PipelineClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/PipelineDeployment:PipelineDeployment": { "properties": { "deploymentId": { "type": "string" }, "kind": { "type": "string", "description": "The deployment method that manages the pipeline.\n" }, "metadataFilePath": { "type": "string", "description": "The path to the file containing metadata about the deployment.\n" }, "versionId": { "type": "string" } }, "type": "object", "required": [ "kind" ] }, "databricks:index/PipelineEnvironment:PipelineEnvironment": { "properties": { "dependencies": { "type": "array", "items": { "type": "string" }, "description": "a list of pip dependencies, as supported by the version of pip in this environment. Each dependency is a [pip requirement file line](https://pip.pypa.io/en/stable/reference/requirements-file-format/). See [API docs](https://docs.databricks.com/api/azure/workspace/pipelines/create#environment-dependencies) for more information.\n\nExample:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Pipeline(\"this\", {\n name: \"Serverless demo\",\n serverless: true,\n catalog: \"main\",\n schema: \"ldp_demo\",\n environment: {\n dependencies: [\n \"foo==0.0.1\",\n \"-r /Workspace/Users/user.name/my-pipeline/requirements.txt\",\n \"/Volumes/main/default/libs/my_lib.whl\",\n ],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Pipeline(\"this\",\n name=\"Serverless demo\",\n serverless=True,\n catalog=\"main\",\n schema=\"ldp_demo\",\n environment={\n \"dependencies\": [\n \"foo==0.0.1\",\n \"-r /Workspace/Users/user.name/my-pipeline/requirements.txt\",\n \"/Volumes/main/default/libs/my_lib.whl\",\n ],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Pipeline(\"this\", new()\n {\n Name = \"Serverless demo\",\n Serverless = true,\n Catalog = \"main\",\n Schema = \"ldp_demo\",\n Environment = new Databricks.Inputs.PipelineEnvironmentArgs\n {\n Dependencies = new[]\n {\n \"foo==0.0.1\",\n \"-r /Workspace/Users/user.name/my-pipeline/requirements.txt\",\n \"/Volumes/main/default/libs/my_lib.whl\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewPipeline(ctx, \"this\", \u0026databricks.PipelineArgs{\n\t\t\tName: pulumi.String(\"Serverless demo\"),\n\t\t\tServerless: pulumi.Bool(true),\n\t\t\tCatalog: pulumi.String(\"main\"),\n\t\t\tSchema: pulumi.String(\"ldp_demo\"),\n\t\t\tEnvironment: \u0026databricks.PipelineEnvironmentArgs{\n\t\t\t\tDependencies: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"foo==0.0.1\"),\n\t\t\t\t\tpulumi.String(\"-r /Workspace/Users/user.name/my-pipeline/requirements.txt\"),\n\t\t\t\t\tpulumi.String(\"/Volumes/main/default/libs/my_lib.whl\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_pipeline\" \"this\" {\n name = \"Serverless demo\"\n serverless = true\n catalog = \"main\"\n schema = \"ldp_demo\"\n environment = {\n dependencies = [\"foo==0.0.1\", \"-r /Workspace/Users/user.name/my-pipeline/requirements.txt\", \"/Volumes/main/default/libs/my_lib.whl\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Pipeline;\nimport com.pulumi.databricks.PipelineArgs;\nimport com.pulumi.databricks.inputs.PipelineEnvironmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Pipeline(\"this\", PipelineArgs.builder()\n .name(\"Serverless demo\")\n .serverless(true)\n .catalog(\"main\")\n .schema(\"ldp_demo\")\n .environment(PipelineEnvironmentArgs.builder()\n .dependencies( \n \"foo==0.0.1\",\n \"-r /Workspace/Users/user.name/my-pipeline/requirements.txt\",\n \"/Volumes/main/default/libs/my_lib.whl\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Pipeline\n properties:\n name: Serverless demo\n serverless: true\n catalog: main\n schema: ldp_demo\n environment:\n dependencies:\n - foo==0.0.1\n - -r /Workspace/Users/user.name/my-pipeline/requirements.txt\n - /Volumes/main/default/libs/my_lib.whl\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "environmentVersion": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineEventLog:PipelineEventLog": { "properties": { "catalog": { "type": "string", "description": "The UC catalog the event log is published under.\n" }, "name": { "type": "string", "description": "The table name the event log is published to in UC.\n" }, "schema": { "type": "string", "description": "The UC schema the event log is published under.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "catalog", "name", "schema" ] } } }, "databricks:index/PipelineFilters:PipelineFilters": { "properties": { "excludes": { "type": "array", "items": { "type": "string" }, "description": "Paths to exclude.\n" }, "includes": { "type": "array", "items": { "type": "string" }, "description": "Paths to include.\n" } }, "type": "object" }, "databricks:index/PipelineGatewayDefinition:PipelineGatewayDefinition": { "properties": { "connectionId": { "type": "string", "description": "Deprecated, Immutable. The Unity Catalog connection this gateway pipeline uses to communicate with the source. *Use \u003cspan pulumi-lang-nodejs=\"`connectionName`\" pulumi-lang-dotnet=\"`ConnectionName`\" pulumi-lang-go=\"`connectionName`\" pulumi-lang-python=\"`connection_name`\" pulumi-lang-yaml=\"`connectionName`\" pulumi-lang-java=\"`connectionName`\" pulumi-lang-hcl=\"`connection_name`\"\u003e`connectionName`\u003c/span\u003e instead!*\n", "willReplaceOnChanges": true }, "connectionName": { "type": "string", "description": "Immutable. The Unity Catalog connection that this gateway pipeline uses to communicate with the source.\n", "willReplaceOnChanges": true }, "connectionParameters": { "$ref": "#/types/databricks:index/PipelineGatewayDefinitionConnectionParameters:PipelineGatewayDefinitionConnectionParameters" }, "gatewayStorageCatalog": { "type": "string", "description": "Required, Immutable. The name of the catalog for the gateway pipeline's storage location.\n", "willReplaceOnChanges": true }, "gatewayStorageName": { "type": "string", "description": "Required. The Unity Catalog-compatible naming for the gateway storage location. This is the destination to use for the data that is extracted by the gateway. Lakeflow Declarative Pipelines system will automatically create the storage location under the catalog and schema.\n" }, "gatewayStorageSchema": { "type": "string", "description": "Required, Immutable. The name of the schema for the gateway pipelines's storage location.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "connectionName", "gatewayStorageCatalog", "gatewayStorageSchema" ] }, "databricks:index/PipelineGatewayDefinitionConnectionParameters:PipelineGatewayDefinitionConnectionParameters": { "properties": { "sourceCatalog": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinition:PipelineIngestionDefinition": { "properties": { "connectionName": { "type": "string", "willReplaceOnChanges": true }, "connectorType": { "type": "string" }, "dataStagingOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionDataStagingOptions:PipelineIngestionDefinitionDataStagingOptions" }, "fullRefreshWindow": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionFullRefreshWindow:PipelineIngestionDefinitionFullRefreshWindow" }, "ingestFromUcForeignCatalog": { "type": "boolean", "willReplaceOnChanges": true }, "ingestionGatewayId": { "type": "string", "willReplaceOnChanges": true }, "netsuiteJarPath": { "type": "string" }, "objects": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObject:PipelineIngestionDefinitionObject" } }, "sourceConfigurations": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionSourceConfiguration:PipelineIngestionDefinitionSourceConfiguration" } }, "sourceType": { "type": "string" }, "tableConfiguration": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionTableConfiguration:PipelineIngestionDefinitionTableConfiguration" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionDataStagingOptions:PipelineIngestionDefinitionDataStagingOptions": { "properties": { "catalogName": { "type": "string" }, "schemaName": { "type": "string" }, "volumeName": { "type": "string" } }, "type": "object", "required": [ "catalogName", "schemaName" ] }, "databricks:index/PipelineIngestionDefinitionFullRefreshWindow:PipelineIngestionDefinitionFullRefreshWindow": { "properties": { "daysOfWeeks": { "type": "array", "items": { "type": "string" } }, "startHour": { "type": "integer" }, "timeZoneId": { "type": "string" } }, "type": "object", "required": [ "startHour" ] }, "databricks:index/PipelineIngestionDefinitionObject:PipelineIngestionDefinitionObject": { "properties": { "report": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectReport:PipelineIngestionDefinitionObjectReport" }, "schema": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchema:PipelineIngestionDefinitionObjectSchema", "description": "The default schema (database) where tables are read from or published to. The presence of this attribute implies that the pipeline is in direct publishing mode.\n" }, "table": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTable:PipelineIngestionDefinitionObjectTable" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectReport:PipelineIngestionDefinitionObjectReport": { "properties": { "destinationCatalog": { "type": "string" }, "destinationSchema": { "type": "string" }, "destinationTable": { "type": "string" }, "sourceUrl": { "type": "string" }, "tableConfiguration": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectReportTableConfiguration:PipelineIngestionDefinitionObjectReportTableConfiguration" } }, "type": "object", "required": [ "destinationCatalog", "destinationSchema", "sourceUrl" ] }, "databricks:index/PipelineIngestionDefinitionObjectReportTableConfiguration:PipelineIngestionDefinitionObjectReportTableConfiguration": { "properties": { "autoFullRefreshPolicy": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionObjectReportTableConfigurationAutoFullRefreshPolicy" }, "excludeColumns": { "type": "array", "items": { "type": "string" } }, "includeColumns": { "type": "array", "items": { "type": "string" } }, "primaryKeys": { "type": "array", "items": { "type": "string" } }, "queryBasedConnectorConfig": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionObjectReportTableConfigurationQueryBasedConnectorConfig" }, "rowFilter": { "type": "string" }, "salesforceIncludeFormulaFields": { "type": "boolean" }, "scdType": { "type": "string" }, "sequenceBies": { "type": "array", "items": { "type": "string" } }, "workdayReportParameters": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParameters" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionObjectReportTableConfigurationAutoFullRefreshPolicy": { "properties": { "enabled": { "type": "boolean" }, "minIntervalHours": { "type": "integer" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionObjectReportTableConfigurationQueryBasedConnectorConfig": { "properties": { "cursorColumns": { "type": "array", "items": { "type": "string" } }, "deletionCondition": { "type": "string" }, "hardDeletionSyncMinIntervalInSeconds": { "type": "integer" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParameters": { "properties": { "incremental": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "reportParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParametersReportParameter" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionObjectReportTableConfigurationWorkdayReportParametersReportParameter": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchema:PipelineIngestionDefinitionObjectSchema": { "properties": { "connectorOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptions" }, "destinationCatalog": { "type": "string" }, "destinationSchema": { "type": "string" }, "sourceCatalog": { "type": "string" }, "sourceSchema": { "type": "string" }, "tableConfiguration": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfiguration:PipelineIngestionDefinitionObjectSchemaTableConfiguration" } }, "type": "object", "required": [ "destinationCatalog", "destinationSchema", "sourceSchema" ] }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptions": { "properties": { "confluenceOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsConfluenceOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsConfluenceOptions" }, "gdriveOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptions" }, "googleAdsOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGoogleAdsOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGoogleAdsOptions" }, "jiraOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsJiraOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsJiraOptions" }, "kafkaOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptions" }, "metaAdsOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsMetaAdsOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsMetaAdsOptions" }, "outlookOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsOutlookOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsOutlookOptions" }, "sharepointOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptions" }, "smartsheetOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSmartsheetOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSmartsheetOptions" }, "tiktokAdsOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsTiktokAdsOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsTiktokAdsOptions" }, "zendeskSupportOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsZendeskSupportOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsZendeskSupportOptions" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsConfluenceOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsConfluenceOptions": { "properties": { "includeConfluenceSpaces": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptions": { "properties": { "entityType": { "type": "string" }, "fileIngestionOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptions" }, "url": { "type": "string", "description": "URL of the Lakeflow Declarative Pipeline on the given workspace.\n" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptions": { "properties": { "corruptRecordColumn": { "type": "string" }, "fileFilters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter" } }, "format": { "type": "string" }, "formatOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "ignoreCorruptFiles": { "type": "boolean" }, "inferColumnTypes": { "type": "boolean" }, "readerCaseSensitive": { "type": "boolean" }, "rescuedDataColumn": { "type": "string" }, "schemaEvolutionMode": { "type": "string" }, "schemaHints": { "type": "string" }, "singleVariantColumn": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter": { "properties": { "modifiedAfter": { "type": "string" }, "modifiedBefore": { "type": "string" }, "pathFilter": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsGoogleAdsOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsGoogleAdsOptions": { "properties": { "lookbackWindowDays": { "type": "integer" }, "managerAccountId": { "type": "string" }, "syncStartDate": { "type": "string" } }, "type": "object", "required": [ "managerAccountId" ] }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsJiraOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsJiraOptions": { "properties": { "includeJiraSpaces": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptions": { "properties": { "clientConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "keyTransformer": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformer:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformer" }, "maxOffsetsPerTrigger": { "type": "integer" }, "startingOffset": { "type": "string" }, "topicPattern": { "type": "string" }, "topics": { "type": "array", "items": { "type": "string" } }, "valueTransformer": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformer:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformer" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformer:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformer": { "properties": { "format": { "type": "string" }, "jsonOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsKeyTransformerJsonOptions": { "properties": { "asVariant": { "type": "boolean" }, "schema": { "type": "string", "description": "The default schema (database) where tables are read from or published to. The presence of this attribute implies that the pipeline is in direct publishing mode.\n" }, "schemaEvolutionMode": { "type": "string" }, "schemaFilePath": { "type": "string" }, "schemaHints": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformer:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformer": { "properties": { "format": { "type": "string" }, "jsonOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsKafkaOptionsValueTransformerJsonOptions": { "properties": { "asVariant": { "type": "boolean" }, "schema": { "type": "string", "description": "The default schema (database) where tables are read from or published to. The presence of this attribute implies that the pipeline is in direct publishing mode.\n" }, "schemaEvolutionMode": { "type": "string" }, "schemaFilePath": { "type": "string" }, "schemaHints": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsMetaAdsOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsMetaAdsOptions": { "properties": { "actionAttributionWindows": { "type": "array", "items": { "type": "string" } }, "actionBreakdowns": { "type": "array", "items": { "type": "string" } }, "actionReportTime": { "type": "string" }, "breakdowns": { "type": "array", "items": { "type": "string" } }, "customInsightsLookbackWindow": { "type": "integer" }, "level": { "type": "string" }, "startDate": { "type": "string" }, "timeIncrement": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsOutlookOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsOutlookOptions": { "properties": { "attachmentMode": { "type": "string" }, "bodyFormat": { "type": "string" }, "folderFilters": { "type": "array", "items": { "type": "string" } }, "includeFolders": { "type": "array", "items": { "type": "string" } }, "includeMailboxes": { "type": "array", "items": { "type": "string" } }, "includeSenders": { "type": "array", "items": { "type": "string" } }, "includeSubjects": { "type": "array", "items": { "type": "string" } }, "senderFilters": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "subjectFilters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptions": { "properties": { "entityType": { "type": "string" }, "fileIngestionOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptions" }, "url": { "type": "string", "description": "URL of the Lakeflow Declarative Pipeline on the given workspace.\n" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptions": { "properties": { "corruptRecordColumn": { "type": "string" }, "fileFilters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter" } }, "format": { "type": "string" }, "formatOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "ignoreCorruptFiles": { "type": "boolean" }, "inferColumnTypes": { "type": "boolean" }, "readerCaseSensitive": { "type": "boolean" }, "rescuedDataColumn": { "type": "string" }, "schemaEvolutionMode": { "type": "string" }, "schemaHints": { "type": "string" }, "singleVariantColumn": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter": { "properties": { "modifiedAfter": { "type": "string" }, "modifiedBefore": { "type": "string" }, "pathFilter": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsSmartsheetOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsSmartsheetOptions": { "properties": { "enforceSchema": { "type": "boolean" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsTiktokAdsOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsTiktokAdsOptions": { "properties": { "dataLevel": { "type": "string" }, "dimensions": { "type": "array", "items": { "type": "string" } }, "lookbackWindowDays": { "type": "integer" }, "metrics": { "type": "array", "items": { "type": "string" } }, "queryLifetime": { "type": "boolean" }, "reportType": { "type": "string" }, "syncStartDate": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaConnectorOptionsZendeskSupportOptions:PipelineIngestionDefinitionObjectSchemaConnectorOptionsZendeskSupportOptions": { "properties": { "startDate": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfiguration:PipelineIngestionDefinitionObjectSchemaTableConfiguration": { "properties": { "autoFullRefreshPolicy": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionObjectSchemaTableConfigurationAutoFullRefreshPolicy" }, "excludeColumns": { "type": "array", "items": { "type": "string" } }, "includeColumns": { "type": "array", "items": { "type": "string" } }, "primaryKeys": { "type": "array", "items": { "type": "string" } }, "queryBasedConnectorConfig": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionObjectSchemaTableConfigurationQueryBasedConnectorConfig" }, "rowFilter": { "type": "string" }, "salesforceIncludeFormulaFields": { "type": "boolean" }, "scdType": { "type": "string" }, "sequenceBies": { "type": "array", "items": { "type": "string" } }, "workdayReportParameters": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParameters" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionObjectSchemaTableConfigurationAutoFullRefreshPolicy": { "properties": { "enabled": { "type": "boolean" }, "minIntervalHours": { "type": "integer" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionObjectSchemaTableConfigurationQueryBasedConnectorConfig": { "properties": { "cursorColumns": { "type": "array", "items": { "type": "string" } }, "deletionCondition": { "type": "string" }, "hardDeletionSyncMinIntervalInSeconds": { "type": "integer" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParameters": { "properties": { "incremental": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "reportParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParametersReportParameter" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionObjectSchemaTableConfigurationWorkdayReportParametersReportParameter": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTable:PipelineIngestionDefinitionObjectTable": { "properties": { "connectorOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptions:PipelineIngestionDefinitionObjectTableConnectorOptions" }, "destinationCatalog": { "type": "string" }, "destinationSchema": { "type": "string" }, "destinationTable": { "type": "string" }, "sourceCatalog": { "type": "string" }, "sourceSchema": { "type": "string" }, "sourceTable": { "type": "string" }, "tableConfiguration": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableTableConfiguration:PipelineIngestionDefinitionObjectTableTableConfiguration" } }, "type": "object", "required": [ "destinationCatalog", "destinationSchema", "sourceTable" ] }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptions:PipelineIngestionDefinitionObjectTableConnectorOptions": { "properties": { "confluenceOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsConfluenceOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsConfluenceOptions" }, "gdriveOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptions" }, "googleAdsOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGoogleAdsOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsGoogleAdsOptions" }, "jiraOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsJiraOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsJiraOptions" }, "kafkaOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptions" }, "metaAdsOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsMetaAdsOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsMetaAdsOptions" }, "outlookOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsOutlookOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsOutlookOptions" }, "sharepointOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptions" }, "smartsheetOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSmartsheetOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsSmartsheetOptions" }, "tiktokAdsOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsTiktokAdsOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsTiktokAdsOptions" }, "zendeskSupportOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsZendeskSupportOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsZendeskSupportOptions" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsConfluenceOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsConfluenceOptions": { "properties": { "includeConfluenceSpaces": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptions": { "properties": { "entityType": { "type": "string" }, "fileIngestionOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptions" }, "url": { "type": "string", "description": "URL of the Lakeflow Declarative Pipeline on the given workspace.\n" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptions": { "properties": { "corruptRecordColumn": { "type": "string" }, "fileFilters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter" } }, "format": { "type": "string" }, "formatOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "ignoreCorruptFiles": { "type": "boolean" }, "inferColumnTypes": { "type": "boolean" }, "readerCaseSensitive": { "type": "boolean" }, "rescuedDataColumn": { "type": "string" }, "schemaEvolutionMode": { "type": "string" }, "schemaHints": { "type": "string" }, "singleVariantColumn": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectTableConnectorOptionsGdriveOptionsFileIngestionOptionsFileFilter": { "properties": { "modifiedAfter": { "type": "string" }, "modifiedBefore": { "type": "string" }, "pathFilter": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsGoogleAdsOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsGoogleAdsOptions": { "properties": { "lookbackWindowDays": { "type": "integer" }, "managerAccountId": { "type": "string" }, "syncStartDate": { "type": "string" } }, "type": "object", "required": [ "managerAccountId" ] }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsJiraOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsJiraOptions": { "properties": { "includeJiraSpaces": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptions": { "properties": { "clientConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "keyTransformer": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformer:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformer" }, "maxOffsetsPerTrigger": { "type": "integer" }, "startingOffset": { "type": "string" }, "topicPattern": { "type": "string" }, "topics": { "type": "array", "items": { "type": "string" } }, "valueTransformer": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformer:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformer" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformer:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformer": { "properties": { "format": { "type": "string" }, "jsonOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsKeyTransformerJsonOptions": { "properties": { "asVariant": { "type": "boolean" }, "schema": { "type": "string", "description": "The default schema (database) where tables are read from or published to. The presence of this attribute implies that the pipeline is in direct publishing mode.\n" }, "schemaEvolutionMode": { "type": "string" }, "schemaFilePath": { "type": "string" }, "schemaHints": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformer:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformer": { "properties": { "format": { "type": "string" }, "jsonOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsKafkaOptionsValueTransformerJsonOptions": { "properties": { "asVariant": { "type": "boolean" }, "schema": { "type": "string", "description": "The default schema (database) where tables are read from or published to. The presence of this attribute implies that the pipeline is in direct publishing mode.\n" }, "schemaEvolutionMode": { "type": "string" }, "schemaFilePath": { "type": "string" }, "schemaHints": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsMetaAdsOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsMetaAdsOptions": { "properties": { "actionAttributionWindows": { "type": "array", "items": { "type": "string" } }, "actionBreakdowns": { "type": "array", "items": { "type": "string" } }, "actionReportTime": { "type": "string" }, "breakdowns": { "type": "array", "items": { "type": "string" } }, "customInsightsLookbackWindow": { "type": "integer" }, "level": { "type": "string" }, "startDate": { "type": "string" }, "timeIncrement": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsOutlookOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsOutlookOptions": { "properties": { "attachmentMode": { "type": "string" }, "bodyFormat": { "type": "string" }, "folderFilters": { "type": "array", "items": { "type": "string" } }, "includeFolders": { "type": "array", "items": { "type": "string" } }, "includeMailboxes": { "type": "array", "items": { "type": "string" } }, "includeSenders": { "type": "array", "items": { "type": "string" } }, "includeSubjects": { "type": "array", "items": { "type": "string" } }, "senderFilters": { "type": "array", "items": { "type": "string" } }, "startDate": { "type": "string" }, "subjectFilters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptions": { "properties": { "entityType": { "type": "string" }, "fileIngestionOptions": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptions" }, "url": { "type": "string", "description": "URL of the Lakeflow Declarative Pipeline on the given workspace.\n" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptions": { "properties": { "corruptRecordColumn": { "type": "string" }, "fileFilters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter" } }, "format": { "type": "string" }, "formatOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "ignoreCorruptFiles": { "type": "boolean" }, "inferColumnTypes": { "type": "boolean" }, "readerCaseSensitive": { "type": "boolean" }, "rescuedDataColumn": { "type": "string" }, "schemaEvolutionMode": { "type": "string" }, "schemaHints": { "type": "string" }, "singleVariantColumn": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter:PipelineIngestionDefinitionObjectTableConnectorOptionsSharepointOptionsFileIngestionOptionsFileFilter": { "properties": { "modifiedAfter": { "type": "string" }, "modifiedBefore": { "type": "string" }, "pathFilter": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsSmartsheetOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsSmartsheetOptions": { "properties": { "enforceSchema": { "type": "boolean" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsTiktokAdsOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsTiktokAdsOptions": { "properties": { "dataLevel": { "type": "string" }, "dimensions": { "type": "array", "items": { "type": "string" } }, "lookbackWindowDays": { "type": "integer" }, "metrics": { "type": "array", "items": { "type": "string" } }, "queryLifetime": { "type": "boolean" }, "reportType": { "type": "string" }, "syncStartDate": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableConnectorOptionsZendeskSupportOptions:PipelineIngestionDefinitionObjectTableConnectorOptionsZendeskSupportOptions": { "properties": { "startDate": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableTableConfiguration:PipelineIngestionDefinitionObjectTableTableConfiguration": { "properties": { "autoFullRefreshPolicy": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionObjectTableTableConfigurationAutoFullRefreshPolicy" }, "excludeColumns": { "type": "array", "items": { "type": "string" } }, "includeColumns": { "type": "array", "items": { "type": "string" } }, "primaryKeys": { "type": "array", "items": { "type": "string" } }, "queryBasedConnectorConfig": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionObjectTableTableConfigurationQueryBasedConnectorConfig" }, "rowFilter": { "type": "string" }, "salesforceIncludeFormulaFields": { "type": "boolean" }, "scdType": { "type": "string" }, "sequenceBies": { "type": "array", "items": { "type": "string" } }, "workdayReportParameters": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParameters" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionObjectTableTableConfigurationAutoFullRefreshPolicy": { "properties": { "enabled": { "type": "boolean" }, "minIntervalHours": { "type": "integer" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionObjectTableTableConfigurationQueryBasedConnectorConfig": { "properties": { "cursorColumns": { "type": "array", "items": { "type": "string" } }, "deletionCondition": { "type": "string" }, "hardDeletionSyncMinIntervalInSeconds": { "type": "integer" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParameters": { "properties": { "incremental": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "reportParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParametersReportParameter" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionObjectTableTableConfigurationWorkdayReportParametersReportParameter": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionSourceConfiguration:PipelineIngestionDefinitionSourceConfiguration": { "properties": { "catalog": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionSourceConfigurationCatalog:PipelineIngestionDefinitionSourceConfigurationCatalog", "description": "The name of default catalog in Unity Catalog. *Change of this parameter forces recreation of the pipeline if you switch from \u003cspan pulumi-lang-nodejs=\"`storage`\" pulumi-lang-dotnet=\"`Storage`\" pulumi-lang-go=\"`storage`\" pulumi-lang-python=\"`storage`\" pulumi-lang-yaml=\"`storage`\" pulumi-lang-java=\"`storage`\" pulumi-lang-hcl=\"`storage`\"\u003e`storage`\u003c/span\u003e to \u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e or vice versa. If pipeline was already created with \u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e set, the value could be changed.* (Conflicts with \u003cspan pulumi-lang-nodejs=\"`storage`\" pulumi-lang-dotnet=\"`Storage`\" pulumi-lang-go=\"`storage`\" pulumi-lang-python=\"`storage`\" pulumi-lang-yaml=\"`storage`\" pulumi-lang-java=\"`storage`\" pulumi-lang-hcl=\"`storage`\"\u003e`storage`\u003c/span\u003e).\n" }, "googleAdsConfig": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionSourceConfigurationGoogleAdsConfig:PipelineIngestionDefinitionSourceConfigurationGoogleAdsConfig" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionSourceConfigurationCatalog:PipelineIngestionDefinitionSourceConfigurationCatalog": { "properties": { "postgres": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionSourceConfigurationCatalogPostgres:PipelineIngestionDefinitionSourceConfigurationCatalogPostgres" }, "sourceCatalog": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionSourceConfigurationCatalogPostgres:PipelineIngestionDefinitionSourceConfigurationCatalogPostgres": { "properties": { "slotConfig": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionSourceConfigurationCatalogPostgresSlotConfig:PipelineIngestionDefinitionSourceConfigurationCatalogPostgresSlotConfig" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionSourceConfigurationCatalogPostgresSlotConfig:PipelineIngestionDefinitionSourceConfigurationCatalogPostgresSlotConfig": { "properties": { "publicationName": { "type": "string" }, "slotName": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionSourceConfigurationGoogleAdsConfig:PipelineIngestionDefinitionSourceConfigurationGoogleAdsConfig": { "properties": { "managerAccountId": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionTableConfiguration:PipelineIngestionDefinitionTableConfiguration": { "properties": { "autoFullRefreshPolicy": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy" }, "excludeColumns": { "type": "array", "items": { "type": "string" } }, "includeColumns": { "type": "array", "items": { "type": "string" } }, "primaryKeys": { "type": "array", "items": { "type": "string" } }, "queryBasedConnectorConfig": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig" }, "rowFilter": { "type": "string" }, "salesforceIncludeFormulaFields": { "type": "boolean" }, "scdType": { "type": "string" }, "sequenceBies": { "type": "array", "items": { "type": "string" } }, "workdayReportParameters": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy:PipelineIngestionDefinitionTableConfigurationAutoFullRefreshPolicy": { "properties": { "enabled": { "type": "boolean" }, "minIntervalHours": { "type": "integer" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig:PipelineIngestionDefinitionTableConfigurationQueryBasedConnectorConfig": { "properties": { "cursorColumns": { "type": "array", "items": { "type": "string" } }, "deletionCondition": { "type": "string" }, "hardDeletionSyncMinIntervalInSeconds": { "type": "integer" } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters:PipelineIngestionDefinitionTableConfigurationWorkdayReportParameters": { "properties": { "incremental": { "type": "boolean" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "reportParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameter" } } }, "type": "object" }, "databricks:index/PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameter:PipelineIngestionDefinitionTableConfigurationWorkdayReportParametersReportParameter": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineLatestUpdate:PipelineLatestUpdate": { "properties": { "creationTime": { "type": "string" }, "state": { "type": "string" }, "updateId": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineLibrary:PipelineLibrary": { "properties": { "file": { "$ref": "#/types/databricks:index/PipelineLibraryFile:PipelineLibraryFile", "description": "specifies path to a file in Databricks Workspace to include as source. Actual path is specified as \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e attribute inside the block.\n" }, "glob": { "$ref": "#/types/databricks:index/PipelineLibraryGlob:PipelineLibraryGlob", "description": "The unified field to include source code. Each entry should have the \u003cspan pulumi-lang-nodejs=\"`include`\" pulumi-lang-dotnet=\"`Include`\" pulumi-lang-go=\"`include`\" pulumi-lang-python=\"`include`\" pulumi-lang-yaml=\"`include`\" pulumi-lang-java=\"`include`\" pulumi-lang-hcl=\"`include`\"\u003e`include`\u003c/span\u003e attribute that can specify a notebook path, a file path, or a folder path that ends `/**` (to include everything from that folder). This field cannot be used together with \u003cspan pulumi-lang-nodejs=\"`notebook`\" pulumi-lang-dotnet=\"`Notebook`\" pulumi-lang-go=\"`notebook`\" pulumi-lang-python=\"`notebook`\" pulumi-lang-yaml=\"`notebook`\" pulumi-lang-java=\"`notebook`\" pulumi-lang-hcl=\"`notebook`\"\u003e`notebook`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`file`\" pulumi-lang-dotnet=\"`File`\" pulumi-lang-go=\"`file`\" pulumi-lang-python=\"`file`\" pulumi-lang-yaml=\"`file`\" pulumi-lang-java=\"`file`\" pulumi-lang-hcl=\"`file`\"\u003e`file`\u003c/span\u003e.\n" }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/PipelineLibraryMaven:PipelineLibraryMaven" }, "notebook": { "$ref": "#/types/databricks:index/PipelineLibraryNotebook:PipelineLibraryNotebook", "description": "specifies path to a Databricks Notebook to include as source. Actual path is specified as \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e attribute inside the block.\n" }, "whl": { "type": "string", "deprecationMessage": "The 'whl' field is deprecated" } }, "type": "object" }, "databricks:index/PipelineLibraryFile:PipelineLibraryFile": { "properties": { "path": { "type": "string" } }, "type": "object", "required": [ "path" ] }, "databricks:index/PipelineLibraryGlob:PipelineLibraryGlob": { "properties": { "include": { "type": "string", "description": "Paths to include.\n" } }, "type": "object", "required": [ "include" ] }, "databricks:index/PipelineLibraryMaven:PipelineLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/PipelineLibraryNotebook:PipelineLibraryNotebook": { "properties": { "path": { "type": "string" } }, "type": "object", "required": [ "path" ] }, "databricks:index/PipelineNotification:PipelineNotification": { "properties": { "alerts": { "type": "array", "items": { "type": "string" }, "description": "non-empty list of alert types. Right now following alert types are supported, consult documentation for actual list\n* `on-update-success` - a pipeline update completes successfully.\n* `on-update-failure` - a pipeline update fails with a retryable error.\n* `on-update-fatal-failure` - a pipeline update fails with a non-retryable (fatal) error.\n* `on-flow-failure` - a single data flow fails.\n" }, "emailRecipients": { "type": "array", "items": { "type": "string" }, "description": "non-empty list of emails to notify.\n" } }, "type": "object" }, "databricks:index/PipelineProviderConfig:PipelineProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PipelineRestartWindow:PipelineRestartWindow": { "properties": { "daysOfWeeks": { "type": "array", "items": { "type": "string" } }, "startHour": { "type": "integer" }, "timeZoneId": { "type": "string" } }, "type": "object", "required": [ "startHour" ] }, "databricks:index/PipelineRunAs:PipelineRunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "The application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role.\n\nExample:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Pipeline(\"this\", {runAs: {\n servicePrincipalName: \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\",\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Pipeline(\"this\", run_as={\n \"service_principal_name\": \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\",\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Pipeline(\"this\", new()\n {\n RunAs = new Databricks.Inputs.PipelineRunAsArgs\n {\n ServicePrincipalName = \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewPipeline(ctx, \"this\", \u0026databricks.PipelineArgs{\n\t\t\tRunAs: \u0026databricks.PipelineRunAsArgs{\n\t\t\t\tServicePrincipalName: pulumi.String(\"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_pipeline\" \"this\" {\n run_as = {\n service_principal_name = \"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Pipeline;\nimport com.pulumi.databricks.PipelineArgs;\nimport com.pulumi.databricks.inputs.PipelineRunAsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Pipeline(\"this\", PipelineArgs.builder()\n .runAs(PipelineRunAsArgs.builder()\n .servicePrincipalName(\"8d23ae77-912e-4a19-81e4-b9c3f5cc9349\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Pipeline\n properties:\n runAs:\n servicePrincipalName: 8d23ae77-912e-4a19-81e4-b9c3f5cc9349\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "userName": { "type": "string", "description": "The email of an active workspace user. Non-admin users can only set this field to their own email.\n" } }, "type": "object" }, "databricks:index/PipelineTrigger:PipelineTrigger": { "properties": { "cron": { "$ref": "#/types/databricks:index/PipelineTriggerCron:PipelineTriggerCron" }, "manual": { "$ref": "#/types/databricks:index/PipelineTriggerManual:PipelineTriggerManual" } }, "type": "object" }, "databricks:index/PipelineTriggerCron:PipelineTriggerCron": { "properties": { "quartzCronSchedule": { "type": "string" }, "timezoneId": { "type": "string" } }, "type": "object" }, "databricks:index/PipelineTriggerManual:PipelineTriggerManual": { "type": "object" }, "databricks:index/PolicyInfoColumnMask:PolicyInfoColumnMask": { "properties": { "functionName": { "type": "string" }, "onColumn": { "type": "string", "description": "The alias of the column to be masked. The alias must refer to one of matched columns.\nThe values of the column is passed to the column mask function as the first argument.\nRequired on create and update\n" }, "usings": { "type": "array", "items": { "$ref": "#/types/databricks:index/PolicyInfoColumnMaskUsing:PolicyInfoColumnMaskUsing" } } }, "type": "object", "required": [ "functionName", "onColumn" ] }, "databricks:index/PolicyInfoColumnMaskUsing:PolicyInfoColumnMaskUsing": { "properties": { "alias": { "type": "string" }, "constant": { "type": "string", "description": "A constant literal\n" } }, "type": "object" }, "databricks:index/PolicyInfoMatchColumn:PolicyInfoMatchColumn": { "properties": { "alias": { "type": "string" }, "condition": { "type": "string", "description": "The condition expression used to match a table column\n" } }, "type": "object" }, "databricks:index/PolicyInfoProviderConfig:PolicyInfoProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PolicyInfoRowFilter:PolicyInfoRowFilter": { "properties": { "functionName": { "type": "string" }, "usings": { "type": "array", "items": { "$ref": "#/types/databricks:index/PolicyInfoRowFilterUsing:PolicyInfoRowFilterUsing" } } }, "type": "object", "required": [ "functionName" ] }, "databricks:index/PolicyInfoRowFilterUsing:PolicyInfoRowFilterUsing": { "properties": { "alias": { "type": "string" }, "constant": { "type": "string", "description": "A constant literal\n" } }, "type": "object" }, "databricks:index/PostgresBranchProviderConfig:PostgresBranchProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresBranchSpec:PostgresBranchSpec": { "properties": { "expireTime": { "type": "string", "description": "(string) - Absolute expiration time for the branch. Empty if expiration is disabled\n" }, "isProtected": { "type": "boolean", "description": "(boolean) - Whether the branch is protected\n" }, "noExpiry": { "type": "boolean", "description": "Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or\u003cspan pulumi-lang-nodejs=\" expireTime \" pulumi-lang-dotnet=\" ExpireTime \" pulumi-lang-go=\" expireTime \" pulumi-lang-python=\" expire_time \" pulumi-lang-yaml=\" expireTime \" pulumi-lang-java=\" expireTime \" pulumi-lang-hcl=\" expire_time \"\u003e expireTime \u003c/span\u003einstead.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`expireTime`\" pulumi-lang-dotnet=\"`ExpireTime`\" pulumi-lang-go=\"`expireTime`\" pulumi-lang-python=\"`expire_time`\" pulumi-lang-yaml=\"`expireTime`\" pulumi-lang-java=\"`expireTime`\" pulumi-lang-hcl=\"`expire_time`\"\u003e`expireTime`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`ttl`\" pulumi-lang-dotnet=\"`Ttl`\" pulumi-lang-go=\"`ttl`\" pulumi-lang-python=\"`ttl`\" pulumi-lang-yaml=\"`ttl`\" pulumi-lang-java=\"`ttl`\" pulumi-lang-hcl=\"`ttl`\"\u003e`ttl`\u003c/span\u003e. When updating, use `spec.expiration` in the update_mask\n" }, "sourceBranch": { "type": "string", "description": "(string) - The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "sourceBranchLsn": { "type": "string", "description": "(string) - The Log Sequence Number (LSN) on the source branch from which this branch was created\n" }, "sourceBranchTime": { "type": "string", "description": "(string) - The point in time on the source branch from which this branch was created\n" }, "ttl": { "type": "string", "description": "Relative time-to-live duration. When set, the branch will expire at\u003cspan pulumi-lang-nodejs=\" creationTime \" pulumi-lang-dotnet=\" CreationTime \" pulumi-lang-go=\" creationTime \" pulumi-lang-python=\" creation_time \" pulumi-lang-yaml=\" creationTime \" pulumi-lang-java=\" creationTime \" pulumi-lang-hcl=\" creation_time \"\u003e creationTime \u003c/span\u003e+ ttl.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`expireTime`\" pulumi-lang-dotnet=\"`ExpireTime`\" pulumi-lang-go=\"`expireTime`\" pulumi-lang-python=\"`expire_time`\" pulumi-lang-yaml=\"`expireTime`\" pulumi-lang-java=\"`expireTime`\" pulumi-lang-hcl=\"`expire_time`\"\u003e`expireTime`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`noExpiry`\" pulumi-lang-dotnet=\"`NoExpiry`\" pulumi-lang-go=\"`noExpiry`\" pulumi-lang-python=\"`no_expiry`\" pulumi-lang-yaml=\"`noExpiry`\" pulumi-lang-java=\"`noExpiry`\" pulumi-lang-hcl=\"`no_expiry`\"\u003e`noExpiry`\u003c/span\u003e. When updating, use `spec.expiration` in the update_mask\n" } }, "type": "object" }, "databricks:index/PostgresBranchStatus:PostgresBranchStatus": { "properties": { "branchId": { "type": "string", "description": "The ID to use for the Branch. This becomes the final component of the branch's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, \u003cspan pulumi-lang-nodejs=\"`development`\" pulumi-lang-dotnet=\"`Development`\" pulumi-lang-go=\"`development`\" pulumi-lang-python=\"`development`\" pulumi-lang-yaml=\"`development`\" pulumi-lang-java=\"`development`\" pulumi-lang-hcl=\"`development`\"\u003e`development`\u003c/span\u003e becomes `projects/my-app/branches/development`\n" }, "currentState": { "type": "string", "description": "(string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: `ARCHIVED`, `DELETED`, `IMPORTING`, `INIT`, `READY`, `RESETTING`\n" }, "default": { "type": "boolean", "description": "(boolean) - Whether the branch is the project's default branch\n" }, "deleteTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch was deleted.\nEmpty if the branch is not deleted\n" }, "expireTime": { "type": "string", "description": "(string) - Absolute expiration time for the branch. Empty if expiration is disabled\n" }, "isProtected": { "type": "boolean", "description": "(boolean) - Whether the branch is protected\n" }, "logicalSizeBytes": { "type": "integer", "description": "(integer) - The logical size of the branch\n" }, "pendingState": { "type": "string", "description": "(string) - The pending state of the branch, if a state transition is in progress. Possible values are: `ARCHIVED`, `DELETED`, `IMPORTING`, `INIT`, `READY`, `RESETTING`\n" }, "purgeTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch is scheduled to be purged.\nEmpty if the branch is not deleted, otherwise set to a timestamp in the future\n" }, "sourceBranch": { "type": "string", "description": "(string) - The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "sourceBranchLsn": { "type": "string", "description": "(string) - The Log Sequence Number (LSN) on the source branch from which this branch was created\n" }, "sourceBranchTime": { "type": "string", "description": "(string) - The point in time on the source branch from which this branch was created\n" }, "stateChangeTime": { "type": "string", "description": "(string) - A timestamp indicating when the \u003cspan pulumi-lang-nodejs=\"`currentState`\" pulumi-lang-dotnet=\"`CurrentState`\" pulumi-lang-go=\"`currentState`\" pulumi-lang-python=\"`current_state`\" pulumi-lang-yaml=\"`currentState`\" pulumi-lang-java=\"`currentState`\" pulumi-lang-hcl=\"`current_state`\"\u003e`currentState`\u003c/span\u003e began\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "branchId", "currentState", "default", "deleteTime", "expireTime", "isProtected", "logicalSizeBytes", "pendingState", "purgeTime", "sourceBranch", "sourceBranchLsn", "sourceBranchTime", "stateChangeTime" ] } } }, "databricks:index/PostgresCatalogProviderConfig:PostgresCatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresCatalogSpec:PostgresCatalogSpec": { "properties": { "branch": { "type": "string", "description": "(string) - The resource path of the branch associated with the catalog.\n" }, "createDatabaseIfMissing": { "type": "boolean", "description": "If set to true, the specified\u003cspan pulumi-lang-nodejs=\" postgresDatabase \" pulumi-lang-dotnet=\" PostgresDatabase \" pulumi-lang-go=\" postgresDatabase \" pulumi-lang-python=\" postgres_database \" pulumi-lang-yaml=\" postgresDatabase \" pulumi-lang-java=\" postgresDatabase \" pulumi-lang-hcl=\" postgres_database \"\u003e postgresDatabase \u003c/span\u003eis created on behalf of the calling user\nif it does not already exist. In this case, the calling user has a role created for\nthem in Postgres if they do not already have one.\n\nDefaults to false, meaning that the request fails if the specified\u003cspan pulumi-lang-nodejs=\" postgresDatabase \" pulumi-lang-dotnet=\" PostgresDatabase \" pulumi-lang-go=\" postgresDatabase \" pulumi-lang-python=\" postgres_database \" pulumi-lang-yaml=\" postgresDatabase \" pulumi-lang-java=\" postgresDatabase \" pulumi-lang-hcl=\" postgres_database \"\u003e postgresDatabase \u003c/span\u003edoes not already exist\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database associated with the catalog\n" } }, "type": "object", "required": [ "postgresDatabase" ], "language": { "nodejs": { "requiredOutputs": [ "createDatabaseIfMissing", "postgresDatabase" ] } } }, "databricks:index/PostgresCatalogStatus:PostgresCatalogStatus": { "properties": { "branch": { "type": "string", "description": "(string) - The resource path of the branch associated with the catalog.\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database associated with the catalog\n" }, "project": { "type": "string", "description": "(string) - The resource path of the project associated with the catalog.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "branch", "postgresDatabase", "project" ] } } }, "databricks:index/PostgresDatabaseProviderConfig:PostgresDatabaseProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresDatabaseSpec:PostgresDatabaseSpec": { "properties": { "postgresDatabase": { "type": "string" }, "role": { "type": "string" } }, "type": "object" }, "databricks:index/PostgresDatabaseStatus:PostgresDatabaseStatus": { "properties": { "databaseId": { "type": "string", "description": "The ID to use for the Database, which will become the final component of\nthe database's resource name.\nThis ID becomes the database name in postgres.\n\nThis value should be 4-63 characters, and only use characters available in DNS names,\nas defined by RFC-1123\n\nIf\u003cspan pulumi-lang-nodejs=\" databaseId \" pulumi-lang-dotnet=\" DatabaseId \" pulumi-lang-go=\" databaseId \" pulumi-lang-python=\" database_id \" pulumi-lang-yaml=\" databaseId \" pulumi-lang-java=\" databaseId \" pulumi-lang-hcl=\" database_id \"\u003e databaseId \u003c/span\u003eis not specified in the request, it is generated automatically\n" }, "postgresDatabase": { "type": "string" }, "role": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "databaseId" ] } } }, "databricks:index/PostgresEndpointProviderConfig:PostgresEndpointProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresEndpointSpec:PostgresEndpointSpec": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units\n" }, "disabled": { "type": "boolean", "description": "(boolean) - Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action\n" }, "endpointType": { "type": "string", "description": "(string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: `ENDPOINT_TYPE_READ_ONLY`, `ENDPOINT_TYPE_READ_WRITE`\n" }, "group": { "$ref": "#/types/databricks:index/PostgresEndpointSpecGroup:PostgresEndpointSpecGroup", "description": "(EndpointGroupStatus) - Details on the HA configuration of the endpoint\n" }, "noSuspension": { "type": "boolean", "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.suspension` in the update_mask\n" }, "settings": { "$ref": "#/types/databricks:index/PostgresEndpointSpecSettings:PostgresEndpointSpecSettings", "description": "(EndpointSettings)\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended\n" } }, "type": "object", "required": [ "endpointType" ] }, "databricks:index/PostgresEndpointSpecGroup:PostgresEndpointSpecGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1\n" }, "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ] }, "databricks:index/PostgresEndpointSpecSettings:PostgresEndpointSpecSettings": { "properties": { "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A raw representation of Postgres settings\n" } }, "type": "object" }, "databricks:index/PostgresEndpointStatus:PostgresEndpointStatus": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units\n" }, "currentState": { "type": "string", "description": "(string) - Possible values are: `ACTIVE`, `DEGRADED`, `IDLE`, `INIT`\n" }, "disabled": { "type": "boolean", "description": "(boolean) - Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action\n" }, "endpointId": { "type": "string", "description": "The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, \u003cspan pulumi-lang-nodejs=\"`primary`\" pulumi-lang-dotnet=\"`Primary`\" pulumi-lang-go=\"`primary`\" pulumi-lang-python=\"`primary`\" pulumi-lang-yaml=\"`primary`\" pulumi-lang-java=\"`primary`\" pulumi-lang-hcl=\"`primary`\"\u003e`primary`\u003c/span\u003e becomes `projects/my-app/branches/development/endpoints/primary`\n" }, "endpointType": { "type": "string", "description": "(string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: `ENDPOINT_TYPE_READ_ONLY`, `ENDPOINT_TYPE_READ_WRITE`\n" }, "group": { "$ref": "#/types/databricks:index/PostgresEndpointStatusGroup:PostgresEndpointStatusGroup", "description": "(EndpointGroupStatus) - Details on the HA configuration of the endpoint\n" }, "hosts": { "$ref": "#/types/databricks:index/PostgresEndpointStatusHosts:PostgresEndpointStatusHosts", "description": "(EndpointHosts) - Contains host information for connecting to the endpoint\n" }, "pendingState": { "type": "string", "description": "(string) - Possible values are: `ACTIVE`, `DEGRADED`, `IDLE`, `INIT`\n" }, "settings": { "$ref": "#/types/databricks:index/PostgresEndpointStatusSettings:PostgresEndpointStatusSettings", "description": "(EndpointSettings)\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autoscalingLimitMaxCu", "autoscalingLimitMinCu", "currentState", "disabled", "endpointId", "endpointType", "group", "hosts", "pendingState", "settings", "suspendTimeoutDuration" ] } } }, "databricks:index/PostgresEndpointStatusGroup:PostgresEndpointStatusGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1\n" }, "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredOutputs": [ "enableReadableSecondaries", "max", "min" ] } } }, "databricks:index/PostgresEndpointStatusHosts:PostgresEndpointStatusHosts": { "properties": { "host": { "type": "string", "description": "(string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects\nto the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations\n" }, "readOnlyHost": { "type": "string", "description": "(string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,\nthis attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined\nif the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "host", "readOnlyHost" ] } } }, "databricks:index/PostgresEndpointStatusSettings:PostgresEndpointStatusSettings": { "properties": { "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A raw representation of Postgres settings\n" } }, "type": "object" }, "databricks:index/PostgresProjectInitialEndpointSpec:PostgresProjectInitialEndpointSpec": { "properties": { "group": { "$ref": "#/types/databricks:index/PostgresProjectInitialEndpointSpecGroup:PostgresProjectInitialEndpointSpecGroup", "description": "Settings for HA configuration of the endpoint\n" } }, "type": "object" }, "databricks:index/PostgresProjectInitialEndpointSpecGroup:PostgresProjectInitialEndpointSpecGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1\n" }, "max": { "type": "integer", "description": "The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "max", "min" ] }, "databricks:index/PostgresProjectProviderConfig:PostgresProjectProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresProjectSpec:PostgresProjectSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "(string) - The budget policy that is applied to the project\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/PostgresProjectSpecCustomTag:PostgresProjectSpecCustomTag" }, "description": "(list of ProjectCustomTag) - The effective custom tags associated with the project\n" }, "defaultBranch": { "type": "string", "description": "(string) - The full resource path of the default branch of the project\n" }, "defaultEndpointSettings": { "$ref": "#/types/databricks:index/PostgresProjectSpecDefaultEndpointSettings:PostgresProjectSpecDefaultEndpointSettings", "description": "(ProjectDefaultEndpointSettings) - The effective default endpoint settings\n" }, "displayName": { "type": "string", "description": "(string) - The effective human-readable project name\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on all endpoints in this project\n" }, "historyRetentionDuration": { "type": "string", "description": "(string) - The effective number of seconds to retain the shared history for point in time recovery\n" }, "pgVersion": { "type": "integer", "description": "(integer) - The effective major Postgres version number\n" } }, "type": "object" }, "databricks:index/PostgresProjectSpecCustomTag:PostgresProjectSpecCustomTag": { "properties": { "key": { "type": "string", "description": "The key of the custom tag\n" }, "value": { "type": "string", "description": "The value of the custom tag\n" } }, "type": "object" }, "databricks:index/PostgresProjectSpecDefaultEndpointSettings:PostgresProjectSpecDefaultEndpointSettings": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "The maximum number of Compute Units. Minimum value is 0.5\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "The minimum number of Compute Units. Minimum value is 0.5\n" }, "noSuspension": { "type": "boolean", "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" }, "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A raw representation of Postgres settings\n" }, "suspendTimeoutDuration": { "type": "string", "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`noSuspension`\" pulumi-lang-dotnet=\"`NoSuspension`\" pulumi-lang-go=\"`noSuspension`\" pulumi-lang-python=\"`no_suspension`\" pulumi-lang-yaml=\"`noSuspension`\" pulumi-lang-java=\"`noSuspension`\" pulumi-lang-hcl=\"`no_suspension`\"\u003e`noSuspension`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" } }, "type": "object" }, "databricks:index/PostgresProjectStatus:PostgresProjectStatus": { "properties": { "branchLogicalSizeLimitBytes": { "type": "integer", "description": "(integer) - The logical size limit for a branch\n" }, "budgetPolicyId": { "type": "string", "description": "(string) - The budget policy that is applied to the project\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/PostgresProjectStatusCustomTag:PostgresProjectStatusCustomTag" }, "description": "(list of ProjectCustomTag) - The effective custom tags associated with the project\n" }, "defaultBranch": { "type": "string", "description": "(string) - The full resource path of the default branch of the project\n" }, "defaultEndpointSettings": { "$ref": "#/types/databricks:index/PostgresProjectStatusDefaultEndpointSettings:PostgresProjectStatusDefaultEndpointSettings", "description": "(ProjectDefaultEndpointSettings) - The effective default endpoint settings\n" }, "displayName": { "type": "string", "description": "(string) - The effective human-readable project name\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on all endpoints in this project\n" }, "historyRetentionDuration": { "type": "string", "description": "(string) - The effective number of seconds to retain the shared history for point in time recovery\n" }, "owner": { "type": "string", "description": "(string) - The email of the project owner\n" }, "pgVersion": { "type": "integer", "description": "(integer) - The effective major Postgres version number\n" }, "projectId": { "type": "string", "description": "The ID to use for the Project. This becomes the final component of the project's resource name.\nThe ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.\nFor example, `my-app` becomes `projects/my-app`\n" }, "syntheticStorageSizeBytes": { "type": "integer", "description": "(integer) - The current space occupied by the project in storage\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "branchLogicalSizeLimitBytes", "budgetPolicyId", "customTags", "defaultBranch", "defaultEndpointSettings", "displayName", "enablePgNativeLogin", "historyRetentionDuration", "owner", "pgVersion", "projectId", "syntheticStorageSizeBytes" ] } } }, "databricks:index/PostgresProjectStatusCustomTag:PostgresProjectStatusCustomTag": { "properties": { "key": { "type": "string", "description": "The key of the custom tag\n" }, "value": { "type": "string", "description": "The value of the custom tag\n" } }, "type": "object" }, "databricks:index/PostgresProjectStatusDefaultEndpointSettings:PostgresProjectStatusDefaultEndpointSettings": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "The maximum number of Compute Units. Minimum value is 0.5\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "The minimum number of Compute Units. Minimum value is 0.5\n" }, "noSuspension": { "type": "boolean", "description": "When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" }, "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A raw representation of Postgres settings\n" }, "suspendTimeoutDuration": { "type": "string", "description": "Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`noSuspension`\" pulumi-lang-dotnet=\"`NoSuspension`\" pulumi-lang-go=\"`noSuspension`\" pulumi-lang-python=\"`no_suspension`\" pulumi-lang-yaml=\"`noSuspension`\" pulumi-lang-java=\"`noSuspension`\" pulumi-lang-hcl=\"`no_suspension`\"\u003e`noSuspension`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" } }, "type": "object" }, "databricks:index/PostgresRoleProviderConfig:PostgresRoleProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresRoleSpec:PostgresRoleSpec": { "properties": { "attributes": { "$ref": "#/types/databricks:index/PostgresRoleSpecAttributes:PostgresRoleSpecAttributes" }, "authMethod": { "type": "string" }, "identityType": { "type": "string" }, "membershipRoles": { "type": "array", "items": { "type": "string" } }, "postgresRole": { "type": "string" } }, "type": "object" }, "databricks:index/PostgresRoleSpecAttributes:PostgresRoleSpecAttributes": { "properties": { "bypassrls": { "type": "boolean" }, "createdb": { "type": "boolean" }, "createrole": { "type": "boolean" } }, "type": "object" }, "databricks:index/PostgresRoleStatus:PostgresRoleStatus": { "properties": { "attributes": { "$ref": "#/types/databricks:index/PostgresRoleStatusAttributes:PostgresRoleStatusAttributes" }, "authMethod": { "type": "string" }, "identityType": { "type": "string" }, "membershipRoles": { "type": "array", "items": { "type": "string" } }, "postgresRole": { "type": "string" }, "roleId": { "type": "string", "description": "The ID to use for the Role, which will become the final component of\nthe role's resource name.\nThis ID becomes the role in Postgres.\n\nThis value should be 4-63 characters, and valid characters\nare lowercase letters, numbers, and hyphens, as defined by RFC 1123.\n\nIf\u003cspan pulumi-lang-nodejs=\" roleId \" pulumi-lang-dotnet=\" RoleId \" pulumi-lang-go=\" roleId \" pulumi-lang-python=\" role_id \" pulumi-lang-yaml=\" roleId \" pulumi-lang-java=\" roleId \" pulumi-lang-hcl=\" role_id \"\u003e roleId \u003c/span\u003eis not specified in the request, it is generated automatically\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "roleId" ] } } }, "databricks:index/PostgresRoleStatusAttributes:PostgresRoleStatusAttributes": { "properties": { "bypassrls": { "type": "boolean" }, "createdb": { "type": "boolean" }, "createrole": { "type": "boolean" } }, "type": "object" }, "databricks:index/PostgresSyncedTableProviderConfig:PostgresSyncedTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/PostgresSyncedTableSpec:PostgresSyncedTableSpec": { "properties": { "branch": { "type": "string", "description": "The full resource name the branch associated with the table.\n\nFormat: \"projects/{project_id}/branches/{branch_id}\"\n" }, "createDatabaseObjectsIfMissing": { "type": "boolean", "description": "If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.\nThe request will fail if this is false and the database/schema do not exist.\n\nDefaults to true if omitted\n" }, "existingPipelineId": { "type": "string", "description": "ID of an existing pipeline to bin-pack this synced table into.\nAt most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n\nThe pipeline used for the synced table is returned via the top level\u003cspan pulumi-lang-nodejs=\" pipelineId \" pulumi-lang-dotnet=\" PipelineId \" pulumi-lang-go=\" pipelineId \" pulumi-lang-python=\" pipeline_id \" pulumi-lang-yaml=\" pipelineId \" pulumi-lang-java=\" pipelineId \" pulumi-lang-hcl=\" pipeline_id \"\u003e pipelineId \u003c/span\u003eattribute\n" }, "newPipelineSpec": { "$ref": "#/types/databricks:index/PostgresSyncedTableSpecNewPipelineSpec:PostgresSyncedTableSpecNewPipelineSpec", "description": "Specification for creating a new pipeline.\nAt most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n\nThe pipeline used for the synced table is returned via the top level\u003cspan pulumi-lang-nodejs=\" pipelineId \" pulumi-lang-dotnet=\" PipelineId \" pulumi-lang-go=\" pipelineId \" pulumi-lang-python=\" pipeline_id \" pulumi-lang-yaml=\" pipelineId \" pulumi-lang-java=\" pipelineId \" pulumi-lang-hcl=\" pipeline_id \"\u003e pipelineId \u003c/span\u003eattribute\n" }, "postgresDatabase": { "type": "string", "description": "The Postgres database name where the synced table will be created in.\n\nIf this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred\nfrom the\u003cspan pulumi-lang-nodejs=\" postgresDatabase \" pulumi-lang-dotnet=\" PostgresDatabase \" pulumi-lang-go=\" postgresDatabase \" pulumi-lang-python=\" postgres_database \" pulumi-lang-yaml=\" postgresDatabase \" pulumi-lang-java=\" postgresDatabase \" pulumi-lang-hcl=\" postgres_database \"\u003e postgresDatabase \u003c/span\u003eassociated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.\n\nA value must be specified when creating a synced table inside a Standard Catalog\n" }, "primaryKeyColumns": { "type": "array", "items": { "type": "string" }, "description": "Primary Key columns to be used for data insert/update in the destination\n" }, "schedulingPolicy": { "type": "string", "description": "Scheduling policy of the underlying pipeline. Possible values are: `CONTINUOUS`, `SNAPSHOT`, `TRIGGERED`\n" }, "sourceTableFullName": { "type": "string", "description": "Three-part (catalog, schema, table) name of the source Delta table.\n\nFor the corresponding destination table, use any of the two:\n\n*\u003cspan pulumi-lang-nodejs=\" syncedTableId \" pulumi-lang-dotnet=\" SyncedTableId \" pulumi-lang-go=\" syncedTableId \" pulumi-lang-python=\" synced_table_id \" pulumi-lang-yaml=\" syncedTableId \" pulumi-lang-java=\" syncedTableId \" pulumi-lang-hcl=\" synced_table_id \"\u003e syncedTableId \u003c/span\u003eused at the creation of the SyncedTable\n* \"name\" consisting of \"synced_tables/\" prefix and the full name of the destination table\n" }, "timeseriesKey": { "type": "string", "description": "Time series key to deduplicate (tie-break) rows with the same primary key\n" } }, "type": "object" }, "databricks:index/PostgresSyncedTableSpecNewPipelineSpec:PostgresSyncedTableSpecNewPipelineSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "Budget policy to set on the newly created pipeline\n" }, "storageCatalog": { "type": "string", "description": "UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables\n" }, "storageSchema": { "type": "string", "description": "UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables\n" } }, "type": "object" }, "databricks:index/PostgresSyncedTableStatus:PostgresSyncedTableStatus": { "properties": { "detailedState": { "type": "string", "description": "(string) - The state of the synced table. Possible values are: `SYNCED_TABLE_OFFLINE`, `SYNCED_TABLE_OFFLINE_FAILED`, `SYNCED_TABLE_ONLINE`, `SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE`, `SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE`, `SYNCED_TABLE_ONLINE_PIPELINE_FAILED`, `SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE`, `SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES`, `SYNCED_TABLE_PROVISIONING`, `SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT`, `SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES`\n" }, "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "lastSync": { "$ref": "#/types/databricks:index/PostgresSyncedTableStatusLastSync:PostgresSyncedTableStatusLastSync", "description": "(SyncedTablePosition) - Summary of the last successful synchronization from source to destination\n" }, "lastSyncTime": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" }, "message": { "type": "string", "description": "(string) - A text description of the current state of the synced table\n" }, "ongoingSyncProgress": { "$ref": "#/types/databricks:index/PostgresSyncedTableStatusOngoingSyncProgress:PostgresSyncedTableStatusOngoingSyncProgress", "description": "(SyncedTablePipelineProgress)\n" }, "pipelineId": { "type": "string", "description": "(string) - ID of the associated pipeline\n" }, "project": { "type": "string", "description": "(string) - The full resource name of the project associated with the table.\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "unityCatalogProvisioningState": { "type": "string", "description": "(string) - The provisioning state of the synced table entity in Unity Catalog. Possible values are: `ACTIVE`, `DEGRADED`, `DELETING`, `FAILED`, `PROVISIONING`, `UPDATING`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "detailedState", "lastProcessedCommitVersion", "lastSync", "lastSyncTime", "message", "ongoingSyncProgress", "pipelineId", "project", "provisioningPhase", "unityCatalogProvisioningState" ] } } }, "databricks:index/PostgresSyncedTableStatusLastSync:PostgresSyncedTableStatusLastSync": { "properties": { "deltaTableSyncInfo": { "$ref": "#/types/databricks:index/PostgresSyncedTableStatusLastSyncDeltaTableSyncInfo:PostgresSyncedTableStatusLastSyncDeltaTableSyncInfo", "description": "(DeltaTableSyncInfo)\n" }, "syncEndTime": { "type": "string", "description": "(string) - The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table\n" }, "syncStartTime": { "type": "string", "description": "(string) - The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deltaTableSyncInfo", "syncEndTime", "syncStartTime" ] } } }, "databricks:index/PostgresSyncedTableStatusLastSyncDeltaTableSyncInfo:PostgresSyncedTableStatusLastSyncDeltaTableSyncInfo": { "properties": { "deltaCommitTime": { "type": "string", "description": "(string) - The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table\n" }, "deltaCommitVersion": { "type": "integer", "description": "(integer) - The Delta Lake commit version that was last successfully synced\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "deltaCommitTime", "deltaCommitVersion" ] } } }, "databricks:index/PostgresSyncedTableStatusOngoingSyncProgress:PostgresSyncedTableStatusOngoingSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ] } } }, "databricks:index/QualityMonitorCustomMetric:QualityMonitorCustomMetric": { "properties": { "definition": { "type": "string", "description": "[create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)\n" }, "inputColumns": { "type": "array", "items": { "type": "string" }, "description": "Columns on the monitored table to apply the custom metrics to.\n" }, "name": { "type": "string", "description": "Name of the custom metric.\n" }, "outputDataType": { "type": "string", "description": "The output type of the custom metric.\n" }, "type": { "type": "string", "description": "The type of the custom metric.\n" } }, "type": "object", "required": [ "definition", "inputColumns", "name", "outputDataType", "type" ] }, "databricks:index/QualityMonitorDataClassificationConfig:QualityMonitorDataClassificationConfig": { "properties": { "enabled": { "type": "boolean", "description": "Whether to enable data classification\n" } }, "type": "object" }, "databricks:index/QualityMonitorInferenceLog:QualityMonitorInferenceLog": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "List of granularities to use when aggregating data into time windows based on their timestamp.\n" }, "labelCol": { "type": "string", "description": "Column of the model label\n" }, "modelIdCol": { "type": "string", "description": "Column of the model id or version\n" }, "predictionCol": { "type": "string", "description": "Column of the model prediction\n" }, "predictionProbaCol": { "type": "string", "description": "Column of the model prediction probabilities\n" }, "problemType": { "type": "string", "description": "Problem type the model aims to solve. Either `PROBLEM_TYPE_CLASSIFICATION` or `PROBLEM_TYPE_REGRESSION`\n" }, "timestampCol": { "type": "string", "description": "Column of the timestamp of predictions\n" } }, "type": "object", "required": [ "granularities", "modelIdCol", "predictionCol", "problemType", "timestampCol" ] }, "databricks:index/QualityMonitorNotifications:QualityMonitorNotifications": { "properties": { "onFailure": { "$ref": "#/types/databricks:index/QualityMonitorNotificationsOnFailure:QualityMonitorNotificationsOnFailure", "description": "who to send notifications to on monitor failure.\n" }, "onNewClassificationTagDetected": { "$ref": "#/types/databricks:index/QualityMonitorNotificationsOnNewClassificationTagDetected:QualityMonitorNotificationsOnNewClassificationTagDetected", "description": "Who to send notifications to when new data classification tags are detected.\n" } }, "type": "object" }, "databricks:index/QualityMonitorNotificationsOnFailure:QualityMonitorNotificationsOnFailure": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/QualityMonitorNotificationsOnNewClassificationTagDetected:QualityMonitorNotificationsOnNewClassificationTagDetected": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/QualityMonitorProviderConfig:QualityMonitorProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ] }, "databricks:index/QualityMonitorSchedule:QualityMonitorSchedule": { "properties": { "pauseStatus": { "type": "string" }, "quartzCronExpression": { "type": "string", "description": "string expression that determines when to run the monitor. See [Quartz documentation](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for examples.\n" }, "timezoneId": { "type": "string", "description": "string with timezone id (e.g., `PST`) in which to evaluate the Quartz expression.\n" } }, "type": "object", "required": [ "quartzCronExpression", "timezoneId" ], "language": { "nodejs": { "requiredOutputs": [ "pauseStatus", "quartzCronExpression", "timezoneId" ] } } }, "databricks:index/QualityMonitorSnapshot:QualityMonitorSnapshot": { "type": "object" }, "databricks:index/QualityMonitorTimeSeries:QualityMonitorTimeSeries": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "List of granularities to use when aggregating data into time windows based on their timestamp.\n" }, "timestampCol": { "type": "string", "description": "Column of the timestamp of predictions\n" } }, "type": "object", "required": [ "granularities", "timestampCol" ] }, "databricks:index/QualityMonitorV2AnomalyDetectionConfig:QualityMonitorV2AnomalyDetectionConfig": { "properties": { "excludedTableFullNames": { "type": "array", "items": { "type": "string" }, "description": "List of fully qualified table names to exclude from anomaly detection\n" }, "lastRunId": { "type": "string", "description": "(string) - Run id of the last run of the workflow\n" }, "latestRunStatus": { "type": "string", "description": "(string) - The status of the last run of the workflow. Possible values are: `ANOMALY_DETECTION_RUN_STATUS_CANCELED`, `ANOMALY_DETECTION_RUN_STATUS_FAILED`, `ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED`, `ANOMALY_DETECTION_RUN_STATUS_PENDING`, `ANOMALY_DETECTION_RUN_STATUS_RUNNING`, `ANOMALY_DETECTION_RUN_STATUS_SUCCESS`, `ANOMALY_DETECTION_RUN_STATUS_UNKNOWN`, `ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "lastRunId", "latestRunStatus" ] } } }, "databricks:index/QualityMonitorV2ProviderConfig:QualityMonitorV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/QualityMonitorV2ValidityCheckConfiguration:QualityMonitorV2ValidityCheckConfiguration": { "properties": { "name": { "type": "string", "description": "Can be set by system. Does not need to be user facing\n" }, "percentNullValidityCheck": { "$ref": "#/types/databricks:index/QualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck:QualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck" }, "rangeValidityCheck": { "$ref": "#/types/databricks:index/QualityMonitorV2ValidityCheckConfigurationRangeValidityCheck:QualityMonitorV2ValidityCheckConfigurationRangeValidityCheck" }, "uniquenessValidityCheck": { "$ref": "#/types/databricks:index/QualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck:QualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck" } }, "type": "object" }, "databricks:index/QualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck:QualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" } }, "upperBound": { "type": "number" } }, "type": "object" }, "databricks:index/QualityMonitorV2ValidityCheckConfigurationRangeValidityCheck:QualityMonitorV2ValidityCheckConfigurationRangeValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" } }, "lowerBound": { "type": "number", "description": "Lower bound for the range\n" }, "upperBound": { "type": "number" } }, "type": "object" }, "databricks:index/QualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck:QualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/QueryParameter:QueryParameter": { "properties": { "dateRangeValue": { "$ref": "#/types/databricks:index/QueryParameterDateRangeValue:QueryParameterDateRangeValue", "description": "Date-range query parameter value. Consists of following attributes (Can only specify one of \u003cspan pulumi-lang-nodejs=\"`dynamicDateRangeValue`\" pulumi-lang-dotnet=\"`DynamicDateRangeValue`\" pulumi-lang-go=\"`dynamicDateRangeValue`\" pulumi-lang-python=\"`dynamic_date_range_value`\" pulumi-lang-yaml=\"`dynamicDateRangeValue`\" pulumi-lang-java=\"`dynamicDateRangeValue`\" pulumi-lang-hcl=\"`dynamic_date_range_value`\"\u003e`dynamicDateRangeValue`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`dateRangeValue`\" pulumi-lang-dotnet=\"`DateRangeValue`\" pulumi-lang-go=\"`dateRangeValue`\" pulumi-lang-python=\"`date_range_value`\" pulumi-lang-yaml=\"`dateRangeValue`\" pulumi-lang-java=\"`dateRangeValue`\" pulumi-lang-hcl=\"`date_range_value`\"\u003e`dateRangeValue`\u003c/span\u003e):\n" }, "dateValue": { "$ref": "#/types/databricks:index/QueryParameterDateValue:QueryParameterDateValue", "description": "Date query parameter value. Consists of following attributes (Can only specify one of \u003cspan pulumi-lang-nodejs=\"`dynamicDateValue`\" pulumi-lang-dotnet=\"`DynamicDateValue`\" pulumi-lang-go=\"`dynamicDateValue`\" pulumi-lang-python=\"`dynamic_date_value`\" pulumi-lang-yaml=\"`dynamicDateValue`\" pulumi-lang-java=\"`dynamicDateValue`\" pulumi-lang-hcl=\"`dynamic_date_value`\"\u003e`dynamicDateValue`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`dateValue`\" pulumi-lang-dotnet=\"`DateValue`\" pulumi-lang-go=\"`dateValue`\" pulumi-lang-python=\"`date_value`\" pulumi-lang-yaml=\"`dateValue`\" pulumi-lang-java=\"`dateValue`\" pulumi-lang-hcl=\"`date_value`\"\u003e`dateValue`\u003c/span\u003e):\n" }, "enumValue": { "$ref": "#/types/databricks:index/QueryParameterEnumValue:QueryParameterEnumValue", "description": "Dropdown parameter value. Consists of following attributes:\n" }, "name": { "type": "string", "description": "Literal parameter marker that appears between double curly braces in the query text.\n" }, "numericValue": { "$ref": "#/types/databricks:index/QueryParameterNumericValue:QueryParameterNumericValue", "description": "Numeric parameter value. Consists of following attributes:\n" }, "queryBackedValue": { "$ref": "#/types/databricks:index/QueryParameterQueryBackedValue:QueryParameterQueryBackedValue", "description": "Query-based dropdown parameter value. Consists of following attributes:\n" }, "textValue": { "$ref": "#/types/databricks:index/QueryParameterTextValue:QueryParameterTextValue", "description": "Text parameter value. Consists of following attributes:\n" }, "title": { "type": "string", "description": "Text displayed in the user-facing parameter widget in the UI.\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/QueryParameterDateRangeValue:QueryParameterDateRangeValue": { "properties": { "dateRangeValue": { "$ref": "#/types/databricks:index/QueryParameterDateRangeValueDateRangeValue:QueryParameterDateRangeValueDateRangeValue", "description": "Manually specified date-time range value. Consists of the following attributes:\n" }, "dynamicDateRangeValue": { "type": "string", "description": "Dynamic date-time range value based on current date-time. Possible values are `TODAY`, `YESTERDAY`, `THIS_WEEK`, `THIS_MONTH`, `THIS_YEAR`, `LAST_WEEK`, `LAST_MONTH`, `LAST_YEAR`, `LAST_HOUR`, `LAST_8_HOURS`, `LAST_24_HOURS`, `LAST_7_DAYS`, `LAST_14_DAYS`, `LAST_30_DAYS`, `LAST_60_DAYS`, `LAST_90_DAYS`, `LAST_12_MONTHS`.\n" }, "precision": { "type": "string", "description": "Date-time precision to format the value into when the query is run. Possible values are `DAY_PRECISION`, `MINUTE_PRECISION`, `SECOND_PRECISION`. Defaults to `DAY_PRECISION` (`YYYY-MM-DD`).\n" }, "startDayOfWeek": { "type": "integer", "description": "Specify what day that starts the week.\n" } }, "type": "object" }, "databricks:index/QueryParameterDateRangeValueDateRangeValue:QueryParameterDateRangeValueDateRangeValue": { "properties": { "end": { "type": "string", "description": "end of the date range.\n" }, "start": { "type": "string", "description": "begin of the date range.\n" } }, "type": "object", "required": [ "end", "start" ] }, "databricks:index/QueryParameterDateValue:QueryParameterDateValue": { "properties": { "dateValue": { "type": "string", "description": "Manually specified date-time value\n" }, "dynamicDateValue": { "type": "string", "description": "Dynamic date-time value based on current date-time. Possible values are `NOW`, `YESTERDAY`.\n" }, "precision": { "type": "string", "description": "Date-time precision to format the value into when the query is run. Possible values are `DAY_PRECISION`, `MINUTE_PRECISION`, `SECOND_PRECISION`. Defaults to `DAY_PRECISION` (`YYYY-MM-DD`).\n" } }, "type": "object" }, "databricks:index/QueryParameterEnumValue:QueryParameterEnumValue": { "properties": { "enumOptions": { "type": "string", "description": "List of valid query parameter values, newline delimited.\n" }, "multiValuesOptions": { "$ref": "#/types/databricks:index/QueryParameterEnumValueMultiValuesOptions:QueryParameterEnumValueMultiValuesOptions", "description": "If specified, allows multiple values to be selected for this parameter. Consists of following attributes:\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of selected query parameter values.\n" } }, "type": "object" }, "databricks:index/QueryParameterEnumValueMultiValuesOptions:QueryParameterEnumValueMultiValuesOptions": { "properties": { "prefix": { "type": "string", "description": "Character that prefixes each selected parameter value.\n" }, "separator": { "type": "string", "description": "Character that separates each selected parameter value. Defaults to a comma.\n" }, "suffix": { "type": "string", "description": "Character that suffixes each selected parameter value.\n" } }, "type": "object" }, "databricks:index/QueryParameterNumericValue:QueryParameterNumericValue": { "properties": { "value": { "type": "number", "description": "actual numeric value.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/QueryParameterQueryBackedValue:QueryParameterQueryBackedValue": { "properties": { "multiValuesOptions": { "$ref": "#/types/databricks:index/QueryParameterQueryBackedValueMultiValuesOptions:QueryParameterQueryBackedValueMultiValuesOptions", "description": "If specified, allows multiple values to be selected for this parameter. Consists of following attributes:\n" }, "queryId": { "type": "string", "description": "ID of the query that provides the parameter values.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of selected query parameter values.\n" } }, "type": "object", "required": [ "queryId" ] }, "databricks:index/QueryParameterQueryBackedValueMultiValuesOptions:QueryParameterQueryBackedValueMultiValuesOptions": { "properties": { "prefix": { "type": "string", "description": "Character that prefixes each selected parameter value.\n" }, "separator": { "type": "string", "description": "Character that separates each selected parameter value. Defaults to a comma.\n" }, "suffix": { "type": "string", "description": "Character that suffixes each selected parameter value.\n" } }, "type": "object" }, "databricks:index/QueryParameterTextValue:QueryParameterTextValue": { "properties": { "value": { "type": "string", "description": "actual text value.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/QueryProviderConfig:QueryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/RecipientIpAccessList:RecipientIpAccessList": { "properties": { "allowedIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Allowed IP Addresses in CIDR notation. Limit of 100.\n" } }, "type": "object" }, "databricks:index/RecipientPropertiesKvpairs:RecipientPropertiesKvpairs": { "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "a map of string key-value pairs with recipient's properties. Properties with name starting with `databricks.` are reserved.\n" } }, "type": "object", "required": [ "properties" ] }, "databricks:index/RecipientProviderConfig:RecipientProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/RecipientToken:RecipientToken": { "properties": { "activationUrl": { "type": "string", "description": "Full activation URL to retrieve the access token. It will be empty if the token is already retrieved.\n" }, "createdAt": { "type": "integer", "description": "Time at which this recipient was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of recipient creator.\n" }, "expirationTime": { "type": "integer", "description": "Expiration timestamp of the token in epoch milliseconds.\n" }, "id": { "type": "string", "description": "Unique ID of the recipient token.\n" }, "updatedAt": { "type": "integer", "description": "Time at which this recipient was updated, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of recipient Token updater.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "activationUrl", "createdAt", "createdBy", "expirationTime", "id", "updatedAt", "updatedBy" ] } } }, "databricks:index/RegisteredModelAlias:RegisteredModelAlias": { "properties": { "aliasName": { "type": "string" }, "catalogName": { "type": "string", "description": "The name of the catalog where the schema and the registered model reside. *Change of this parameter forces recreation of the resource.*\n" }, "id": { "type": "string", "description": "Equal to the full name of the model (`catalog_name.schema_name.name`) and used to identify the model uniquely across the metastore.\n" }, "modelName": { "type": "string" }, "schemaName": { "type": "string", "description": "The name of the schema where the registered model resides. *Change of this parameter forces recreation of the resource.*\n" }, "versionNum": { "type": "integer" } }, "type": "object" }, "databricks:index/RegisteredModelProviderConfig:RegisteredModelProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/RepoProviderConfig:RepoProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/RepoSparseCheckout:RepoSparseCheckout": { "properties": { "patterns": { "type": "array", "items": { "type": "string" }, "description": "array of paths (directories) that will be used for sparse checkout. List of patterns could be updated in-place.\n\nAddition or removal of the \u003cspan pulumi-lang-nodejs=\"`sparseCheckout`\" pulumi-lang-dotnet=\"`SparseCheckout`\" pulumi-lang-go=\"`sparseCheckout`\" pulumi-lang-python=\"`sparse_checkout`\" pulumi-lang-yaml=\"`sparseCheckout`\" pulumi-lang-java=\"`sparseCheckout`\" pulumi-lang-hcl=\"`sparse_checkout`\"\u003e`sparseCheckout`\u003c/span\u003e configuration block will lead to recreation of the Git folder.\n" } }, "type": "object", "required": [ "patterns" ] }, "databricks:index/RestrictWorkspaceAdminsSettingProviderConfig:RestrictWorkspaceAdminsSettingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/RestrictWorkspaceAdminsSettingRestrictWorkspaceAdmins:RestrictWorkspaceAdminsSettingRestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean" }, "status": { "type": "string", "description": "The restrict workspace admins status for the workspace.\n" } }, "type": "object", "required": [ "status" ] }, "databricks:index/RfaAccessRequestDestinationsDestination:RfaAccessRequestDestinationsDestination": { "properties": { "destinationId": { "type": "string", "description": "The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations,\nor the unique Databricks notification destination ID for all other external destinations\n" }, "destinationType": { "type": "string", "description": "The type of the destination. Possible values are: `EMAIL`, `GENERIC_WEBHOOK`, `MICROSOFT_TEAMS`, `SLACK`, `URL`\n" }, "specialDestination": { "type": "string", "description": "This field is used to denote whether the destination is the email of the owner of the securable object.\nThe special destination cannot be assigned to a securable and only represents the default destination of the securable.\nThe securable types that support default special destinations are: \"catalog\", \u003cspan pulumi-lang-nodejs=\"\"externalLocation\"\" pulumi-lang-dotnet=\"\"ExternalLocation\"\" pulumi-lang-go=\"\"externalLocation\"\" pulumi-lang-python=\"\"external_location\"\" pulumi-lang-yaml=\"\"externalLocation\"\" pulumi-lang-java=\"\"externalLocation\"\" pulumi-lang-hcl=\"\"external_location\"\"\u003e\"externalLocation\"\u003c/span\u003e, \"connection\", \"credential\", and \"metastore\".\nThe **destination_type** of a **special_destination** is always EMAIL. Possible values are: `SPECIAL_DESTINATION_CATALOG_OWNER`, `SPECIAL_DESTINATION_CONNECTION_OWNER`, `SPECIAL_DESTINATION_CREDENTIAL_OWNER`, `SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER`, `SPECIAL_DESTINATION_METASTORE_OWNER`\n" } }, "type": "object" }, "databricks:index/RfaAccessRequestDestinationsDestinationSourceSecurable:RfaAccessRequestDestinationsDestinationSourceSecurable": { "properties": { "fullName": { "type": "string", "description": "(string) - The full name of the securable. Redundant with the name in the securable object, but necessary for Pulumi integration\n" }, "providerShare": { "type": "string", "description": "Optional. The name of the Share object that contains the securable when the securable is\ngetting shared in D2D Delta Sharing\n" }, "type": { "type": "string", "description": "Required. The type of securable (catalog/schema/table).\nOptional if\u003cspan pulumi-lang-nodejs=\" resourceName \" pulumi-lang-dotnet=\" ResourceName \" pulumi-lang-go=\" resourceName \" pulumi-lang-python=\" resource_name \" pulumi-lang-yaml=\" resourceName \" pulumi-lang-java=\" resourceName \" pulumi-lang-hcl=\" resource_name \"\u003e resourceName \u003c/span\u003eis present. Possible values are: `CATALOG`, `CLEAN_ROOM`, `CONNECTION`, `CREDENTIAL`, `EXTERNAL_LOCATION`, `EXTERNAL_METADATA`, `FUNCTION`, `METASTORE`, `PIPELINE`, `PROVIDER`, `RECIPIENT`, `SCHEMA`, `SHARE`, `STAGING_TABLE`, `STORAGE_CREDENTIAL`, `TABLE`, `VOLUME`\n" } }, "type": "object" }, "databricks:index/RfaAccessRequestDestinationsProviderConfig:RfaAccessRequestDestinationsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/RfaAccessRequestDestinationsSecurable:RfaAccessRequestDestinationsSecurable": { "properties": { "fullName": { "type": "string", "description": "Required. The full name of the catalog/schema/table.\nOptional if\u003cspan pulumi-lang-nodejs=\" resourceName \" pulumi-lang-dotnet=\" ResourceName \" pulumi-lang-go=\" resourceName \" pulumi-lang-python=\" resource_name \" pulumi-lang-yaml=\" resourceName \" pulumi-lang-java=\" resourceName \" pulumi-lang-hcl=\" resource_name \"\u003e resourceName \u003c/span\u003eis present\n" }, "providerShare": { "type": "string", "description": "Optional. The name of the Share object that contains the securable when the securable is\ngetting shared in D2D Delta Sharing\n" }, "type": { "type": "string", "description": "Required. The type of securable (catalog/schema/table).\nOptional if\u003cspan pulumi-lang-nodejs=\" resourceName \" pulumi-lang-dotnet=\" ResourceName \" pulumi-lang-go=\" resourceName \" pulumi-lang-python=\" resource_name \" pulumi-lang-yaml=\" resourceName \" pulumi-lang-java=\" resourceName \" pulumi-lang-hcl=\" resource_name \"\u003e resourceName \u003c/span\u003eis present. Possible values are: `CATALOG`, `CLEAN_ROOM`, `CONNECTION`, `CREDENTIAL`, `EXTERNAL_LOCATION`, `EXTERNAL_METADATA`, `FUNCTION`, `METASTORE`, `PIPELINE`, `PROVIDER`, `RECIPIENT`, `SCHEMA`, `SHARE`, `STAGING_TABLE`, `STORAGE_CREDENTIAL`, `TABLE`, `VOLUME`\n" } }, "type": "object" }, "databricks:index/SchemaProviderConfig:SchemaProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SecretAclProviderConfig:SecretAclProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SecretProviderConfig:SecretProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SecretScopeKeyvaultMetadata:SecretScopeKeyvaultMetadata": { "properties": { "dnsName": { "type": "string", "willReplaceOnChanges": true }, "resourceId": { "type": "string", "willReplaceOnChanges": true } }, "type": "object", "required": [ "dnsName", "resourceId" ] }, "databricks:index/SecretScopeProviderConfig:SecretScopeProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SecretUcProviderConfig:SecretUcProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ServicePrincipalFederationPolicyOidcPolicy:ServicePrincipalFederationPolicyOidcPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id\n" }, "issuer": { "type": "string", "description": "The required token issuer, as specified in the 'iss' claim of federated tokens\n" }, "jwksJson": { "type": "string", "description": "The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri \" pulumi-lang-dotnet=\" JwksUri \" pulumi-lang-go=\" jwksUri \" pulumi-lang-python=\" jwks_uri \" pulumi-lang-yaml=\" jwksUri \" pulumi-lang-java=\" jwksUri \" pulumi-lang-hcl=\" jwks_uri \"\u003e jwksUri \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson\n\" pulumi-lang-dotnet=\" JwksJson\n\" pulumi-lang-go=\" jwksJson\n\" pulumi-lang-python=\" jwks_json\n\" pulumi-lang-yaml=\" jwksJson\n\" pulumi-lang-java=\" jwksJson\n\" pulumi-lang-hcl=\" jwks_json\n\"\u003e jwksJson\n\u003c/span\u003eare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys\n" }, "jwksUri": { "type": "string", "description": "URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri\n\" pulumi-lang-dotnet=\" JwksUri\n\" pulumi-lang-go=\" jwksUri\n\" pulumi-lang-python=\" jwks_uri\n\" pulumi-lang-yaml=\" jwksUri\n\" pulumi-lang-java=\" jwksUri\n\" pulumi-lang-hcl=\" jwks_uri\n\"\u003e jwksUri\n\u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson \" pulumi-lang-dotnet=\" JwksJson \" pulumi-lang-go=\" jwksJson \" pulumi-lang-python=\" jwks_json \" pulumi-lang-yaml=\" jwksJson \" pulumi-lang-java=\" jwksJson \" pulumi-lang-hcl=\" jwks_json \"\u003e jwksJson \u003c/span\u003eare both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys\n" }, "subject": { "type": "string", "description": "The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies\n" }, "subjectClaim": { "type": "string", "description": "The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'\n" } }, "type": "object" }, "databricks:index/ServicePrincipalProviderConfig:ServicePrincipalProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ServicePrincipalRoleProviderConfig:ServicePrincipalRoleProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ServicePrincipalSecretProviderConfig:ServicePrincipalSecretProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/ShareObject:ShareObject": { "properties": { "addedAt": { "type": "integer" }, "addedBy": { "type": "string" }, "cdfEnabled": { "type": "boolean", "description": "Whether to enable Change Data Feed (cdf) on the shared object. When this field is set, field \u003cspan pulumi-lang-nodejs=\"`historyDataSharingStatus`\" pulumi-lang-dotnet=\"`HistoryDataSharingStatus`\" pulumi-lang-go=\"`historyDataSharingStatus`\" pulumi-lang-python=\"`history_data_sharing_status`\" pulumi-lang-yaml=\"`historyDataSharingStatus`\" pulumi-lang-java=\"`historyDataSharingStatus`\" pulumi-lang-hcl=\"`history_data_sharing_status`\"\u003e`historyDataSharingStatus`\u003c/span\u003e can not be set.\n" }, "comment": { "type": "string", "description": "Description about the object.\n" }, "content": { "type": "string", "description": "The content of the notebook file when the data object type is NOTEBOOK_FILE. This should be base64 encoded. Required for adding a NOTEBOOK_FILE, optional for updating, ignored for other types.\n" }, "dataObjectType": { "type": "string", "description": "Type of the data object. Supported types: `TABLE`, `FOREIGN_TABLE`, `SCHEMA`, `VIEW`, `MATERIALIZED_VIEW`, `STREAMING_TABLE`, `MODEL`, `NOTEBOOK_FILE`, `FUNCTION`, `FEATURE_SPEC`, and `VOLUME`.\n" }, "effectiveCdfEnabled": { "type": "boolean" }, "effectiveHistoryDataSharingStatus": { "type": "string" }, "effectiveSharedAs": { "type": "string" }, "effectiveStartVersion": { "type": "integer" }, "effectiveStringSharedAs": { "type": "string" }, "historyDataSharingStatus": { "type": "string", "description": "Whether to enable history sharing, one of: `ENABLED`, `DISABLED`. When a table has history sharing enabled, recipients can query table data by version, starting from the current table version. If not specified, clients can only query starting from the version of the object at the time it was added to the share. *NOTE*: The\u003cspan pulumi-lang-nodejs=\" startVersion \" pulumi-lang-dotnet=\" StartVersion \" pulumi-lang-go=\" startVersion \" pulumi-lang-python=\" start_version \" pulumi-lang-yaml=\" startVersion \" pulumi-lang-java=\" startVersion \" pulumi-lang-hcl=\" start_version \"\u003e startVersion \u003c/span\u003eshould be less than or equal the current version of the object. When this field is set, field \u003cspan pulumi-lang-nodejs=\"`cdfEnabled`\" pulumi-lang-dotnet=\"`CdfEnabled`\" pulumi-lang-go=\"`cdfEnabled`\" pulumi-lang-python=\"`cdf_enabled`\" pulumi-lang-yaml=\"`cdfEnabled`\" pulumi-lang-java=\"`cdfEnabled`\" pulumi-lang-hcl=\"`cdf_enabled`\"\u003e`cdfEnabled`\u003c/span\u003e can not be set.\n\nTo share only part of a table when you add the table to a share, you can provide partition specifications. This is specified by a number of \u003cspan pulumi-lang-nodejs=\"`partition`\" pulumi-lang-dotnet=\"`Partition`\" pulumi-lang-go=\"`partition`\" pulumi-lang-python=\"`partition`\" pulumi-lang-yaml=\"`partition`\" pulumi-lang-java=\"`partition`\" pulumi-lang-hcl=\"`partition`\"\u003e`partition`\u003c/span\u003e blocks. Each entry in \u003cspan pulumi-lang-nodejs=\"`partition`\" pulumi-lang-dotnet=\"`Partition`\" pulumi-lang-go=\"`partition`\" pulumi-lang-python=\"`partition`\" pulumi-lang-yaml=\"`partition`\" pulumi-lang-java=\"`partition`\" pulumi-lang-hcl=\"`partition`\"\u003e`partition`\u003c/span\u003e block takes a list of \u003cspan pulumi-lang-nodejs=\"`value`\" pulumi-lang-dotnet=\"`Value`\" pulumi-lang-go=\"`value`\" pulumi-lang-python=\"`value`\" pulumi-lang-yaml=\"`value`\" pulumi-lang-java=\"`value`\" pulumi-lang-hcl=\"`value`\"\u003e`value`\u003c/span\u003e blocks. The field is documented below.\n" }, "name": { "type": "string", "description": "Full name of the object, e.g. `catalog.schema.name` for a tables, views, volumes and models, or `catalog.schema` for schemas.\n" }, "partitions": { "type": "array", "items": { "$ref": "#/types/databricks:index/ShareObjectPartition:ShareObjectPartition" }, "description": "Array of partitions for the shared data.\n" }, "sharedAs": { "type": "string", "description": "A user-provided alias name for **table-like data objects** within the share. Use this field for: `TABLE`, `VIEW`, `MATERIALIZED_VIEW`, `STREAMING_TABLE`, `FOREIGN_TABLE`. **Do not use this field for volumes, models, notebooks, or functions** (use \u003cspan pulumi-lang-nodejs=\"`stringSharedAs`\" pulumi-lang-dotnet=\"`StringSharedAs`\" pulumi-lang-go=\"`stringSharedAs`\" pulumi-lang-python=\"`string_shared_as`\" pulumi-lang-yaml=\"`stringSharedAs`\" pulumi-lang-java=\"`stringSharedAs`\" pulumi-lang-hcl=\"`string_shared_as`\"\u003e`stringSharedAs`\u003c/span\u003e instead). If not provided, the object's original name will be used. Must be a 2-part name `\u003cschema\u003e.\u003ctable\u003e` containing only alphanumeric characters and underscores. The \u003cspan pulumi-lang-nodejs=\"`sharedAs`\" pulumi-lang-dotnet=\"`SharedAs`\" pulumi-lang-go=\"`sharedAs`\" pulumi-lang-python=\"`shared_as`\" pulumi-lang-yaml=\"`sharedAs`\" pulumi-lang-java=\"`sharedAs`\" pulumi-lang-hcl=\"`shared_as`\"\u003e`sharedAs`\u003c/span\u003e name must be unique within a share. Change forces creation of a new resource.\n" }, "startVersion": { "type": "integer", "description": "The start version associated with the object for cdf. This allows data providers to control the lowest object version that is accessible by clients.\n" }, "status": { "type": "string", "description": "Status of the object, one of: `ACTIVE`, `PERMISSION_DENIED`.\n" }, "stringSharedAs": { "type": "string", "description": "A user-provided alias name for **non-table data objects** within the share. Use this field for: `VOLUME`, `MODEL`, `NOTEBOOK_FILE`, `FUNCTION`. **Do not use this field for tables, views, or streaming tables** (use \u003cspan pulumi-lang-nodejs=\"`sharedAs`\" pulumi-lang-dotnet=\"`SharedAs`\" pulumi-lang-go=\"`sharedAs`\" pulumi-lang-python=\"`shared_as`\" pulumi-lang-yaml=\"`sharedAs`\" pulumi-lang-java=\"`sharedAs`\" pulumi-lang-hcl=\"`shared_as`\"\u003e`sharedAs`\u003c/span\u003e instead). Format varies by type: For volumes, models, and functions use `\u003cschema\u003e.\u003cname\u003e` (2-part name); for notebooks use the file name. Names must contain only alphanumeric characters and underscores. The \u003cspan pulumi-lang-nodejs=\"`stringSharedAs`\" pulumi-lang-dotnet=\"`StringSharedAs`\" pulumi-lang-go=\"`stringSharedAs`\" pulumi-lang-python=\"`string_shared_as`\" pulumi-lang-yaml=\"`stringSharedAs`\" pulumi-lang-java=\"`stringSharedAs`\" pulumi-lang-hcl=\"`string_shared_as`\"\u003e`stringSharedAs`\u003c/span\u003e name must be unique for objects of the same type within a share. Change forces creation of a new resource.\n" } }, "type": "object", "required": [ "dataObjectType", "name" ], "language": { "nodejs": { "requiredOutputs": [ "addedAt", "addedBy", "dataObjectType", "effectiveCdfEnabled", "effectiveHistoryDataSharingStatus", "effectiveSharedAs", "effectiveStartVersion", "effectiveStringSharedAs", "name", "status" ] } } }, "databricks:index/ShareObjectPartition:ShareObjectPartition": { "properties": { "values": { "type": "array", "items": { "$ref": "#/types/databricks:index/ShareObjectPartitionValue:ShareObjectPartitionValue" }, "description": "The value of the partition column. When this value is not set, it means null value. When this field is set, field \u003cspan pulumi-lang-nodejs=\"`recipientPropertyKey`\" pulumi-lang-dotnet=\"`RecipientPropertyKey`\" pulumi-lang-go=\"`recipientPropertyKey`\" pulumi-lang-python=\"`recipient_property_key`\" pulumi-lang-yaml=\"`recipientPropertyKey`\" pulumi-lang-java=\"`recipientPropertyKey`\" pulumi-lang-hcl=\"`recipient_property_key`\"\u003e`recipientPropertyKey`\u003c/span\u003e can not be set.\n" } }, "type": "object" }, "databricks:index/ShareObjectPartitionValue:ShareObjectPartitionValue": { "properties": { "name": { "type": "string", "description": "The name of the partition column.\n" }, "op": { "type": "string", "description": "The operator to apply for the value, one of: `EQUAL`, `LIKE`\n" }, "recipientPropertyKey": { "type": "string", "description": "The key of a Delta Sharing recipient's property. For example `databricks-account-id`. When this field is set, field \u003cspan pulumi-lang-nodejs=\"`value`\" pulumi-lang-dotnet=\"`Value`\" pulumi-lang-go=\"`value`\" pulumi-lang-python=\"`value`\" pulumi-lang-yaml=\"`value`\" pulumi-lang-java=\"`value`\" pulumi-lang-hcl=\"`value`\"\u003e`value`\u003c/span\u003e can not be set.\n" }, "value": { "type": "string", "description": "The value of the partition column. When this value is not set, it means null value. When this field is set, field \u003cspan pulumi-lang-nodejs=\"`recipientPropertyKey`\" pulumi-lang-dotnet=\"`RecipientPropertyKey`\" pulumi-lang-go=\"`recipientPropertyKey`\" pulumi-lang-python=\"`recipient_property_key`\" pulumi-lang-yaml=\"`recipientPropertyKey`\" pulumi-lang-java=\"`recipientPropertyKey`\" pulumi-lang-hcl=\"`recipient_property_key`\"\u003e`recipientPropertyKey`\u003c/span\u003e can not be set.\n" } }, "type": "object", "required": [ "name", "op" ] }, "databricks:index/ShareProviderConfig:ShareProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ] }, "databricks:index/SqlAlertOptions:SqlAlertOptions": { "properties": { "column": { "type": "string", "description": "Name of column in the query result to compare in alert evaluation.\n" }, "customBody": { "type": "string", "description": "Custom body of alert notification, if it exists. See [Alerts API reference](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.\n" }, "customSubject": { "type": "string", "description": "Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See [Alerts API reference](https://docs.databricks.com/sql/user/alerts/index.html) for custom templating instructions.\n" }, "emptyResultState": { "type": "string", "description": "State that alert evaluates to when query result is empty. Currently supported values are \u003cspan pulumi-lang-nodejs=\"`unknown`\" pulumi-lang-dotnet=\"`Unknown`\" pulumi-lang-go=\"`unknown`\" pulumi-lang-python=\"`unknown`\" pulumi-lang-yaml=\"`unknown`\" pulumi-lang-java=\"`unknown`\" pulumi-lang-hcl=\"`unknown`\"\u003e`unknown`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`triggered`\" pulumi-lang-dotnet=\"`Triggered`\" pulumi-lang-go=\"`triggered`\" pulumi-lang-python=\"`triggered`\" pulumi-lang-yaml=\"`triggered`\" pulumi-lang-java=\"`triggered`\" pulumi-lang-hcl=\"`triggered`\"\u003e`triggered`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`ok`\" pulumi-lang-dotnet=\"`Ok`\" pulumi-lang-go=\"`ok`\" pulumi-lang-python=\"`ok`\" pulumi-lang-yaml=\"`ok`\" pulumi-lang-java=\"`ok`\" pulumi-lang-hcl=\"`ok`\"\u003e`ok`\u003c/span\u003e - check [API documentation](https://docs.databricks.com/api/workspace/alerts/create) for full list of supported values.\n" }, "muted": { "type": "boolean", "description": "Whether or not the alert is muted. If an alert is muted, it will not notify users and alert destinations when triggered.\n" }, "op": { "type": "string", "description": "Operator used to compare in alert evaluation. (Enum: `\u003e`, `\u003e=`, `\u003c`, `\u003c=`, `==`, `!=`)\n" }, "value": { "type": "string", "description": "Value used to compare in alert evaluation.\n" } }, "type": "object", "required": [ "column", "op", "value" ] }, "databricks:index/SqlAlertProviderConfig:SqlAlertProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlDashboardProviderConfig:SqlDashboardProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlEndpointChannel:SqlEndpointChannel": { "properties": { "dbsqlVersion": { "type": "string" }, "name": { "type": "string", "description": "Name of the Databricks SQL release channel. Possible values are: `CHANNEL_NAME_PREVIEW` and `CHANNEL_NAME_CURRENT`. Default is `CHANNEL_NAME_CURRENT`.\n" } }, "type": "object" }, "databricks:index/SqlEndpointHealth:SqlEndpointHealth": { "properties": { "details": { "type": "string" }, "failureReason": { "$ref": "#/types/databricks:index/SqlEndpointHealthFailureReason:SqlEndpointHealthFailureReason" }, "message": { "type": "string" }, "status": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "databricks:index/SqlEndpointHealthFailureReason:SqlEndpointHealthFailureReason": { "properties": { "code": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string" } }, "type": "object" }, "databricks:index/SqlEndpointOdbcParams:SqlEndpointOdbcParams": { "properties": { "hostname": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "databricks:index/SqlEndpointProviderConfig:SqlEndpointProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlEndpointTags:SqlEndpointTags": { "properties": { "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/SqlEndpointTagsCustomTag:SqlEndpointTagsCustomTag" } } }, "type": "object" }, "databricks:index/SqlEndpointTagsCustomTag:SqlEndpointTagsCustomTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ] }, "databricks:index/SqlGlobalConfigProviderConfig:SqlGlobalConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlPermissionsPrivilegeAssignment:SqlPermissionsPrivilegeAssignment": { "properties": { "principal": { "type": "string", "description": "\u003cspan pulumi-lang-nodejs=\"`displayName`\" pulumi-lang-dotnet=\"`DisplayName`\" pulumi-lang-go=\"`displayName`\" pulumi-lang-python=\"`display_name`\" pulumi-lang-yaml=\"`displayName`\" pulumi-lang-java=\"`displayName`\" pulumi-lang-hcl=\"`display_name`\"\u003e`displayName`\u003c/span\u003e for a\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eor databricks_user, \u003cspan pulumi-lang-nodejs=\"`applicationId`\" pulumi-lang-dotnet=\"`ApplicationId`\" pulumi-lang-go=\"`applicationId`\" pulumi-lang-python=\"`application_id`\" pulumi-lang-yaml=\"`applicationId`\" pulumi-lang-java=\"`applicationId`\" pulumi-lang-hcl=\"`application_id`\"\u003e`applicationId`\u003c/span\u003e for a databricks_service_principal.\n" }, "privileges": { "type": "array", "items": { "type": "string" }, "description": "set of available privilege names in upper case.\n\n\n[Available](https://docs.databricks.com/security/access-control/table-acls/object-privileges.html) privilege names are:\n[Available](https://docs.databricks.com/security/access-control/table-acls/object-privileges.html) privilege names are:\n\n\n* `SELECT` - gives read access to an object.\n* `SELECT` - gives read access to an object.\n* `CREATE` - gives the ability to create an object (for example, a table in a database).\n* `CREATE` - gives the ability to create an object (for example, a table in a database).\n* `MODIFY` - gives the ability to add, delete, and modify data to or from an object.\n* `MODIFY` - gives the ability to add, delete, and modify data to or from an object.\n* `USAGE` - do not give any abilities, but is an additional requirement to perform any action on a database object.\n* `USAGE` - do not give any abilities, but is an additional requirement to perform any action on a database object.\n* `READ_METADATA` - gives the ability to view an object and its metadata.\n* `READ_METADATA` - gives the ability to view an object and its metadata.\n* `CREATE_NAMED_FUNCTION` - gives the ability to create a named UDF in an existing catalog or database.\n* `CREATE_NAMED_FUNCTION` - gives the ability to create a named UDF in an existing catalog or database.\n* `MODIFY_CLASSPATH` - gives the ability to add files to the Spark classpath.\n* `MODIFY_CLASSPATH` - gives the ability to add files to the Spark classpath.\n\n\n\u003e Even though the value `ALL PRIVILEGES` is mentioned in Table ACL documentation, it's not recommended to use it from Pulumi, as it may result in unnecessary state updates.\n\u003e Even though the value `ALL PRIVILEGES` is mentioned in Table ACL documentation, it's not recommended to use it from Pulumi, as it may result in unnecessary state updates.\n" } }, "type": "object", "required": [ "principal", "privileges" ] }, "databricks:index/SqlPermissionsProviderConfig:SqlPermissionsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlQueryParameter:SqlQueryParameter": { "properties": { "date": { "$ref": "#/types/databricks:index/SqlQueryParameterDate:SqlQueryParameterDate" }, "dateRange": { "$ref": "#/types/databricks:index/SqlQueryParameterDateRange:SqlQueryParameterDateRange" }, "datetime": { "$ref": "#/types/databricks:index/SqlQueryParameterDatetime:SqlQueryParameterDatetime" }, "datetimeRange": { "$ref": "#/types/databricks:index/SqlQueryParameterDatetimeRange:SqlQueryParameterDatetimeRange" }, "datetimesec": { "$ref": "#/types/databricks:index/SqlQueryParameterDatetimesec:SqlQueryParameterDatetimesec" }, "datetimesecRange": { "$ref": "#/types/databricks:index/SqlQueryParameterDatetimesecRange:SqlQueryParameterDatetimesecRange" }, "enum": { "$ref": "#/types/databricks:index/SqlQueryParameterEnum:SqlQueryParameterEnum" }, "name": { "type": "string", "description": "The literal parameter marker that appears between double curly braces in the query text.\nParameters can have several different types. Type is specified using one of the following configuration blocks: \u003cspan pulumi-lang-nodejs=\"`text`\" pulumi-lang-dotnet=\"`Text`\" pulumi-lang-go=\"`text`\" pulumi-lang-python=\"`text`\" pulumi-lang-yaml=\"`text`\" pulumi-lang-java=\"`text`\" pulumi-lang-hcl=\"`text`\"\u003e`text`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`number`\" pulumi-lang-dotnet=\"`Number`\" pulumi-lang-go=\"`number`\" pulumi-lang-python=\"`number`\" pulumi-lang-yaml=\"`number`\" pulumi-lang-java=\"`number`\" pulumi-lang-hcl=\"`number`\"\u003e`number`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`enum`\" pulumi-lang-dotnet=\"`Enum`\" pulumi-lang-go=\"`enum`\" pulumi-lang-python=\"`enum`\" pulumi-lang-yaml=\"`enum`\" pulumi-lang-java=\"`enum`\" pulumi-lang-hcl=\"`enum`\"\u003e`enum`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`query`\" pulumi-lang-dotnet=\"`Query`\" pulumi-lang-go=\"`query`\" pulumi-lang-python=\"`query`\" pulumi-lang-yaml=\"`query`\" pulumi-lang-java=\"`query`\" pulumi-lang-hcl=\"`query`\"\u003e`query`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`date`\" pulumi-lang-dotnet=\"`Date`\" pulumi-lang-go=\"`date`\" pulumi-lang-python=\"`date`\" pulumi-lang-yaml=\"`date`\" pulumi-lang-java=\"`date`\" pulumi-lang-hcl=\"`date`\"\u003e`date`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`datetime`\" pulumi-lang-dotnet=\"`Datetime`\" pulumi-lang-go=\"`datetime`\" pulumi-lang-python=\"`datetime`\" pulumi-lang-yaml=\"`datetime`\" pulumi-lang-java=\"`datetime`\" pulumi-lang-hcl=\"`datetime`\"\u003e`datetime`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`datetimesec`\" pulumi-lang-dotnet=\"`Datetimesec`\" pulumi-lang-go=\"`datetimesec`\" pulumi-lang-python=\"`datetimesec`\" pulumi-lang-yaml=\"`datetimesec`\" pulumi-lang-java=\"`datetimesec`\" pulumi-lang-hcl=\"`datetimesec`\"\u003e`datetimesec`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`dateRange`\" pulumi-lang-dotnet=\"`DateRange`\" pulumi-lang-go=\"`dateRange`\" pulumi-lang-python=\"`date_range`\" pulumi-lang-yaml=\"`dateRange`\" pulumi-lang-java=\"`dateRange`\" pulumi-lang-hcl=\"`date_range`\"\u003e`dateRange`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`datetimeRange`\" pulumi-lang-dotnet=\"`DatetimeRange`\" pulumi-lang-go=\"`datetimeRange`\" pulumi-lang-python=\"`datetime_range`\" pulumi-lang-yaml=\"`datetimeRange`\" pulumi-lang-java=\"`datetimeRange`\" pulumi-lang-hcl=\"`datetime_range`\"\u003e`datetimeRange`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`datetimesecRange`\" pulumi-lang-dotnet=\"`DatetimesecRange`\" pulumi-lang-go=\"`datetimesecRange`\" pulumi-lang-python=\"`datetimesec_range`\" pulumi-lang-yaml=\"`datetimesecRange`\" pulumi-lang-java=\"`datetimesecRange`\" pulumi-lang-hcl=\"`datetimesec_range`\"\u003e`datetimesecRange`\u003c/span\u003e.\n\nFor \u003cspan pulumi-lang-nodejs=\"`text`\" pulumi-lang-dotnet=\"`Text`\" pulumi-lang-go=\"`text`\" pulumi-lang-python=\"`text`\" pulumi-lang-yaml=\"`text`\" pulumi-lang-java=\"`text`\" pulumi-lang-hcl=\"`text`\"\u003e`text`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`number`\" pulumi-lang-dotnet=\"`Number`\" pulumi-lang-go=\"`number`\" pulumi-lang-python=\"`number`\" pulumi-lang-yaml=\"`number`\" pulumi-lang-java=\"`number`\" pulumi-lang-hcl=\"`number`\"\u003e`number`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`date`\" pulumi-lang-dotnet=\"`Date`\" pulumi-lang-go=\"`date`\" pulumi-lang-python=\"`date`\" pulumi-lang-yaml=\"`date`\" pulumi-lang-java=\"`date`\" pulumi-lang-hcl=\"`date`\"\u003e`date`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`datetime`\" pulumi-lang-dotnet=\"`Datetime`\" pulumi-lang-go=\"`datetime`\" pulumi-lang-python=\"`datetime`\" pulumi-lang-yaml=\"`datetime`\" pulumi-lang-java=\"`datetime`\" pulumi-lang-hcl=\"`datetime`\"\u003e`datetime`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`datetimesec`\" pulumi-lang-dotnet=\"`Datetimesec`\" pulumi-lang-go=\"`datetimesec`\" pulumi-lang-python=\"`datetimesec`\" pulumi-lang-yaml=\"`datetimesec`\" pulumi-lang-java=\"`datetimesec`\" pulumi-lang-hcl=\"`datetimesec`\"\u003e`datetimesec`\u003c/span\u003e block\n" }, "number": { "$ref": "#/types/databricks:index/SqlQueryParameterNumber:SqlQueryParameterNumber" }, "query": { "$ref": "#/types/databricks:index/SqlQueryParameterQuery:SqlQueryParameterQuery", "description": "The text of the query to be run.\n" }, "text": { "$ref": "#/types/databricks:index/SqlQueryParameterText:SqlQueryParameterText" }, "title": { "type": "string", "description": "The text displayed in a parameter picking widget.\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/SqlQueryParameterDate:SqlQueryParameterDate": { "properties": { "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/SqlQueryParameterDateRange:SqlQueryParameterDateRange": { "properties": { "range": { "$ref": "#/types/databricks:index/SqlQueryParameterDateRangeRange:SqlQueryParameterDateRangeRange" }, "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object" }, "databricks:index/SqlQueryParameterDateRangeRange:SqlQueryParameterDateRangeRange": { "properties": { "end": { "type": "string" }, "start": { "type": "string" } }, "type": "object", "required": [ "end", "start" ] }, "databricks:index/SqlQueryParameterDatetime:SqlQueryParameterDatetime": { "properties": { "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/SqlQueryParameterDatetimeRange:SqlQueryParameterDatetimeRange": { "properties": { "range": { "$ref": "#/types/databricks:index/SqlQueryParameterDatetimeRangeRange:SqlQueryParameterDatetimeRangeRange" }, "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object" }, "databricks:index/SqlQueryParameterDatetimeRangeRange:SqlQueryParameterDatetimeRangeRange": { "properties": { "end": { "type": "string" }, "start": { "type": "string" } }, "type": "object", "required": [ "end", "start" ] }, "databricks:index/SqlQueryParameterDatetimesec:SqlQueryParameterDatetimesec": { "properties": { "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/SqlQueryParameterDatetimesecRange:SqlQueryParameterDatetimesecRange": { "properties": { "range": { "$ref": "#/types/databricks:index/SqlQueryParameterDatetimesecRangeRange:SqlQueryParameterDatetimesecRangeRange" }, "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object" }, "databricks:index/SqlQueryParameterDatetimesecRangeRange:SqlQueryParameterDatetimesecRangeRange": { "properties": { "end": { "type": "string" }, "start": { "type": "string" } }, "type": "object", "required": [ "end", "start" ] }, "databricks:index/SqlQueryParameterEnum:SqlQueryParameterEnum": { "properties": { "multiple": { "$ref": "#/types/databricks:index/SqlQueryParameterEnumMultiple:SqlQueryParameterEnumMultiple" }, "options": { "type": "array", "items": { "type": "string" } }, "value": { "type": "string", "description": "The default value for this parameter.\n" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "options" ] }, "databricks:index/SqlQueryParameterEnumMultiple:SqlQueryParameterEnumMultiple": { "properties": { "prefix": { "type": "string" }, "separator": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "separator" ] }, "databricks:index/SqlQueryParameterNumber:SqlQueryParameterNumber": { "properties": { "value": { "type": "number", "description": "The default value for this parameter.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/SqlQueryParameterQuery:SqlQueryParameterQuery": { "properties": { "multiple": { "$ref": "#/types/databricks:index/SqlQueryParameterQueryMultiple:SqlQueryParameterQueryMultiple" }, "queryId": { "type": "string" }, "value": { "type": "string", "description": "The default value for this parameter.\n" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "queryId" ] }, "databricks:index/SqlQueryParameterQueryMultiple:SqlQueryParameterQueryMultiple": { "properties": { "prefix": { "type": "string" }, "separator": { "type": "string" }, "suffix": { "type": "string" } }, "type": "object", "required": [ "separator" ] }, "databricks:index/SqlQueryParameterText:SqlQueryParameterText": { "properties": { "value": { "type": "string", "description": "The default value for this parameter.\n" } }, "type": "object", "required": [ "value" ] }, "databricks:index/SqlQueryProviderConfig:SqlQueryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlQuerySchedule:SqlQuerySchedule": { "properties": { "continuous": { "$ref": "#/types/databricks:index/SqlQueryScheduleContinuous:SqlQueryScheduleContinuous" }, "daily": { "$ref": "#/types/databricks:index/SqlQueryScheduleDaily:SqlQueryScheduleDaily" }, "weekly": { "$ref": "#/types/databricks:index/SqlQueryScheduleWeekly:SqlQueryScheduleWeekly" } }, "type": "object" }, "databricks:index/SqlQueryScheduleContinuous:SqlQueryScheduleContinuous": { "properties": { "intervalSeconds": { "type": "integer" }, "untilDate": { "type": "string" } }, "type": "object", "required": [ "intervalSeconds" ] }, "databricks:index/SqlQueryScheduleDaily:SqlQueryScheduleDaily": { "properties": { "intervalDays": { "type": "integer" }, "timeOfDay": { "type": "string" }, "untilDate": { "type": "string" } }, "type": "object", "required": [ "intervalDays", "timeOfDay" ] }, "databricks:index/SqlQueryScheduleWeekly:SqlQueryScheduleWeekly": { "properties": { "dayOfWeek": { "type": "string" }, "intervalWeeks": { "type": "integer" }, "timeOfDay": { "type": "string" }, "untilDate": { "type": "string" } }, "type": "object", "required": [ "dayOfWeek", "intervalWeeks", "timeOfDay" ] }, "databricks:index/SqlTableColumn:SqlTableColumn": { "properties": { "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "identity": { "type": "string", "description": "Whether the field is an identity column. Can be \u003cspan pulumi-lang-nodejs=\"`default`\" pulumi-lang-dotnet=\"`Default`\" pulumi-lang-go=\"`default`\" pulumi-lang-python=\"`default`\" pulumi-lang-yaml=\"`default`\" pulumi-lang-java=\"`default`\" pulumi-lang-hcl=\"`default`\"\u003e`default`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`always`\" pulumi-lang-dotnet=\"`Always`\" pulumi-lang-go=\"`always`\" pulumi-lang-python=\"`always`\" pulumi-lang-yaml=\"`always`\" pulumi-lang-java=\"`always`\" pulumi-lang-hcl=\"`always`\"\u003e`always`\u003c/span\u003e, or unset. It is unset by default.\n" }, "name": { "type": "string", "description": "User-visible name of column\n" }, "nullable": { "type": "boolean", "description": "Whether field is nullable (Default: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e)\n" }, "type": { "type": "string", "description": "Column type spec (with metadata) as SQL text. Not supported for `VIEW` table_type.\n\n\u003e **Note:** When using `MAP` column types, do not include whitespace after commas in the type definition. For example, use `MAP\u003cSTRING,STRING\u003e` instead of `MAP\u003cSTRING, STRING\u003e`.\n" }, "typeJson": { "type": "string" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "name", "type", "typeJson" ] } } }, "databricks:index/SqlTableProviderConfig:SqlTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlVisualizationProviderConfig:SqlVisualizationProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SqlWidgetParameter:SqlWidgetParameter": { "properties": { "mapTo": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "type" ] }, "databricks:index/SqlWidgetPosition:SqlWidgetPosition": { "properties": { "autoHeight": { "type": "boolean" }, "posX": { "type": "integer" }, "posY": { "type": "integer" }, "sizeX": { "type": "integer" }, "sizeY": { "type": "integer" } }, "type": "object", "required": [ "sizeX", "sizeY" ] }, "databricks:index/SqlWidgetProviderConfig:SqlWidgetProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/StorageCredentialAwsIamRole:StorageCredentialAwsIamRole": { "properties": { "externalId": { "type": "string", "description": "The external ID used in role assumption to prevent the confused deputy problem.\n" }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form `arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF`.\n\n\u003cspan pulumi-lang-nodejs=\"`azureManagedIdentity`\" pulumi-lang-dotnet=\"`AzureManagedIdentity`\" pulumi-lang-go=\"`azureManagedIdentity`\" pulumi-lang-python=\"`azure_managed_identity`\" pulumi-lang-yaml=\"`azureManagedIdentity`\" pulumi-lang-java=\"`azureManagedIdentity`\" pulumi-lang-hcl=\"`azure_managed_identity`\"\u003e`azureManagedIdentity`\u003c/span\u003e optional configuration block for using managed identity as credential details for Azure (recommended over service principal):\n" }, "unityCatalogIamArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.\n" } }, "type": "object", "required": [ "roleArn" ], "language": { "nodejs": { "requiredOutputs": [ "externalId", "roleArn", "unityCatalogIamArn" ] } } }, "databricks:index/StorageCredentialAzureManagedIdentity:StorageCredentialAzureManagedIdentity": { "properties": { "accessConnectorId": { "type": "string", "description": "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`.\n" }, "credentialId": { "type": "string" }, "managedIdentityId": { "type": "string", "description": "The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name`.\n\n\u003cspan pulumi-lang-nodejs=\"`databricksGcpServiceAccount`\" pulumi-lang-dotnet=\"`DatabricksGcpServiceAccount`\" pulumi-lang-go=\"`databricksGcpServiceAccount`\" pulumi-lang-python=\"`databricks_gcp_service_account`\" pulumi-lang-yaml=\"`databricksGcpServiceAccount`\" pulumi-lang-java=\"`databricksGcpServiceAccount`\" pulumi-lang-hcl=\"`databricks_gcp_service_account`\"\u003e`databricksGcpServiceAccount`\u003c/span\u003e optional configuration block for creating a Databricks-managed GCP Service Account:\n" } }, "type": "object", "required": [ "accessConnectorId" ], "language": { "nodejs": { "requiredOutputs": [ "accessConnectorId", "credentialId" ] } } }, "databricks:index/StorageCredentialAzureServicePrincipal:StorageCredentialAzureServicePrincipal": { "properties": { "applicationId": { "type": "string", "description": "The application ID of the application registration within the referenced AAD tenant\n" }, "clientSecret": { "type": "string", "description": "The client secret generated for the above app ID in AAD. **This field is redacted on output**\n", "secret": true }, "directoryId": { "type": "string", "description": "The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application\n" } }, "type": "object", "required": [ "applicationId", "clientSecret", "directoryId" ] }, "databricks:index/StorageCredentialCloudflareApiToken:StorageCredentialCloudflareApiToken": { "properties": { "accessKeyId": { "type": "string", "description": "R2 API token access key ID\n" }, "accountId": { "type": "string", "description": "R2 account ID\n" }, "secretAccessKey": { "type": "string", "description": "R2 API token secret access key\n\n\u003cspan pulumi-lang-nodejs=\"`azureServicePrincipal`\" pulumi-lang-dotnet=\"`AzureServicePrincipal`\" pulumi-lang-go=\"`azureServicePrincipal`\" pulumi-lang-python=\"`azure_service_principal`\" pulumi-lang-yaml=\"`azureServicePrincipal`\" pulumi-lang-java=\"`azureServicePrincipal`\" pulumi-lang-hcl=\"`azure_service_principal`\"\u003e`azureServicePrincipal`\u003c/span\u003e optional configuration block to use service principal as credential details for Azure (Legacy):\n", "secret": true } }, "type": "object", "required": [ "accessKeyId", "accountId", "secretAccessKey" ] }, "databricks:index/StorageCredentialDatabricksGcpServiceAccount:StorageCredentialDatabricksGcpServiceAccount": { "properties": { "credentialId": { "type": "string" }, "email": { "type": "string", "description": "The email of the GCP service account created, to be granted access to relevant buckets.\n\n\u003cspan pulumi-lang-nodejs=\"`cloudflareApiToken`\" pulumi-lang-dotnet=\"`CloudflareApiToken`\" pulumi-lang-go=\"`cloudflareApiToken`\" pulumi-lang-python=\"`cloudflare_api_token`\" pulumi-lang-yaml=\"`cloudflareApiToken`\" pulumi-lang-java=\"`cloudflareApiToken`\" pulumi-lang-hcl=\"`cloudflare_api_token`\"\u003e`cloudflareApiToken`\u003c/span\u003e optional configuration block for using a Cloudflare API Token as credential details. This requires account admin access:\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "credentialId", "email" ] } } }, "databricks:index/StorageCredentialGcpServiceAccountKey:StorageCredentialGcpServiceAccountKey": { "properties": { "email": { "type": "string", "description": "The email of the GCP service account created, to be granted access to relevant buckets.\n\n\u003cspan pulumi-lang-nodejs=\"`cloudflareApiToken`\" pulumi-lang-dotnet=\"`CloudflareApiToken`\" pulumi-lang-go=\"`cloudflareApiToken`\" pulumi-lang-python=\"`cloudflare_api_token`\" pulumi-lang-yaml=\"`cloudflareApiToken`\" pulumi-lang-java=\"`cloudflareApiToken`\" pulumi-lang-hcl=\"`cloudflare_api_token`\"\u003e`cloudflareApiToken`\u003c/span\u003e optional configuration block for using a Cloudflare API Token as credential details. This requires account admin access:\n" }, "privateKey": { "type": "string", "secret": true }, "privateKeyId": { "type": "string" } }, "type": "object", "required": [ "email", "privateKey", "privateKeyId" ] }, "databricks:index/StorageCredentialProviderConfig:StorageCredentialProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SupervisorAgentProviderConfig:SupervisorAgentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SupervisorAgentToolApp:SupervisorAgentToolApp": { "properties": { "name": { "type": "string", "description": "App name\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/SupervisorAgentToolGenieSpace:SupervisorAgentToolGenieSpace": { "properties": { "id": { "type": "string", "description": "(string, deprecated) - Deprecated: Use\u003cspan pulumi-lang-nodejs=\" toolId \" pulumi-lang-dotnet=\" ToolId \" pulumi-lang-go=\" toolId \" pulumi-lang-python=\" tool_id \" pulumi-lang-yaml=\" toolId \" pulumi-lang-java=\" toolId \" pulumi-lang-hcl=\" tool_id \"\u003e toolId \u003c/span\u003einstead\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/SupervisorAgentToolKnowledgeAssistant:SupervisorAgentToolKnowledgeAssistant": { "properties": { "knowledgeAssistantId": { "type": "string", "description": "The ID of the knowledge assistant\n" }, "servingEndpointName": { "type": "string", "description": "Deprecated: use\u003cspan pulumi-lang-nodejs=\" knowledgeAssistantId \" pulumi-lang-dotnet=\" KnowledgeAssistantId \" pulumi-lang-go=\" knowledgeAssistantId \" pulumi-lang-python=\" knowledge_assistant_id \" pulumi-lang-yaml=\" knowledgeAssistantId \" pulumi-lang-java=\" knowledgeAssistantId \" pulumi-lang-hcl=\" knowledge_assistant_id \"\u003e knowledgeAssistantId \u003c/span\u003einstead\n" } }, "type": "object", "required": [ "knowledgeAssistantId" ] }, "databricks:index/SupervisorAgentToolProviderConfig:SupervisorAgentToolProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/SupervisorAgentToolUcConnection:SupervisorAgentToolUcConnection": { "properties": { "name": { "type": "string", "description": "(string) - Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/SupervisorAgentToolUcFunction:SupervisorAgentToolUcFunction": { "properties": { "name": { "type": "string", "description": "(string) - Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/SupervisorAgentToolVolume:SupervisorAgentToolVolume": { "properties": { "name": { "type": "string", "description": "Full uc volume name\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/SystemSchemaProviderConfig:SystemSchemaProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/TableColumn:TableColumn": { "properties": { "comment": { "type": "string" }, "name": { "type": "string" }, "nullable": { "type": "boolean" }, "partitionIndex": { "type": "integer" }, "position": { "type": "integer" }, "typeIntervalType": { "type": "string" }, "typeJson": { "type": "string" }, "typeName": { "type": "string" }, "typePrecision": { "type": "integer" }, "typeScale": { "type": "integer" }, "typeText": { "type": "string" } }, "type": "object", "required": [ "name", "position", "typeName", "typeText" ] }, "databricks:index/TableProviderConfig:TableProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/TagPolicyProviderConfig:TagPolicyProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/TagPolicyValue:TagPolicyValue": { "properties": { "name": { "type": "string" } }, "type": "object", "required": [ "name" ] }, "databricks:index/TokenProviderConfig:TokenProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/UserInstanceProfileProviderConfig:UserInstanceProfileProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/UserProviderConfig:UserProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/UserRoleProviderConfig:UserRoleProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/VectorSearchEndpointEndpointStatus:VectorSearchEndpointEndpointStatus": { "properties": { "message": { "type": "string", "description": "Additional status message.\n" }, "state": { "type": "string", "description": "Current state of the endpoint. Currently following values are supported: `PROVISIONING`, `ONLINE`, and `OFFLINE`.\n" } }, "type": "object" }, "databricks:index/VectorSearchEndpointProviderConfig:VectorSearchEndpointProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/VectorSearchEndpointScalingInfo:VectorSearchEndpointScalingInfo": { "properties": { "requestedTargetQps": { "type": "integer" }, "state": { "type": "string", "description": "Current state of the endpoint. Currently following values are supported: `PROVISIONING`, `ONLINE`, and `OFFLINE`.\n" } }, "type": "object" }, "databricks:index/VectorSearchIndexDeltaSyncIndexSpec:VectorSearchIndexDeltaSyncIndexSpec": { "properties": { "columnsToIndices": { "type": "array", "items": { "type": "string" }, "willReplaceOnChanges": true }, "columnsToSyncs": { "type": "array", "items": { "type": "string" }, "willReplaceOnChanges": true }, "embeddingSourceColumns": { "type": "array", "items": { "$ref": "#/types/databricks:index/VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn:VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn" }, "description": "array of objects representing columns that contain the embedding source. Each entry consists of:\n", "willReplaceOnChanges": true }, "embeddingVectorColumns": { "type": "array", "items": { "$ref": "#/types/databricks:index/VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn:VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn" }, "description": "array of objects representing columns that contain the embedding vectors. Each entry consists of:\n", "willReplaceOnChanges": true }, "embeddingWritebackTable": { "type": "string", "description": "Automatically sync the vector index contents and computed embeddings to the specified Delta table. The only supported table name is the index name with the suffix `_writeback_table`.\n", "willReplaceOnChanges": true }, "pipelineId": { "type": "string", "description": "ID of the associated Delta Live Table pipeline.\n" }, "pipelineType": { "type": "string", "description": "Pipeline execution mode. Possible values are:\n* `TRIGGERED`: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.\n* `CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep the vector index fresh.\n", "willReplaceOnChanges": true }, "sourceTable": { "type": "string", "description": "The name of the source table.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "pipelineId" ] } } }, "databricks:index/VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn:VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn": { "properties": { "embeddingModelEndpointName": { "type": "string", "description": "The name of the embedding model endpoint, used by default for both ingestion and querying.\n", "willReplaceOnChanges": true }, "modelEndpointNameForQuery": { "type": "string", "description": "The name of the embedding model endpoint which, if specified, is used for querying (not ingestion).\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the column\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn:VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn": { "properties": { "embeddingDimension": { "type": "integer", "description": "Dimension of the embedding vector.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the column.\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/VectorSearchIndexDirectAccessIndexSpec:VectorSearchIndexDirectAccessIndexSpec": { "properties": { "embeddingSourceColumns": { "type": "array", "items": { "$ref": "#/types/databricks:index/VectorSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn:VectorSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn" }, "description": "array of objects representing columns that contain the embedding source. Each entry consists of:\n", "willReplaceOnChanges": true }, "embeddingVectorColumns": { "type": "array", "items": { "$ref": "#/types/databricks:index/VectorSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn:VectorSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn" }, "description": "array of objects representing columns that contain the embedding vectors. Each entry consists of:\n", "willReplaceOnChanges": true }, "schemaJson": { "type": "string", "description": "The schema of the index in JSON format. Check the [API documentation](https://docs.databricks.com/api/workspace/vectorsearchindexes/createindex#direct_access_index_spec-schema_json) for a list of supported data types.\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/VectorSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn:VectorSearchIndexDirectAccessIndexSpecEmbeddingSourceColumn": { "properties": { "embeddingModelEndpointName": { "type": "string", "description": "The name of the embedding model endpoint\n", "willReplaceOnChanges": true }, "modelEndpointNameForQuery": { "type": "string", "description": "The name of the embedding model endpoint which, if specified, is used for querying (not ingestion).\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the column\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/VectorSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn:VectorSearchIndexDirectAccessIndexSpecEmbeddingVectorColumn": { "properties": { "embeddingDimension": { "type": "integer", "description": "Dimension of the embedding vector.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the column.\n", "willReplaceOnChanges": true } }, "type": "object" }, "databricks:index/VectorSearchIndexProviderConfig:VectorSearchIndexProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/VectorSearchIndexStatus:VectorSearchIndexStatus": { "properties": { "indexUrl": { "type": "string", "description": "Index API Url to be used to perform operations on the index\n" }, "indexedRowCount": { "type": "integer", "description": "Number of rows indexed\n" }, "message": { "type": "string", "description": "Message associated with the index status\n" }, "ready": { "type": "boolean", "description": "Whether the index is ready for search\n" } }, "type": "object" }, "databricks:index/VolumeProviderConfig:VolumeProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WarehousesDefaultWarehouseOverrideProviderConfig:WarehousesDefaultWarehouseOverrideProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WorkspaceBindingProviderConfig:WorkspaceBindingProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WorkspaceConfProviderConfig:WorkspaceConfProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WorkspaceEntityTagAssignmentProviderConfig:WorkspaceEntityTagAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WorkspaceFileProviderConfig:WorkspaceFileProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WorkspaceSettingV2AibiDashboardEmbeddingAccessPolicy:WorkspaceSettingV2AibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ] }, "databricks:index/WorkspaceSettingV2AibiDashboardEmbeddingApprovedDomains:WorkspaceSettingV2AibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/WorkspaceSettingV2AllowedAppsUserApiScopes:WorkspaceSettingV2AllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspace:WorkspaceSettingV2AutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean" }, "enabled": { "type": "boolean" }, "enablementDetails": { "$ref": "#/types/databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer" }, "minutes": { "type": "integer" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2BooleanVal:WorkspaceSettingV2BooleanVal": { "properties": { "value": { "type": "boolean" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2CollaborationPlatformConnectivity:WorkspaceSettingV2CollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ] }, "databricks:index/WorkspaceSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:WorkspaceSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ] }, "databricks:index/WorkspaceSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:WorkspaceSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveAllowedAppsUserApiScopes:WorkspaceSettingV2EffectiveAllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspace:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean" }, "enabled": { "type": "boolean" }, "enablementDetails": { "$ref": "#/types/databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:WorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer" }, "minutes": { "type": "integer" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveBooleanVal:WorkspaceSettingV2EffectiveBooleanVal": { "properties": { "value": { "type": "boolean" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveCollaborationPlatformConnectivity:WorkspaceSettingV2EffectiveCollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ] }, "databricks:index/WorkspaceSettingV2EffectiveIntegerVal:WorkspaceSettingV2EffectiveIntegerVal": { "properties": { "value": { "type": "integer" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveOperationalEmailCustomRecipient:WorkspaceSettingV2EffectiveOperationalEmailCustomRecipient": { "properties": { "email": { "type": "string" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectivePersonalCompute:WorkspaceSettingV2EffectivePersonalCompute": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2EffectiveRestrictWorkspaceAdmins:WorkspaceSettingV2EffectiveRestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ] }, "databricks:index/WorkspaceSettingV2EffectiveStringVal:WorkspaceSettingV2EffectiveStringVal": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2IntegerVal:WorkspaceSettingV2IntegerVal": { "properties": { "value": { "type": "integer" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2OperationalEmailCustomRecipient:WorkspaceSettingV2OperationalEmailCustomRecipient": { "properties": { "email": { "type": "string" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2PersonalCompute:WorkspaceSettingV2PersonalCompute": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/WorkspaceSettingV2ProviderConfig:WorkspaceSettingV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "workspaceId" ] } } }, "databricks:index/WorkspaceSettingV2RestrictWorkspaceAdmins:WorkspaceSettingV2RestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ] }, "databricks:index/WorkspaceSettingV2StringVal:WorkspaceSettingV2StringVal": { "properties": { "value": { "type": "string" } }, "type": "object" }, "databricks:index/getAccountFederationPoliciesPolicy:getAccountFederationPoliciesPolicy": { "properties": { "createTime": { "type": "string", "description": "(string) - Creation time of the federation policy\n" }, "description": { "type": "string", "description": "(string) - Description of the federation policy\n" }, "name": { "type": "string", "description": "(string) - Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL\n" }, "oidcPolicy": { "$ref": "#/types/databricks:index/getAccountFederationPoliciesPolicyOidcPolicy:getAccountFederationPoliciesPolicyOidcPolicy", "description": "(OidcFederationPolicy)\n" }, "policyId": { "type": "string", "description": "(string) - The ID of the federation policy. Output only\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies\n" }, "uid": { "type": "string", "description": "(string) - Unique, immutable id of the federation policy\n" }, "updateTime": { "type": "string", "description": "(string) - Last update time of the federation policy\n" } }, "type": "object", "required": [ "createTime", "description", "name", "oidcPolicy", "policyId", "servicePrincipalId", "uid", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountFederationPoliciesPolicyOidcPolicy:getAccountFederationPoliciesPolicyOidcPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id\n" }, "issuer": { "type": "string", "description": "(string) - The required token issuer, as specified in the 'iss' claim of federated tokens\n" }, "jwksJson": { "type": "string", "description": "(string) - The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri \" pulumi-lang-dotnet=\" JwksUri \" pulumi-lang-go=\" jwksUri \" pulumi-lang-python=\" jwks_uri \" pulumi-lang-yaml=\" jwksUri \" pulumi-lang-java=\" jwksUri \" pulumi-lang-hcl=\" jwks_uri \"\u003e jwksUri \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson\n\" pulumi-lang-dotnet=\" JwksJson\n\" pulumi-lang-go=\" jwksJson\n\" pulumi-lang-python=\" jwks_json\n\" pulumi-lang-yaml=\" jwksJson\n\" pulumi-lang-java=\" jwksJson\n\" pulumi-lang-hcl=\" jwks_json\n\"\u003e jwksJson\n\u003c/span\u003eare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys\n" }, "jwksUri": { "type": "string", "description": "(string) - URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri\n\" pulumi-lang-dotnet=\" JwksUri\n\" pulumi-lang-go=\" jwksUri\n\" pulumi-lang-python=\" jwks_uri\n\" pulumi-lang-yaml=\" jwksUri\n\" pulumi-lang-java=\" jwksUri\n\" pulumi-lang-hcl=\" jwks_uri\n\"\u003e jwksUri\n\u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson \" pulumi-lang-dotnet=\" JwksJson \" pulumi-lang-go=\" jwksJson \" pulumi-lang-python=\" jwks_json \" pulumi-lang-yaml=\" jwksJson \" pulumi-lang-java=\" jwksJson \" pulumi-lang-hcl=\" jwks_json \"\u003e jwksJson \u003c/span\u003eare both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys\n" }, "subject": { "type": "string", "description": "(string) - The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies\n" }, "subjectClaim": { "type": "string", "description": "(string) - The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'\n" } }, "type": "object" }, "databricks:index/getAccountFederationPolicyOidcPolicy:getAccountFederationPolicyOidcPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id\n" }, "issuer": { "type": "string", "description": "(string) - The required token issuer, as specified in the 'iss' claim of federated tokens\n" }, "jwksJson": { "type": "string", "description": "(string) - The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri \" pulumi-lang-dotnet=\" JwksUri \" pulumi-lang-go=\" jwksUri \" pulumi-lang-python=\" jwks_uri \" pulumi-lang-yaml=\" jwksUri \" pulumi-lang-java=\" jwksUri \" pulumi-lang-hcl=\" jwks_uri \"\u003e jwksUri \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson\n\" pulumi-lang-dotnet=\" JwksJson\n\" pulumi-lang-go=\" jwksJson\n\" pulumi-lang-python=\" jwks_json\n\" pulumi-lang-yaml=\" jwksJson\n\" pulumi-lang-java=\" jwksJson\n\" pulumi-lang-hcl=\" jwks_json\n\"\u003e jwksJson\n\u003c/span\u003eare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys\n" }, "jwksUri": { "type": "string", "description": "(string) - URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri\n\" pulumi-lang-dotnet=\" JwksUri\n\" pulumi-lang-go=\" jwksUri\n\" pulumi-lang-python=\" jwks_uri\n\" pulumi-lang-yaml=\" jwksUri\n\" pulumi-lang-java=\" jwksUri\n\" pulumi-lang-hcl=\" jwks_uri\n\"\u003e jwksUri\n\u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson \" pulumi-lang-dotnet=\" JwksJson \" pulumi-lang-go=\" jwksJson \" pulumi-lang-python=\" jwks_json \" pulumi-lang-yaml=\" jwksJson \" pulumi-lang-java=\" jwksJson \" pulumi-lang-hcl=\" jwks_json \"\u003e jwksJson \u003c/span\u003eare both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys\n" }, "subject": { "type": "string", "description": "(string) - The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies\n" }, "subjectClaim": { "type": "string", "description": "(string) - The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItem:getAccountNetworkPoliciesItem": { "properties": { "accountId": { "type": "string", "description": "(string) - The associated account ID for this Network Policy object\n" }, "egress": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemEgress:getAccountNetworkPoliciesItemEgress", "description": "(NetworkPolicyEgress) - The network policies applying for egress traffic\n" }, "ingress": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngress:getAccountNetworkPoliciesItemIngress", "description": "(CustomerFacingIngressNetworkPolicy) - The network policies applying for ingress traffic\n" }, "ingressDryRun": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRun:getAccountNetworkPoliciesItemIngressDryRun", "description": "(CustomerFacingIngressNetworkPolicy) - The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests\n" }, "networkPolicyId": { "type": "string", "description": "(string) - The unique identifier for the network policy\n" } }, "type": "object", "required": [ "accountId", "egress", "ingress", "ingressDryRun", "networkPolicyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemEgress:getAccountNetworkPoliciesItemEgress": { "properties": { "networkAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccess:getAccountNetworkPoliciesItemEgressNetworkAccess", "description": "(EgressNetworkPolicyNetworkAccessPolicy) - The access policy enforced for egress traffic to the internet\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccess:getAccountNetworkPoliciesItemEgressNetworkAccess": { "properties": { "allowedInternetDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessAllowedInternetDestination:getAccountNetworkPoliciesItemEgressNetworkAccessAllowedInternetDestination" }, "description": "(list of EgressNetworkPolicyNetworkAccessPolicyInternetDestination) - List of internet destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode\n" }, "allowedStorageDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessAllowedStorageDestination:getAccountNetworkPoliciesItemEgressNetworkAccessAllowedStorageDestination" }, "description": "(list of EgressNetworkPolicyNetworkAccessPolicyStorageDestination) - List of storage destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode\n" }, "blockedInternetDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessBlockedInternetDestination:getAccountNetworkPoliciesItemEgressNetworkAccessBlockedInternetDestination" }, "description": "(list of EgressNetworkPolicyNetworkAccessPolicyInternetDestination) - List of internet destinations that serverless workloads are blocked from accessing.\nThese destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN.\nCurrently supports DNS_NAME type only; IP_RANGE support is planned\n" }, "policyEnforcement": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessPolicyEnforcement:getAccountNetworkPoliciesItemEgressNetworkAccessPolicyEnforcement", "description": "(EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement) - Optional. When\u003cspan pulumi-lang-nodejs=\" policyEnforcement \" pulumi-lang-dotnet=\" PolicyEnforcement \" pulumi-lang-go=\" policyEnforcement \" pulumi-lang-python=\" policy_enforcement \" pulumi-lang-yaml=\" policyEnforcement \" pulumi-lang-java=\" policyEnforcement \" pulumi-lang-hcl=\" policy_enforcement \"\u003e policyEnforcement \u003c/span\u003eis not provided, we default to ENFORCE_MODE_ALL_SERVICES\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessAllowedInternetDestination:getAccountNetworkPoliciesItemEgressNetworkAccessAllowedInternetDestination": { "properties": { "destination": { "type": "string", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "internetDestinationType": { "type": "string", "description": "(string) - The type of internet destination. Currently only DNS_NAME is supported. Possible values are: `DNS_NAME`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessAllowedStorageDestination:getAccountNetworkPoliciesItemEgressNetworkAccessAllowedStorageDestination": { "properties": { "azureStorageAccount": { "type": "string", "description": "(string) - The Azure storage account name\n" }, "azureStorageService": { "type": "string", "description": "(string) - The Azure storage service type (blob, dfs, etc.)\n" }, "bucketName": { "type": "string", "description": "(string)\n" }, "region": { "type": "string", "description": "(string)\n" }, "storageDestinationType": { "type": "string", "description": "(string) - The type of storage destination. Possible values are: `AWS_S3`, `AZURE_STORAGE`, `GOOGLE_CLOUD_STORAGE`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessBlockedInternetDestination:getAccountNetworkPoliciesItemEgressNetworkAccessBlockedInternetDestination": { "properties": { "destination": { "type": "string", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "internetDestinationType": { "type": "string", "description": "(string) - The type of internet destination. Currently only DNS_NAME is supported. Possible values are: `DNS_NAME`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemEgressNetworkAccessPolicyEnforcement:getAccountNetworkPoliciesItemEgressNetworkAccessPolicyEnforcement": { "properties": { "dryRunModeProductFilters": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - When empty, it means dry run for all products.\nWhen non-empty, it means dry run for specific products and for the other products, they will run in enforced mode\n" }, "enforcementMode": { "type": "string", "description": "(string) - The mode of policy enforcement. ENFORCED blocks traffic that violates policy,\nwhile DRY_RUN only logs violations without blocking. When not specified,\ndefaults to ENFORCED. Possible values are: `DRY_RUN`, `ENFORCED`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngress:getAccountNetworkPoliciesItemIngress": { "properties": { "crossWorkspaceAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccess:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccess", "description": "(CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess)\n" }, "privateAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccess:getAccountNetworkPoliciesItemIngressPrivateAccess", "description": "(CustomerFacingIngressNetworkPolicyPrivateAccess) - The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access\n" }, "publicAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccess:getAccountNetworkPoliciesItemIngressPublicAccess", "description": "(CustomerFacingIngressNetworkPolicyPublicAccess) - The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccess:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRule:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRule:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRule:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRule:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRun:getAccountNetworkPoliciesItemIngressDryRun": { "properties": { "crossWorkspaceAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccess:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccess", "description": "(CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess)\n" }, "privateAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccess:getAccountNetworkPoliciesItemIngressDryRunPrivateAccess", "description": "(CustomerFacingIngressNetworkPolicyPrivateAccess) - The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access\n" }, "publicAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccess:getAccountNetworkPoliciesItemIngressDryRunPublicAccess", "description": "(CustomerFacingIngressNetworkPolicyPublicAccess) - The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccess:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRule:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRule:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRule:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRule:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPoliciesItemIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccess:getAccountNetworkPoliciesItemIngressDryRunPrivateAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRule:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRule:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRule:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessAllowRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRule:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressDryRunPrivateAccessDenyRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccess:getAccountNetworkPoliciesItemIngressDryRunPublicAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRule:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRule:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRule:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRule:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccess:getAccountNetworkPoliciesItemIngressPrivateAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRule:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRule:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRule:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressPrivateAccessAllowRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRule:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPoliciesItemIngressPrivateAccessDenyRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccess:getAccountNetworkPoliciesItemIngressPublicAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRule:getAccountNetworkPoliciesItemIngressPublicAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRule:getAccountNetworkPoliciesItemIngressPublicAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRule:getAccountNetworkPoliciesItemIngressPublicAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthentication:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestination:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOrigin:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessAllowRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRule:getAccountNetworkPoliciesItemIngressPublicAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthentication:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestination:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOrigin:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPoliciesItemIngressPublicAccessDenyRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyEgress:getAccountNetworkPolicyEgress": { "properties": { "networkAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyEgressNetworkAccess:getAccountNetworkPolicyEgressNetworkAccess", "description": "(EgressNetworkPolicyNetworkAccessPolicy) - The access policy enforced for egress traffic to the internet\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyEgressNetworkAccess:getAccountNetworkPolicyEgressNetworkAccess": { "properties": { "allowedInternetDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination:getAccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination" }, "description": "(list of EgressNetworkPolicyNetworkAccessPolicyInternetDestination) - List of internet destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode\n" }, "allowedStorageDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination:getAccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination" }, "description": "(list of EgressNetworkPolicyNetworkAccessPolicyStorageDestination) - List of storage destinations that serverless workloads are allowed to access when in RESTRICTED_ACCESS mode\n" }, "blockedInternetDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination:getAccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination" }, "description": "(list of EgressNetworkPolicyNetworkAccessPolicyInternetDestination) - List of internet destinations that serverless workloads are blocked from accessing.\nThese destinations are enforced when restriction mode is RESTRICTED_ACCESS or DRY_RUN.\nCurrently supports DNS_NAME type only; IP_RANGE support is planned\n" }, "policyEnforcement": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyEgressNetworkAccessPolicyEnforcement:getAccountNetworkPolicyEgressNetworkAccessPolicyEnforcement", "description": "(EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement) - Optional. When\u003cspan pulumi-lang-nodejs=\" policyEnforcement \" pulumi-lang-dotnet=\" PolicyEnforcement \" pulumi-lang-go=\" policyEnforcement \" pulumi-lang-python=\" policy_enforcement \" pulumi-lang-yaml=\" policyEnforcement \" pulumi-lang-java=\" policyEnforcement \" pulumi-lang-hcl=\" policy_enforcement \"\u003e policyEnforcement \u003c/span\u003eis not provided, we default to ENFORCE_MODE_ALL_SERVICES\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination:getAccountNetworkPolicyEgressNetworkAccessAllowedInternetDestination": { "properties": { "destination": { "type": "string", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "internetDestinationType": { "type": "string", "description": "(string) - The type of internet destination. Currently only DNS_NAME is supported. Possible values are: `DNS_NAME`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination:getAccountNetworkPolicyEgressNetworkAccessAllowedStorageDestination": { "properties": { "azureStorageAccount": { "type": "string", "description": "(string) - The Azure storage account name\n" }, "azureStorageService": { "type": "string", "description": "(string) - The Azure storage service type (blob, dfs, etc.)\n" }, "bucketName": { "type": "string", "description": "(string)\n" }, "region": { "type": "string", "description": "(string)\n" }, "storageDestinationType": { "type": "string", "description": "(string) - The type of storage destination. Possible values are: `AWS_S3`, `AZURE_STORAGE`, `GOOGLE_CLOUD_STORAGE`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination:getAccountNetworkPolicyEgressNetworkAccessBlockedInternetDestination": { "properties": { "destination": { "type": "string", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "internetDestinationType": { "type": "string", "description": "(string) - The type of internet destination. Currently only DNS_NAME is supported. Possible values are: `DNS_NAME`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyEgressNetworkAccessPolicyEnforcement:getAccountNetworkPolicyEgressNetworkAccessPolicyEnforcement": { "properties": { "dryRunModeProductFilters": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - When empty, it means dry run for all products.\nWhen non-empty, it means dry run for specific products and for the other products, they will run in enforced mode\n" }, "enforcementMode": { "type": "string", "description": "(string) - The mode of policy enforcement. ENFORCED blocks traffic that violates policy,\nwhile DRY_RUN only logs violations without blocking. When not specified,\ndefaults to ENFORCED. Possible values are: `DRY_RUN`, `ENFORCED`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngress:getAccountNetworkPolicyIngress": { "properties": { "crossWorkspaceAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccess:getAccountNetworkPolicyIngressCrossWorkspaceAccess", "description": "(CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess)\n" }, "privateAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccess:getAccountNetworkPolicyIngressPrivateAccess", "description": "(CustomerFacingIngressNetworkPolicyPrivateAccess) - The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access\n" }, "publicAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccess:getAccountNetworkPolicyIngressPublicAccess", "description": "(CustomerFacingIngressNetworkPolicyPublicAccess) - The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccess:getAccountNetworkPolicyIngressCrossWorkspaceAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRun:getAccountNetworkPolicyIngressDryRun": { "properties": { "crossWorkspaceAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccess:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccess", "description": "(CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess)\n" }, "privateAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccess:getAccountNetworkPolicyIngressDryRunPrivateAccess", "description": "(CustomerFacingIngressNetworkPolicyPrivateAccess) - The network policy restrictions for private access to the workspace.\nConfigures how registered private endpoints are allowed or denied access\n" }, "publicAccess": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccess:getAccountNetworkPolicyIngressDryRunPublicAccess", "description": "(CustomerFacingIngressNetworkPolicyPublicAccess) - The network policy restrictions for public access to the workspace.\nConfigures how public internet traffic is allowed or denied access\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccess:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessAllowRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOrigin": { "properties": { "allSourceWorkspaces": { "type": "boolean", "description": "(boolean) - Matches all source workspaces\n" }, "selectedWorkspaces": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceIdList) - Specific source workspace IDs to match\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces:getAccountNetworkPolicyIngressDryRunCrossWorkspaceAccessDenyRuleOriginSelectedWorkspaces": { "properties": { "workspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccess:getAccountNetworkPolicyIngressDryRunPrivateAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRule:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRule:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRule:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPolicyIngressDryRunPrivateAccessAllowRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRule:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPolicyIngressDryRunPrivateAccessDenyRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccess:getAccountNetworkPolicyIngressDryRunPublicAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRule:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRule:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRule:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessAllowRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRule:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressDryRunPublicAccessDenyRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccess:getAccountNetworkPolicyIngressPrivateAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRule:getAccountNetworkPolicyIngressPrivateAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRule:getAccountNetworkPolicyIngressPrivateAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRule:getAccountNetworkPolicyIngressPrivateAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestination:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin:getAccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPrivateAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestination:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPrivateAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin:getAccountNetworkPolicyIngressPrivateAccessAllowRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints:getAccountNetworkPolicyIngressPrivateAccessAllowRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRule:getAccountNetworkPolicyIngressPrivateAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestination:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin:getAccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPrivateAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestination:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPrivateAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin:getAccountNetworkPolicyIngressPrivateAccessDenyRuleOrigin": { "properties": { "allPrivateAccess": { "type": "boolean", "description": "(boolean)\n" }, "allRegisteredEndpoints": { "type": "boolean", "description": "(boolean)\n" }, "azureWorkspacePrivateLink": { "type": "boolean", "description": "(boolean)\n" }, "endpoints": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints", "description": "(CustomerFacingIngressNetworkPolicyEndpoints)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints:getAccountNetworkPolicyIngressPrivateAccessDenyRuleOriginEndpoints": { "properties": { "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccess:getAccountNetworkPolicyIngressPublicAccess": { "properties": { "allowRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRule:getAccountNetworkPolicyIngressPublicAccessAllowRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "denyRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRule:getAccountNetworkPolicyIngressPublicAccessDenyRule" }, "description": "(list of CustomerFacingIngressNetworkPolicyPublicIngressRule)\n" }, "restrictionMode": { "type": "string", "description": "(string) - The restriction mode that controls how serverless workloads can access the internet. Possible values are: `FULL_ACCESS`, `RESTRICTED_ACCESS`\n" } }, "type": "object", "required": [ "restrictionMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRule:getAccountNetworkPolicyIngressPublicAccessAllowRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestination:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleOrigin:getAccountNetworkPolicyIngressPublicAccessAllowRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication:getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPublicAccessAllowRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestination:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPublicAccessAllowRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleOrigin:getAccountNetworkPolicyIngressPublicAccessAllowRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressPublicAccessAllowRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRule:getAccountNetworkPolicyIngressPublicAccessDenyRule": { "properties": { "authentication": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication", "description": "(CustomerFacingIngressNetworkPolicyAuthentication)\n" }, "destination": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestination:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestination", "description": "(string) - The internet destination to which access will be allowed. Format dependent on the destination type\n" }, "label": { "type": "string", "description": "(string) - The label for this ingress rule\n" }, "origin": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleOrigin:getAccountNetworkPolicyIngressPublicAccessDenyRuleOrigin", "description": "(CustomerFacingIngressNetworkPolicyPublicRequestOrigin)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication:getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthentication": { "properties": { "identities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity" }, "description": "(list of CustomerFacingIngressNetworkPolicyAuthenticationIdentity) - Valid only when IdentityType is IDENTITY_TYPE_SELECTED_IDENTITIES\n" }, "identityType": { "type": "string", "description": "(string) - Possible values are: `IDENTITY_TYPE_ALL_SERVICE_PRINCIPALS`, `IDENTITY_TYPE_ALL_USERS`, `IDENTITY_TYPE_SELECTED_IDENTITIES`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity:getAccountNetworkPolicyIngressPublicAccessDenyRuleAuthenticationIdentity": { "properties": { "principalId": { "type": "integer", "description": "(integer)\n" }, "principalType": { "type": "string", "description": "(string) - Possible values are: `PRINCIPAL_TYPE_SERVICE_PRINCIPAL`, `PRINCIPAL_TYPE_USER`\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestination:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestination": { "properties": { "accountApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi", "description": "(CustomerFacingIngressNetworkPolicyAccountApiDestination)\n" }, "accountDatabricksOne": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne", "description": "(CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination) - Account DatabricksOne destination is not supported.\nDO NOT change the stage of this destination past PRIVATE_PREVIEW\n" }, "accountUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi", "description": "(CustomerFacingIngressNetworkPolicyAccountUiDestination)\n" }, "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" }, "appsRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime", "description": "(CustomerFacingIngressNetworkPolicyAppsRuntimeDestination)\n" }, "lakebaseRuntime": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime", "description": "(CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination)\n" }, "workspaceApi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceApiDestination)\n" }, "workspaceUi": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi", "description": "(CustomerFacingIngressNetworkPolicyWorkspaceUiDestination)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountDatabricksOne": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAccountUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationAppsRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationLakebaseRuntime": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceApi": { "properties": { "scopeQualifier": { "type": "string", "description": "(string) - Qualifies the breadth of API access for the listed scopes. See ApiScopeQualifier. Possible values are: `API_SCOPE_QUALIFIER_ALL`, `API_SCOPE_QUALIFIER_READ`\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi:getAccountNetworkPolicyIngressPublicAccessDenyRuleDestinationWorkspaceUi": { "properties": { "allDestinations": { "type": "boolean", "description": "(boolean) - Must be set to true\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleOrigin:getAccountNetworkPolicyIngressPublicAccessDenyRuleOrigin": { "properties": { "allIpRanges": { "type": "boolean", "description": "(boolean) - Matches all IPv4 and IPv6 ranges (both public and private)\n" }, "excludedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Excluded means: all public IP ranges except this one\n" }, "includedIpRanges": { "$ref": "#/types/databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges", "description": "(CustomerFacingIngressNetworkPolicyIpRanges) - Will not allow IP ranges with private IPs\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges:getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginExcludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges:getAccountNetworkPolicyIngressPublicAccessDenyRuleOriginIncludedIpRanges": { "properties": { "ipRanges": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - We only support IPv4 and IPv4 CIDR notation for now\n" } }, "type": "object" }, "databricks:index/getAccountSettingUserPreferenceV2BooleanVal:getAccountSettingUserPreferenceV2BooleanVal": { "properties": { "value": { "type": "boolean", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingUserPreferenceV2EffectiveBooleanVal:getAccountSettingUserPreferenceV2EffectiveBooleanVal": { "properties": { "value": { "type": "boolean", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingUserPreferenceV2EffectiveStringVal:getAccountSettingUserPreferenceV2EffectiveStringVal": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingUserPreferenceV2StringVal:getAccountSettingUserPreferenceV2StringVal": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AibiDashboardEmbeddingAccessPolicy:getAccountSettingV2AibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountSettingV2AibiDashboardEmbeddingApprovedDomains:getAccountSettingV2AibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AllowedAppsUserApiScopes:getAccountSettingV2AllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspace:getAccountSettingV2AutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean", "description": "(boolean)\n" }, "enabled": { "type": "boolean", "description": "(boolean)\n" }, "enablementDetails": { "$ref": "#/types/databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:getAccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails", "description": "(ClusterAutoRestartMessageEnablementDetails)\n" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow", "description": "(ClusterAutoRestartMessageMaintenanceWindow)\n" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:getAccountSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "(boolean) - The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule", "description": "(ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "(string) - Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "(string) - Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime", "description": "(ClusterAutoRestartMessageMaintenanceWindowWindowStartTime)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getAccountSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer", "description": "(integer)\n" }, "minutes": { "type": "integer", "description": "(integer)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2BooleanVal:getAccountSettingV2BooleanVal": { "properties": { "value": { "type": "boolean", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2CollaborationPlatformConnectivity:getAccountSettingV2CollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:getAccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:getAccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveAllowedAppsUserApiScopes:getAccountSettingV2EffectiveAllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspace:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean", "description": "(boolean)\n" }, "enabled": { "type": "boolean", "description": "(boolean)\n" }, "enablementDetails": { "$ref": "#/types/databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails", "description": "(ClusterAutoRestartMessageEnablementDetails)\n" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow", "description": "(ClusterAutoRestartMessageMaintenanceWindow)\n" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "(boolean) - The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule", "description": "(ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "(string) - Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "(string) - Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime", "description": "(ClusterAutoRestartMessageMaintenanceWindowWindowStartTime)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getAccountSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer", "description": "(integer)\n" }, "minutes": { "type": "integer", "description": "(integer)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveBooleanVal:getAccountSettingV2EffectiveBooleanVal": { "properties": { "value": { "type": "boolean", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveCollaborationPlatformConnectivity:getAccountSettingV2EffectiveCollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountSettingV2EffectiveIntegerVal:getAccountSettingV2EffectiveIntegerVal": { "properties": { "value": { "type": "integer", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveOperationalEmailCustomRecipient:getAccountSettingV2EffectiveOperationalEmailCustomRecipient": { "properties": { "email": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectivePersonalCompute:getAccountSettingV2EffectivePersonalCompute": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2EffectiveRestrictWorkspaceAdmins:getAccountSettingV2EffectiveRestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "(boolean) - When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountSettingV2EffectiveStringVal:getAccountSettingV2EffectiveStringVal": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2IntegerVal:getAccountSettingV2IntegerVal": { "properties": { "value": { "type": "integer", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2OperationalEmailCustomRecipient:getAccountSettingV2OperationalEmailCustomRecipient": { "properties": { "email": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2PersonalCompute:getAccountSettingV2PersonalCompute": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAccountSettingV2RestrictWorkspaceAdmins:getAccountSettingV2RestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "(boolean) - When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAccountSettingV2StringVal:getAccountSettingV2StringVal": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getAlertV2EffectiveRunAs:getAlertV2EffectiveRunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "(string) - Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role\n" }, "userName": { "type": "string", "description": "(string) - The email of an active workspace user. Can only set this field to their own email\n" } }, "type": "object" }, "databricks:index/getAlertV2Evaluation:getAlertV2Evaluation": { "properties": { "comparisonOperator": { "type": "string", "description": "(string) - Operator used for comparison in alert evaluation. Possible values are: `EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IS_NOT_NULL`, `IS_NULL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`\n" }, "emptyResultState": { "type": "string", "description": "(string) - Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. Possible values are: `ERROR`, `OK`, `TRIGGERED`, `UNKNOWN`\n" }, "lastEvaluatedAt": { "type": "string", "description": "(string) - Timestamp of the last evaluation\n" }, "notification": { "$ref": "#/types/databricks:index/getAlertV2EvaluationNotification:getAlertV2EvaluationNotification", "description": "(AlertV2Notification) - User or Notification Destination to notify when alert is triggered\n" }, "source": { "$ref": "#/types/databricks:index/getAlertV2EvaluationSource:getAlertV2EvaluationSource", "description": "(AlertV2OperandColumn) - Source column from result to use to evaluate alert\n" }, "state": { "type": "string", "description": "(string) - Latest state of alert evaluation. Possible values are: `ERROR`, `OK`, `TRIGGERED`, `UNKNOWN`\n" }, "threshold": { "$ref": "#/types/databricks:index/getAlertV2EvaluationThreshold:getAlertV2EvaluationThreshold", "description": "(AlertV2Operand) - Threshold to user for alert evaluation, can be a column or a value\n" } }, "type": "object", "required": [ "comparisonOperator", "lastEvaluatedAt", "source", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertV2EvaluationNotification:getAlertV2EvaluationNotification": { "properties": { "effectiveNotifyOnOk": { "type": "boolean" }, "effectiveRetriggerSeconds": { "type": "integer" }, "notifyOnOk": { "type": "boolean", "description": "(boolean) - Whether to notify alert subscribers when alert returns back to normal\n" }, "retriggerSeconds": { "type": "integer", "description": "(integer) - Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAlertV2EvaluationNotificationSubscription:getAlertV2EvaluationNotificationSubscription" }, "description": "(list of AlertV2Subscription)\n" } }, "type": "object", "required": [ "effectiveNotifyOnOk", "effectiveRetriggerSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertV2EvaluationNotificationSubscription:getAlertV2EvaluationNotificationSubscription": { "properties": { "destinationId": { "type": "string", "description": "(string)\n" }, "userEmail": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getAlertV2EvaluationSource:getAlertV2EvaluationSource": { "properties": { "aggregation": { "type": "string", "description": "(string) - If not set, the behavior is equivalent to using `First row` in the UI. Possible values are: `AVG`, `COUNT`, `COUNT_DISTINCT`, `MAX`, `MEDIAN`, `MIN`, `STDDEV`, `SUM`\n" }, "display": { "type": "string", "description": "(string)\n" }, "name": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertV2EvaluationThreshold:getAlertV2EvaluationThreshold": { "properties": { "column": { "$ref": "#/types/databricks:index/getAlertV2EvaluationThresholdColumn:getAlertV2EvaluationThresholdColumn", "description": "(AlertV2OperandColumn)\n" }, "value": { "$ref": "#/types/databricks:index/getAlertV2EvaluationThresholdValue:getAlertV2EvaluationThresholdValue", "description": "(AlertV2OperandValue)\n" } }, "type": "object" }, "databricks:index/getAlertV2EvaluationThresholdColumn:getAlertV2EvaluationThresholdColumn": { "properties": { "aggregation": { "type": "string", "description": "(string) - If not set, the behavior is equivalent to using `First row` in the UI. Possible values are: `AVG`, `COUNT`, `COUNT_DISTINCT`, `MAX`, `MEDIAN`, `MIN`, `STDDEV`, `SUM`\n" }, "display": { "type": "string", "description": "(string)\n" }, "name": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertV2EvaluationThresholdValue:getAlertV2EvaluationThresholdValue": { "properties": { "boolValue": { "type": "boolean", "description": "(boolean)\n" }, "doubleValue": { "type": "number", "description": "(number)\n" }, "stringValue": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getAlertV2ProviderConfig:getAlertV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertV2RunAs:getAlertV2RunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "(string) - Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role\n" }, "userName": { "type": "string", "description": "(string) - The email of an active workspace user. Can only set this field to their own email\n" } }, "type": "object" }, "databricks:index/getAlertV2Schedule:getAlertV2Schedule": { "properties": { "pauseStatus": { "type": "string", "description": "(string) - Indicate whether this schedule is paused or not. Possible values are: `PAUSED`, `UNPAUSED`\n" }, "quartzCronSchedule": { "type": "string", "description": "(string) - A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html\n" }, "timezoneId": { "type": "string", "description": "(string) - A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the\u003cspan pulumi-lang-nodejs=\" quartzCronSchedule \" pulumi-lang-dotnet=\" QuartzCronSchedule \" pulumi-lang-go=\" quartzCronSchedule \" pulumi-lang-python=\" quartz_cron_schedule \" pulumi-lang-yaml=\" quartzCronSchedule \" pulumi-lang-java=\" quartzCronSchedule \" pulumi-lang-hcl=\" quartz_cron_schedule \"\u003e quartzCronSchedule \u003c/span\u003eto determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details\n" } }, "type": "object", "required": [ "quartzCronSchedule", "timezoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2Alert:getAlertsV2Alert": { "properties": { "createTime": { "type": "string", "description": "(string) - The timestamp indicating when the alert was created\n" }, "customDescription": { "type": "string", "description": "(string) - Custom description for the alert. support mustache template\n" }, "customSummary": { "type": "string", "description": "(string) - Custom summary for the alert. support mustache template\n" }, "displayName": { "type": "string", "description": "(string) - The display name of the alert\n" }, "effectiveRunAs": { "$ref": "#/types/databricks:index/getAlertsV2AlertEffectiveRunAs:getAlertsV2AlertEffectiveRunAs", "description": "(AlertV2RunAs) - The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults\n" }, "evaluation": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluation:getAlertsV2AlertEvaluation", "description": "(AlertV2Evaluation)\n" }, "id": { "type": "string", "description": "(string) - UUID identifying the alert\n" }, "lifecycleState": { "type": "string", "description": "(string) - Indicates whether the query is trashed. Possible values are: `ACTIVE`, `DELETED`\n" }, "ownerUserName": { "type": "string", "description": "(string) - The owner's username. This field is set to \"Unavailable\" if the user has been deleted\n" }, "parentPath": { "type": "string", "description": "(string) - The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getAlertsV2AlertProviderConfig:getAlertsV2AlertProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "queryText": { "type": "string", "description": "(string) - Text of the query to be run\n" }, "runAs": { "$ref": "#/types/databricks:index/getAlertsV2AlertRunAs:getAlertsV2AlertRunAs", "description": "(AlertV2RunAs) - Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set \u003cspan pulumi-lang-nodejs=\"`servicePrincipalName`\" pulumi-lang-dotnet=\"`ServicePrincipalName`\" pulumi-lang-go=\"`servicePrincipalName`\" pulumi-lang-python=\"`service_principal_name`\" pulumi-lang-yaml=\"`servicePrincipalName`\" pulumi-lang-java=\"`servicePrincipalName`\" pulumi-lang-hcl=\"`service_principal_name`\"\u003e`servicePrincipalName`\u003c/span\u003e to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user\n" }, "runAsUserName": { "type": "string", "description": "(string, deprecated) - The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use \u003cspan pulumi-lang-nodejs=\"`runAs`\" pulumi-lang-dotnet=\"`RunAs`\" pulumi-lang-go=\"`runAs`\" pulumi-lang-python=\"`run_as`\" pulumi-lang-yaml=\"`runAs`\" pulumi-lang-java=\"`runAs`\" pulumi-lang-hcl=\"`run_as`\"\u003e`runAs`\u003c/span\u003e field instead. This field will be removed in a future release\n" }, "schedule": { "$ref": "#/types/databricks:index/getAlertsV2AlertSchedule:getAlertsV2AlertSchedule", "description": "(CronSchedule)\n" }, "updateTime": { "type": "string", "description": "(string) - The timestamp indicating when the alert was updated\n" }, "warehouseId": { "type": "string", "description": "(string) - ID of the SQL warehouse attached to the alert\n" } }, "type": "object", "required": [ "createTime", "customDescription", "customSummary", "displayName", "effectiveRunAs", "evaluation", "id", "lifecycleState", "ownerUserName", "parentPath", "queryText", "runAs", "runAsUserName", "schedule", "updateTime", "warehouseId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2AlertEffectiveRunAs:getAlertsV2AlertEffectiveRunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "(string) - Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role\n" }, "userName": { "type": "string", "description": "(string) - The email of an active workspace user. Can only set this field to their own email\n" } }, "type": "object" }, "databricks:index/getAlertsV2AlertEvaluation:getAlertsV2AlertEvaluation": { "properties": { "comparisonOperator": { "type": "string", "description": "(string) - Operator used for comparison in alert evaluation. Possible values are: `EQUAL`, `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `IS_NOT_NULL`, `IS_NULL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL`, `NOT_EQUAL`\n" }, "emptyResultState": { "type": "string", "description": "(string) - Alert state if result is empty. Please avoid setting this field to be `UNKNOWN` because `UNKNOWN` state is planned to be deprecated. Possible values are: `ERROR`, `OK`, `TRIGGERED`, `UNKNOWN`\n" }, "lastEvaluatedAt": { "type": "string", "description": "(string) - Timestamp of the last evaluation\n" }, "notification": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluationNotification:getAlertsV2AlertEvaluationNotification", "description": "(AlertV2Notification) - User or Notification Destination to notify when alert is triggered\n" }, "source": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluationSource:getAlertsV2AlertEvaluationSource", "description": "(AlertV2OperandColumn) - Source column from result to use to evaluate alert\n" }, "state": { "type": "string", "description": "(string) - Latest state of alert evaluation. Possible values are: `ERROR`, `OK`, `TRIGGERED`, `UNKNOWN`\n" }, "threshold": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluationThreshold:getAlertsV2AlertEvaluationThreshold", "description": "(AlertV2Operand) - Threshold to user for alert evaluation, can be a column or a value\n" } }, "type": "object", "required": [ "comparisonOperator", "lastEvaluatedAt", "source", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2AlertEvaluationNotification:getAlertsV2AlertEvaluationNotification": { "properties": { "effectiveNotifyOnOk": { "type": "boolean" }, "effectiveRetriggerSeconds": { "type": "integer" }, "notifyOnOk": { "type": "boolean", "description": "(boolean) - Whether to notify alert subscribers when alert returns back to normal\n" }, "retriggerSeconds": { "type": "integer", "description": "(integer) - Number of seconds an alert waits after being triggered before it is allowed to send another notification.\nIf set to 0 or omitted, the alert will not send any further notifications after the first trigger\nSetting this value to 1 allows the alert to send a notification on every evaluation where the condition is met, effectively making it always retrigger for notification purposes\n" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluationNotificationSubscription:getAlertsV2AlertEvaluationNotificationSubscription" }, "description": "(list of AlertV2Subscription)\n" } }, "type": "object", "required": [ "effectiveNotifyOnOk", "effectiveRetriggerSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2AlertEvaluationNotificationSubscription:getAlertsV2AlertEvaluationNotificationSubscription": { "properties": { "destinationId": { "type": "string", "description": "(string)\n" }, "userEmail": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getAlertsV2AlertEvaluationSource:getAlertsV2AlertEvaluationSource": { "properties": { "aggregation": { "type": "string", "description": "(string) - If not set, the behavior is equivalent to using `First row` in the UI. Possible values are: `AVG`, `COUNT`, `COUNT_DISTINCT`, `MAX`, `MEDIAN`, `MIN`, `STDDEV`, `SUM`\n" }, "display": { "type": "string", "description": "(string)\n" }, "name": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2AlertEvaluationThreshold:getAlertsV2AlertEvaluationThreshold": { "properties": { "column": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluationThresholdColumn:getAlertsV2AlertEvaluationThresholdColumn", "description": "(AlertV2OperandColumn)\n" }, "value": { "$ref": "#/types/databricks:index/getAlertsV2AlertEvaluationThresholdValue:getAlertsV2AlertEvaluationThresholdValue", "description": "(AlertV2OperandValue)\n" } }, "type": "object" }, "databricks:index/getAlertsV2AlertEvaluationThresholdColumn:getAlertsV2AlertEvaluationThresholdColumn": { "properties": { "aggregation": { "type": "string", "description": "(string) - If not set, the behavior is equivalent to using `First row` in the UI. Possible values are: `AVG`, `COUNT`, `COUNT_DISTINCT`, `MAX`, `MEDIAN`, `MIN`, `STDDEV`, `SUM`\n" }, "display": { "type": "string", "description": "(string)\n" }, "name": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2AlertEvaluationThresholdValue:getAlertsV2AlertEvaluationThresholdValue": { "properties": { "boolValue": { "type": "boolean", "description": "(boolean)\n" }, "doubleValue": { "type": "number", "description": "(number)\n" }, "stringValue": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getAlertsV2AlertProviderConfig:getAlertsV2AlertProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2AlertRunAs:getAlertsV2AlertRunAs": { "properties": { "servicePrincipalName": { "type": "string", "description": "(string) - Application ID of an active service principal. Setting this field requires the `servicePrincipal/user` role\n" }, "userName": { "type": "string", "description": "(string) - The email of an active workspace user. Can only set this field to their own email\n" } }, "type": "object" }, "databricks:index/getAlertsV2AlertSchedule:getAlertsV2AlertSchedule": { "properties": { "pauseStatus": { "type": "string", "description": "(string) - Indicate whether this schedule is paused or not. Possible values are: `PAUSED`, `UNPAUSED`\n" }, "quartzCronSchedule": { "type": "string", "description": "(string) - A cron expression using quartz syntax that specifies the schedule for this pipeline.\nShould use the quartz format described here: http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html\n" }, "timezoneId": { "type": "string", "description": "(string) - A Java timezone id. The schedule will be resolved using this timezone.\nThis will be combined with the\u003cspan pulumi-lang-nodejs=\" quartzCronSchedule \" pulumi-lang-dotnet=\" QuartzCronSchedule \" pulumi-lang-go=\" quartzCronSchedule \" pulumi-lang-python=\" quartz_cron_schedule \" pulumi-lang-yaml=\" quartzCronSchedule \" pulumi-lang-java=\" quartzCronSchedule \" pulumi-lang-hcl=\" quartz_cron_schedule \"\u003e quartzCronSchedule \u003c/span\u003eto determine the schedule.\nSee https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html for details\n" } }, "type": "object", "required": [ "quartzCronSchedule", "timezoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAlertsV2ProviderConfig:getAlertsV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppApp:getAppApp": { "properties": { "activeDeployment": { "$ref": "#/types/databricks:index/getAppAppActiveDeployment:getAppAppActiveDeployment", "description": "attribute - the active deployment of the app.\n" }, "appStatus": { "$ref": "#/types/databricks:index/getAppAppAppStatus:getAppAppAppStatus", "description": "attribute\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this resource.\n" }, "computeMaxInstances": { "type": "integer" }, "computeMinInstances": { "type": "integer" }, "computeSize": { "type": "string", "description": "A string specifying compute size for the App.\n" }, "computeStatus": { "$ref": "#/types/databricks:index/getAppAppComputeStatus:getAppAppComputeStatus", "description": "attribute\n" }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "defaultSourceCodePath": { "type": "string", "description": "The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.\n" }, "description": { "type": "string", "description": "The description of the resource.\n" }, "effectiveBudgetPolicyId": { "type": "string", "description": "The effective budget policy ID.\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "The effective usage policy ID.\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of effective api scopes granted to the user access token.\n" }, "gitRepository": { "$ref": "#/types/databricks:index/getAppAppGitRepository:getAppAppGitRepository", "description": "attribute - Git repository configuration for app deployments.\n" }, "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "name": { "type": "string", "description": "The name of the app.\n" }, "oauth2AppClientId": { "type": "string", "description": "The OAuth2 client ID of the app's integration, set when the app uses user authorization.\n" }, "oauth2AppIntegrationId": { "type": "string", "description": "The unique ID of the OAuth2 integration associated with the app.\n" }, "pendingDeployment": { "$ref": "#/types/databricks:index/getAppAppPendingDeployment:getAppAppPendingDeployment", "description": "attribute - the pending deployment of the app. Schema is identical to \u003cspan pulumi-lang-nodejs=\"`activeDeployment`\" pulumi-lang-dotnet=\"`ActiveDeployment`\" pulumi-lang-go=\"`activeDeployment`\" pulumi-lang-python=\"`active_deployment`\" pulumi-lang-yaml=\"`activeDeployment`\" pulumi-lang-java=\"`activeDeployment`\" pulumi-lang-hcl=\"`active_deployment`\"\u003e`activeDeployment`\u003c/span\u003e.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppAppResource:getAppAppResource" }, "description": "A list of resources that the app have access to.\n" }, "servicePrincipalClientId": { "type": "string", "description": "client_id (application_id) of the app service principal\n" }, "servicePrincipalId": { "type": "integer", "description": "id of the app service principal\n" }, "servicePrincipalName": { "type": "string", "description": "name of the app service principal\n" }, "space": { "type": "string", "description": "Name of the app space this app belongs to.\n" }, "telemetryExportDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppAppTelemetryExportDestination:getAppAppTelemetryExportDestination" }, "description": "A list of telemetry export destinations.\n" }, "thumbnailUrl": { "type": "string", "description": "The URL of the thumbnail image for the app.\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" }, "updater": { "type": "string", "description": "The email of the user that last updated the app.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" }, "usagePolicyId": { "type": "string", "description": "The Usage Policy ID set for this resource.\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of api scopes granted to the user access token.\n" } }, "type": "object", "required": [ "activeDeployment", "appStatus", "computeStatus", "createTime", "creator", "defaultSourceCodePath", "effectiveBudgetPolicyId", "effectiveUsagePolicyId", "effectiveUserApiScopes", "id", "name", "oauth2AppClientId", "oauth2AppIntegrationId", "pendingDeployment", "servicePrincipalClientId", "servicePrincipalId", "servicePrincipalName", "thumbnailUrl", "updateTime", "updater", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppActiveDeployment:getAppAppActiveDeployment": { "properties": { "commands": { "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "deploymentArtifacts": { "$ref": "#/types/databricks:index/getAppAppActiveDeploymentDeploymentArtifacts:getAppAppActiveDeploymentDeploymentArtifacts", "description": "attribute\n" }, "deploymentId": { "type": "string", "description": "The unique ID of the deployment.\n" }, "envVars": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppAppActiveDeploymentEnvVar:getAppAppActiveDeploymentEnvVar" } }, "gitSource": { "$ref": "#/types/databricks:index/getAppAppActiveDeploymentGitSource:getAppAppActiveDeploymentGitSource" }, "mode": { "type": "string", "description": "The deployment mode (`AUTO_SYNC` or `SNAPSHOT`).\n" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "status": { "$ref": "#/types/databricks:index/getAppAppActiveDeploymentStatus:getAppAppActiveDeploymentStatus", "description": "attribute\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" } }, "type": "object", "required": [ "createTime", "creator", "deploymentArtifacts", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppActiveDeploymentDeploymentArtifacts:getAppAppActiveDeploymentDeploymentArtifacts": { "properties": { "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" } }, "type": "object" }, "databricks:index/getAppAppActiveDeploymentEnvVar:getAppAppActiveDeploymentEnvVar": { "properties": { "name": { "type": "string", "description": "The name of the app.\n" }, "value": { "type": "string" }, "valueFrom": { "type": "string" } }, "type": "object" }, "databricks:index/getAppAppActiveDeploymentGitSource:getAppAppActiveDeploymentGitSource": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "commit": { "type": "string" }, "gitRepository": { "$ref": "#/types/databricks:index/getAppAppActiveDeploymentGitSourceGitRepository:getAppAppActiveDeploymentGitSourceGitRepository", "description": "attribute - Git repository configuration for app deployments.\n" }, "resolvedCommit": { "type": "string" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "tag": { "type": "string" } }, "type": "object", "required": [ "gitRepository", "resolvedCommit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppActiveDeploymentGitSourceGitRepository:getAppAppActiveDeploymentGitSourceGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider (case insensitive). Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppActiveDeploymentStatus:getAppAppActiveDeploymentStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppAppStatus:getAppAppAppStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppComputeStatus:getAppAppComputeStatus": { "properties": { "activeInstances": { "type": "integer" }, "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "activeInstances", "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppGitRepository:getAppAppGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider (case insensitive). Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppPendingDeployment:getAppAppPendingDeployment": { "properties": { "commands": { "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "deploymentArtifacts": { "$ref": "#/types/databricks:index/getAppAppPendingDeploymentDeploymentArtifacts:getAppAppPendingDeploymentDeploymentArtifacts", "description": "attribute\n" }, "deploymentId": { "type": "string", "description": "The unique ID of the deployment.\n" }, "envVars": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppAppPendingDeploymentEnvVar:getAppAppPendingDeploymentEnvVar" } }, "gitSource": { "$ref": "#/types/databricks:index/getAppAppPendingDeploymentGitSource:getAppAppPendingDeploymentGitSource" }, "mode": { "type": "string", "description": "The deployment mode (`AUTO_SYNC` or `SNAPSHOT`).\n" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "status": { "$ref": "#/types/databricks:index/getAppAppPendingDeploymentStatus:getAppAppPendingDeploymentStatus", "description": "attribute\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" } }, "type": "object", "required": [ "createTime", "creator", "deploymentArtifacts", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppPendingDeploymentDeploymentArtifacts:getAppAppPendingDeploymentDeploymentArtifacts": { "properties": { "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" } }, "type": "object" }, "databricks:index/getAppAppPendingDeploymentEnvVar:getAppAppPendingDeploymentEnvVar": { "properties": { "name": { "type": "string", "description": "The name of the app.\n" }, "value": { "type": "string" }, "valueFrom": { "type": "string" } }, "type": "object" }, "databricks:index/getAppAppPendingDeploymentGitSource:getAppAppPendingDeploymentGitSource": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "commit": { "type": "string" }, "gitRepository": { "$ref": "#/types/databricks:index/getAppAppPendingDeploymentGitSourceGitRepository:getAppAppPendingDeploymentGitSourceGitRepository", "description": "attribute - Git repository configuration for app deployments.\n" }, "resolvedCommit": { "type": "string" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "tag": { "type": "string" } }, "type": "object", "required": [ "gitRepository", "resolvedCommit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppPendingDeploymentGitSourceGitRepository:getAppAppPendingDeploymentGitSourceGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider (case insensitive). Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppPendingDeploymentStatus:getAppAppPendingDeploymentStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResource:getAppAppResource": { "properties": { "app": { "$ref": "#/types/databricks:index/getAppAppResourceApp:getAppAppResourceApp", "description": "attribute - reference to another Databricks App.\n" }, "database": { "$ref": "#/types/databricks:index/getAppAppResourceDatabase:getAppAppResourceDatabase", "description": "The resource path of a specific database within the branch (e.g. `projects/proj-abc123/branches/branch-xyz789/databases/db-456`).\n" }, "description": { "type": "string", "description": "The description of the resource.\n" }, "experiment": { "$ref": "#/types/databricks:index/getAppAppResourceExperiment:getAppAppResourceExperiment", "description": "attribute\n" }, "genieSpace": { "$ref": "#/types/databricks:index/getAppAppResourceGenieSpace:getAppAppResourceGenieSpace", "description": "attribute\n" }, "job": { "$ref": "#/types/databricks:index/getAppAppResourceJob:getAppAppResourceJob", "description": "attribute\n" }, "name": { "type": "string", "description": "The name of the app.\n" }, "postgres": { "$ref": "#/types/databricks:index/getAppAppResourcePostgres:getAppAppResourcePostgres", "description": "attribute\n" }, "secret": { "$ref": "#/types/databricks:index/getAppAppResourceSecret:getAppAppResourceSecret", "description": "attribute\n" }, "servingEndpoint": { "$ref": "#/types/databricks:index/getAppAppResourceServingEndpoint:getAppAppResourceServingEndpoint", "description": "attribute\n" }, "sqlWarehouse": { "$ref": "#/types/databricks:index/getAppAppResourceSqlWarehouse:getAppAppResourceSqlWarehouse", "description": "attribute\n" }, "ucSecurable": { "$ref": "#/types/databricks:index/getAppAppResourceUcSecurable:getAppAppResourceUcSecurable", "description": "attribute (see the [API docs](https://docs.databricks.com/api/workspace/apps/create#resources-uc_securable) for full list of supported UC objects)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceApp:getAppAppResourceApp": { "properties": { "name": { "type": "string", "description": "The name of the app.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object" }, "databricks:index/getAppAppResourceDatabase:getAppAppResourceDatabase": { "properties": { "databaseName": { "type": "string", "description": "The name of database.\n" }, "instanceName": { "type": "string", "description": "The name of database instance.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "databaseName", "instanceName", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceExperiment:getAppAppResourceExperiment": { "properties": { "experimentId": { "type": "string", "description": "The ID of the MLflow experiment to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "experimentId", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceGenieSpace:getAppAppResourceGenieSpace": { "properties": { "name": { "type": "string", "description": "The name of the app.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" }, "spaceId": { "type": "string", "description": "The unique ID of Genie Space.\n" } }, "type": "object", "required": [ "name", "permission", "spaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceJob:getAppAppResourceJob": { "properties": { "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourcePostgres:getAppAppResourcePostgres": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "database": { "type": "string", "description": "The resource path of a specific database within the branch (e.g. `projects/proj-abc123/branches/branch-xyz789/databases/db-456`).\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object" }, "databricks:index/getAppAppResourceSecret:getAppAppResourceSecret": { "properties": { "key": { "type": "string", "description": "Key of the secret to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" }, "scope": { "type": "string", "description": "Scope of the secret to grant permission on.\n" } }, "type": "object", "required": [ "key", "permission", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceServingEndpoint:getAppAppResourceServingEndpoint": { "properties": { "name": { "type": "string", "description": "The name of the app.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "name", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceSqlWarehouse:getAppAppResourceSqlWarehouse": { "properties": { "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppResourceUcSecurable:getAppAppResourceUcSecurable": { "properties": { "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" }, "securableFullName": { "type": "string", "description": "The full name of UC securable, i.e. `my-catalog.my-schema.my-volume`.\n" }, "securableKind": { "type": "string" }, "securableType": { "type": "string", "description": "The type of UC securable. Supported values are `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`.\n" } }, "type": "object", "required": [ "permission", "securableFullName", "securableKind", "securableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppAppTelemetryExportDestination:getAppAppTelemetryExportDestination": { "properties": { "unityCatalog": { "$ref": "#/types/databricks:index/getAppAppTelemetryExportDestinationUnityCatalog:getAppAppTelemetryExportDestinationUnityCatalog", "description": "attribute\n" } }, "type": "object" }, "databricks:index/getAppAppTelemetryExportDestinationUnityCatalog:getAppAppTelemetryExportDestinationUnityCatalog": { "properties": { "logsTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry logs.\n" }, "metricsTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry metrics.\n" }, "tracesTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry traces (spans).\n" } }, "type": "object", "required": [ "logsTable", "metricsTable", "tracesTable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppProviderConfig:getAppProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceProviderConfig:getAppSpaceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResource:getAppSpaceResource": { "properties": { "app": { "$ref": "#/types/databricks:index/getAppSpaceResourceApp:getAppSpaceResourceApp", "description": "(AppResourceApp)\n" }, "database": { "$ref": "#/types/databricks:index/getAppSpaceResourceDatabase:getAppSpaceResourceDatabase", "description": "(string)\n" }, "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "experiment": { "$ref": "#/types/databricks:index/getAppSpaceResourceExperiment:getAppSpaceResourceExperiment", "description": "(AppResourceExperiment)\n" }, "genieSpace": { "$ref": "#/types/databricks:index/getAppSpaceResourceGenieSpace:getAppSpaceResourceGenieSpace", "description": "(AppResourceGenieSpace)\n" }, "job": { "$ref": "#/types/databricks:index/getAppSpaceResourceJob:getAppSpaceResourceJob", "description": "(AppResourceJob)\n" }, "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "postgres": { "$ref": "#/types/databricks:index/getAppSpaceResourcePostgres:getAppSpaceResourcePostgres", "description": "(AppResourcePostgres)\n" }, "secret": { "$ref": "#/types/databricks:index/getAppSpaceResourceSecret:getAppSpaceResourceSecret", "description": "(AppResourceSecret)\n" }, "servingEndpoint": { "$ref": "#/types/databricks:index/getAppSpaceResourceServingEndpoint:getAppSpaceResourceServingEndpoint", "description": "(AppResourceServingEndpoint)\n" }, "sqlWarehouse": { "$ref": "#/types/databricks:index/getAppSpaceResourceSqlWarehouse:getAppSpaceResourceSqlWarehouse", "description": "(AppResourceSqlWarehouse)\n" }, "ucSecurable": { "$ref": "#/types/databricks:index/getAppSpaceResourceUcSecurable:getAppSpaceResourceUcSecurable", "description": "(AppResourceUcSecurable)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceApp:getAppSpaceResourceApp": { "properties": { "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object" }, "databricks:index/getAppSpaceResourceDatabase:getAppSpaceResourceDatabase": { "properties": { "databaseName": { "type": "string", "description": "(string)\n" }, "instanceName": { "type": "string", "description": "(string)\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "databaseName", "instanceName", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceExperiment:getAppSpaceResourceExperiment": { "properties": { "experimentId": { "type": "string", "description": "(string)\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "experimentId", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceGenieSpace:getAppSpaceResourceGenieSpace": { "properties": { "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "spaceId": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name", "permission", "spaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceJob:getAppSpaceResourceJob": { "properties": { "id": { "type": "string", "description": "(string) - Id of the SQL warehouse to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourcePostgres:getAppSpaceResourcePostgres": { "properties": { "branch": { "type": "string", "description": "(string)\n" }, "database": { "type": "string", "description": "(string)\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object" }, "databricks:index/getAppSpaceResourceSecret:getAppSpaceResourceSecret": { "properties": { "key": { "type": "string", "description": "(string) - Key of the secret to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "scope": { "type": "string", "description": "(string) - Scope of the secret to grant permission on\n" } }, "type": "object", "required": [ "key", "permission", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceServingEndpoint:getAppSpaceResourceServingEndpoint": { "properties": { "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "name", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceSqlWarehouse:getAppSpaceResourceSqlWarehouse": { "properties": { "id": { "type": "string", "description": "(string) - Id of the SQL warehouse to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceResourceUcSecurable:getAppSpaceResourceUcSecurable": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "securableFullName": { "type": "string", "description": "(string)\n" }, "securableKind": { "type": "string", "description": "(string) - The securable kind from Unity Catalog.\nSee https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind\n" }, "securableType": { "type": "string", "description": "(string) - Possible values are: `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`\n" } }, "type": "object", "required": [ "permission", "securableFullName", "securableKind", "securableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpaceStatus:getAppSpaceStatus": { "properties": { "message": { "type": "string", "description": "(string) - Message providing context about the current state\n" }, "state": { "type": "string", "description": "(string) - The state of the app space. Possible values are: `SPACE_ACTIVE`, `SPACE_CREATING`, `SPACE_DELETED`, `SPACE_DELETING`, `SPACE_ERROR`, `SPACE_UPDATING`\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesProviderConfig:getAppSpacesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpace:getAppSpacesSpace": { "properties": { "createTime": { "type": "string", "description": "(string) - The creation time of the app space. Formatted timestamp in ISO 6801\n" }, "creator": { "type": "string", "description": "(string) - The email of the user that created the app space\n" }, "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "(string) - The effective usage policy ID used by apps in the space\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The effective api scopes granted to the user access token\n" }, "id": { "type": "string", "description": "(string) - Id of the SQL warehouse to grant permission on\n" }, "name": { "type": "string", "description": "(string) - Name of the serving endpoint to grant permission on\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getAppSpacesSpaceProviderConfig:getAppSpacesSpaceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResource:getAppSpacesSpaceResource" }, "description": "(list of AppResource) - Resources for the app space. Resources configured at the space level are available to all apps in the space\n" }, "servicePrincipalClientId": { "type": "string", "description": "(string) - The service principal client ID for the app space\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID for the app space\n" }, "servicePrincipalName": { "type": "string", "description": "(string) - The service principal name for the app space\n" }, "status": { "$ref": "#/types/databricks:index/getAppSpacesSpaceStatus:getAppSpacesSpaceStatus", "description": "(SpaceStatus) - The status of the app space\n" }, "updateTime": { "type": "string", "description": "(string) - The update time of the app space. Formatted timestamp in ISO 6801\n" }, "updater": { "type": "string", "description": "(string) - The email of the user that last updated the app space\n" }, "usagePolicyId": { "type": "string", "description": "(string) - The usage policy ID for managing cost at the space level\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - OAuth scopes for apps in the space\n" } }, "type": "object", "required": [ "createTime", "creator", "description", "effectiveUsagePolicyId", "effectiveUserApiScopes", "id", "name", "resources", "servicePrincipalClientId", "servicePrincipalId", "servicePrincipalName", "status", "updateTime", "updater", "usagePolicyId", "userApiScopes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceProviderConfig:getAppSpacesSpaceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResource:getAppSpacesSpaceResource": { "properties": { "app": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceApp:getAppSpacesSpaceResourceApp", "description": "(AppResourceApp)\n" }, "database": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceDatabase:getAppSpacesSpaceResourceDatabase", "description": "(string)\n" }, "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "experiment": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceExperiment:getAppSpacesSpaceResourceExperiment", "description": "(AppResourceExperiment)\n" }, "genieSpace": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceGenieSpace:getAppSpacesSpaceResourceGenieSpace", "description": "(AppResourceGenieSpace)\n" }, "job": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceJob:getAppSpacesSpaceResourceJob", "description": "(AppResourceJob)\n" }, "name": { "type": "string", "description": "(string) - Name of the serving endpoint to grant permission on\n" }, "postgres": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourcePostgres:getAppSpacesSpaceResourcePostgres", "description": "(AppResourcePostgres)\n" }, "secret": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceSecret:getAppSpacesSpaceResourceSecret", "description": "(AppResourceSecret)\n" }, "servingEndpoint": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceServingEndpoint:getAppSpacesSpaceResourceServingEndpoint", "description": "(AppResourceServingEndpoint)\n" }, "sqlWarehouse": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceSqlWarehouse:getAppSpacesSpaceResourceSqlWarehouse", "description": "(AppResourceSqlWarehouse)\n" }, "ucSecurable": { "$ref": "#/types/databricks:index/getAppSpacesSpaceResourceUcSecurable:getAppSpacesSpaceResourceUcSecurable", "description": "(AppResourceUcSecurable)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceApp:getAppSpacesSpaceResourceApp": { "properties": { "name": { "type": "string", "description": "(string) - Name of the serving endpoint to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object" }, "databricks:index/getAppSpacesSpaceResourceDatabase:getAppSpacesSpaceResourceDatabase": { "properties": { "databaseName": { "type": "string", "description": "(string)\n" }, "instanceName": { "type": "string", "description": "(string)\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "databaseName", "instanceName", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceExperiment:getAppSpacesSpaceResourceExperiment": { "properties": { "experimentId": { "type": "string", "description": "(string)\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "experimentId", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceGenieSpace:getAppSpacesSpaceResourceGenieSpace": { "properties": { "name": { "type": "string", "description": "(string) - Name of the serving endpoint to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "spaceId": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name", "permission", "spaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceJob:getAppSpacesSpaceResourceJob": { "properties": { "id": { "type": "string", "description": "(string) - Id of the SQL warehouse to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourcePostgres:getAppSpacesSpaceResourcePostgres": { "properties": { "branch": { "type": "string", "description": "(string)\n" }, "database": { "type": "string", "description": "(string)\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object" }, "databricks:index/getAppSpacesSpaceResourceSecret:getAppSpacesSpaceResourceSecret": { "properties": { "key": { "type": "string", "description": "(string) - Key of the secret to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "scope": { "type": "string", "description": "(string) - Scope of the secret to grant permission on\n" } }, "type": "object", "required": [ "key", "permission", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceServingEndpoint:getAppSpacesSpaceResourceServingEndpoint": { "properties": { "name": { "type": "string", "description": "(string) - Name of the serving endpoint to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "name", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceSqlWarehouse:getAppSpacesSpaceResourceSqlWarehouse": { "properties": { "id": { "type": "string", "description": "(string) - Id of the SQL warehouse to grant permission on\n" }, "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceResourceUcSecurable:getAppSpacesSpaceResourceUcSecurable": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MODIFY`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "securableFullName": { "type": "string", "description": "(string)\n" }, "securableKind": { "type": "string", "description": "(string) - The securable kind from Unity Catalog.\nSee https://docs.databricks.com/api/workspace/tables/get#securable_kind_manifest-securable_kind\n" }, "securableType": { "type": "string", "description": "(string) - Possible values are: `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`\n" } }, "type": "object", "required": [ "permission", "securableFullName", "securableKind", "securableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppSpacesSpaceStatus:getAppSpacesSpaceStatus": { "properties": { "message": { "type": "string", "description": "(string) - Message providing context about the current state\n" }, "state": { "type": "string", "description": "(string) - The state of the app space. Possible values are: `SPACE_ACTIVE`, `SPACE_CREATING`, `SPACE_DELETED`, `SPACE_DELETING`, `SPACE_ERROR`, `SPACE_UPDATING`\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsApp:getAppsApp": { "properties": { "activeDeployment": { "$ref": "#/types/databricks:index/getAppsAppActiveDeployment:getAppsAppActiveDeployment", "description": "attribute - the active deployment of the app.\n" }, "appStatus": { "$ref": "#/types/databricks:index/getAppsAppAppStatus:getAppsAppAppStatus", "description": "attribute\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this resource.\n" }, "computeMaxInstances": { "type": "integer" }, "computeMinInstances": { "type": "integer" }, "computeSize": { "type": "string", "description": "A string specifying compute size for the App.\n" }, "computeStatus": { "$ref": "#/types/databricks:index/getAppsAppComputeStatus:getAppsAppComputeStatus", "description": "attribute\n" }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "defaultSourceCodePath": { "type": "string", "description": "The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.\n" }, "description": { "type": "string", "description": "The description of the resource.\n" }, "effectiveBudgetPolicyId": { "type": "string", "description": "The effective budget policy ID.\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "The effective usage policy ID.\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of effective api scopes granted to the user access token.\n" }, "gitRepository": { "$ref": "#/types/databricks:index/getAppsAppGitRepository:getAppsAppGitRepository", "description": "attribute - Git repository configuration for app deployments.\n" }, "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "oauth2AppClientId": { "type": "string", "description": "The OAuth2 client ID of the app's integration, set when the app uses user authorization.\n" }, "oauth2AppIntegrationId": { "type": "string", "description": "The unique ID of the OAuth2 integration associated with the app.\n" }, "pendingDeployment": { "$ref": "#/types/databricks:index/getAppsAppPendingDeployment:getAppsAppPendingDeployment", "description": "attribute - the pending deployment of the app. Schema is identical to \u003cspan pulumi-lang-nodejs=\"`activeDeployment`\" pulumi-lang-dotnet=\"`ActiveDeployment`\" pulumi-lang-go=\"`activeDeployment`\" pulumi-lang-python=\"`active_deployment`\" pulumi-lang-yaml=\"`activeDeployment`\" pulumi-lang-java=\"`activeDeployment`\" pulumi-lang-hcl=\"`active_deployment`\"\u003e`activeDeployment`\u003c/span\u003e.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppsAppResource:getAppsAppResource" }, "description": "A list of resources that the app have access to.\n" }, "servicePrincipalClientId": { "type": "string", "description": "client_id (application_id) of the app service principal\n" }, "servicePrincipalId": { "type": "integer", "description": "id of the app service principal\n" }, "servicePrincipalName": { "type": "string", "description": "name of the app service principal\n" }, "space": { "type": "string", "description": "Name of the app space this app belongs to.\n" }, "telemetryExportDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppsAppTelemetryExportDestination:getAppsAppTelemetryExportDestination" }, "description": "A list of telemetry export destinations.\n" }, "thumbnailUrl": { "type": "string", "description": "The URL of the thumbnail image for the app.\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" }, "updater": { "type": "string", "description": "The email of the user that last updated the app.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" }, "usagePolicyId": { "type": "string", "description": "The Usage Policy ID set for this resource.\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of api scopes granted to the user access token.\n" } }, "type": "object", "required": [ "activeDeployment", "appStatus", "computeStatus", "createTime", "creator", "defaultSourceCodePath", "effectiveBudgetPolicyId", "effectiveUsagePolicyId", "effectiveUserApiScopes", "id", "name", "oauth2AppClientId", "oauth2AppIntegrationId", "pendingDeployment", "servicePrincipalClientId", "servicePrincipalId", "servicePrincipalName", "thumbnailUrl", "updateTime", "updater", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppActiveDeployment:getAppsAppActiveDeployment": { "properties": { "commands": { "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "deploymentArtifacts": { "$ref": "#/types/databricks:index/getAppsAppActiveDeploymentDeploymentArtifacts:getAppsAppActiveDeploymentDeploymentArtifacts", "description": "attribute\n" }, "deploymentId": { "type": "string", "description": "The unique ID of the deployment.\n" }, "envVars": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppsAppActiveDeploymentEnvVar:getAppsAppActiveDeploymentEnvVar" } }, "gitSource": { "$ref": "#/types/databricks:index/getAppsAppActiveDeploymentGitSource:getAppsAppActiveDeploymentGitSource" }, "mode": { "type": "string", "description": "The deployment mode (`AUTO_SYNC` or `SNAPSHOT`).\n" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "status": { "$ref": "#/types/databricks:index/getAppsAppActiveDeploymentStatus:getAppsAppActiveDeploymentStatus", "description": "attribute\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" } }, "type": "object", "required": [ "createTime", "creator", "deploymentArtifacts", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppActiveDeploymentDeploymentArtifacts:getAppsAppActiveDeploymentDeploymentArtifacts": { "properties": { "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" } }, "type": "object" }, "databricks:index/getAppsAppActiveDeploymentEnvVar:getAppsAppActiveDeploymentEnvVar": { "properties": { "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "value": { "type": "string" }, "valueFrom": { "type": "string" } }, "type": "object" }, "databricks:index/getAppsAppActiveDeploymentGitSource:getAppsAppActiveDeploymentGitSource": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "commit": { "type": "string" }, "gitRepository": { "$ref": "#/types/databricks:index/getAppsAppActiveDeploymentGitSourceGitRepository:getAppsAppActiveDeploymentGitSourceGitRepository", "description": "attribute - Git repository configuration for app deployments.\n" }, "resolvedCommit": { "type": "string" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "tag": { "type": "string" } }, "type": "object", "required": [ "gitRepository", "resolvedCommit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppActiveDeploymentGitSourceGitRepository:getAppsAppActiveDeploymentGitSourceGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider (case insensitive). Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppActiveDeploymentStatus:getAppsAppActiveDeploymentStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppAppStatus:getAppsAppAppStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppComputeStatus:getAppsAppComputeStatus": { "properties": { "activeInstances": { "type": "integer" }, "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "activeInstances", "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppGitRepository:getAppsAppGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider (case insensitive). Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppPendingDeployment:getAppsAppPendingDeployment": { "properties": { "commands": { "type": "array", "items": { "type": "string" } }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "deploymentArtifacts": { "$ref": "#/types/databricks:index/getAppsAppPendingDeploymentDeploymentArtifacts:getAppsAppPendingDeploymentDeploymentArtifacts", "description": "attribute\n" }, "deploymentId": { "type": "string", "description": "The unique ID of the deployment.\n" }, "envVars": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppsAppPendingDeploymentEnvVar:getAppsAppPendingDeploymentEnvVar" } }, "gitSource": { "$ref": "#/types/databricks:index/getAppsAppPendingDeploymentGitSource:getAppsAppPendingDeploymentGitSource" }, "mode": { "type": "string", "description": "The deployment mode (`AUTO_SYNC` or `SNAPSHOT`).\n" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "status": { "$ref": "#/types/databricks:index/getAppsAppPendingDeploymentStatus:getAppsAppPendingDeploymentStatus", "description": "attribute\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" } }, "type": "object", "required": [ "createTime", "creator", "deploymentArtifacts", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppPendingDeploymentDeploymentArtifacts:getAppsAppPendingDeploymentDeploymentArtifacts": { "properties": { "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" } }, "type": "object" }, "databricks:index/getAppsAppPendingDeploymentEnvVar:getAppsAppPendingDeploymentEnvVar": { "properties": { "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "value": { "type": "string" }, "valueFrom": { "type": "string" } }, "type": "object" }, "databricks:index/getAppsAppPendingDeploymentGitSource:getAppsAppPendingDeploymentGitSource": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "commit": { "type": "string" }, "gitRepository": { "$ref": "#/types/databricks:index/getAppsAppPendingDeploymentGitSourceGitRepository:getAppsAppPendingDeploymentGitSourceGitRepository", "description": "attribute - Git repository configuration for app deployments.\n" }, "resolvedCommit": { "type": "string" }, "sourceCodePath": { "type": "string", "description": "The snapshotted workspace file system path of the source code loaded by the deployed app.\n" }, "tag": { "type": "string" } }, "type": "object", "required": [ "gitRepository", "resolvedCommit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppPendingDeploymentGitSourceGitRepository:getAppsAppPendingDeploymentGitSourceGitRepository": { "properties": { "provider": { "type": "string", "description": "Git provider (case insensitive). Supported values: `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`.\n" }, "url": { "type": "string", "description": "URL of the Git repository.\n" } }, "type": "object", "required": [ "provider", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppPendingDeploymentStatus:getAppsAppPendingDeploymentStatus": { "properties": { "message": { "type": "string", "description": "The status message of the deployment.\n" }, "state": { "type": "string", "description": "The state of the deployment.\n" } }, "type": "object", "required": [ "message", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResource:getAppsAppResource": { "properties": { "app": { "$ref": "#/types/databricks:index/getAppsAppResourceApp:getAppsAppResourceApp", "description": "attribute - reference to another Databricks App.\n" }, "database": { "$ref": "#/types/databricks:index/getAppsAppResourceDatabase:getAppsAppResourceDatabase", "description": "The resource path of a specific database within the branch (e.g. `projects/proj-abc123/branches/branch-xyz789/databases/db-456`).\n" }, "description": { "type": "string", "description": "The description of the resource.\n" }, "experiment": { "$ref": "#/types/databricks:index/getAppsAppResourceExperiment:getAppsAppResourceExperiment", "description": "attribute\n" }, "genieSpace": { "$ref": "#/types/databricks:index/getAppsAppResourceGenieSpace:getAppsAppResourceGenieSpace", "description": "attribute\n" }, "job": { "$ref": "#/types/databricks:index/getAppsAppResourceJob:getAppsAppResourceJob", "description": "attribute\n" }, "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "postgres": { "$ref": "#/types/databricks:index/getAppsAppResourcePostgres:getAppsAppResourcePostgres", "description": "attribute\n" }, "secret": { "$ref": "#/types/databricks:index/getAppsAppResourceSecret:getAppsAppResourceSecret", "description": "attribute\n" }, "servingEndpoint": { "$ref": "#/types/databricks:index/getAppsAppResourceServingEndpoint:getAppsAppResourceServingEndpoint", "description": "attribute\n" }, "sqlWarehouse": { "$ref": "#/types/databricks:index/getAppsAppResourceSqlWarehouse:getAppsAppResourceSqlWarehouse", "description": "attribute\n" }, "ucSecurable": { "$ref": "#/types/databricks:index/getAppsAppResourceUcSecurable:getAppsAppResourceUcSecurable", "description": "attribute (see the [API docs](https://docs.databricks.com/api/workspace/apps/create#resources-uc_securable) for full list of supported UC objects)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceApp:getAppsAppResourceApp": { "properties": { "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object" }, "databricks:index/getAppsAppResourceDatabase:getAppsAppResourceDatabase": { "properties": { "databaseName": { "type": "string", "description": "The name of database.\n" }, "instanceName": { "type": "string", "description": "The name of database instance.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "databaseName", "instanceName", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceExperiment:getAppsAppResourceExperiment": { "properties": { "experimentId": { "type": "string", "description": "The ID of the MLflow experiment to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "experimentId", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceGenieSpace:getAppsAppResourceGenieSpace": { "properties": { "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" }, "spaceId": { "type": "string", "description": "The unique ID of Genie Space.\n" } }, "type": "object", "required": [ "name", "permission", "spaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceJob:getAppsAppResourceJob": { "properties": { "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourcePostgres:getAppsAppResourcePostgres": { "properties": { "branch": { "type": "string", "description": "The resource path of the Lakebase Autoscaling branch (e.g. `projects/proj-abc123/branches/branch-xyz789`).\n" }, "database": { "type": "string", "description": "The resource path of a specific database within the branch (e.g. `projects/proj-abc123/branches/branch-xyz789/databases/db-456`).\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object" }, "databricks:index/getAppsAppResourceSecret:getAppsAppResourceSecret": { "properties": { "key": { "type": "string", "description": "Key of the secret to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" }, "scope": { "type": "string", "description": "Scope of the secret to grant permission on.\n" } }, "type": "object", "required": [ "key", "permission", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceServingEndpoint:getAppsAppResourceServingEndpoint": { "properties": { "name": { "type": "string", "description": "The name of the app to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "name", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceSqlWarehouse:getAppsAppResourceSqlWarehouse": { "properties": { "id": { "type": "string", "description": "Id of the job to grant permission on.\n" }, "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" } }, "type": "object", "required": [ "id", "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppResourceUcSecurable:getAppsAppResourceUcSecurable": { "properties": { "permission": { "type": "string", "description": "Permission to grant on the experiment. Supported permissions are: `CAN_READ`, `CAN_EDIT`, `CAN_MANAGE`.\n" }, "securableFullName": { "type": "string", "description": "The full name of UC securable, i.e. `my-catalog.my-schema.my-volume`.\n" }, "securableKind": { "type": "string" }, "securableType": { "type": "string", "description": "The type of UC securable. Supported values are `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`.\n" } }, "type": "object", "required": [ "permission", "securableFullName", "securableKind", "securableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsAppTelemetryExportDestination:getAppsAppTelemetryExportDestination": { "properties": { "unityCatalog": { "$ref": "#/types/databricks:index/getAppsAppTelemetryExportDestinationUnityCatalog:getAppsAppTelemetryExportDestinationUnityCatalog", "description": "attribute\n" } }, "type": "object" }, "databricks:index/getAppsAppTelemetryExportDestinationUnityCatalog:getAppsAppTelemetryExportDestinationUnityCatalog": { "properties": { "logsTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry logs.\n" }, "metricsTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry metrics.\n" }, "tracesTable": { "type": "string", "description": "Full name of the Unity Catalog table for OpenTelemetry traces (spans).\n" } }, "type": "object", "required": [ "logsTable", "metricsTable", "tracesTable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsProviderConfig:getAppsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifest:getAppsSettingsCustomTemplateManifest": { "properties": { "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "resourceSpecs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpec:getAppsSettingsCustomTemplateManifestResourceSpec" }, "description": "(list of AppManifestAppResourceSpec)\n" }, "version": { "type": "integer", "description": "(integer) - The manifest schema version, for now only 1 is allowed\n" } }, "type": "object", "required": [ "name", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpec:getAppsSettingsCustomTemplateManifestResourceSpec": { "properties": { "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "experimentSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecExperimentSpec:getAppsSettingsCustomTemplateManifestResourceSpecExperimentSpec", "description": "(AppManifestAppResourceExperimentSpec)\n" }, "jobSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecJobSpec:getAppsSettingsCustomTemplateManifestResourceSpecJobSpec", "description": "(AppManifestAppResourceJobSpec)\n" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "secretSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecSecretSpec:getAppsSettingsCustomTemplateManifestResourceSpecSecretSpec", "description": "(AppManifestAppResourceSecretSpec)\n" }, "servingEndpointSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec:getAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec", "description": "(AppManifestAppResourceServingEndpointSpec)\n" }, "sqlWarehouseSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec:getAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec", "description": "(AppManifestAppResourceSqlWarehouseSpec)\n" }, "ucSecurableSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec:getAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec", "description": "(AppManifestAppResourceUcSecurableSpec)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecExperimentSpec:getAppsSettingsCustomTemplateManifestResourceSpecExperimentSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecJobSpec:getAppsSettingsCustomTemplateManifestResourceSpecJobSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecSecretSpec:getAppsSettingsCustomTemplateManifestResourceSpecSecretSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec:getAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec:getAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec:getAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "securableType": { "type": "string", "description": "(string) - Possible values are: `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`\n" } }, "type": "object", "required": [ "permission", "securableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplateProviderConfig:getAppsSettingsCustomTemplateProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesProviderConfig:getAppsSettingsCustomTemplatesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplate:getAppsSettingsCustomTemplatesTemplate": { "properties": { "creator": { "type": "string", "description": "(string)\n" }, "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "gitProvider": { "type": "string", "description": "(string) - The Git provider of the template\n" }, "gitRepo": { "type": "string", "description": "(string) - The Git repository URL that the template resides in\n" }, "manifest": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifest:getAppsSettingsCustomTemplatesTemplateManifest", "description": "(AppManifest) - The manifest of the template. It defines fields and default values when installing the template\n" }, "name": { "type": "string", "description": "(string) - Name of the App Resource\n" }, "path": { "type": "string", "description": "(string) - The path to the template within the Git repository\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateProviderConfig:getAppsSettingsCustomTemplatesTemplateProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "type": "object", "required": [ "creator", "description", "gitProvider", "gitRepo", "manifest", "name", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifest:getAppsSettingsCustomTemplatesTemplateManifest": { "properties": { "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "name": { "type": "string", "description": "(string) - Name of the App Resource\n" }, "resourceSpecs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpec" }, "description": "(list of AppManifestAppResourceSpec)\n" }, "version": { "type": "integer", "description": "(integer) - The manifest schema version, for now only 1 is allowed\n" } }, "type": "object", "required": [ "name", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpec": { "properties": { "description": { "type": "string", "description": "(string) - Description of the App Resource\n" }, "experimentSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecExperimentSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecExperimentSpec", "description": "(AppManifestAppResourceExperimentSpec)\n" }, "jobSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecJobSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecJobSpec", "description": "(AppManifestAppResourceJobSpec)\n" }, "name": { "type": "string", "description": "(string) - Name of the App Resource\n" }, "secretSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSecretSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSecretSpec", "description": "(AppManifestAppResourceSecretSpec)\n" }, "servingEndpointSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecServingEndpointSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecServingEndpointSpec", "description": "(AppManifestAppResourceServingEndpointSpec)\n" }, "sqlWarehouseSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSqlWarehouseSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSqlWarehouseSpec", "description": "(AppManifestAppResourceSqlWarehouseSpec)\n" }, "ucSecurableSpec": { "$ref": "#/types/databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecUcSecurableSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecUcSecurableSpec", "description": "(AppManifestAppResourceUcSecurableSpec)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecExperimentSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecExperimentSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecJobSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecJobSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSecretSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSecretSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecServingEndpointSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecServingEndpointSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSqlWarehouseSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecSqlWarehouseSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" } }, "type": "object", "required": [ "permission" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateManifestResourceSpecUcSecurableSpec:getAppsSettingsCustomTemplatesTemplateManifestResourceSpecUcSecurableSpec": { "properties": { "permission": { "type": "string", "description": "(string) - Possible values are: `EXECUTE`, `MANAGE`, `READ_VOLUME`, `SELECT`, `USE_CONNECTION`, `WRITE_VOLUME`\n" }, "securableType": { "type": "string", "description": "(string) - Possible values are: `CONNECTION`, `FUNCTION`, `TABLE`, `VOLUME`\n" } }, "type": "object", "required": [ "permission", "securableType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getAppsSettingsCustomTemplatesTemplateProviderConfig:getAppsSettingsCustomTemplatesTemplateProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getBudgetPoliciesFilterBy:getBudgetPoliciesFilterBy": { "properties": { "creatorUserId": { "type": "integer", "description": "The policy creator user id to be filtered on.\nIf unspecified, all policies will be returned\n" }, "creatorUserName": { "type": "string", "description": "The policy creator user name to be filtered on.\nIf unspecified, all policies will be returned\n" }, "policyName": { "type": "string", "description": "(string) - The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`\n" } }, "type": "object" }, "databricks:index/getBudgetPoliciesPolicy:getBudgetPoliciesPolicy": { "properties": { "bindingWorkspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "(list of integer) - List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getBudgetPoliciesPolicyCustomTag:getBudgetPoliciesPolicyCustomTag" }, "description": "(list of CustomPolicyTag) - A list of tags defined by the customer. At most 20 entries are allowed per policy\n" }, "policyId": { "type": "string", "description": "(string) - The Id of the policy. This field is generated by Databricks and globally unique\n" }, "policyName": { "type": "string", "description": "(string) - The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`\n" } }, "type": "object", "required": [ "bindingWorkspaceIds", "customTags", "policyId", "policyName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getBudgetPoliciesPolicyCustomTag:getBudgetPoliciesPolicyCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the tag.\n- Must be unique among all custom tags of the same policy\n- Cannot be “budget-policy-name”, “budget-policy-id” or \"budget-policy-resolution-result\" -\nthese tags are preserved\n" }, "value": { "type": "string", "description": "(string) - The value of the tag\n" } }, "type": "object", "required": [ "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getBudgetPoliciesSortSpec:getBudgetPoliciesSortSpec": { "properties": { "descending": { "type": "boolean", "description": "Whether to sort in descending order\n" }, "field": { "type": "string", "description": "The filed to sort by. Possible values are: `POLICY_NAME`\n" } }, "type": "object" }, "databricks:index/getBudgetPolicyCustomTag:getBudgetPolicyCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the tag.\n- Must be unique among all custom tags of the same policy\n- Cannot be “budget-policy-name”, “budget-policy-id” or \"budget-policy-resolution-result\" -\nthese tags are preserved\n" }, "value": { "type": "string", "description": "(string) - The value of the tag\n" } }, "type": "object", "required": [ "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getCatalogCatalogInfo:getCatalogCatalogInfo": { "properties": { "browseOnly": { "type": "boolean" }, "catalogType": { "type": "string", "description": "Type of the catalog, e.g. `MANAGED_CATALOG`, `DELTASHARING_CATALOG`, `SYSTEM_CATALOG`,\n" }, "comment": { "type": "string", "description": "Free-form text description\n" }, "connectionName": { "type": "string", "description": "The name of the connection to an external data source.\n" }, "createdAt": { "type": "integer", "description": "Time at which this catalog was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of catalog creator.\n" }, "effectivePredictiveOptimizationFlag": { "$ref": "#/types/databricks:index/getCatalogCatalogInfoEffectivePredictiveOptimizationFlag:getCatalogCatalogInfoEffectivePredictiveOptimizationFlag", "description": "object describing applied predictive optimization flag.\n" }, "enablePredictiveOptimization": { "type": "string", "description": "Whether predictive optimization should be enabled for this object and objects under it.\n" }, "fullName": { "type": "string", "description": "The full name of the catalog. Corresponds with the name field.\n" }, "isolationMode": { "type": "string", "description": "Whether the current securable is accessible from all workspaces or a specific set of workspaces.\n" }, "managedEncryptionSettings": { "$ref": "#/types/databricks:index/getCatalogCatalogInfoManagedEncryptionSettings:getCatalogCatalogInfoManagedEncryptionSettings" }, "metastoreId": { "type": "string", "description": "Unique identifier of parent metastore.\n" }, "name": { "type": "string", "description": "name of the catalog\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of key-value properties attached to the securable.\n" }, "owner": { "type": "string", "description": "Current owner of the catalog\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of key-value properties attached to the securable.\n" }, "providerName": { "type": "string", "description": "The name of delta sharing provider.\n" }, "provisioningInfo": { "$ref": "#/types/databricks:index/getCatalogCatalogInfoProvisioningInfo:getCatalogCatalogInfoProvisioningInfo" }, "securableType": { "type": "string", "description": "Securable type.\n" }, "shareName": { "type": "string", "description": "The name of the share under the share provider.\n" }, "storageLocation": { "type": "string", "description": "Storage Location URL (full path) for managed tables within catalog.\n" }, "storageRoot": { "type": "string", "description": "Storage root URL for managed tables within catalog.\n" }, "updatedAt": { "type": "integer", "description": "Time at which this catalog was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified catalog.\n" } }, "type": "object" }, "databricks:index/getCatalogCatalogInfoEffectivePredictiveOptimizationFlag:getCatalogCatalogInfoEffectivePredictiveOptimizationFlag": { "properties": { "inheritedFromName": { "type": "string" }, "inheritedFromType": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "value" ] }, "databricks:index/getCatalogCatalogInfoManagedEncryptionSettings:getCatalogCatalogInfoManagedEncryptionSettings": { "properties": { "azureEncryptionSettings": { "$ref": "#/types/databricks:index/getCatalogCatalogInfoManagedEncryptionSettingsAzureEncryptionSettings:getCatalogCatalogInfoManagedEncryptionSettingsAzureEncryptionSettings" }, "azureKeyVaultKeyId": { "type": "string" }, "customerManagedKeyId": { "type": "string" } }, "type": "object" }, "databricks:index/getCatalogCatalogInfoManagedEncryptionSettingsAzureEncryptionSettings:getCatalogCatalogInfoManagedEncryptionSettingsAzureEncryptionSettings": { "properties": { "azureCmkAccessConnectorId": { "type": "string" }, "azureCmkManagedIdentityId": { "type": "string" }, "azureTenantId": { "type": "string" } }, "type": "object", "required": [ "azureTenantId" ] }, "databricks:index/getCatalogCatalogInfoProvisioningInfo:getCatalogCatalogInfoProvisioningInfo": { "properties": { "state": { "type": "string" } }, "type": "object" }, "databricks:index/getCatalogProviderConfig:getCatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getCatalogsProviderConfig:getCatalogsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClusterClusterInfo:getClusterClusterInfo": { "properties": { "autoscale": { "$ref": "#/types/databricks:index/getClusterClusterInfoAutoscale:getClusterClusterInfoAutoscale" }, "autoterminationMinutes": { "type": "integer", "description": "Automatically terminate the cluster after being inactive for this time in minutes. If specified, the threshold must be between 10 and 10000 minutes. You can also set this value to 0 to explicitly disable automatic termination.\n" }, "awsAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoAwsAttributes:getClusterClusterInfoAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoAzureAttributes:getClusterClusterInfoAzureAttributes" }, "clusterCores": { "type": "number" }, "clusterId": { "type": "string", "description": "The id of the cluster.\n" }, "clusterLogConf": { "$ref": "#/types/databricks:index/getClusterClusterInfoClusterLogConf:getClusterClusterInfoClusterLogConf" }, "clusterLogStatus": { "$ref": "#/types/databricks:index/getClusterClusterInfoClusterLogStatus:getClusterClusterInfoClusterLogStatus" }, "clusterMemoryMb": { "type": "integer" }, "clusterName": { "type": "string", "description": "The exact name of the cluster to search. Can only be specified if there is exactly one cluster with the provided name.\n" }, "clusterSource": { "type": "string" }, "creatorUserName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional tags for cluster resources.\n" }, "dataSecurityMode": { "type": "string", "description": "Security features of the cluster. Unity Catalog requires `SINGLE_USER` or `USER_ISOLATION` mode. `LEGACY_PASSTHROUGH` for passthrough cluster and `LEGACY_TABLE_ACL` for Table ACL cluster. Default to `NONE`, i.e. no security feature enabled.\n" }, "defaultTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dockerImage": { "$ref": "#/types/databricks:index/getClusterClusterInfoDockerImage:getClusterClusterInfoDockerImage" }, "driver": { "$ref": "#/types/databricks:index/getClusterClusterInfoDriver:getClusterClusterInfoDriver" }, "driverInstancePoolId": { "type": "string", "description": "similar to \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e, but for driver node.\n" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/getClusterClusterInfoDriverNodeTypeFlexibility:getClusterClusterInfoDriverNodeTypeFlexibility" }, "driverNodeTypeId": { "type": "string", "description": "The node type of the Spark driver.\n" }, "enableElasticDisk": { "type": "boolean", "description": "Use autoscaling local storage.\n" }, "enableLocalDiskEncryption": { "type": "boolean", "description": "Enable local disk encryption.\n" }, "executors": { "type": "array", "items": { "$ref": "#/types/databricks:index/getClusterClusterInfoExecutor:getClusterClusterInfoExecutor" } }, "gcpAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoGcpAttributes:getClusterClusterInfoGcpAttributes" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScript:getClusterClusterInfoInitScript" } }, "instancePoolId": { "type": "string", "description": "The pool of idle instances the cluster is attached to.\n" }, "isSingleNode": { "type": "boolean" }, "jdbcPort": { "type": "integer" }, "kind": { "type": "string" }, "lastRestartedTime": { "type": "integer" }, "lastStateLossTime": { "type": "integer" }, "nodeTypeId": { "type": "string", "description": "Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003eid.\n" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string", "description": "Identifier of Cluster Policy to validate cluster and preset certain defaults.\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string", "description": "The type of runtime of the cluster\n" }, "singleUserName": { "type": "string", "description": "The optional user name of the user to assign to an interactive cluster. This field is required when using standard AAD Passthrough for Azure Data Lake Storage (ADLS) with a single-user cluster (i.e., not high-concurrency clusters).\n" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with key-value pairs to fine-tune Spark clusters.\n" }, "sparkContextId": { "type": "integer" }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with environment variable key-value pairs to fine-tune Spark clusters. Key-value pairs of the form (X,Y) are exported (i.e., X='Y') while launching the driver and workers.\n" }, "sparkVersion": { "type": "string", "description": "[Runtime version](https://docs.databricks.com/runtime/index.html) of the cluster.\n" }, "spec": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpec:getClusterClusterInfoSpec" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public key contents that will be added to each Spark node in this cluster.\n" }, "startTime": { "type": "integer" }, "state": { "type": "string" }, "stateMessage": { "type": "string" }, "terminatedTime": { "type": "integer" }, "terminationReason": { "$ref": "#/types/databricks:index/getClusterClusterInfoTerminationReason:getClusterClusterInfoTerminationReason" }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/getClusterClusterInfoWorkerNodeTypeFlexibility:getClusterClusterInfoWorkerNodeTypeFlexibility" }, "workloadType": { "$ref": "#/types/databricks:index/getClusterClusterInfoWorkloadType:getClusterClusterInfoWorkloadType" } }, "type": "object" }, "databricks:index/getClusterClusterInfoAutoscale:getClusterClusterInfoAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/getClusterClusterInfoAwsAttributes:getClusterClusterInfoAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoAzureAttributes:getClusterClusterInfoAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/getClusterClusterInfoAzureAttributesLogAnalyticsInfo:getClusterClusterInfoAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getClusterClusterInfoAzureAttributesLogAnalyticsInfo:getClusterClusterInfoAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoClusterLogConf:getClusterClusterInfoClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/getClusterClusterInfoClusterLogConfDbfs:getClusterClusterInfoClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/getClusterClusterInfoClusterLogConfS3:getClusterClusterInfoClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/getClusterClusterInfoClusterLogConfVolumes:getClusterClusterInfoClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/getClusterClusterInfoClusterLogConfDbfs:getClusterClusterInfoClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoClusterLogConfS3:getClusterClusterInfoClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoClusterLogConfVolumes:getClusterClusterInfoClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoClusterLogStatus:getClusterClusterInfoClusterLogStatus": { "properties": { "lastAttempted": { "type": "integer" }, "lastException": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoDockerImage:getClusterClusterInfoDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getClusterClusterInfoDockerImageBasicAuth:getClusterClusterInfoDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoDockerImageBasicAuth:getClusterClusterInfoDockerImageBasicAuth": { "properties": { "password": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoDriver:getClusterClusterInfoDriver": { "properties": { "hostPrivateIp": { "type": "string" }, "instanceId": { "type": "string" }, "nodeAwsAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoDriverNodeAwsAttributes:getClusterClusterInfoDriverNodeAwsAttributes" }, "nodeId": { "type": "string" }, "privateIp": { "type": "string" }, "publicDns": { "type": "string" }, "startTimestamp": { "type": "integer" } }, "type": "object" }, "databricks:index/getClusterClusterInfoDriverNodeAwsAttributes:getClusterClusterInfoDriverNodeAwsAttributes": { "properties": { "isSpot": { "type": "boolean" } }, "type": "object" }, "databricks:index/getClusterClusterInfoDriverNodeTypeFlexibility:getClusterClusterInfoDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getClusterClusterInfoExecutor:getClusterClusterInfoExecutor": { "properties": { "hostPrivateIp": { "type": "string" }, "instanceId": { "type": "string" }, "nodeAwsAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoExecutorNodeAwsAttributes:getClusterClusterInfoExecutorNodeAwsAttributes" }, "nodeId": { "type": "string" }, "privateIp": { "type": "string" }, "publicDns": { "type": "string" }, "startTimestamp": { "type": "integer" } }, "type": "object" }, "databricks:index/getClusterClusterInfoExecutorNodeAwsAttributes:getClusterClusterInfoExecutorNodeAwsAttributes": { "properties": { "isSpot": { "type": "boolean" } }, "type": "object" }, "databricks:index/getClusterClusterInfoGcpAttributes:getClusterClusterInfoGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoInitScript:getClusterClusterInfoInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptAbfss:getClusterClusterInfoInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptDbfs:getClusterClusterInfoInitScriptDbfs" }, "file": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptFile:getClusterClusterInfoInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptGcs:getClusterClusterInfoInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptS3:getClusterClusterInfoInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptVolumes:getClusterClusterInfoInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/getClusterClusterInfoInitScriptWorkspace:getClusterClusterInfoInitScriptWorkspace" } }, "type": "object" }, "databricks:index/getClusterClusterInfoInitScriptAbfss:getClusterClusterInfoInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoInitScriptDbfs:getClusterClusterInfoInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoInitScriptFile:getClusterClusterInfoInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoInitScriptGcs:getClusterClusterInfoInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoInitScriptS3:getClusterClusterInfoInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoInitScriptVolumes:getClusterClusterInfoInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoInitScriptWorkspace:getClusterClusterInfoInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpec:getClusterClusterInfoSpec": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecAutoscale:getClusterClusterInfoSpecAutoscale" }, "awsAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecAwsAttributes:getClusterClusterInfoSpecAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecAzureAttributes:getClusterClusterInfoSpecAzureAttributes" }, "clusterId": { "type": "string", "description": "The id of the cluster.\n" }, "clusterLogConf": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecClusterLogConf:getClusterClusterInfoSpecClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecClusterMountInfo:getClusterClusterInfoSpecClusterMountInfo" } }, "clusterName": { "type": "string", "description": "The exact name of the cluster to search. Can only be specified if there is exactly one cluster with the provided name.\n" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional tags for cluster resources.\n" }, "dataSecurityMode": { "type": "string", "description": "Security features of the cluster. Unity Catalog requires `SINGLE_USER` or `USER_ISOLATION` mode. `LEGACY_PASSTHROUGH` for passthrough cluster and `LEGACY_TABLE_ACL` for Table ACL cluster. Default to `NONE`, i.e. no security feature enabled.\n" }, "dockerImage": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecDockerImage:getClusterClusterInfoSpecDockerImage" }, "driverInstancePoolId": { "type": "string", "description": "similar to \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e, but for driver node.\n" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecDriverNodeTypeFlexibility:getClusterClusterInfoSpecDriverNodeTypeFlexibility" }, "driverNodeTypeId": { "type": "string", "description": "The node type of the Spark driver.\n" }, "enableElasticDisk": { "type": "boolean", "description": "Use autoscaling local storage.\n" }, "enableLocalDiskEncryption": { "type": "boolean", "description": "Enable local disk encryption.\n" }, "gcpAttributes": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecGcpAttributes:getClusterClusterInfoSpecGcpAttributes" }, "idempotencyToken": { "type": "string", "description": "An optional token to guarantee the idempotency of cluster creation requests.\n" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScript:getClusterClusterInfoSpecInitScript" } }, "instancePoolId": { "type": "string", "description": "The pool of idle instances the cluster is attached to.\n" }, "isSingleNode": { "type": "boolean" }, "kind": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecLibrary:getClusterClusterInfoSpecLibrary" } }, "nodeTypeId": { "type": "string", "description": "Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003eid.\n" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string", "description": "Identifier of Cluster Policy to validate cluster and preset certain defaults.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecProviderConfig:getClusterClusterInfoSpecProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string", "description": "The type of runtime of the cluster\n" }, "singleUserName": { "type": "string", "description": "The optional user name of the user to assign to an interactive cluster. This field is required when using standard AAD Passthrough for Azure Data Lake Storage (ADLS) with a single-user cluster (i.e., not high-concurrency clusters).\n" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with key-value pairs to fine-tune Spark clusters.\n" }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with environment variable key-value pairs to fine-tune Spark clusters. Key-value pairs of the form (X,Y) are exported (i.e., X='Y') while launching the driver and workers.\n" }, "sparkVersion": { "type": "string", "description": "[Runtime version](https://docs.databricks.com/runtime/index.html) of the cluster.\n" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public key contents that will be added to each Spark node in this cluster.\n" }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecWorkerNodeTypeFlexibility:getClusterClusterInfoSpecWorkerNodeTypeFlexibility" }, "workloadType": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecWorkloadType:getClusterClusterInfoSpecWorkloadType" } }, "type": "object", "required": [ "clusterId", "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "providerConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClusterClusterInfoSpecAutoscale:getClusterClusterInfoSpecAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecAwsAttributes:getClusterClusterInfoSpecAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeIops": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeThroughput": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecAzureAttributes:getClusterClusterInfoSpecAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "logAnalyticsInfo": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecAzureAttributesLogAnalyticsInfo:getClusterClusterInfoSpecAzureAttributesLogAnalyticsInfo" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecAzureAttributesLogAnalyticsInfo:getClusterClusterInfoSpecAzureAttributesLogAnalyticsInfo": { "properties": { "logAnalyticsPrimaryKey": { "type": "string" }, "logAnalyticsWorkspaceId": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecClusterLogConf:getClusterClusterInfoSpecClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecClusterLogConfDbfs:getClusterClusterInfoSpecClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecClusterLogConfS3:getClusterClusterInfoSpecClusterLogConfS3" }, "volumes": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecClusterLogConfVolumes:getClusterClusterInfoSpecClusterLogConfVolumes" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecClusterLogConfDbfs:getClusterClusterInfoSpecClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecClusterLogConfS3:getClusterClusterInfoSpecClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecClusterLogConfVolumes:getClusterClusterInfoSpecClusterLogConfVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecClusterMountInfo:getClusterClusterInfoSpecClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecClusterMountInfoNetworkFilesystemInfo:getClusterClusterInfoSpecClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/getClusterClusterInfoSpecClusterMountInfoNetworkFilesystemInfo:getClusterClusterInfoSpecClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/getClusterClusterInfoSpecDockerImage:getClusterClusterInfoSpecDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecDockerImageBasicAuth:getClusterClusterInfoSpecDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getClusterClusterInfoSpecDockerImageBasicAuth:getClusterClusterInfoSpecDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/getClusterClusterInfoSpecDriverNodeTypeFlexibility:getClusterClusterInfoSpecDriverNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecGcpAttributes:getClusterClusterInfoSpecGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "confidentialComputeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecInitScript:getClusterClusterInfoSpecInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptAbfss:getClusterClusterInfoSpecInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptDbfs:getClusterClusterInfoSpecInitScriptDbfs", "deprecationMessage": "For init scripts use 'volumes', 'workspace' or cloud storage location instead of 'dbfs'." }, "file": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptFile:getClusterClusterInfoSpecInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptGcs:getClusterClusterInfoSpecInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptS3:getClusterClusterInfoSpecInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptVolumes:getClusterClusterInfoSpecInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecInitScriptWorkspace:getClusterClusterInfoSpecInitScriptWorkspace" } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecInitScriptAbfss:getClusterClusterInfoSpecInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecInitScriptDbfs:getClusterClusterInfoSpecInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecInitScriptFile:getClusterClusterInfoSpecInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecInitScriptGcs:getClusterClusterInfoSpecInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecInitScriptS3:getClusterClusterInfoSpecInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecInitScriptVolumes:getClusterClusterInfoSpecInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecInitScriptWorkspace:getClusterClusterInfoSpecInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getClusterClusterInfoSpecLibrary:getClusterClusterInfoSpecLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecLibraryCran:getClusterClusterInfoSpecLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecLibraryMaven:getClusterClusterInfoSpecLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecLibraryProviderConfig:getClusterClusterInfoSpecLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecLibraryPypi:getClusterClusterInfoSpecLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "required": [ "providerConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClusterClusterInfoSpecLibraryCran:getClusterClusterInfoSpecLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getClusterClusterInfoSpecLibraryMaven:getClusterClusterInfoSpecLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/getClusterClusterInfoSpecLibraryProviderConfig:getClusterClusterInfoSpecLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClusterClusterInfoSpecLibraryPypi:getClusterClusterInfoSpecLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getClusterClusterInfoSpecProviderConfig:getClusterClusterInfoSpecProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClusterClusterInfoSpecWorkerNodeTypeFlexibility:getClusterClusterInfoSpecWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getClusterClusterInfoSpecWorkloadType:getClusterClusterInfoSpecWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/getClusterClusterInfoSpecWorkloadTypeClients:getClusterClusterInfoSpecWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/getClusterClusterInfoSpecWorkloadTypeClients:getClusterClusterInfoSpecWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/getClusterClusterInfoTerminationReason:getClusterClusterInfoTerminationReason": { "properties": { "code": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string" } }, "type": "object" }, "databricks:index/getClusterClusterInfoWorkerNodeTypeFlexibility:getClusterClusterInfoWorkerNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getClusterClusterInfoWorkloadType:getClusterClusterInfoWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/getClusterClusterInfoWorkloadTypeClients:getClusterClusterInfoWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/getClusterClusterInfoWorkloadTypeClients:getClusterClusterInfoWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/getClusterPolicyProviderConfig:getClusterPolicyProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClusterProviderConfig:getClusterProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getClustersFilterBy:getClustersFilterBy": { "properties": { "clusterSources": { "type": "array", "items": { "type": "string" }, "description": "List of cluster sources to filter by. Possible values are `API`, `JOB`, `MODELS`, `PIPELINE`, `PIPELINE_MAINTENANCE`, `SQL`, and `UI`.\n" }, "clusterStates": { "type": "array", "items": { "type": "string" }, "description": "List of cluster states to filter by. Possible values are `RUNNING`, `PENDING`, `RESIZING`, `RESTARTING`, `TERMINATING`, `TERMINATED`, `ERROR`, and `UNKNOWN`.\n" }, "isPinned": { "type": "boolean", "description": "Whether to filter by pinned clusters.\n" }, "policyId": { "type": "string", "description": "Filter by\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003eid.\n" } }, "type": "object" }, "databricks:index/getClustersProviderConfig:getClustersProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getCurrentConfigProviderConfig:getCurrentConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getCurrentMetastoreMetastoreInfo:getCurrentMetastoreMetastoreInfo": { "properties": { "cloud": { "type": "string" }, "createdAt": { "type": "integer", "description": "Timestamp (in milliseconds) when the current metastore was created.\n" }, "createdBy": { "type": "string", "description": "the ID of the identity that created the current metastore.\n" }, "defaultDataAccessConfigId": { "type": "string", "description": "the ID of the default data access configuration.\n" }, "deltaSharingOrganizationName": { "type": "string", "description": "The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing.\n" }, "deltaSharingRecipientTokenLifetimeInSeconds": { "type": "integer", "description": "the expiration duration in seconds on recipient data access tokens.\n" }, "deltaSharingScope": { "type": "string", "description": "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.\n" }, "externalAccessEnabled": { "type": "boolean" }, "globalMetastoreId": { "type": "string", "description": "Identifier in form of `\u003ccloud\u003e:\u003cregion\u003e:\u003cmetastore_id\u003e` for use in Databricks to Databricks Delta Sharing.\n" }, "metastoreId": { "type": "string", "description": "Metastore ID.\n" }, "name": { "type": "string", "description": "Name of metastore.\n" }, "owner": { "type": "string", "description": "Username/group name/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the metastore owner.\n" }, "privilegeModelVersion": { "type": "string", "description": "the version of the privilege model used by the metastore.\n" }, "region": { "type": "string", "description": "(Mandatory for account-level) The region of the metastore.\n" }, "storageRoot": { "type": "string", "description": "Path on cloud storage account, where managed \u003cspan pulumi-lang-nodejs=\"`databricks.Table`\" pulumi-lang-dotnet=\"`databricks.Table`\" pulumi-lang-go=\"`Table`\" pulumi-lang-python=\"`Table`\" pulumi-lang-yaml=\"`databricks.Table`\" pulumi-lang-java=\"`databricks.Table`\" pulumi-lang-hcl=\"`databricks_table`\"\u003e`databricks.Table`\u003c/span\u003e are stored.\n" }, "storageRootCredentialId": { "type": "string", "description": "ID of a storage credential used for the \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e.\n" }, "storageRootCredentialName": { "type": "string", "description": "Name of a storage credential used for the \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e.\n" }, "updatedAt": { "type": "integer", "description": "Timestamp (in milliseconds) when the current metastore was updated.\n" }, "updatedBy": { "type": "string", "description": "the ID of the identity that updated the current metastore.\n" } }, "type": "object" }, "databricks:index/getCurrentMetastoreProviderConfig:getCurrentMetastoreProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getCurrentUserProviderConfig:getCurrentUserProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDashboardsDashboard:getDashboardsDashboard": { "properties": { "createTime": { "type": "string", "description": "The timestamp of when the dashboard was created.\n" }, "dashboardId": { "type": "string", "description": "The unique ID of the dashboard.\n" }, "displayName": { "type": "string", "description": "The display name of the dashboard.\n" }, "etag": { "type": "string" }, "lifecycleState": { "type": "string" }, "parentPath": { "type": "string" }, "path": { "type": "string" }, "serializedDashboard": { "type": "string" }, "updateTime": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "createTime", "dashboardId", "etag", "lifecycleState", "parentPath", "path", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDashboardsProviderConfig:getDashboardsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataClassificationCatalogConfigAutoTagConfig:getDataClassificationCatalogConfigAutoTagConfig": { "properties": { "autoTaggingMode": { "type": "string", "description": "(string) - Whether auto-tagging is enabled or disabled for this classification tag. Possible values are: `AUTO_TAGGING_DISABLED`, `AUTO_TAGGING_ENABLED`\n" }, "classificationTag": { "type": "string", "description": "(string) - The Classification Tag. For built-in classes this is a system tag (e.g., \"class.name\",\n\"class.location\"); for custom classes it is a user-defined governance tag key\n" } }, "type": "object", "required": [ "autoTaggingMode", "classificationTag" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataClassificationCatalogConfigIncludedSchemas:getDataClassificationCatalogConfigIncludedSchemas": { "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object", "required": [ "names" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataClassificationCatalogConfigProviderConfig:getDataClassificationCatalogConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorAnomalyDetectionConfig:getDataQualityMonitorAnomalyDetectionConfig": { "properties": { "excludedTableFullNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of fully qualified table names to exclude from anomaly detection\n" } }, "type": "object" }, "databricks:index/getDataQualityMonitorDataProfilingConfig:getDataQualityMonitorDataProfilingConfig": { "properties": { "assetsDir": { "type": "string", "description": "(string) - Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs\n" }, "baselineTableName": { "type": "string", "description": "(string) - Baseline table name.\nBaseline data is used to compute drift from the data in the monitored \u003cspan pulumi-lang-nodejs=\"`tableName`\" pulumi-lang-dotnet=\"`TableName`\" pulumi-lang-go=\"`tableName`\" pulumi-lang-python=\"`table_name`\" pulumi-lang-yaml=\"`tableName`\" pulumi-lang-java=\"`tableName`\" pulumi-lang-hcl=\"`table_name`\"\u003e`tableName`\u003c/span\u003e.\nThe baseline table and the monitored table shall have the same schema\n" }, "customMetrics": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigCustomMetric:getDataQualityMonitorDataProfilingConfigCustomMetric" }, "description": "(list of DataProfilingCustomMetric) - Custom metrics\n" }, "dashboardId": { "type": "string", "description": "(string) - Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state\n" }, "driftMetricsTableName": { "type": "string", "description": "(string) - Table that stores drift metrics data. Format: `catalog.schema.table_name`\n" }, "effectiveWarehouseId": { "type": "string", "description": "(string) - The warehouse for dashboard creation\n" }, "inferenceLog": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigInferenceLog:getDataQualityMonitorDataProfilingConfigInferenceLog", "description": "(InferenceLogConfig) - `Analysis Configuration` for monitoring inference log tables\n" }, "latestMonitorFailureMessage": { "type": "string", "description": "(string) - The latest error message for a monitor failure\n" }, "monitorVersion": { "type": "integer", "description": "(integer) - Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\u003cspan pulumi-lang-nodejs=\"\nmonitorVersion \" pulumi-lang-dotnet=\"\nMonitorVersion \" pulumi-lang-go=\"\nmonitorVersion \" pulumi-lang-python=\"\nmonitor_version \" pulumi-lang-yaml=\"\nmonitorVersion \" pulumi-lang-java=\"\nmonitorVersion \" pulumi-lang-hcl=\"\nmonitor_version \"\u003e\nmonitorVersion \u003c/span\u003enumbers\n" }, "monitoredTableName": { "type": "string", "description": "(string) - Unity Catalog table to monitor. Format: `catalog.schema.table_name`\n" }, "notificationSettings": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigNotificationSettings:getDataQualityMonitorDataProfilingConfigNotificationSettings", "description": "(NotificationSettings) - Field for specifying notification settings\n" }, "outputSchemaId": { "type": "string", "description": "(string) - ID of the schema where output tables are created\n" }, "profileMetricsTableName": { "type": "string", "description": "(string) - Table that stores profile metrics data. Format: `catalog.schema.table_name`\n" }, "schedule": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigSchedule:getDataQualityMonitorDataProfilingConfigSchedule", "description": "(CronSchedule) - The cron schedule\n" }, "skipBuiltinDashboard": { "type": "boolean", "description": "(boolean) - Whether to skip creating a default dashboard summarizing data quality metrics\n" }, "slicingExprs": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for \u003cspan pulumi-lang-nodejs=\"`col2 \" pulumi-lang-dotnet=\"`Col2 \" pulumi-lang-go=\"`col2 \" pulumi-lang-python=\"`col_2 \" pulumi-lang-yaml=\"`col2 \" pulumi-lang-java=\"`col2 \" pulumi-lang-hcl=\"`col_2 \"\u003e`col2 \u003c/span\u003e\u003e 10` (True and False), and one slice per unique value in\n\u003cspan pulumi-lang-nodejs=\"`col1`\" pulumi-lang-dotnet=\"`Col1`\" pulumi-lang-go=\"`col1`\" pulumi-lang-python=\"`col1`\" pulumi-lang-yaml=\"`col1`\" pulumi-lang-java=\"`col1`\" pulumi-lang-hcl=\"`col1`\"\u003e`col1`\u003c/span\u003e. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices\n" }, "snapshot": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigSnapshot:getDataQualityMonitorDataProfilingConfigSnapshot", "description": "(SnapshotConfig) - `Analysis Configuration` for monitoring snapshot tables\n" }, "status": { "type": "string", "description": "(string) - The data profiling monitor status. Possible values are: `DATA_PROFILING_STATUS_ACTIVE`, `DATA_PROFILING_STATUS_DELETE_PENDING`, `DATA_PROFILING_STATUS_ERROR`, `DATA_PROFILING_STATUS_FAILED`, `DATA_PROFILING_STATUS_PENDING`\n" }, "timeSeries": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigTimeSeries:getDataQualityMonitorDataProfilingConfigTimeSeries", "description": "(TimeSeriesConfig) - `Analysis Configuration` for monitoring time series tables\n" }, "warehouseId": { "type": "string", "description": "(string) - Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used\n" } }, "type": "object", "required": [ "dashboardId", "driftMetricsTableName", "effectiveWarehouseId", "latestMonitorFailureMessage", "monitorVersion", "monitoredTableName", "outputSchemaId", "profileMetricsTableName", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorDataProfilingConfigCustomMetric:getDataQualityMonitorDataProfilingConfigCustomMetric": { "properties": { "definition": { "type": "string", "description": "(string) - Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)\n" }, "inputColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns\n" }, "name": { "type": "string", "description": "(string) - Name of the metric in the output tables\n" }, "outputDataType": { "type": "string", "description": "(string) - The output type of the custom metric\n" }, "type": { "type": "string", "description": "(string) - The type of the custom metric. Possible values are: `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE`, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED`, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT`\n" } }, "type": "object", "required": [ "definition", "inputColumns", "name", "outputDataType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorDataProfilingConfigInferenceLog:getDataQualityMonitorDataProfilingConfigInferenceLog": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of granularities to use when aggregating data into time windows based on their timestamp\n" }, "labelColumn": { "type": "string", "description": "(string) - Column for the label\n" }, "modelIdColumn": { "type": "string", "description": "(string) - Column for the model identifier\n" }, "predictionColumn": { "type": "string", "description": "(string) - Column for the prediction\n" }, "problemType": { "type": "string", "description": "(string) - Problem type the model aims to solve. Possible values are: `INFERENCE_PROBLEM_TYPE_CLASSIFICATION`, `INFERENCE_PROBLEM_TYPE_REGRESSION`\n" }, "timestampColumn": { "type": "string", "description": "(string) - Column for the timestamp\n" } }, "type": "object", "required": [ "granularities", "modelIdColumn", "predictionColumn", "problemType", "timestampColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorDataProfilingConfigNotificationSettings:getDataQualityMonitorDataProfilingConfigNotificationSettings": { "properties": { "onFailure": { "$ref": "#/types/databricks:index/getDataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure:getDataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure", "description": "(NotificationDestination) - Destinations to send notifications on failure/timeout\n" } }, "type": "object" }, "databricks:index/getDataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure:getDataQualityMonitorDataProfilingConfigNotificationSettingsOnFailure": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The list of email addresses to send the notification to. A maximum of 5 email addresses is supported\n" } }, "type": "object" }, "databricks:index/getDataQualityMonitorDataProfilingConfigSchedule:getDataQualityMonitorDataProfilingConfigSchedule": { "properties": { "pauseStatus": { "type": "string", "description": "(string) - Read only field that indicates whether the schedule is paused or not. Possible values are: `CRON_SCHEDULE_PAUSE_STATUS_PAUSED`, `CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED`\n" }, "quartzCronExpression": { "type": "string", "description": "(string) - The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)\n" }, "timezoneId": { "type": "string", "description": "(string) - A Java timezone id. The schedule for a job will be resolved with respect to this timezone.\nSee `Java TimeZone \u003chttp://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html\u003e`_ for details.\nThe timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression\n" } }, "type": "object", "required": [ "pauseStatus", "quartzCronExpression", "timezoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorDataProfilingConfigSnapshot:getDataQualityMonitorDataProfilingConfigSnapshot": { "type": "object" }, "databricks:index/getDataQualityMonitorDataProfilingConfigTimeSeries:getDataQualityMonitorDataProfilingConfigTimeSeries": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of granularities to use when aggregating data into time windows based on their timestamp\n" }, "timestampColumn": { "type": "string", "description": "(string) - Column for the timestamp\n" } }, "type": "object", "required": [ "granularities", "timestampColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorProviderConfig:getDataQualityMonitorProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitor:getDataQualityMonitorsMonitor": { "properties": { "anomalyDetectionConfig": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorAnomalyDetectionConfig:getDataQualityMonitorsMonitorAnomalyDetectionConfig", "description": "(AnomalyDetectionConfig) - Anomaly Detection Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e object types\n" }, "dataProfilingConfig": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfig:getDataQualityMonitorsMonitorDataProfilingConfig", "description": "(DataProfilingConfig) - Data Profiling Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e object types. Exactly one `Analysis Configuration`\nmust be present\n" }, "objectId": { "type": "string", "description": "(string) - The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n" }, "objectType": { "type": "string", "description": "(string) - The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorProviderConfig:getDataQualityMonitorsMonitorProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "type": "object", "required": [ "anomalyDetectionConfig", "dataProfilingConfig", "objectId", "objectType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitorAnomalyDetectionConfig:getDataQualityMonitorsMonitorAnomalyDetectionConfig": { "properties": { "excludedTableFullNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of fully qualified table names to exclude from anomaly detection\n" } }, "type": "object" }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfig:getDataQualityMonitorsMonitorDataProfilingConfig": { "properties": { "assetsDir": { "type": "string", "description": "(string) - Field for specifying the absolute path to a custom directory to store data-monitoring\nassets. Normally prepopulated to a default user location via UI and Python APIs\n" }, "baselineTableName": { "type": "string", "description": "(string) - Baseline table name.\nBaseline data is used to compute drift from the data in the monitored \u003cspan pulumi-lang-nodejs=\"`tableName`\" pulumi-lang-dotnet=\"`TableName`\" pulumi-lang-go=\"`tableName`\" pulumi-lang-python=\"`table_name`\" pulumi-lang-yaml=\"`tableName`\" pulumi-lang-java=\"`tableName`\" pulumi-lang-hcl=\"`table_name`\"\u003e`tableName`\u003c/span\u003e.\nThe baseline table and the monitored table shall have the same schema\n" }, "customMetrics": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigCustomMetric:getDataQualityMonitorsMonitorDataProfilingConfigCustomMetric" }, "description": "(list of DataProfilingCustomMetric) - Custom metrics\n" }, "dashboardId": { "type": "string", "description": "(string) - Id of dashboard that visualizes the computed metrics.\nThis can be empty if the monitor is in PENDING state\n" }, "driftMetricsTableName": { "type": "string", "description": "(string) - Table that stores drift metrics data. Format: `catalog.schema.table_name`\n" }, "effectiveWarehouseId": { "type": "string", "description": "(string) - The warehouse for dashboard creation\n" }, "inferenceLog": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigInferenceLog:getDataQualityMonitorsMonitorDataProfilingConfigInferenceLog", "description": "(InferenceLogConfig) - `Analysis Configuration` for monitoring inference log tables\n" }, "latestMonitorFailureMessage": { "type": "string", "description": "(string) - The latest error message for a monitor failure\n" }, "monitorVersion": { "type": "integer", "description": "(integer) - Represents the current monitor configuration version in use. The version will be represented in a\nnumeric fashion (1,2,3...). The field has flexibility to take on negative values, which can indicate corrupted\u003cspan pulumi-lang-nodejs=\"\nmonitorVersion \" pulumi-lang-dotnet=\"\nMonitorVersion \" pulumi-lang-go=\"\nmonitorVersion \" pulumi-lang-python=\"\nmonitor_version \" pulumi-lang-yaml=\"\nmonitorVersion \" pulumi-lang-java=\"\nmonitorVersion \" pulumi-lang-hcl=\"\nmonitor_version \"\u003e\nmonitorVersion \u003c/span\u003enumbers\n" }, "monitoredTableName": { "type": "string", "description": "(string) - Unity Catalog table to monitor. Format: `catalog.schema.table_name`\n" }, "notificationSettings": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettings:getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettings", "description": "(NotificationSettings) - Field for specifying notification settings\n" }, "outputSchemaId": { "type": "string", "description": "(string) - ID of the schema where output tables are created\n" }, "profileMetricsTableName": { "type": "string", "description": "(string) - Table that stores profile metrics data. Format: `catalog.schema.table_name`\n" }, "schedule": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigSchedule:getDataQualityMonitorsMonitorDataProfilingConfigSchedule", "description": "(CronSchedule) - The cron schedule\n" }, "skipBuiltinDashboard": { "type": "boolean", "description": "(boolean) - Whether to skip creating a default dashboard summarizing data quality metrics\n" }, "slicingExprs": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column expressions to slice data with for targeted analysis. The data is grouped by\neach expression independently, resulting in a separate slice for each predicate and its\ncomplements. For example `slicing_exprs=[“col_1”, “col_2 \u003e 10”]` will generate the following\nslices: two slices for \u003cspan pulumi-lang-nodejs=\"`col2 \" pulumi-lang-dotnet=\"`Col2 \" pulumi-lang-go=\"`col2 \" pulumi-lang-python=\"`col_2 \" pulumi-lang-yaml=\"`col2 \" pulumi-lang-java=\"`col2 \" pulumi-lang-hcl=\"`col_2 \"\u003e`col2 \u003c/span\u003e\u003e 10` (True and False), and one slice per unique value in\n\u003cspan pulumi-lang-nodejs=\"`col1`\" pulumi-lang-dotnet=\"`Col1`\" pulumi-lang-go=\"`col1`\" pulumi-lang-python=\"`col1`\" pulumi-lang-yaml=\"`col1`\" pulumi-lang-java=\"`col1`\" pulumi-lang-hcl=\"`col1`\"\u003e`col1`\u003c/span\u003e. For high-cardinality columns, only the top 100 unique values by frequency will\ngenerate slices\n" }, "snapshot": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigSnapshot:getDataQualityMonitorsMonitorDataProfilingConfigSnapshot", "description": "(SnapshotConfig) - `Analysis Configuration` for monitoring snapshot tables\n" }, "status": { "type": "string", "description": "(string) - The data profiling monitor status. Possible values are: `DATA_PROFILING_STATUS_ACTIVE`, `DATA_PROFILING_STATUS_DELETE_PENDING`, `DATA_PROFILING_STATUS_ERROR`, `DATA_PROFILING_STATUS_FAILED`, `DATA_PROFILING_STATUS_PENDING`\n" }, "timeSeries": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigTimeSeries:getDataQualityMonitorsMonitorDataProfilingConfigTimeSeries", "description": "(TimeSeriesConfig) - `Analysis Configuration` for monitoring time series tables\n" }, "warehouseId": { "type": "string", "description": "(string) - Optional argument to specify the warehouse for dashboard creation. If not specified, the first running\nwarehouse will be used\n" } }, "type": "object", "required": [ "dashboardId", "driftMetricsTableName", "effectiveWarehouseId", "latestMonitorFailureMessage", "monitorVersion", "monitoredTableName", "outputSchemaId", "profileMetricsTableName", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigCustomMetric:getDataQualityMonitorsMonitorDataProfilingConfigCustomMetric": { "properties": { "definition": { "type": "string", "description": "(string) - Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)\n" }, "inputColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - A list of column names in the input table the metric should be computed for.\nCan use ``\":table\"`` to indicate that the metric needs information from multiple columns\n" }, "name": { "type": "string", "description": "(string) - Name of the metric in the output tables\n" }, "outputDataType": { "type": "string", "description": "(string) - The output type of the custom metric\n" }, "type": { "type": "string", "description": "(string) - The type of the custom metric. Possible values are: `DATA_PROFILING_CUSTOM_METRIC_TYPE_AGGREGATE`, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DERIVED`, `DATA_PROFILING_CUSTOM_METRIC_TYPE_DRIFT`\n" } }, "type": "object", "required": [ "definition", "inputColumns", "name", "outputDataType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigInferenceLog:getDataQualityMonitorsMonitorDataProfilingConfigInferenceLog": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of granularities to use when aggregating data into time windows based on their timestamp\n" }, "labelColumn": { "type": "string", "description": "(string) - Column for the label\n" }, "modelIdColumn": { "type": "string", "description": "(string) - Column for the model identifier\n" }, "predictionColumn": { "type": "string", "description": "(string) - Column for the prediction\n" }, "problemType": { "type": "string", "description": "(string) - Problem type the model aims to solve. Possible values are: `INFERENCE_PROBLEM_TYPE_CLASSIFICATION`, `INFERENCE_PROBLEM_TYPE_REGRESSION`\n" }, "timestampColumn": { "type": "string", "description": "(string) - Column for the timestamp\n" } }, "type": "object", "required": [ "granularities", "modelIdColumn", "predictionColumn", "problemType", "timestampColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettings:getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettings": { "properties": { "onFailure": { "$ref": "#/types/databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettingsOnFailure:getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettingsOnFailure", "description": "(NotificationDestination) - Destinations to send notifications on failure/timeout\n" } }, "type": "object" }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettingsOnFailure:getDataQualityMonitorsMonitorDataProfilingConfigNotificationSettingsOnFailure": { "properties": { "emailAddresses": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The list of email addresses to send the notification to. A maximum of 5 email addresses is supported\n" } }, "type": "object" }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigSchedule:getDataQualityMonitorsMonitorDataProfilingConfigSchedule": { "properties": { "pauseStatus": { "type": "string", "description": "(string) - Read only field that indicates whether the schedule is paused or not. Possible values are: `CRON_SCHEDULE_PAUSE_STATUS_PAUSED`, `CRON_SCHEDULE_PAUSE_STATUS_UNPAUSED`\n" }, "quartzCronExpression": { "type": "string", "description": "(string) - The expression that determines when to run the monitor. See [examples](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)\n" }, "timezoneId": { "type": "string", "description": "(string) - A Java timezone id. The schedule for a job will be resolved with respect to this timezone.\nSee `Java TimeZone \u003chttp://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html\u003e`_ for details.\nThe timezone id (e.g., ``America/Los_Angeles``) in which to evaluate the quartz expression\n" } }, "type": "object", "required": [ "pauseStatus", "quartzCronExpression", "timezoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigSnapshot:getDataQualityMonitorsMonitorDataProfilingConfigSnapshot": { "type": "object" }, "databricks:index/getDataQualityMonitorsMonitorDataProfilingConfigTimeSeries:getDataQualityMonitorsMonitorDataProfilingConfigTimeSeries": { "properties": { "granularities": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of granularities to use when aggregating data into time windows based on their timestamp\n" }, "timestampColumn": { "type": "string", "description": "(string) - Column for the timestamp\n" } }, "type": "object", "required": [ "granularities", "timestampColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsMonitorProviderConfig:getDataQualityMonitorsMonitorProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityMonitorsProviderConfig:getDataQualityMonitorsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityRefreshProviderConfig:getDataQualityRefreshProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityRefreshesProviderConfig:getDataQualityRefreshesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityRefreshesRefresh:getDataQualityRefreshesRefresh": { "properties": { "endTimeMs": { "type": "integer", "description": "(integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)\n" }, "message": { "type": "string", "description": "(string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)\n" }, "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getDataQualityRefreshesRefreshProviderConfig:getDataQualityRefreshesRefreshProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "refreshId": { "type": "integer", "description": "(integer) - Unique id of the refresh operation\n" }, "startTimeMs": { "type": "integer", "description": "(integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)\n" }, "state": { "type": "string", "description": "(string) - The current state of the refresh. Possible values are: `MONITOR_REFRESH_STATE_CANCELED`, `MONITOR_REFRESH_STATE_FAILED`, `MONITOR_REFRESH_STATE_PENDING`, `MONITOR_REFRESH_STATE_RUNNING`, `MONITOR_REFRESH_STATE_SUCCESS`, `MONITOR_REFRESH_STATE_UNKNOWN`\n" }, "trigger": { "type": "string", "description": "(string) - What triggered the refresh. Possible values are: `MONITOR_REFRESH_TRIGGER_DATA_CHANGE`, `MONITOR_REFRESH_TRIGGER_MANUAL`, `MONITOR_REFRESH_TRIGGER_SCHEDULE`, `MONITOR_REFRESH_TRIGGER_UNKNOWN`\n" } }, "type": "object", "required": [ "endTimeMs", "message", "objectId", "objectType", "refreshId", "startTimeMs", "state", "trigger" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDataQualityRefreshesRefreshProviderConfig:getDataQualityRefreshesRefreshProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseDatabaseCatalogProviderConfig:getDatabaseDatabaseCatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseDatabaseCatalogsDatabaseCatalog:getDatabaseDatabaseCatalogsDatabaseCatalog": { "properties": { "createDatabaseIfNotExists": { "type": "boolean", "description": "(boolean)\n" }, "databaseInstanceName": { "type": "string", "description": "(string) - The name of the DatabaseInstance housing the database\n" }, "databaseName": { "type": "string", "description": "(string) - The name of the database (in a instance) associated with the catalog\n" }, "name": { "type": "string", "description": "(string) - The name of the catalog in UC\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig:getDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "uid": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "createDatabaseIfNotExists", "databaseInstanceName", "databaseName", "name", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig:getDatabaseDatabaseCatalogsDatabaseCatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseDatabaseCatalogsProviderConfig:getDatabaseDatabaseCatalogsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstanceChildInstanceRef:getDatabaseInstanceChildInstanceRef": { "properties": { "branchTime": { "type": "string", "description": "(string) - Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "effectiveLsn": { "type": "string", "description": "(string) - For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "lsn": { "type": "string", "description": "(string) - User-specified WAL LSN of the ref database instance.\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" } }, "type": "object", "required": [ "effectiveLsn", "lsn", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstanceCustomTag:getDatabaseInstanceCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getDatabaseInstanceEffectiveCustomTag:getDatabaseInstanceEffectiveCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getDatabaseInstanceParentInstanceRef:getDatabaseInstanceParentInstanceRef": { "properties": { "branchTime": { "type": "string", "description": "(string) - Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "effectiveLsn": { "type": "string", "description": "(string) - For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "lsn": { "type": "string", "description": "(string) - User-specified WAL LSN of the ref database instance.\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" } }, "type": "object", "required": [ "effectiveLsn", "lsn", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstanceProviderConfig:getDatabaseInstanceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstancesDatabaseInstance:getDatabaseInstancesDatabaseInstance": { "properties": { "capacity": { "type": "string", "description": "(string) - The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\"\n" }, "childInstanceRefs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDatabaseInstancesDatabaseInstanceChildInstanceRef:getDatabaseInstancesDatabaseInstanceChildInstanceRef" }, "description": "(list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is\nparent instance\n" }, "creationTime": { "type": "string", "description": "(string) - The timestamp when the instance was created\n" }, "creator": { "type": "string", "description": "(string) - The email of the creator of the instance\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDatabaseInstancesDatabaseInstanceCustomTag:getDatabaseInstancesDatabaseInstanceCustomTag" }, "description": "(list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses\n" }, "effectiveCapacity": { "type": "string", "description": "(string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveCustomTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDatabaseInstancesDatabaseInstanceEffectiveCustomTag:getDatabaseInstancesDatabaseInstanceEffectiveCustomTag" }, "description": "(list of CustomTag) - The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveEnablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether the instance has PG native password login enabled.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveEnableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveNodeCount": { "type": "integer", "description": "(integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveRetentionWindowInDays": { "type": "integer", "description": "(integer) - The retention window for the instance. This is the time window in days\nfor which the historical data is retained.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveStopped": { "type": "boolean", "description": "(boolean) - Whether the instance is stopped.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "(string) - The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on the instance. Defaults to false\n" }, "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false\n" }, "name": { "type": "string", "description": "(string) - Name of the ref database instance\n" }, "nodeCount": { "type": "integer", "description": "(integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see\u003cspan pulumi-lang-nodejs=\" effectiveNodeCount \" pulumi-lang-dotnet=\" EffectiveNodeCount \" pulumi-lang-go=\" effectiveNodeCount \" pulumi-lang-python=\" effective_node_count \" pulumi-lang-yaml=\" effectiveNodeCount \" pulumi-lang-java=\" effectiveNodeCount \" pulumi-lang-hcl=\" effective_node_count \"\u003e effectiveNodeCount \u003c/span\u003efor the output\n" }, "parentInstanceRef": { "$ref": "#/types/databricks:index/getDatabaseInstancesDatabaseInstanceParentInstanceRef:getDatabaseInstancesDatabaseInstanceParentInstanceRef", "description": "(DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "pgVersion": { "type": "string", "description": "(string) - The version of Postgres running on the instance\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getDatabaseInstancesDatabaseInstanceProviderConfig:getDatabaseInstancesDatabaseInstanceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "readOnlyDns": { "type": "string", "description": "(string) - The DNS endpoint to connect to the instance for read only access. This is only available if\u003cspan pulumi-lang-nodejs=\"\nenableReadableSecondaries \" pulumi-lang-dotnet=\"\nEnableReadableSecondaries \" pulumi-lang-go=\"\nenableReadableSecondaries \" pulumi-lang-python=\"\nenable_readable_secondaries \" pulumi-lang-yaml=\"\nenableReadableSecondaries \" pulumi-lang-java=\"\nenableReadableSecondaries \" pulumi-lang-hcl=\"\nenable_readable_secondaries \"\u003e\nenableReadableSecondaries \u003c/span\u003eis true\n" }, "readWriteDns": { "type": "string", "description": "(string) - The DNS endpoint to connect to the instance for read+write access\n" }, "retentionWindowInDays": { "type": "integer", "description": "(integer) - The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days\n" }, "state": { "type": "string", "description": "(string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`\n" }, "stopped": { "type": "boolean", "description": "(boolean) - Whether to stop the instance. An input only param, see\u003cspan pulumi-lang-nodejs=\" effectiveStopped \" pulumi-lang-dotnet=\" EffectiveStopped \" pulumi-lang-go=\" effectiveStopped \" pulumi-lang-python=\" effective_stopped \" pulumi-lang-yaml=\" effectiveStopped \" pulumi-lang-java=\" effectiveStopped \" pulumi-lang-hcl=\" effective_stopped \"\u003e effectiveStopped \u003c/span\u003efor the output\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" }, "usagePolicyId": { "type": "string", "description": "(string) - The desired usage policy to associate with the instance\n" } }, "type": "object", "required": [ "capacity", "childInstanceRefs", "creationTime", "creator", "customTags", "effectiveCapacity", "effectiveCustomTags", "effectiveEnablePgNativeLogin", "effectiveEnableReadableSecondaries", "effectiveNodeCount", "effectiveRetentionWindowInDays", "effectiveStopped", "effectiveUsagePolicyId", "enablePgNativeLogin", "enableReadableSecondaries", "name", "nodeCount", "parentInstanceRef", "pgVersion", "readOnlyDns", "readWriteDns", "retentionWindowInDays", "state", "stopped", "uid", "usagePolicyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstancesDatabaseInstanceChildInstanceRef:getDatabaseInstancesDatabaseInstanceChildInstanceRef": { "properties": { "branchTime": { "type": "string", "description": "(string) - Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "effectiveLsn": { "type": "string", "description": "(string) - For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "lsn": { "type": "string", "description": "(string) - User-specified WAL LSN of the ref database instance.\n" }, "name": { "type": "string", "description": "(string) - Name of the ref database instance\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" } }, "type": "object", "required": [ "effectiveLsn", "lsn", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstancesDatabaseInstanceCustomTag:getDatabaseInstancesDatabaseInstanceCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getDatabaseInstancesDatabaseInstanceEffectiveCustomTag:getDatabaseInstancesDatabaseInstanceEffectiveCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getDatabaseInstancesDatabaseInstanceParentInstanceRef:getDatabaseInstancesDatabaseInstanceParentInstanceRef": { "properties": { "branchTime": { "type": "string", "description": "(string) - Branch time of the ref database instance.\nFor a parent ref instance, this is the point in time on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the point in time on the instance from which the child\ninstance was created.\nInput: For specifying the point in time to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "effectiveLsn": { "type": "string", "description": "(string) - For a parent ref instance, this is the LSN on the parent instance from which the\ninstance was created.\nFor a child ref instance, this is the LSN on the instance from which the child instance\nwas created.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "lsn": { "type": "string", "description": "(string) - User-specified WAL LSN of the ref database instance.\n" }, "name": { "type": "string", "description": "(string) - Name of the ref database instance\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" } }, "type": "object", "required": [ "effectiveLsn", "lsn", "uid" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstancesDatabaseInstanceProviderConfig:getDatabaseInstancesDatabaseInstanceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseInstancesProviderConfig:getDatabaseInstancesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatus": { "properties": { "continuousUpdateStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus", "description": "(SyncedTableContinuousUpdateStatus)\n" }, "detailedState": { "type": "string", "description": "(string) - The state of the synced table. Possible values are: `SYNCED_TABLED_OFFLINE`, `SYNCED_TABLE_OFFLINE_FAILED`, `SYNCED_TABLE_ONLINE`, `SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE`, `SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE`, `SYNCED_TABLE_ONLINE_PIPELINE_FAILED`, `SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE`, `SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES`, `SYNCED_TABLE_PROVISIONING`, `SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT`, `SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES`\n" }, "failedStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus", "description": "(SyncedTableFailedStatus)\n" }, "lastSync": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync:getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync", "description": "(SyncedTablePosition) - Summary of the last successful synchronization from source to destination.\n" }, "message": { "type": "string", "description": "(string) - A text description of the current state of the synced table\n" }, "pipelineId": { "type": "string", "description": "(string) - ID of the associated pipeline. The pipeline ID may have been provided by the client\n(in the case of bin packing), or generated by the server (when creating a new pipeline)\n" }, "provisioningStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus", "description": "(SyncedTableProvisioningStatus)\n" }, "triggeredUpdateStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus", "description": "(SyncedTableTriggeredUpdateStatus)\n" } }, "type": "object", "required": [ "detailedState", "lastSync", "message", "pipelineId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress", "description": "(SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state\n" }, "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" } }, "type": "object", "required": [ "initialPipelineSyncProgress", "lastProcessedCommitVersion", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" } }, "type": "object", "required": [ "lastProcessedCommitVersion", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync:getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync": { "properties": { "deltaTableSyncInfo": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo:getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo", "description": "(DeltaTableSyncInfo)\n" }, "syncEndTimestamp": { "type": "string", "description": "(string) - The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table\n" }, "syncStartTimestamp": { "type": "string", "description": "(string) - The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started\n" } }, "type": "object", "required": [ "deltaTableSyncInfo", "syncEndTimestamp", "syncStartTimestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo:getDatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo": { "properties": { "deltaCommitTimestamp": { "type": "string", "description": "(string) - The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table\n" }, "deltaCommitVersion": { "type": "integer", "description": "(integer) - The Delta Lake commit version that was last successfully synced\n" } }, "type": "object", "required": [ "deltaCommitTimestamp", "deltaCommitVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress", "description": "(SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state\n" } }, "type": "object", "required": [ "initialPipelineSyncProgress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus:getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" }, "triggeredUpdateProgress": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress:getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress", "description": "(SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline\n" } }, "type": "object", "required": [ "lastProcessedCommitVersion", "timestamp", "triggeredUpdateProgress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress:getDatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableProviderConfig:getDatabaseSyncedDatabaseTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableSpec:getDatabaseSyncedDatabaseTableSpec": { "properties": { "createDatabaseObjectsIfMissing": { "type": "boolean", "description": "(boolean) - If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist\n" }, "existingPipelineId": { "type": "string", "description": "(string) - At most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n" }, "newPipelineSpec": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTableSpecNewPipelineSpec:getDatabaseSyncedDatabaseTableSpecNewPipelineSpec", "description": "(NewPipelineSpec) - At most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n" }, "primaryKeyColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Primary Key columns to be used for data insert/update in the destination\n" }, "schedulingPolicy": { "type": "string", "description": "(string) - Scheduling policy of the underlying pipeline. Possible values are: `CONTINUOUS`, `SNAPSHOT`, `TRIGGERED`\n" }, "sourceTableFullName": { "type": "string", "description": "(string) - Three-part (catalog, schema, table) name of the source Delta table\n" }, "timeseriesKey": { "type": "string", "description": "(string) - Time series key to deduplicate (tie-break) rows with the same primary key\n" } }, "type": "object", "required": [ "createDatabaseObjectsIfMissing", "existingPipelineId", "newPipelineSpec" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTableSpecNewPipelineSpec:getDatabaseSyncedDatabaseTableSpecNewPipelineSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "(string) - Budget policy to set on the newly created pipeline\n" }, "storageCatalog": { "type": "string", "description": "(string) - This field needs to be specified if the destination catalog is a managed postgres catalog.\n" }, "storageSchema": { "type": "string", "description": "(string) - This field needs to be specified if the destination catalog is a managed postgres catalog.\n" } }, "type": "object" }, "databricks:index/getDatabaseSyncedDatabaseTablesProviderConfig:getDatabaseSyncedDatabaseTablesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTable:getDatabaseSyncedDatabaseTablesSyncedTable": { "properties": { "dataSynchronizationStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatus", "description": "(SyncedTableStatus) - Synced Table data synchronization status\n" }, "databaseInstanceName": { "type": "string", "description": "(string) - Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected)\n" }, "effectiveDatabaseInstanceName": { "type": "string", "description": "(string) - The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveLogicalDatabaseName": { "type": "string", "description": "(string) - The name of the logical database that this table is registered to.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "logicalDatabaseName": { "type": "string", "description": "(string) - Target Postgres database object (logical database) name for this table.\n" }, "name": { "type": "string", "description": "(string) - Full three-part (catalog, schema, table) name of the table\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableProviderConfig:getDatabaseSyncedDatabaseTablesSyncedTableProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableSpec:getDatabaseSyncedDatabaseTablesSyncedTableSpec", "description": "(SyncedTableSpec)\n" }, "unityCatalogProvisioningState": { "type": "string", "description": "(string) - The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously). Possible values are: `ACTIVE`, `DEGRADED`, `DELETING`, `FAILED`, `PROVISIONING`, `UPDATING`\n" } }, "type": "object", "required": [ "dataSynchronizationStatus", "databaseInstanceName", "effectiveDatabaseInstanceName", "effectiveLogicalDatabaseName", "logicalDatabaseName", "name", "spec", "unityCatalogProvisioningState" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatus": { "properties": { "continuousUpdateStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatus", "description": "(SyncedTableContinuousUpdateStatus)\n" }, "detailedState": { "type": "string", "description": "(string) - The state of the synced table. Possible values are: `SYNCED_TABLED_OFFLINE`, `SYNCED_TABLE_OFFLINE_FAILED`, `SYNCED_TABLE_ONLINE`, `SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE`, `SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE`, `SYNCED_TABLE_ONLINE_PIPELINE_FAILED`, `SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE`, `SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES`, `SYNCED_TABLE_PROVISIONING`, `SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT`, `SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES`\n" }, "failedStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusFailedStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusFailedStatus", "description": "(SyncedTableFailedStatus)\n" }, "lastSync": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSync:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSync", "description": "(SyncedTablePosition) - Summary of the last successful synchronization from source to destination.\n" }, "message": { "type": "string", "description": "(string) - A text description of the current state of the synced table\n" }, "pipelineId": { "type": "string", "description": "(string) - ID of the associated pipeline. The pipeline ID may have been provided by the client\n(in the case of bin packing), or generated by the server (when creating a new pipeline)\n" }, "provisioningStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatus", "description": "(SyncedTableProvisioningStatus)\n" }, "triggeredUpdateStatus": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatus", "description": "(SyncedTableTriggeredUpdateStatus)\n" } }, "type": "object", "required": [ "detailedState", "lastSync", "message", "pipelineId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress", "description": "(SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state\n" }, "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" } }, "type": "object", "required": [ "initialPipelineSyncProgress", "lastProcessedCommitVersion", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusFailedStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusFailedStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" } }, "type": "object", "required": [ "lastProcessedCommitVersion", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSync:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSync": { "properties": { "deltaTableSyncInfo": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo", "description": "(DeltaTableSyncInfo)\n" }, "syncEndTimestamp": { "type": "string", "description": "(string) - The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table\n" }, "syncStartTimestamp": { "type": "string", "description": "(string) - The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started\n" } }, "type": "object", "required": [ "deltaTableSyncInfo", "syncEndTimestamp", "syncStartTimestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo": { "properties": { "deltaCommitTimestamp": { "type": "string", "description": "(string) - The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table\n" }, "deltaCommitVersion": { "type": "integer", "description": "(integer) - The Delta Lake commit version that was last successfully synced\n" } }, "type": "object", "required": [ "deltaCommitTimestamp", "deltaCommitVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatus": { "properties": { "initialPipelineSyncProgress": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress", "description": "(SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the\nPROVISIONING_INITIAL_SNAPSHOT state\n" } }, "type": "object", "required": [ "initialPipelineSyncProgress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatus:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatus": { "properties": { "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "timestamp": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" }, "triggeredUpdateProgress": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress", "description": "(SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline\n" } }, "type": "object", "required": [ "lastProcessedCommitVersion", "timestamp", "triggeredUpdateProgress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress:getDatabaseSyncedDatabaseTablesSyncedTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "provisioningPhase", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableProviderConfig:getDatabaseSyncedDatabaseTablesSyncedTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableSpec:getDatabaseSyncedDatabaseTablesSyncedTableSpec": { "properties": { "createDatabaseObjectsIfMissing": { "type": "boolean", "description": "(boolean) - If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist\n" }, "existingPipelineId": { "type": "string", "description": "(string) - At most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n" }, "newPipelineSpec": { "$ref": "#/types/databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableSpecNewPipelineSpec:getDatabaseSyncedDatabaseTablesSyncedTableSpecNewPipelineSpec", "description": "(NewPipelineSpec) - At most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n" }, "primaryKeyColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Primary Key columns to be used for data insert/update in the destination\n" }, "schedulingPolicy": { "type": "string", "description": "(string) - Scheduling policy of the underlying pipeline. Possible values are: `CONTINUOUS`, `SNAPSHOT`, `TRIGGERED`\n" }, "sourceTableFullName": { "type": "string", "description": "(string) - Three-part (catalog, schema, table) name of the source Delta table\n" }, "timeseriesKey": { "type": "string", "description": "(string) - Time series key to deduplicate (tie-break) rows with the same primary key\n" } }, "type": "object", "required": [ "createDatabaseObjectsIfMissing", "existingPipelineId", "newPipelineSpec" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDatabaseSyncedDatabaseTablesSyncedTableSpecNewPipelineSpec:getDatabaseSyncedDatabaseTablesSyncedTableSpecNewPipelineSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "(string) - Budget policy to set on the newly created pipeline\n" }, "storageCatalog": { "type": "string", "description": "(string) - This field needs to be specified if the destination catalog is a managed postgres catalog.\n" }, "storageSchema": { "type": "string", "description": "(string) - This field needs to be specified if the destination catalog is a managed postgres catalog.\n" } }, "type": "object" }, "databricks:index/getDbfsFilePathsPathList:getDbfsFilePathsPathList": { "properties": { "fileSize": { "type": "integer" }, "path": { "type": "string", "description": "Path on DBFS for the file to perform listing\n" } }, "type": "object" }, "databricks:index/getDbfsFilePathsProviderConfig:getDbfsFilePathsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDbfsFileProviderConfig:getDbfsFileProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDirectoryProviderConfig:getDirectoryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssets:getDisasterRecoveryFailoverGroupUnityCatalogAssets": { "properties": { "catalogs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog:getDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog" }, "description": "(list of UcCatalog) - UC catalogs to replicate\n" }, "dataReplicationWorkspaceSet": { "type": "string", "description": "(string) - The workspace set whose workspaces will be used for data replication\nof all UC catalogs' underlying storage\n" }, "locationMappings": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping:getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping" }, "description": "(list of LocationMapping) - Location mappings - storage URI per region for each location\n" } }, "type": "object", "required": [ "catalogs", "dataReplicationWorkspaceSet" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog:getDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog": { "properties": { "name": { "type": "string", "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping:getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping": { "properties": { "name": { "type": "string", "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" }, "uriByRegions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion:getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion" }, "description": "(list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI\n" } }, "type": "object", "required": [ "name", "uriByRegions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion:getDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion": { "properties": { "region": { "type": "string", "description": "(string) - The region name\n" }, "uri": { "type": "string", "description": "(string) - The storage URI for this region\n" } }, "type": "object", "required": [ "region", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupWorkspaceSet:getDisasterRecoveryFailoverGroupWorkspaceSet": { "properties": { "name": { "type": "string", "description": "Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" }, "replicateWorkspaceAssets": { "type": "boolean", "description": "(boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.\nRequires all workspaces in the set to be Mission Critical tier\n" }, "stableUrlNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Resource names of stable URLs associated with this workspace set.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.\nThe referenced stable URLs must already exist (via CreateStableUrl)\n" }, "workspaceIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Workspace IDs in this set. The system derives and validates regions.\nEA: exactly 2 workspaces (one per region)\n" } }, "type": "object", "required": [ "name", "replicateWorkspaceAssets", "workspaceIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroup:getDisasterRecoveryFailoverGroupsFailoverGroup": { "properties": { "createTime": { "type": "string", "description": "(string) - Time at which this failover group was created\n" }, "effectivePrimaryRegion": { "type": "string", "description": "(string) - Current effective primary region. Replication flows FROM workspaces in this region.\nChanges after a successful failover\n" }, "etag": { "type": "string", "description": "(string) - Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications\n" }, "initialPrimaryRegion": { "type": "string", "description": "(string) - Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses\n" }, "name": { "type": "string", "description": "(string) - Resource name for this workspace set\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of all regions participating in this failover group\n" }, "replicationPoint": { "type": "string", "description": "(string) - The latest point in time to which data has been replicated\n" }, "state": { "type": "string", "description": "(string) - Aggregate state of the failover group. Possible values are: `ACTIVE`, `CREATING`, `CREATION_FAILED`, `DELETING`, `DELETION_FAILED`, `FAILING_OVER`, `FAILOVER_FAILED`, `INITIAL_REPLICATION`\n" }, "unityCatalogAssets": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssets:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssets", "description": "(UcReplicationConfig) - Unity Catalog replication configuration\n" }, "updateTime": { "type": "string", "description": "(string) - Time at which this failover group was last modified\n" }, "workspaceSets": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupWorkspaceSet:getDisasterRecoveryFailoverGroupsFailoverGroupWorkspaceSet" }, "description": "(list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other\n" } }, "type": "object", "required": [ "createTime", "effectivePrimaryRegion", "etag", "initialPrimaryRegion", "name", "regions", "replicationPoint", "state", "unityCatalogAssets", "updateTime", "workspaceSets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssets:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssets": { "properties": { "catalogs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsCatalog:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsCatalog" }, "description": "(list of UcCatalog) - UC catalogs to replicate\n" }, "dataReplicationWorkspaceSet": { "type": "string", "description": "(string) - The workspace set whose workspaces will be used for data replication\nof all UC catalogs' underlying storage\n" }, "locationMappings": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMapping:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMapping" }, "description": "(list of LocationMapping) - Location mappings - storage URI per region for each location\n" } }, "type": "object", "required": [ "catalogs", "dataReplicationWorkspaceSet" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsCatalog:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsCatalog": { "properties": { "name": { "type": "string", "description": "(string) - Resource name for this workspace set\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMapping:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMapping": { "properties": { "name": { "type": "string", "description": "(string) - Resource name for this workspace set\n" }, "uriByRegions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion" }, "description": "(list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI\n" } }, "type": "object", "required": [ "name", "uriByRegions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion:getDisasterRecoveryFailoverGroupsFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion": { "properties": { "region": { "type": "string", "description": "(string) - The region name\n" }, "uri": { "type": "string", "description": "(string) - The storage URI for this region\n" } }, "type": "object", "required": [ "region", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryFailoverGroupsFailoverGroupWorkspaceSet:getDisasterRecoveryFailoverGroupsFailoverGroupWorkspaceSet": { "properties": { "name": { "type": "string", "description": "(string) - Resource name for this workspace set\n" }, "replicateWorkspaceAssets": { "type": "boolean", "description": "(boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set.\nRequires all workspaces in the set to be Mission Critical tier\n" }, "stableUrlNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Resource names of stable URLs associated with this workspace set.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}.\nThe referenced stable URLs must already exist (via CreateStableUrl)\n" }, "workspaceIds": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Workspace IDs in this set. The system derives and validates regions.\nEA: exactly 2 workspaces (one per region)\n" } }, "type": "object", "required": [ "name", "replicateWorkspaceAssets", "workspaceIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getDisasterRecoveryStableUrlsStableUrl:getDisasterRecoveryStableUrlsStableUrl": { "properties": { "failoverGroupName": { "type": "string", "description": "(string) - Fully qualified resource name of the FailoverGroup this stable URL is\ncurrently linked to, in the format\n`accounts/{account_id}/failover-groups/{failover_group_id}`. Empty when\nthe stable URL is not attached to any failover group. Server-controlled:\nwritten by CreateFailoverGroup / UpdateFailoverGroup on link, cleared by\nDeleteFailoverGroup / UpdateFailoverGroup on unlink\n" }, "initialWorkspaceId": { "type": "string", "description": "(string) - The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics\n" }, "name": { "type": "string", "description": "(string) - Fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}\n" }, "url": { "type": "string", "description": "(string) - The stable URL endpoint. Generated by the backend on creation and\nimmutable thereafter. For non-Private-Link workspaces this is\n`https://\u003cspog_host\u003e/?c=\u003cconnection_id\u003e`. For Private-Link workspaces\nthis is the per-connection hostname\n" } }, "type": "object", "required": [ "failoverGroupName", "initialWorkspaceId", "name", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEndpointAzurePrivateEndpointInfo:getEndpointAzurePrivateEndpointInfo": { "properties": { "privateEndpointName": { "type": "string", "description": "(string) - The name of the Private Endpoint in the Azure subscription\n" }, "privateEndpointResourceGuid": { "type": "string", "description": "(string) - The GUID of the Private Endpoint resource in the Azure subscription.\nThis is assigned by Azure when the user sets up the Private Endpoint\n" }, "privateEndpointResourceId": { "type": "string", "description": "(string) - The full resource ID of the Private Endpoint\n" }, "privateLinkServiceId": { "type": "string", "description": "(string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to\n" } }, "type": "object", "required": [ "privateEndpointName", "privateEndpointResourceGuid", "privateEndpointResourceId", "privateLinkServiceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEndpointsItem:getEndpointsItem": { "properties": { "accountId": { "type": "string", "description": "(string) - The Databricks Account in which the endpoint object exists\n" }, "azurePrivateEndpointInfo": { "$ref": "#/types/databricks:index/getEndpointsItemAzurePrivateEndpointInfo:getEndpointsItemAzurePrivateEndpointInfo", "description": "(AzurePrivateEndpointInfo) - Info for an Azure private endpoint\n" }, "createTime": { "type": "string", "description": "(string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone\n" }, "displayName": { "type": "string", "description": "(string) - The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum\n" }, "endpointId": { "type": "string", "description": "(string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks\n" }, "name": { "type": "string", "description": "(string) - The resource name of the endpoint, which uniquely identifies the endpoint\n" }, "region": { "type": "string", "description": "(string) - The cloud provider region where this endpoint is located\n" }, "state": { "type": "string", "description": "(string) - The state of the endpoint. The endpoint can only be used if the state is `APPROVED`. Possible values are: `APPROVED`, `DISCONNECTED`, `FAILED`, `PENDING`\n" }, "useCase": { "type": "string", "description": "(string) - The use case that determines the type of network connectivity this endpoint provides.\nThis field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are: `SERVICE_DIRECT`\n" } }, "type": "object", "required": [ "accountId", "azurePrivateEndpointInfo", "createTime", "displayName", "endpointId", "name", "region", "state", "useCase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEndpointsItemAzurePrivateEndpointInfo:getEndpointsItemAzurePrivateEndpointInfo": { "properties": { "privateEndpointName": { "type": "string", "description": "(string) - The name of the Private Endpoint in the Azure subscription\n" }, "privateEndpointResourceGuid": { "type": "string", "description": "(string) - The GUID of the Private Endpoint resource in the Azure subscription.\nThis is assigned by Azure when the user sets up the Private Endpoint\n" }, "privateEndpointResourceId": { "type": "string", "description": "(string) - The full resource ID of the Private Endpoint\n" }, "privateLinkServiceId": { "type": "string", "description": "(string) - The resource ID of the Databricks Private Link Service that this Private Endpoint connects to\n" } }, "type": "object", "required": [ "privateEndpointName", "privateEndpointResourceGuid", "privateEndpointResourceId", "privateLinkServiceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEntityTagAssignmentProviderConfig:getEntityTagAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEntityTagAssignmentsProviderConfig:getEntityTagAssignmentsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEntityTagAssignmentsTagAssignment:getEntityTagAssignmentsTagAssignment": { "properties": { "entityName": { "type": "string", "description": "The fully qualified name of the entity to which the tag is assigned\n" }, "entityType": { "type": "string", "description": "The type of the entity to which the tag is assigned\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getEntityTagAssignmentsTagAssignmentProviderConfig:getEntityTagAssignmentsTagAssignmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "(string) - The source type of the tag assignment, e.g., user-assigned or system-assigned. Possible values are: `TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION`\n" }, "tagKey": { "type": "string", "description": "(string) - The key of the tag\n" }, "tagValue": { "type": "string", "description": "(string) - The value of the tag\n" }, "updateTime": { "type": "string", "description": "(string) - The timestamp when the tag assignment was last updated\n" }, "updatedBy": { "type": "string", "description": "(string) - The user or principal who updated the tag assignment\n" } }, "type": "object", "required": [ "entityName", "entityType", "sourceType", "tagKey", "tagValue", "updateTime", "updatedBy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEntityTagAssignmentsTagAssignmentProviderConfig:getEntityTagAssignmentsTagAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig:getEnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEnvironmentsWorkspaceBaseEnvironmentProviderConfig:getEnvironmentsWorkspaceBaseEnvironmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEnvironmentsWorkspaceBaseEnvironmentsProviderConfig:getEnvironmentsWorkspaceBaseEnvironmentsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironment:getEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironment": { "properties": { "baseEnvironmentType": { "type": "string", "description": "(string) - The type of base environment (CPU or GPU). Possible values are: `CPU`, `GPU`\n" }, "createTime": { "type": "string", "description": "(string) - Timestamp when the environment was created\n" }, "creatorUserId": { "type": "string", "description": "(string) - User ID of the creator\n" }, "displayName": { "type": "string", "description": "(string) - Human-readable display name for the workspace base environment\n" }, "effectiveBaseEnvironmentType": { "type": "string" }, "filepath": { "type": "string", "description": "(string) - The WSFS or UC Volumes path to the environment YAML file\n" }, "isDefault": { "type": "boolean", "description": "(boolean) - Whether this is the default environment for the workspace\n" }, "lastUpdatedUserId": { "type": "string", "description": "(string) - User ID of the last user who updated the environment\n" }, "message": { "type": "string", "description": "(string) - Status message providing additional details about the environment status\n" }, "name": { "type": "string", "description": "(string) - The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig:getEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "status": { "type": "string", "description": "(string) - The status of the materialized workspace base environment. Possible values are: `CREATED`, `EXPIRED`, `FAILED`, `INVALID`, `PENDING`, `REFRESHING`\n" }, "updateTime": { "type": "string", "description": "(string) - Timestamp when the environment was last updated\n" } }, "type": "object", "required": [ "baseEnvironmentType", "createTime", "creatorUserId", "displayName", "effectiveBaseEnvironmentType", "filepath", "isDefault", "lastUpdatedUserId", "message", "name", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig:getEnvironmentsWorkspaceBaseEnvironmentsWorkspaceBaseEnvironmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getExternalLocationExternalLocationInfo:getExternalLocationExternalLocationInfo": { "properties": { "browseOnly": { "type": "boolean" }, "comment": { "type": "string", "description": "User-supplied comment.\n" }, "createdAt": { "type": "integer", "description": "Time at which this catalog was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of catalog creator.\n" }, "credentialId": { "type": "string", "description": "Unique ID of storage credential.\n" }, "credentialName": { "type": "string", "description": "Name of the\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003eto use with this external location.\n" }, "effectiveEnableFileEvents": { "type": "boolean" }, "effectiveFileEventQueue": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueue:getExternalLocationExternalLocationInfoEffectiveFileEventQueue" }, "enableFileEvents": { "type": "boolean" }, "encryptionDetails": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEncryptionDetails:getExternalLocationExternalLocationInfoEncryptionDetails", "description": "A block describing encryption options that apply to clients connecting to cloud storage. Consisting of the following attributes:\n" }, "fallback": { "type": "boolean" }, "fileEventQueue": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueue:getExternalLocationExternalLocationInfoFileEventQueue" }, "isolationMode": { "type": "string" }, "metastoreId": { "type": "string", "description": "Unique identifier of the parent Metastore.\n" }, "name": { "type": "string", "description": "The name of the external location\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the external location owner.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the external location is read-only.\n" }, "updatedAt": { "type": "integer", "description": "Time at which this catalog was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified catalog.\n" }, "url": { "type": "string", "description": "Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure), `gs://[bucket-host]/[bucket-dir]` (GCP).\n" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueue:getExternalLocationExternalLocationInfoEffectiveFileEventQueue": { "properties": { "managedAqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedAqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedAqs" }, "managedPubsub": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedPubsub:getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedPubsub" }, "managedSqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedSqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedSqs" }, "providedAqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedAqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedAqs" }, "providedPubsub": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedPubsub:getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedPubsub" }, "providedSqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedSqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedSqs" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedAqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string" }, "subscriptionId": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedPubsub:getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedSqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueManagedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedAqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string" }, "subscriptionId": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedPubsub:getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedSqs:getExternalLocationExternalLocationInfoEffectiveFileEventQueueProvidedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEncryptionDetails:getExternalLocationExternalLocationInfoEncryptionDetails": { "properties": { "sseEncryptionDetails": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoEncryptionDetailsSseEncryptionDetails:getExternalLocationExternalLocationInfoEncryptionDetailsSseEncryptionDetails", "description": "a block describing server-Side Encryption properties for clients communicating with AWS S3. Consists of the following attributes:\n" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoEncryptionDetailsSseEncryptionDetails:getExternalLocationExternalLocationInfoEncryptionDetailsSseEncryptionDetails": { "properties": { "algorithm": { "type": "string", "description": "Encryption algorithm value. Sets the value of the `x-amz-server-side-encryption` header in S3 request.\n" }, "awsKmsKeyArn": { "type": "string", "description": "ARN of the SSE-KMS key used with the S3 location, when `algorithm = \"SSE-KMS\"`.\n" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueue:getExternalLocationExternalLocationInfoFileEventQueue": { "properties": { "managedAqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueueManagedAqs:getExternalLocationExternalLocationInfoFileEventQueueManagedAqs" }, "managedPubsub": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueueManagedPubsub:getExternalLocationExternalLocationInfoFileEventQueueManagedPubsub" }, "managedSqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueueManagedSqs:getExternalLocationExternalLocationInfoFileEventQueueManagedSqs" }, "providedAqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueueProvidedAqs:getExternalLocationExternalLocationInfoFileEventQueueProvidedAqs" }, "providedPubsub": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueueProvidedPubsub:getExternalLocationExternalLocationInfoFileEventQueueProvidedPubsub" }, "providedSqs": { "$ref": "#/types/databricks:index/getExternalLocationExternalLocationInfoFileEventQueueProvidedSqs:getExternalLocationExternalLocationInfoFileEventQueueProvidedSqs" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueueManagedAqs:getExternalLocationExternalLocationInfoFileEventQueueManagedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string" }, "subscriptionId": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueueManagedPubsub:getExternalLocationExternalLocationInfoFileEventQueueManagedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueueManagedSqs:getExternalLocationExternalLocationInfoFileEventQueueManagedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueueProvidedAqs:getExternalLocationExternalLocationInfoFileEventQueueProvidedAqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" }, "resourceGroup": { "type": "string" }, "subscriptionId": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueueProvidedPubsub:getExternalLocationExternalLocationInfoFileEventQueueProvidedPubsub": { "properties": { "managedResourceId": { "type": "string" }, "subscriptionName": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationExternalLocationInfoFileEventQueueProvidedSqs:getExternalLocationExternalLocationInfoFileEventQueueProvidedSqs": { "properties": { "managedResourceId": { "type": "string" }, "queueUrl": { "type": "string" } }, "type": "object" }, "databricks:index/getExternalLocationProviderConfig:getExternalLocationProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getExternalLocationsProviderConfig:getExternalLocationsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getExternalMetadataProviderConfig:getExternalMetadataProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getExternalMetadatasExternalMetadata:getExternalMetadatasExternalMetadata": { "properties": { "columns": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of columns associated with the external metadata object\n" }, "createTime": { "type": "string", "description": "(string) - Time at which this external metadata object was created\n" }, "createdBy": { "type": "string", "description": "(string) - Username of external metadata object creator\n" }, "description": { "type": "string", "description": "(string) - User-provided free-form text description\n" }, "entityType": { "type": "string", "description": "(string) - Type of entity within the external system\n" }, "id": { "type": "string", "description": "(string) - Unique identifier of the external metadata object\n" }, "metastoreId": { "type": "string", "description": "(string) - Unique identifier of parent metastore\n" }, "name": { "type": "string", "description": "(string) - Name of the external metadata object\n" }, "owner": { "type": "string", "description": "(string) - Owner of the external metadata object\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A map of key-value properties attached to the external metadata object\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getExternalMetadatasExternalMetadataProviderConfig:getExternalMetadatasExternalMetadataProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "systemType": { "type": "string", "description": "(string) - Type of external system. Possible values are: `AMAZON_REDSHIFT`, `AZURE_SYNAPSE`, `CONFLUENT`, `DATABRICKS`, `GOOGLE_BIGQUERY`, `KAFKA`, `LOOKER`, `MICROSOFT_FABRIC`, `MICROSOFT_SQL_SERVER`, `MONGODB`, `MYSQL`, `ORACLE`, `OTHER`, `POSTGRESQL`, `POWER_BI`, `SALESFORCE`, `SAP`, `SERVICENOW`, `SNOWFLAKE`, `STREAM_NATIVE`, `TABLEAU`, `TERADATA`, `WORKDAY`\n" }, "updateTime": { "type": "string", "description": "(string) - Time at which this external metadata object was last modified\n" }, "updatedBy": { "type": "string", "description": "(string) - Username of user who last modified external metadata object\n" }, "url": { "type": "string", "description": "(string) - URL associated with the external metadata object\n" } }, "type": "object", "required": [ "columns", "createTime", "createdBy", "description", "entityType", "id", "metastoreId", "name", "owner", "properties", "systemType", "updateTime", "updatedBy", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getExternalMetadatasExternalMetadataProviderConfig:getExternalMetadatasExternalMetadataProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getExternalMetadatasProviderConfig:getExternalMetadatasProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureEntity:getFeatureEngineeringFeatureEntity": { "properties": { "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunction:getFeatureEngineeringFeatureFunction": { "properties": { "aggregationFunction": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunction:getFeatureEngineeringFeatureFunctionAggregationFunction", "description": "(AggregationFunction) - An aggregation function applied over a time window\n" }, "columnSelection": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionColumnSelection:getFeatureEngineeringFeatureFunctionColumnSelection", "description": "(ColumnSelection) - Selects the latest value of a single column in a data source\n" }, "extraParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionExtraParameter:getFeatureEngineeringFeatureFunctionExtraParameter" }, "description": "(list of FunctionExtraParameter, deprecated) - Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nExtra parameters for parameterized functions\n" }, "functionType": { "type": "string", "description": "(string, deprecated) - Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nThe type of the function. Possible values are: `APPROX_COUNT_DISTINCT`, `APPROX_PERCENTILE`, `AVG`, `COUNT`, `FIRST`, `LAST`, `MAX`, `MIN`, `STDDEV_POP`, `STDDEV_SAMP`, `SUM`, `VAR_POP`, `VAR_SAMP`\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunction:getFeatureEngineeringFeatureFunctionAggregationFunction": { "properties": { "approxCountDistinct": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct:getFeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct", "description": "(ApproxCountDistinctFunction)\n" }, "approxPercentile": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile:getFeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile", "description": "(ApproxPercentileFunction)\n" }, "avg": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionAvg:getFeatureEngineeringFeatureFunctionAggregationFunctionAvg", "description": "(AvgFunction)\n" }, "countFunction": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionCountFunction:getFeatureEngineeringFeatureFunctionAggregationFunctionCountFunction", "description": "(CountFunction)\n" }, "first": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionFirst:getFeatureEngineeringFeatureFunctionAggregationFunctionFirst", "description": "(FirstFunction)\n" }, "last": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionLast:getFeatureEngineeringFeatureFunctionAggregationFunctionLast", "description": "(LastFunction)\n" }, "max": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionMax:getFeatureEngineeringFeatureFunctionAggregationFunctionMax", "description": "(MaxFunction)\n" }, "min": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionMin:getFeatureEngineeringFeatureFunctionAggregationFunctionMin", "description": "(MinFunction)\n" }, "stddevPop": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionStddevPop:getFeatureEngineeringFeatureFunctionAggregationFunctionStddevPop", "description": "(StddevPopFunction)\n" }, "stddevSamp": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp:getFeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp", "description": "(StddevSampFunction)\n" }, "sum": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionSum:getFeatureEngineeringFeatureFunctionAggregationFunctionSum", "description": "(SumFunction)\n" }, "timeWindow": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow", "description": "(TimeWindow) - The time window over which the aggregation is computed\n" }, "varPop": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionVarPop:getFeatureEngineeringFeatureFunctionAggregationFunctionVarPop", "description": "(VarPopFunction)\n" }, "varSamp": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionVarSamp:getFeatureEngineeringFeatureFunctionAggregationFunctionVarSamp", "description": "(VarSampFunction)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct:getFeatureEngineeringFeatureFunctionAggregationFunctionApproxCountDistinct": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" }, "relativeSd": { "type": "number", "description": "(number) - The maximum relative standard deviation allowed (default defined by Spark)\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile:getFeatureEngineeringFeatureFunctionAggregationFunctionApproxPercentile": { "properties": { "accuracy": { "type": "integer", "description": "(integer) - The accuracy parameter (higher is more accurate but slower)\n" }, "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" }, "percentile": { "type": "number", "description": "(number) - The percentile value to compute (between 0 and 1)\n" } }, "type": "object", "required": [ "input", "percentile" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionAvg:getFeatureEngineeringFeatureFunctionAggregationFunctionAvg": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionCountFunction:getFeatureEngineeringFeatureFunctionAggregationFunctionCountFunction": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionFirst:getFeatureEngineeringFeatureFunctionAggregationFunctionFirst": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionLast:getFeatureEngineeringFeatureFunctionAggregationFunctionLast": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionMax:getFeatureEngineeringFeatureFunctionAggregationFunctionMax": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionMin:getFeatureEngineeringFeatureFunctionAggregationFunctionMin": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionStddevPop:getFeatureEngineeringFeatureFunctionAggregationFunctionStddevPop": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp:getFeatureEngineeringFeatureFunctionAggregationFunctionStddevSamp": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionSum:getFeatureEngineeringFeatureFunctionAggregationFunctionSum": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindow": { "properties": { "continuous": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous", "description": "(ContinuousWindow, deprecated)\n" }, "rolling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling", "description": "(RollingWindow)\n" }, "sliding": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding", "description": "(SlidingWindow)\n" }, "tumbling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling", "description": "(TumblingWindow)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowContinuous": { "properties": { "offset": { "type": "string", "description": "(string) - The offset of the continuous window (must be non-positive)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowRolling": { "properties": { "delay": { "type": "string", "description": "(string) - The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowSliding": { "properties": { "slideDuration": { "type": "string", "description": "(string) - The slide duration (interval by which windows advance, must be positive and less than duration)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "slideDuration", "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling:getFeatureEngineeringFeatureFunctionAggregationFunctionTimeWindowTumbling": { "properties": { "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionVarPop:getFeatureEngineeringFeatureFunctionAggregationFunctionVarPop": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionAggregationFunctionVarSamp:getFeatureEngineeringFeatureFunctionAggregationFunctionVarSamp": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionColumnSelection:getFeatureEngineeringFeatureFunctionColumnSelection": { "properties": { "column": { "type": "string", "description": "(string) - Column name from source to select as the feature value\n" } }, "type": "object", "required": [ "column" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureFunctionExtraParameter:getFeatureEngineeringFeatureFunctionExtraParameter": { "properties": { "key": { "type": "string", "description": "(string) - The name of the parameter\n" }, "value": { "type": "string", "description": "(string) - The value of the parameter\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureLineageContext:getFeatureEngineeringFeatureLineageContext": { "properties": { "jobContext": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureLineageContextJobContext:getFeatureEngineeringFeatureLineageContextJobContext", "description": "(JobContext) - Job context information including job ID and run ID\n" }, "notebookId": { "type": "integer", "description": "(integer) - The notebook ID where this API was invoked\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureLineageContextJobContext:getFeatureEngineeringFeatureLineageContextJobContext": { "properties": { "jobId": { "type": "integer", "description": "(integer) - The job ID where this API invoked\n" }, "jobRunId": { "type": "integer", "description": "(integer) - The job run ID where this API was invoked\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureProviderConfig:getFeatureEngineeringFeatureProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureSource:getFeatureEngineeringFeatureSource": { "properties": { "deltaTableSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceDeltaTableSource:getFeatureEngineeringFeatureSourceDeltaTableSource", "description": "(DeltaTableSource) - A Delta table data source\n" }, "kafkaSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceKafkaSource:getFeatureEngineeringFeatureSourceKafkaSource", "description": "(KafkaSource) - A Kafka stream data source\n" }, "requestSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceRequestSource:getFeatureEngineeringFeatureSourceRequestSource", "description": "(RequestSource) - A request-time data source\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureSourceDeltaTableSource:getFeatureEngineeringFeatureSourceDeltaTableSource": { "properties": { "dataframeSchema": { "type": "string", "description": "(string) - Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colA\"\" pulumi-lang-dotnet=\"\"ColA\"\" pulumi-lang-go=\"\"colA\"\" pulumi-lang-python=\"\"col_a\"\" pulumi-lang-yaml=\"\"colA\"\" pulumi-lang-java=\"\"colA\"\" pulumi-lang-hcl=\"\"col_a\"\"\u003e\"colA\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colC\"\" pulumi-lang-dotnet=\"\"ColC\"\" pulumi-lang-go=\"\"colC\"\" pulumi-lang-python=\"\"col_c\"\" pulumi-lang-yaml=\"\"colC\"\" pulumi-lang-java=\"\"colC\"\" pulumi-lang-hcl=\"\"col_c\"\"\u003e\"colC\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}\n" }, "entityColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string, deprecated) - Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table\n" }, "filterCondition": { "type": "string", "description": "(string) - The filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value\n" }, "timeseriesColumn": { "type": "string", "description": "(string, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table\n" }, "transformationSql": { "type": "string", "description": "(string) - A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC \" pulumi-lang-dotnet=\" ColC \" pulumi-lang-go=\" colC \" pulumi-lang-python=\" col_c \" pulumi-lang-yaml=\" colC \" pulumi-lang-java=\" colC \" pulumi-lang-hcl=\" col_c \"\u003e colC \u003c/span\u003eFROM x.y.z WHERE\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e\u003e 0\" would have \u003cspan pulumi-lang-nodejs=\"`transformationSql`\" pulumi-lang-dotnet=\"`TransformationSql`\" pulumi-lang-go=\"`transformationSql`\" pulumi-lang-python=\"`transformation_sql`\" pulumi-lang-yaml=\"`transformationSql`\" pulumi-lang-java=\"`transformationSql`\" pulumi-lang-hcl=\"`transformation_sql`\"\u003e`transformationSql`\u003c/span\u003e \"*,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC\"\" pulumi-lang-dotnet=\" ColC\"\" pulumi-lang-go=\" colC\"\" pulumi-lang-python=\" col_c\"\" pulumi-lang-yaml=\" colC\"\" pulumi-lang-java=\" colC\"\" pulumi-lang-hcl=\" col_c\"\"\u003e colC\"\u003c/span\u003e)\nIf\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis not provided, all columns of the delta table are present in the DataSource dataframe\n" } }, "type": "object", "required": [ "fullName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureSourceKafkaSource:getFeatureEngineeringFeatureSourceKafkaSource": { "properties": { "entityColumnIdentifiers": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier:getFeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier" }, "description": "(list of ColumnIdentifier, deprecated) - Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity column identifiers of the Kafka source\n" }, "filterCondition": { "type": "string", "description": "(string) - The filter condition applied to the source data before aggregation\n" }, "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" }, "timeseriesColumnIdentifier": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier:getFeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier", "description": "(ColumnIdentifier, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column identifier of the Kafka source\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier:getFeatureEngineeringFeatureSourceKafkaSourceEntityColumnIdentifier": { "properties": { "variantExprPath": { "type": "string", "description": "(string) - String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip\n" } }, "type": "object", "required": [ "variantExprPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier:getFeatureEngineeringFeatureSourceKafkaSourceTimeseriesColumnIdentifier": { "properties": { "variantExprPath": { "type": "string", "description": "(string) - String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip\n" } }, "type": "object", "required": [ "variantExprPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureSourceRequestSource:getFeatureEngineeringFeatureSourceRequestSource": { "properties": { "flatSchema": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceRequestSourceFlatSchema:getFeatureEngineeringFeatureSourceRequestSourceFlatSchema", "description": "(FlatSchema) - A flat schema with scalar-typed fields only\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureSourceRequestSourceFlatSchema:getFeatureEngineeringFeatureSourceRequestSourceFlatSchema": { "properties": { "fields": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureSourceRequestSourceFlatSchemaField:getFeatureEngineeringFeatureSourceRequestSourceFlatSchemaField" }, "description": "(list of FieldDefinition) - The list of fields in this schema\n" } }, "type": "object", "required": [ "fields" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureSourceRequestSourceFlatSchemaField:getFeatureEngineeringFeatureSourceRequestSourceFlatSchemaField": { "properties": { "dataType": { "type": "string", "description": "(string) - The scalar data type of the field. Possible values are: `BINARY`, `BOOLEAN`, `DATE`, `DECIMAL`, `DOUBLE`, `FLOAT`, `INTEGER`, `LONG`, `SHORT`, `STRING`, `TIMESTAMP`\n" }, "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" } }, "type": "object", "required": [ "dataType", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureTimeWindow:getFeatureEngineeringFeatureTimeWindow": { "properties": { "continuous": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureTimeWindowContinuous:getFeatureEngineeringFeatureTimeWindowContinuous", "description": "(ContinuousWindow, deprecated)\n" }, "rolling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureTimeWindowRolling:getFeatureEngineeringFeatureTimeWindowRolling", "description": "(RollingWindow)\n" }, "sliding": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureTimeWindowSliding:getFeatureEngineeringFeatureTimeWindowSliding", "description": "(SlidingWindow)\n" }, "tumbling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeatureTimeWindowTumbling:getFeatureEngineeringFeatureTimeWindowTumbling", "description": "(TumblingWindow)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeatureTimeWindowContinuous:getFeatureEngineeringFeatureTimeWindowContinuous": { "properties": { "offset": { "type": "string", "description": "(string) - The offset of the continuous window (must be non-positive)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureTimeWindowRolling:getFeatureEngineeringFeatureTimeWindowRolling": { "properties": { "delay": { "type": "string", "description": "(string) - The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureTimeWindowSliding:getFeatureEngineeringFeatureTimeWindowSliding": { "properties": { "slideDuration": { "type": "string", "description": "(string) - The slide duration (interval by which windows advance, must be positive and less than duration)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "slideDuration", "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureTimeWindowTumbling:getFeatureEngineeringFeatureTimeWindowTumbling": { "properties": { "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeatureTimeseriesColumn:getFeatureEngineeringFeatureTimeseriesColumn": { "properties": { "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeature:getFeatureEngineeringFeaturesFeature": { "properties": { "catalogName": { "type": "string", "description": "Name of parent catalog for features of interest\n" }, "createdAt": { "type": "string", "description": "(string) - Time at which this feature was created\n" }, "createdBy": { "type": "string", "description": "(string) - Username of the feature creator\n" }, "description": { "type": "string", "description": "(string) - The description of the feature\n" }, "entities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureEntity:getFeatureEngineeringFeaturesFeatureEntity" }, "description": "(list of EntityColumn) - The entity columns for the feature, used as aggregation keys and for query-time lookup\n" }, "filterCondition": { "type": "string", "description": "(string) - The filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "(string) - The full three-part (catalog, schema, table) name of the Delta table\n" }, "function": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunction:getFeatureEngineeringFeaturesFeatureFunction", "description": "(Function) - The function by which the feature is computed\n" }, "inputs": { "type": "array", "items": { "type": "string" }, "description": "(list of string, deprecated) - Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed\n" }, "lineageContext": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureLineageContext:getFeatureEngineeringFeaturesFeatureLineageContext", "description": "(LineageContext) - Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users\n" }, "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureProviderConfig:getFeatureEngineeringFeaturesFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "schemaName": { "type": "string", "description": "Name of parent schema relative to its parent catalog\n" }, "source": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSource:getFeatureEngineeringFeaturesFeatureSource", "description": "(DataSource) - The data source of the feature\n" }, "timeWindow": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindow:getFeatureEngineeringFeaturesFeatureTimeWindow", "description": "(TimeWindow) - The time window over which the aggregation is computed\n" }, "timeseriesColumn": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureTimeseriesColumn:getFeatureEngineeringFeaturesFeatureTimeseriesColumn", "description": "(string, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table\n" } }, "type": "object", "required": [ "catalogName", "createdAt", "createdBy", "description", "entities", "filterCondition", "fullName", "function", "inputs", "lineageContext", "name", "schemaName", "source", "timeWindow", "timeseriesColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureEntity:getFeatureEngineeringFeaturesFeatureEntity": { "properties": { "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunction:getFeatureEngineeringFeaturesFeatureFunction": { "properties": { "aggregationFunction": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunction:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunction", "description": "(AggregationFunction) - An aggregation function applied over a time window\n" }, "columnSelection": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionColumnSelection:getFeatureEngineeringFeaturesFeatureFunctionColumnSelection", "description": "(ColumnSelection) - Selects the latest value of a single column in a data source\n" }, "extraParameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionExtraParameter:getFeatureEngineeringFeaturesFeatureFunctionExtraParameter" }, "description": "(list of FunctionExtraParameter, deprecated) - Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nExtra parameters for parameterized functions\n" }, "functionType": { "type": "string", "description": "(string, deprecated) - Deprecated: Use the function oneof with AggregationFunction instead. Kept for backwards compatibility.\nThe type of the function. Possible values are: `APPROX_COUNT_DISTINCT`, `APPROX_PERCENTILE`, `AVG`, `COUNT`, `FIRST`, `LAST`, `MAX`, `MIN`, `STDDEV_POP`, `STDDEV_SAMP`, `SUM`, `VAR_POP`, `VAR_SAMP`\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunction:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunction": { "properties": { "approxCountDistinct": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxCountDistinct:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxCountDistinct", "description": "(ApproxCountDistinctFunction)\n" }, "approxPercentile": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxPercentile:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxPercentile", "description": "(ApproxPercentileFunction)\n" }, "avg": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionAvg:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionAvg", "description": "(AvgFunction)\n" }, "countFunction": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionCountFunction:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionCountFunction", "description": "(CountFunction)\n" }, "first": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionFirst:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionFirst", "description": "(FirstFunction)\n" }, "last": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionLast:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionLast", "description": "(LastFunction)\n" }, "max": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMax:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMax", "description": "(MaxFunction)\n" }, "min": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMin:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMin", "description": "(MinFunction)\n" }, "stddevPop": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevPop:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevPop", "description": "(StddevPopFunction)\n" }, "stddevSamp": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevSamp:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevSamp", "description": "(StddevSampFunction)\n" }, "sum": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionSum:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionSum", "description": "(SumFunction)\n" }, "timeWindow": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindow:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindow", "description": "(TimeWindow) - The time window over which the aggregation is computed\n" }, "varPop": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarPop:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarPop", "description": "(VarPopFunction)\n" }, "varSamp": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarSamp:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarSamp", "description": "(VarSampFunction)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxCountDistinct:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxCountDistinct": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" }, "relativeSd": { "type": "number", "description": "(number) - The maximum relative standard deviation allowed (default defined by Spark)\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxPercentile:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionApproxPercentile": { "properties": { "accuracy": { "type": "integer", "description": "(integer) - The accuracy parameter (higher is more accurate but slower)\n" }, "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" }, "percentile": { "type": "number", "description": "(number) - The percentile value to compute (between 0 and 1)\n" } }, "type": "object", "required": [ "input", "percentile" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionAvg:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionAvg": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionCountFunction:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionCountFunction": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionFirst:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionFirst": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionLast:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionLast": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMax:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMax": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMin:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionMin": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevPop:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevPop": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevSamp:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionStddevSamp": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionSum:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionSum": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindow:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindow": { "properties": { "continuous": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowContinuous:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowContinuous", "description": "(ContinuousWindow, deprecated)\n" }, "rolling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowRolling:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowRolling", "description": "(RollingWindow)\n" }, "sliding": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowSliding:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowSliding", "description": "(SlidingWindow)\n" }, "tumbling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowTumbling:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowTumbling", "description": "(TumblingWindow)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowContinuous:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowContinuous": { "properties": { "offset": { "type": "string", "description": "(string) - The offset of the continuous window (must be non-positive)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowRolling:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowRolling": { "properties": { "delay": { "type": "string", "description": "(string) - The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowSliding:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowSliding": { "properties": { "slideDuration": { "type": "string", "description": "(string) - The slide duration (interval by which windows advance, must be positive and less than duration)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "slideDuration", "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowTumbling:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionTimeWindowTumbling": { "properties": { "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarPop:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarPop": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarSamp:getFeatureEngineeringFeaturesFeatureFunctionAggregationFunctionVarSamp": { "properties": { "input": { "type": "string", "description": "(string) - The input column from which the sample variance is computed\n" } }, "type": "object", "required": [ "input" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionColumnSelection:getFeatureEngineeringFeaturesFeatureFunctionColumnSelection": { "properties": { "column": { "type": "string", "description": "(string) - Column name from source to select as the feature value\n" } }, "type": "object", "required": [ "column" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureFunctionExtraParameter:getFeatureEngineeringFeaturesFeatureFunctionExtraParameter": { "properties": { "key": { "type": "string", "description": "(string) - The name of the parameter\n" }, "value": { "type": "string", "description": "(string) - The value of the parameter\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureLineageContext:getFeatureEngineeringFeaturesFeatureLineageContext": { "properties": { "jobContext": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureLineageContextJobContext:getFeatureEngineeringFeaturesFeatureLineageContextJobContext", "description": "(JobContext) - Job context information including job ID and run ID\n" }, "notebookId": { "type": "integer", "description": "(integer) - The notebook ID where this API was invoked\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureLineageContextJobContext:getFeatureEngineeringFeaturesFeatureLineageContextJobContext": { "properties": { "jobId": { "type": "integer", "description": "(integer) - The job ID where this API invoked\n" }, "jobRunId": { "type": "integer", "description": "(integer) - The job run ID where this API was invoked\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureProviderConfig:getFeatureEngineeringFeaturesFeatureProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureSource:getFeatureEngineeringFeaturesFeatureSource": { "properties": { "deltaTableSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceDeltaTableSource:getFeatureEngineeringFeaturesFeatureSourceDeltaTableSource", "description": "(DeltaTableSource) - A Delta table data source\n" }, "kafkaSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceKafkaSource:getFeatureEngineeringFeaturesFeatureSourceKafkaSource", "description": "(KafkaSource) - A Kafka stream data source\n" }, "requestSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceRequestSource:getFeatureEngineeringFeaturesFeatureSourceRequestSource", "description": "(RequestSource) - A request-time data source\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceDeltaTableSource:getFeatureEngineeringFeaturesFeatureSourceDeltaTableSource": { "properties": { "dataframeSchema": { "type": "string", "description": "(string) - Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colA\"\" pulumi-lang-dotnet=\"\"ColA\"\" pulumi-lang-go=\"\"colA\"\" pulumi-lang-python=\"\"col_a\"\" pulumi-lang-yaml=\"\"colA\"\" pulumi-lang-java=\"\"colA\"\" pulumi-lang-hcl=\"\"col_a\"\"\u003e\"colA\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colC\"\" pulumi-lang-dotnet=\"\"ColC\"\" pulumi-lang-go=\"\"colC\"\" pulumi-lang-python=\"\"col_c\"\" pulumi-lang-yaml=\"\"colC\"\" pulumi-lang-java=\"\"colC\"\" pulumi-lang-hcl=\"\"col_c\"\"\u003e\"colC\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}\n" }, "entityColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string, deprecated) - Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table\n" }, "filterCondition": { "type": "string", "description": "(string) - The filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "(string) - The full three-part (catalog, schema, table) name of the Delta table\n" }, "timeseriesColumn": { "type": "string", "description": "(string, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table\n" }, "transformationSql": { "type": "string", "description": "(string) - A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC \" pulumi-lang-dotnet=\" ColC \" pulumi-lang-go=\" colC \" pulumi-lang-python=\" col_c \" pulumi-lang-yaml=\" colC \" pulumi-lang-java=\" colC \" pulumi-lang-hcl=\" col_c \"\u003e colC \u003c/span\u003eFROM x.y.z WHERE\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e\u003e 0\" would have \u003cspan pulumi-lang-nodejs=\"`transformationSql`\" pulumi-lang-dotnet=\"`TransformationSql`\" pulumi-lang-go=\"`transformationSql`\" pulumi-lang-python=\"`transformation_sql`\" pulumi-lang-yaml=\"`transformationSql`\" pulumi-lang-java=\"`transformationSql`\" pulumi-lang-hcl=\"`transformation_sql`\"\u003e`transformationSql`\u003c/span\u003e \"*,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC\"\" pulumi-lang-dotnet=\" ColC\"\" pulumi-lang-go=\" colC\"\" pulumi-lang-python=\" col_c\"\" pulumi-lang-yaml=\" colC\"\" pulumi-lang-java=\" colC\"\" pulumi-lang-hcl=\" col_c\"\"\u003e colC\"\u003c/span\u003e)\nIf\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis not provided, all columns of the delta table are present in the DataSource dataframe\n" } }, "type": "object", "required": [ "fullName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceKafkaSource:getFeatureEngineeringFeaturesFeatureSourceKafkaSource": { "properties": { "entityColumnIdentifiers": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceKafkaSourceEntityColumnIdentifier:getFeatureEngineeringFeaturesFeatureSourceKafkaSourceEntityColumnIdentifier" }, "description": "(list of ColumnIdentifier, deprecated) - Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity column identifiers of the Kafka source\n" }, "filterCondition": { "type": "string", "description": "(string) - The filter condition applied to the source data before aggregation\n" }, "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" }, "timeseriesColumnIdentifier": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceKafkaSourceTimeseriesColumnIdentifier:getFeatureEngineeringFeaturesFeatureSourceKafkaSourceTimeseriesColumnIdentifier", "description": "(ColumnIdentifier, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column identifier of the Kafka source\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceKafkaSourceEntityColumnIdentifier:getFeatureEngineeringFeaturesFeatureSourceKafkaSourceEntityColumnIdentifier": { "properties": { "variantExprPath": { "type": "string", "description": "(string) - String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip\n" } }, "type": "object", "required": [ "variantExprPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceKafkaSourceTimeseriesColumnIdentifier:getFeatureEngineeringFeaturesFeatureSourceKafkaSourceTimeseriesColumnIdentifier": { "properties": { "variantExprPath": { "type": "string", "description": "(string) - String representation of the column name using dot-prefixed path notation. For nested fields, the leaf value is what will be present in materialized tables\nand expected to match at query time. For example, the leaf node of value.trip_details.location_details.pickup_zip is pickup_zip\n" } }, "type": "object", "required": [ "variantExprPath" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceRequestSource:getFeatureEngineeringFeaturesFeatureSourceRequestSource": { "properties": { "flatSchema": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchema:getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchema", "description": "(FlatSchema) - A flat schema with scalar-typed fields only\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchema:getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchema": { "properties": { "fields": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchemaField:getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchemaField" }, "description": "(list of FieldDefinition) - The list of fields in this schema\n" } }, "type": "object", "required": [ "fields" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchemaField:getFeatureEngineeringFeaturesFeatureSourceRequestSourceFlatSchemaField": { "properties": { "dataType": { "type": "string", "description": "(string) - The scalar data type of the field. Possible values are: `BINARY`, `BOOLEAN`, `DATE`, `DECIMAL`, `DOUBLE`, `FLOAT`, `INTEGER`, `LONG`, `SHORT`, `STRING`, `TIMESTAMP`\n" }, "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" } }, "type": "object", "required": [ "dataType", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindow:getFeatureEngineeringFeaturesFeatureTimeWindow": { "properties": { "continuous": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowContinuous:getFeatureEngineeringFeaturesFeatureTimeWindowContinuous", "description": "(ContinuousWindow, deprecated)\n" }, "rolling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowRolling:getFeatureEngineeringFeaturesFeatureTimeWindowRolling", "description": "(RollingWindow)\n" }, "sliding": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowSliding:getFeatureEngineeringFeaturesFeatureTimeWindowSliding", "description": "(SlidingWindow)\n" }, "tumbling": { "$ref": "#/types/databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowTumbling:getFeatureEngineeringFeaturesFeatureTimeWindowTumbling", "description": "(TumblingWindow)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowContinuous:getFeatureEngineeringFeaturesFeatureTimeWindowContinuous": { "properties": { "offset": { "type": "string", "description": "(string) - The offset of the continuous window (must be non-positive)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowRolling:getFeatureEngineeringFeaturesFeatureTimeWindowRolling": { "properties": { "delay": { "type": "string", "description": "(string) - The delay applied to the end of the rolling window (must be non-negative).\nFor example, delay=1d shifts the window end 1 day before the evaluation time\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowSliding:getFeatureEngineeringFeaturesFeatureTimeWindowSliding": { "properties": { "slideDuration": { "type": "string", "description": "(string) - The slide duration (interval by which windows advance, must be positive and less than duration)\n" }, "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "slideDuration", "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureTimeWindowTumbling:getFeatureEngineeringFeaturesFeatureTimeWindowTumbling": { "properties": { "windowDuration": { "type": "string", "description": "(string) - The duration of each tumbling window (non-overlapping, fixed-duration windows)\n" } }, "type": "object", "required": [ "windowDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesFeatureTimeseriesColumn:getFeatureEngineeringFeaturesFeatureTimeseriesColumn": { "properties": { "name": { "type": "string", "description": "(string) - The name of the timeseries column. For Kafka sources, use dot-prefixed path notation to\nreference fields within the key or value schema (e.g., \"value.event_timestamp\"). For nested\nfields, the leaf node name (e.g., \u003cspan pulumi-lang-nodejs=\"\"eventTimestamp\"\" pulumi-lang-dotnet=\"\"EventTimestamp\"\" pulumi-lang-go=\"\"eventTimestamp\"\" pulumi-lang-python=\"\"event_timestamp\"\" pulumi-lang-yaml=\"\"eventTimestamp\"\" pulumi-lang-java=\"\"eventTimestamp\"\" pulumi-lang-hcl=\"\"event_timestamp\"\"\u003e\"eventTimestamp\"\u003c/span\u003e from \"value.event_details.event_timestamp\")\nis what will be present in materialized tables and expected to match at query time.\nTODO(FS-939): Colon-prefixed notation (e.g., \"value:event_timestamp\") is supported for\nbackwards compatibility but is deprecated; migrate to dot notation\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringFeaturesProviderConfig:getFeatureEngineeringFeaturesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigAuthConfig:getFeatureEngineeringKafkaConfigAuthConfig": { "properties": { "mtlsConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfig:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfig", "description": "(MtlsConfig) - Mutual-TLS authentication. See MtlsConfig\n" }, "ucServiceCredentialName": { "type": "string", "description": "(string) - Name of the Unity Catalog service credential. This value will be set under the option databricks.serviceCredential\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfig:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfig": { "properties": { "disableHostnameVerification": { "type": "boolean", "description": "(boolean) - Set to true only when the broker certificate's SAN intentionally does not match\nthe connection endpoint — for example when reaching the cluster through a\nPrivateLink endpoint whose DNS name is not in the broker certificate. Skipping\nthe hostname check removes a defense against man-in-the-middle attacks; do not\nenable casually. mTLS client authentication is unaffected by this option.\n" }, "keyPasswordRef": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef", "description": "(SecretScopeReference) - Secret-scope reference for the private key password. Often the same value as the\nkeystore password (keytool's default), but provided as a separate field because\nApache Kafka requires it as a distinct option (kafka.ssl.key.password)\n" }, "keystoreLocation": { "type": "string", "description": "(string) - Unity Catalog volume path to the JKS keystore file containing the client certificate\nand private key. e.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/client.jks\". The\nmaterialization compute must have read permission on this volume\n" }, "keystorePasswordRef": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef", "description": "(SecretScopeReference) - Secret-scope reference for the JKS keystore password\n" }, "truststoreLocation": { "type": "string", "description": "(string) - Unity Catalog volume path to the JKS truststore file containing the CA certificate(s)\ntrusted to verify the Kafka broker's server certificate.\ne.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/truststore.jks\"\n" }, "truststorePasswordRef": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef", "description": "(SecretScopeReference) - Secret-scope reference for the JKS truststore password\n" } }, "type": "object", "required": [ "keyPasswordRef", "keystoreLocation", "keystorePasswordRef", "truststoreLocation", "truststorePasswordRef" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeyPasswordRef": { "properties": { "key": { "type": "string", "description": "(string) - The key within the scope\n" }, "scope": { "type": "string", "description": "(string) - The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef": { "properties": { "key": { "type": "string", "description": "(string) - The key within the scope\n" }, "scope": { "type": "string", "description": "(string) - The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef:getFeatureEngineeringKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef": { "properties": { "key": { "type": "string", "description": "(string) - The key within the scope\n" }, "scope": { "type": "string", "description": "(string) - The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigBackfillSource:getFeatureEngineeringKafkaConfigBackfillSource": { "properties": { "deltaTableName": { "type": "string", "description": "(string) - The full three-part name (catalog, schema, name) of the Delta table containing the historical data to backfill\n" }, "deltaTableSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource:getFeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource", "description": "(DeltaTableSource, deprecated) - Deprecated: Use\u003cspan pulumi-lang-nodejs=\" deltaTableName \" pulumi-lang-dotnet=\" DeltaTableName \" pulumi-lang-go=\" deltaTableName \" pulumi-lang-python=\" delta_table_name \" pulumi-lang-yaml=\" deltaTableName \" pulumi-lang-java=\" deltaTableName \" pulumi-lang-hcl=\" delta_table_name \"\u003e deltaTableName \u003c/span\u003einstead. Kept for backwards compatibility.\nThe Delta table source containing the historical data to backfill.\nOnly the delta table name is used for backfill, other fields are ignored\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource:getFeatureEngineeringKafkaConfigBackfillSourceDeltaTableSource": { "properties": { "dataframeSchema": { "type": "string", "description": "(string) - Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colA\"\" pulumi-lang-dotnet=\"\"ColA\"\" pulumi-lang-go=\"\"colA\"\" pulumi-lang-python=\"\"col_a\"\" pulumi-lang-yaml=\"\"colA\"\" pulumi-lang-java=\"\"colA\"\" pulumi-lang-hcl=\"\"col_a\"\"\u003e\"colA\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colC\"\" pulumi-lang-dotnet=\"\"ColC\"\" pulumi-lang-go=\"\"colC\"\" pulumi-lang-python=\"\"col_c\"\" pulumi-lang-yaml=\"\"colC\"\" pulumi-lang-java=\"\"colC\"\" pulumi-lang-hcl=\"\"col_c\"\"\u003e\"colC\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}\n" }, "entityColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string, deprecated) - Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table\n" }, "filterCondition": { "type": "string", "description": "(string) - Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections\n" }, "fullName": { "type": "string", "description": "(string) - The full three-part (catalog, schema, table) name of the Delta table\n" }, "timeseriesColumn": { "type": "string", "description": "(string, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table\n" }, "transformationSql": { "type": "string", "description": "(string) - A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC \" pulumi-lang-dotnet=\" ColC \" pulumi-lang-go=\" colC \" pulumi-lang-python=\" col_c \" pulumi-lang-yaml=\" colC \" pulumi-lang-java=\" colC \" pulumi-lang-hcl=\" col_c \"\u003e colC \u003c/span\u003eFROM x.y.z WHERE\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e\u003e 0\" would have \u003cspan pulumi-lang-nodejs=\"`transformationSql`\" pulumi-lang-dotnet=\"`TransformationSql`\" pulumi-lang-go=\"`transformationSql`\" pulumi-lang-python=\"`transformation_sql`\" pulumi-lang-yaml=\"`transformationSql`\" pulumi-lang-java=\"`transformationSql`\" pulumi-lang-hcl=\"`transformation_sql`\"\u003e`transformationSql`\u003c/span\u003e \"*,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC\"\" pulumi-lang-dotnet=\" ColC\"\" pulumi-lang-go=\" colC\"\" pulumi-lang-python=\" col_c\"\" pulumi-lang-yaml=\" colC\"\" pulumi-lang-java=\" colC\"\" pulumi-lang-hcl=\" col_c\"\"\u003e colC\"\u003c/span\u003e)\nIf\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis not provided, all columns of the delta table are present in the DataSource dataframe\n" } }, "type": "object", "required": [ "fullName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigKeySchema:getFeatureEngineeringKafkaConfigKeySchema": { "properties": { "jsonSchema": { "type": "string", "description": "(string) - Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigProviderConfig:getFeatureEngineeringKafkaConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigSubscriptionMode:getFeatureEngineeringKafkaConfigSubscriptionMode": { "properties": { "assign": { "type": "string", "description": "(string) - A JSON string that contains the specific topic-partitions to consume from.\nFor example, for '{\"topicA\":[0,1],\"topicB\":[2,4]}', topicA's 0'th and 1st partitions will be consumed from\n" }, "subscribe": { "type": "string", "description": "(string) - A comma-separated list of Kafka topics to read from. For example, 'topicA,topicB,topicC'\n" }, "subscribePattern": { "type": "string", "description": "(string) - A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigValueSchema:getFeatureEngineeringKafkaConfigValueSchema": { "properties": { "jsonSchema": { "type": "string", "description": "(string) - Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfig:getFeatureEngineeringKafkaConfigsKafkaConfig": { "properties": { "authConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfig:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfig", "description": "(AuthConfig) - Authentication configuration for connection to topics\n" }, "backfillSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSource:getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSource", "description": "(BackfillSource) - A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config\n" }, "bootstrapServers": { "type": "string", "description": "(string) - A comma-separated list of host/port pairs pointing to Kafka cluster\n" }, "extraOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)\n" }, "keySchema": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigKeySchema:getFeatureEngineeringKafkaConfigsKafkaConfigKeySchema", "description": "(SchemaConfig) - Schema configuration for extracting message keys from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" }, "name": { "type": "string", "description": "(string) - Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigProviderConfig:getFeatureEngineeringKafkaConfigsKafkaConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "subscriptionMode": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigSubscriptionMode:getFeatureEngineeringKafkaConfigsKafkaConfigSubscriptionMode", "description": "(SubscriptionMode) - Options to configure which Kafka topics to pull data from\n" }, "valueSchema": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigValueSchema:getFeatureEngineeringKafkaConfigsKafkaConfigValueSchema", "description": "(SchemaConfig) - Schema configuration for extracting message values from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" } }, "type": "object", "required": [ "authConfig", "backfillSource", "bootstrapServers", "extraOptions", "keySchema", "name", "subscriptionMode", "valueSchema" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfig:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfig": { "properties": { "mtlsConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfig:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfig", "description": "(MtlsConfig) - Mutual-TLS authentication. See MtlsConfig\n" }, "ucServiceCredentialName": { "type": "string", "description": "(string) - Name of the Unity Catalog service credential. This value will be set under the option databricks.serviceCredential\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfig:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfig": { "properties": { "disableHostnameVerification": { "type": "boolean", "description": "(boolean) - Set to true only when the broker certificate's SAN intentionally does not match\nthe connection endpoint — for example when reaching the cluster through a\nPrivateLink endpoint whose DNS name is not in the broker certificate. Skipping\nthe hostname check removes a defense against man-in-the-middle attacks; do not\nenable casually. mTLS client authentication is unaffected by this option.\n" }, "keyPasswordRef": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeyPasswordRef:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeyPasswordRef", "description": "(SecretScopeReference) - Secret-scope reference for the private key password. Often the same value as the\nkeystore password (keytool's default), but provided as a separate field because\nApache Kafka requires it as a distinct option (kafka.ssl.key.password)\n" }, "keystoreLocation": { "type": "string", "description": "(string) - Unity Catalog volume path to the JKS keystore file containing the client certificate\nand private key. e.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/client.jks\". The\nmaterialization compute must have read permission on this volume\n" }, "keystorePasswordRef": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef", "description": "(SecretScopeReference) - Secret-scope reference for the JKS keystore password\n" }, "truststoreLocation": { "type": "string", "description": "(string) - Unity Catalog volume path to the JKS truststore file containing the CA certificate(s)\ntrusted to verify the Kafka broker's server certificate.\ne.g. \"/Volumes/\u003ccatalog\u003e/\u003cschema\u003e/\u003cvolume\u003e/truststore.jks\"\n" }, "truststorePasswordRef": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef", "description": "(SecretScopeReference) - Secret-scope reference for the JKS truststore password\n" } }, "type": "object", "required": [ "keyPasswordRef", "keystoreLocation", "keystorePasswordRef", "truststoreLocation", "truststorePasswordRef" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeyPasswordRef:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeyPasswordRef": { "properties": { "key": { "type": "string", "description": "(string) - The key within the scope\n" }, "scope": { "type": "string", "description": "(string) - The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigKeystorePasswordRef": { "properties": { "key": { "type": "string", "description": "(string) - The key within the scope\n" }, "scope": { "type": "string", "description": "(string) - The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef:getFeatureEngineeringKafkaConfigsKafkaConfigAuthConfigMtlsConfigTruststorePasswordRef": { "properties": { "key": { "type": "string", "description": "(string) - The key within the scope\n" }, "scope": { "type": "string", "description": "(string) - The Databricks secret scope name\n" } }, "type": "object", "required": [ "key", "scope" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSource:getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSource": { "properties": { "deltaTableName": { "type": "string", "description": "(string) - The full three-part name (catalog, schema, name) of the Delta table containing the historical data to backfill\n" }, "deltaTableSource": { "$ref": "#/types/databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSourceDeltaTableSource:getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSourceDeltaTableSource", "description": "(DeltaTableSource, deprecated) - Deprecated: Use\u003cspan pulumi-lang-nodejs=\" deltaTableName \" pulumi-lang-dotnet=\" DeltaTableName \" pulumi-lang-go=\" deltaTableName \" pulumi-lang-python=\" delta_table_name \" pulumi-lang-yaml=\" deltaTableName \" pulumi-lang-java=\" deltaTableName \" pulumi-lang-hcl=\" delta_table_name \"\u003e deltaTableName \u003c/span\u003einstead. Kept for backwards compatibility.\nThe Delta table source containing the historical data to backfill.\nOnly the delta table name is used for backfill, other fields are ignored\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSourceDeltaTableSource:getFeatureEngineeringKafkaConfigsKafkaConfigBackfillSourceDeltaTableSource": { "properties": { "dataframeSchema": { "type": "string", "description": "(string) - Schema of the resulting dataframe after transformations, in Spark StructType JSON format (from df.schema.json()).\nRequired if\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis specified.\nExample: {\"type\":\"struct\",\"fields\":[{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colA\"\" pulumi-lang-dotnet=\"\"ColA\"\" pulumi-lang-go=\"\"colA\"\" pulumi-lang-python=\"\"col_a\"\" pulumi-lang-yaml=\"\"colA\"\" pulumi-lang-java=\"\"colA\"\" pulumi-lang-hcl=\"\"col_a\"\"\u003e\"colA\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\u003cspan pulumi-lang-nodejs=\"\"colC\"\" pulumi-lang-dotnet=\"\"ColC\"\" pulumi-lang-go=\"\"colC\"\" pulumi-lang-python=\"\"col_c\"\" pulumi-lang-yaml=\"\"colC\"\" pulumi-lang-java=\"\"colC\"\" pulumi-lang-hcl=\"\"col_c\"\"\u003e\"colC\"\u003c/span\u003e,\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}\n" }, "entityColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string, deprecated) - Deprecated: Use Feature.entity instead. Kept for backwards compatibility.\nThe entity columns of the Delta table\n" }, "filterCondition": { "type": "string", "description": "(string) - Single WHERE clause to filter delta table before applying transformations. Will be row-wise evaluated, so should only include conditionals and projections\n" }, "fullName": { "type": "string", "description": "(string) - The full three-part (catalog, schema, table) name of the Delta table\n" }, "timeseriesColumn": { "type": "string", "description": "(string, deprecated) - Deprecated: Use Feature.timeseries_column instead. Kept for backwards compatibility.\nThe timeseries column of the Delta table\n" }, "transformationSql": { "type": "string", "description": "(string) - A single SQL SELECT expression applied after filter_condition.\nShould contains all the columns needed (eg. \"SELECT *,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC \" pulumi-lang-dotnet=\" ColC \" pulumi-lang-go=\" colC \" pulumi-lang-python=\" col_c \" pulumi-lang-yaml=\" colC \" pulumi-lang-java=\" colC \" pulumi-lang-hcl=\" col_c \"\u003e colC \u003c/span\u003eFROM x.y.z WHERE\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e\u003e 0\" would have \u003cspan pulumi-lang-nodejs=\"`transformationSql`\" pulumi-lang-dotnet=\"`TransformationSql`\" pulumi-lang-go=\"`transformationSql`\" pulumi-lang-python=\"`transformation_sql`\" pulumi-lang-yaml=\"`transformationSql`\" pulumi-lang-java=\"`transformationSql`\" pulumi-lang-hcl=\"`transformation_sql`\"\u003e`transformationSql`\u003c/span\u003e \"*,\u003cspan pulumi-lang-nodejs=\" colA \" pulumi-lang-dotnet=\" ColA \" pulumi-lang-go=\" colA \" pulumi-lang-python=\" col_a \" pulumi-lang-yaml=\" colA \" pulumi-lang-java=\" colA \" pulumi-lang-hcl=\" col_a \"\u003e colA \u003c/span\u003e+\u003cspan pulumi-lang-nodejs=\" colB \" pulumi-lang-dotnet=\" ColB \" pulumi-lang-go=\" colB \" pulumi-lang-python=\" col_b \" pulumi-lang-yaml=\" colB \" pulumi-lang-java=\" colB \" pulumi-lang-hcl=\" col_b \"\u003e colB \u003c/span\u003eAS\u003cspan pulumi-lang-nodejs=\" colC\"\" pulumi-lang-dotnet=\" ColC\"\" pulumi-lang-go=\" colC\"\" pulumi-lang-python=\" col_c\"\" pulumi-lang-yaml=\" colC\"\" pulumi-lang-java=\" colC\"\" pulumi-lang-hcl=\" col_c\"\"\u003e colC\"\u003c/span\u003e)\nIf\u003cspan pulumi-lang-nodejs=\" transformationSql \" pulumi-lang-dotnet=\" TransformationSql \" pulumi-lang-go=\" transformationSql \" pulumi-lang-python=\" transformation_sql \" pulumi-lang-yaml=\" transformationSql \" pulumi-lang-java=\" transformationSql \" pulumi-lang-hcl=\" transformation_sql \"\u003e transformationSql \u003c/span\u003eis not provided, all columns of the delta table are present in the DataSource dataframe\n" } }, "type": "object", "required": [ "fullName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigKeySchema:getFeatureEngineeringKafkaConfigsKafkaConfigKeySchema": { "properties": { "jsonSchema": { "type": "string", "description": "(string) - Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigProviderConfig:getFeatureEngineeringKafkaConfigsKafkaConfigProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigSubscriptionMode:getFeatureEngineeringKafkaConfigsKafkaConfigSubscriptionMode": { "properties": { "assign": { "type": "string", "description": "(string) - A JSON string that contains the specific topic-partitions to consume from.\nFor example, for '{\"topicA\":[0,1],\"topicB\":[2,4]}', topicA's 0'th and 1st partitions will be consumed from\n" }, "subscribe": { "type": "string", "description": "(string) - A comma-separated list of Kafka topics to read from. For example, 'topicA,topicB,topicC'\n" }, "subscribePattern": { "type": "string", "description": "(string) - A regular expression matching topics to subscribe to. For example, 'topic.*' will subscribe to all topics starting with 'topic'\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigsKafkaConfigValueSchema:getFeatureEngineeringKafkaConfigsKafkaConfigValueSchema": { "properties": { "jsonSchema": { "type": "string", "description": "(string) - Schema of the JSON object in standard IETF JSON schema format (https://json-schema.org/)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringKafkaConfigsProviderConfig:getFeatureEngineeringKafkaConfigsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeatureCronScheduleTrigger:getFeatureEngineeringMaterializedFeatureCronScheduleTrigger": { "properties": { "cronExpression": { "type": "string", "description": "(string) - The cron expression defining the schedule (e.g., \"0 0 * * *\" for daily at midnight)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringMaterializedFeatureOfflineStoreConfig:getFeatureEngineeringMaterializedFeatureOfflineStoreConfig": { "properties": { "catalogName": { "type": "string", "description": "(string) - The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "schemaName": { "type": "string", "description": "(string) - The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "tableNamePrefix": { "type": "string", "description": "(string) - Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix\n" } }, "type": "object", "required": [ "catalogName", "schemaName", "tableNamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeatureOnlineStoreConfig:getFeatureEngineeringMaterializedFeatureOnlineStoreConfig": { "properties": { "catalogName": { "type": "string", "description": "(string) - The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "onlineStoreName": { "type": "string", "description": "(string) - The name of the target online store\n" }, "schemaName": { "type": "string", "description": "(string) - The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "tableNamePrefix": { "type": "string", "description": "(string) - Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix\n" } }, "type": "object", "required": [ "catalogName", "onlineStoreName", "schemaName", "tableNamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeatureProviderConfig:getFeatureEngineeringMaterializedFeatureProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeatureStreamingMode:getFeatureEngineeringMaterializedFeatureStreamingMode": { "properties": { "mode": { "type": "string", "description": "(string) - The type of streaming mode used by the materialization pipeline. Possible values are: `STREAMING_MODE_TYPE_MBM`, `STREAMING_MODE_TYPE_RTM`\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringMaterializedFeatureTableTrigger:getFeatureEngineeringMaterializedFeatureTableTrigger": { "type": "object" }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeature:getFeatureEngineeringMaterializedFeaturesMaterializedFeature": { "properties": { "cronSchedule": { "type": "string", "description": "(string) - The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone\n" }, "cronScheduleTrigger": { "$ref": "#/types/databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureCronScheduleTrigger:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureCronScheduleTrigger", "description": "(CronSchedule) - A cron-based schedule trigger for the materialization pipeline\n" }, "featureName": { "type": "string", "description": "Filter by feature name. If specified, only materialized features materialized from this feature will be returned\n" }, "isOnline": { "type": "boolean", "description": "(boolean) - True if this is an online materialized feature. False if it is an offline materialized feature\n" }, "lastMaterializationTime": { "type": "string", "description": "(string) - The timestamp when the pipeline last ran and updated the materialized feature values.\nIf the pipeline has not run yet, this field will be null\n" }, "materializedFeatureId": { "type": "string", "description": "(string) - Server-assigned unique identifier for the materialized feature\n" }, "offlineStoreConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOfflineStoreConfig:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOfflineStoreConfig", "description": "(OfflineStoreConfig) - Destination for writing feature values to an offline Delta table\n" }, "onlineStoreConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOnlineStoreConfig:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOnlineStoreConfig", "description": "(OnlineStoreConfig) - Destination for writing feature values to an online Lakebase table\n" }, "pipelineScheduleState": { "type": "string", "description": "(string) - The schedule state of the materialization pipeline. Possible values are: `ACTIVE`, `PAUSED`, `SNAPSHOT`\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureProviderConfig:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "streamingMode": { "$ref": "#/types/databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureStreamingMode:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureStreamingMode", "description": "(StreamingMode) - The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads\n" }, "tableName": { "type": "string", "description": "(string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only\n" }, "tableTrigger": { "$ref": "#/types/databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureTableTrigger:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureTableTrigger", "description": "(TableTrigger) - A trigger that fires when the upstream source table changes\n" } }, "type": "object", "required": [ "cronSchedule", "cronScheduleTrigger", "featureName", "isOnline", "lastMaterializationTime", "materializedFeatureId", "offlineStoreConfig", "onlineStoreConfig", "pipelineScheduleState", "streamingMode", "tableName", "tableTrigger" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureCronScheduleTrigger:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureCronScheduleTrigger": { "properties": { "cronExpression": { "type": "string", "description": "(string) - The cron expression defining the schedule (e.g., \"0 0 * * *\" for daily at midnight)\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOfflineStoreConfig:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOfflineStoreConfig": { "properties": { "catalogName": { "type": "string", "description": "(string) - The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "schemaName": { "type": "string", "description": "(string) - The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "tableNamePrefix": { "type": "string", "description": "(string) - Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix\n" } }, "type": "object", "required": [ "catalogName", "schemaName", "tableNamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOnlineStoreConfig:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureOnlineStoreConfig": { "properties": { "catalogName": { "type": "string", "description": "(string) - The Unity Catalog catalog name. This name is also used as the Lakebase logical database name.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "onlineStoreName": { "type": "string", "description": "(string) - The name of the target online store\n" }, "schemaName": { "type": "string", "description": "(string) - The Unity Catalog schema name. This name is also used as the Lakebase schema name under the database.\nQuoting is handled by the backend where needed, do not pre-quote it\n" }, "tableNamePrefix": { "type": "string", "description": "(string) - Prefix for Unity Catalog table name.\nThe materialized feature will be stored in a Lakebase table with this prefix and a generated postfix\n" } }, "type": "object", "required": [ "catalogName", "onlineStoreName", "schemaName", "tableNamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureProviderConfig:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureStreamingMode:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureStreamingMode": { "properties": { "mode": { "type": "string", "description": "(string) - The type of streaming mode used by the materialization pipeline. Possible values are: `STREAMING_MODE_TYPE_MBM`, `STREAMING_MODE_TYPE_RTM`\n" } }, "type": "object" }, "databricks:index/getFeatureEngineeringMaterializedFeaturesMaterializedFeatureTableTrigger:getFeatureEngineeringMaterializedFeaturesMaterializedFeatureTableTrigger": { "type": "object" }, "databricks:index/getFeatureEngineeringMaterializedFeaturesProviderConfig:getFeatureEngineeringMaterializedFeaturesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getFunctionsFunction:getFunctionsFunction": { "properties": { "browseOnly": { "type": "boolean", "description": "Indicates whether the principal is limited to retrieving metadata for the associated object through the `BROWSE` privilege when \u003cspan pulumi-lang-nodejs=\"`includeBrowse`\" pulumi-lang-dotnet=\"`IncludeBrowse`\" pulumi-lang-go=\"`includeBrowse`\" pulumi-lang-python=\"`include_browse`\" pulumi-lang-yaml=\"`includeBrowse`\" pulumi-lang-java=\"`includeBrowse`\" pulumi-lang-hcl=\"`include_browse`\"\u003e`includeBrowse`\u003c/span\u003e is enabled in the request.\n" }, "catalogName": { "type": "string", "description": "Name of databricks_catalog.\n" }, "comment": { "type": "string", "description": "User-provided free-form text description.\n" }, "createdAt": { "type": "integer", "description": "Time at which this function was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of function creator.\n" }, "dataType": { "type": "string", "description": "Scalar function return data type.\n" }, "externalLanguage": { "type": "string", "description": "External function language.\n" }, "externalName": { "type": "string", "description": "External function name.\n" }, "fullDataType": { "type": "string", "description": "Pretty printed function data type.\n" }, "fullName": { "type": "string", "description": "Full name of function, in form of catalog_name.schema_name.function__name\n" }, "functionId": { "type": "string", "description": "Id of Function, relative to parent schema.\n" }, "inputParams": { "$ref": "#/types/databricks:index/getFunctionsFunctionInputParams:getFunctionsFunctionInputParams", "description": "object describing input parameters. Consists of the single attribute:\n" }, "isDeterministic": { "type": "boolean", "description": "Boolean flag specifying whether the function is deterministic.\n" }, "isNullCall": { "type": "boolean", "description": "Boolean flag whether function null call.\n" }, "metastoreId": { "type": "string", "description": "Unique identifier of parent metastore.\n" }, "name": { "type": "string", "description": "Name of parameter.\n" }, "owner": { "type": "string", "description": "Username of current owner of function.\n" }, "parameterStyle": { "type": "string", "description": "Function parameter style. `S` is the value for SQL.\n" }, "properties": { "type": "string", "description": "JSON-serialized key-value pair map, encoded (escaped) as a string.\n" }, "returnParams": { "$ref": "#/types/databricks:index/getFunctionsFunctionReturnParams:getFunctionsFunctionReturnParams", "description": "Table function return parameters. See \u003cspan pulumi-lang-nodejs=\"`inputParams`\" pulumi-lang-dotnet=\"`InputParams`\" pulumi-lang-go=\"`inputParams`\" pulumi-lang-python=\"`input_params`\" pulumi-lang-yaml=\"`inputParams`\" pulumi-lang-java=\"`inputParams`\" pulumi-lang-hcl=\"`input_params`\"\u003e`inputParams`\u003c/span\u003e for description.\n" }, "routineBody": { "type": "string", "description": "Function language (`SQL` or `EXTERNAL`). When `EXTERNAL` is used, the language of the routine function should be specified in the \u003cspan pulumi-lang-nodejs=\"`externalLanguage`\" pulumi-lang-dotnet=\"`ExternalLanguage`\" pulumi-lang-go=\"`externalLanguage`\" pulumi-lang-python=\"`external_language`\" pulumi-lang-yaml=\"`externalLanguage`\" pulumi-lang-java=\"`externalLanguage`\" pulumi-lang-hcl=\"`external_language`\"\u003e`externalLanguage`\u003c/span\u003e field, and the \u003cspan pulumi-lang-nodejs=\"`returnParams`\" pulumi-lang-dotnet=\"`ReturnParams`\" pulumi-lang-go=\"`returnParams`\" pulumi-lang-python=\"`return_params`\" pulumi-lang-yaml=\"`returnParams`\" pulumi-lang-java=\"`returnParams`\" pulumi-lang-hcl=\"`return_params`\"\u003e`returnParams`\u003c/span\u003e of the function cannot be used (as `TABLE` return type is not supported), and the \u003cspan pulumi-lang-nodejs=\"`sqlDataAccess`\" pulumi-lang-dotnet=\"`SqlDataAccess`\" pulumi-lang-go=\"`sqlDataAccess`\" pulumi-lang-python=\"`sql_data_access`\" pulumi-lang-yaml=\"`sqlDataAccess`\" pulumi-lang-java=\"`sqlDataAccess`\" pulumi-lang-hcl=\"`sql_data_access`\"\u003e`sqlDataAccess`\u003c/span\u003e field must be `NO_SQL`.\n" }, "routineDefinition": { "type": "string", "description": "Function body.\n" }, "routineDependencies": { "$ref": "#/types/databricks:index/getFunctionsFunctionRoutineDependencies:getFunctionsFunctionRoutineDependencies", "description": "Function dependencies.\n" }, "schemaName": { "type": "string", "description": "Name of databricks_schema.\n" }, "securityType": { "type": "string", "description": "Function security type. (Enum: `DEFINER`).\n" }, "specificName": { "type": "string", "description": "Specific name of the function; Reserved for future use.\n" }, "sqlDataAccess": { "type": "string", "description": "Function SQL data access (`CONTAINS_SQL`, `READS_SQL_DATA`, `NO_SQL`).\n" }, "sqlPath": { "type": "string", "description": "List of schemes whose objects can be referenced without qualification.\n" }, "updatedAt": { "type": "integer", "description": "Time at which this function was created, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified function.\n" } }, "type": "object" }, "databricks:index/getFunctionsFunctionInputParams:getFunctionsFunctionInputParams": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFunctionsFunctionInputParamsParameter:getFunctionsFunctionInputParamsParameter" }, "description": "The array of definitions of the function's parameters:\n" } }, "type": "object" }, "databricks:index/getFunctionsFunctionInputParamsParameter:getFunctionsFunctionInputParamsParameter": { "properties": { "comment": { "type": "string", "description": "User-provided free-form text description.\n" }, "name": { "type": "string", "description": "Name of parameter.\n" }, "parameterDefault": { "type": "string", "description": "Default value of the parameter.\n" }, "parameterMode": { "type": "string", "description": "The mode of the function parameter.\n" }, "parameterType": { "type": "string", "description": "The type of function parameter (`PARAM` or `COLUMN`).\n" }, "position": { "type": "integer", "description": "Ordinal position of column (starting at position 0).\n" }, "typeIntervalType": { "type": "string", "description": "Format of IntervalType.\n" }, "typeJson": { "type": "string", "description": "Full data type spec, JSON-serialized.\n" }, "typeName": { "type": "string", "description": "Name of type (INT, STRUCT, MAP, etc.).\n" }, "typePrecision": { "type": "integer", "description": "Digits of precision; required on Create for DecimalTypes.\n" }, "typeScale": { "type": "integer", "description": "Digits to right of decimal; Required on Create for DecimalTypes.\n" }, "typeText": { "type": "string", "description": "Full data type spec, SQL/catalogString text.\n" } }, "type": "object", "required": [ "name", "position", "typeName", "typeText" ] }, "databricks:index/getFunctionsFunctionReturnParams:getFunctionsFunctionReturnParams": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFunctionsFunctionReturnParamsParameter:getFunctionsFunctionReturnParamsParameter" }, "description": "The array of definitions of the function's parameters:\n" } }, "type": "object" }, "databricks:index/getFunctionsFunctionReturnParamsParameter:getFunctionsFunctionReturnParamsParameter": { "properties": { "comment": { "type": "string", "description": "User-provided free-form text description.\n" }, "name": { "type": "string", "description": "Name of parameter.\n" }, "parameterDefault": { "type": "string", "description": "Default value of the parameter.\n" }, "parameterMode": { "type": "string", "description": "The mode of the function parameter.\n" }, "parameterType": { "type": "string", "description": "The type of function parameter (`PARAM` or `COLUMN`).\n" }, "position": { "type": "integer", "description": "Ordinal position of column (starting at position 0).\n" }, "typeIntervalType": { "type": "string", "description": "Format of IntervalType.\n" }, "typeJson": { "type": "string", "description": "Full data type spec, JSON-serialized.\n" }, "typeName": { "type": "string", "description": "Name of type (INT, STRUCT, MAP, etc.).\n" }, "typePrecision": { "type": "integer", "description": "Digits of precision; required on Create for DecimalTypes.\n" }, "typeScale": { "type": "integer", "description": "Digits to right of decimal; Required on Create for DecimalTypes.\n" }, "typeText": { "type": "string", "description": "Full data type spec, SQL/catalogString text.\n" } }, "type": "object", "required": [ "name", "position", "typeName", "typeText" ] }, "databricks:index/getFunctionsFunctionRoutineDependencies:getFunctionsFunctionRoutineDependencies": { "properties": { "dependencies": { "type": "array", "items": { "$ref": "#/types/databricks:index/getFunctionsFunctionRoutineDependenciesDependency:getFunctionsFunctionRoutineDependenciesDependency" } } }, "type": "object" }, "databricks:index/getFunctionsFunctionRoutineDependenciesDependency:getFunctionsFunctionRoutineDependenciesDependency": { "properties": { "connection": { "$ref": "#/types/databricks:index/getFunctionsFunctionRoutineDependenciesDependencyConnection:getFunctionsFunctionRoutineDependenciesDependencyConnection" }, "credential": { "$ref": "#/types/databricks:index/getFunctionsFunctionRoutineDependenciesDependencyCredential:getFunctionsFunctionRoutineDependenciesDependencyCredential" }, "function": { "$ref": "#/types/databricks:index/getFunctionsFunctionRoutineDependenciesDependencyFunction:getFunctionsFunctionRoutineDependenciesDependencyFunction" }, "table": { "$ref": "#/types/databricks:index/getFunctionsFunctionRoutineDependenciesDependencyTable:getFunctionsFunctionRoutineDependenciesDependencyTable" } }, "type": "object" }, "databricks:index/getFunctionsFunctionRoutineDependenciesDependencyConnection:getFunctionsFunctionRoutineDependenciesDependencyConnection": { "properties": { "connectionName": { "type": "string" } }, "type": "object" }, "databricks:index/getFunctionsFunctionRoutineDependenciesDependencyCredential:getFunctionsFunctionRoutineDependenciesDependencyCredential": { "properties": { "credentialName": { "type": "string" } }, "type": "object" }, "databricks:index/getFunctionsFunctionRoutineDependenciesDependencyFunction:getFunctionsFunctionRoutineDependenciesDependencyFunction": { "properties": { "functionFullName": { "type": "string" } }, "type": "object", "required": [ "functionFullName" ] }, "databricks:index/getFunctionsFunctionRoutineDependenciesDependencyTable:getFunctionsFunctionRoutineDependenciesDependencyTable": { "properties": { "tableFullName": { "type": "string" } }, "type": "object", "required": [ "tableFullName" ] }, "databricks:index/getFunctionsProviderConfig:getFunctionsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getGroupProviderConfig:getGroupProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getInstancePoolPoolInfo:getInstancePoolPoolInfo": { "properties": { "awsAttributes": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoAwsAttributes:getInstancePoolPoolInfoAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoAzureAttributes:getInstancePoolPoolInfoAzureAttributes" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "defaultTags": { "type": "object", "additionalProperties": { "type": "string" } }, "diskSpec": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoDiskSpec:getInstancePoolPoolInfoDiskSpec" }, "enableElasticDisk": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoGcpAttributes:getInstancePoolPoolInfoGcpAttributes" }, "idleInstanceAutoterminationMinutes": { "type": "integer" }, "instancePoolFleetAttributes": { "type": "array", "items": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttribute:getInstancePoolPoolInfoInstancePoolFleetAttribute" } }, "instancePoolId": { "type": "string" }, "instancePoolName": { "type": "string" }, "maxCapacity": { "type": "integer" }, "minIdleInstances": { "type": "integer" }, "nodeTypeFlexibility": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoNodeTypeFlexibility:getInstancePoolPoolInfoNodeTypeFlexibility" }, "nodeTypeId": { "type": "string" }, "preloadedDockerImages": { "type": "array", "items": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoPreloadedDockerImage:getInstancePoolPoolInfoPreloadedDockerImage" } }, "preloadedSparkVersions": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "stats": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoStats:getInstancePoolPoolInfoStats" } }, "type": "object", "required": [ "defaultTags", "idleInstanceAutoterminationMinutes", "instancePoolId", "instancePoolName" ], "language": { "nodejs": { "requiredInputs": [ "idleInstanceAutoterminationMinutes", "instancePoolName" ] } } }, "databricks:index/getInstancePoolPoolInfoAwsAttributes:getInstancePoolPoolInfoAwsAttributes": { "properties": { "availability": { "type": "string" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object", "required": [ "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getInstancePoolPoolInfoAzureAttributes:getInstancePoolPoolInfoAzureAttributes": { "properties": { "availability": { "type": "string" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getInstancePoolPoolInfoDiskSpec:getInstancePoolPoolInfoDiskSpec": { "properties": { "diskCount": { "type": "integer" }, "diskSize": { "type": "integer" }, "diskType": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoDiskSpecDiskType:getInstancePoolPoolInfoDiskSpecDiskType" } }, "type": "object" }, "databricks:index/getInstancePoolPoolInfoDiskSpecDiskType:getInstancePoolPoolInfoDiskSpecDiskType": { "properties": { "azureDiskVolumeType": { "type": "string" }, "ebsVolumeType": { "type": "string" } }, "type": "object" }, "databricks:index/getInstancePoolPoolInfoGcpAttributes:getInstancePoolPoolInfoGcpAttributes": { "properties": { "gcpAvailability": { "type": "string" }, "localSsdCount": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object", "required": [ "localSsdCount", "zoneId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttribute:getInstancePoolPoolInfoInstancePoolFleetAttribute": { "properties": { "fleetOnDemandOption": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttributeFleetOnDemandOption:getInstancePoolPoolInfoInstancePoolFleetAttributeFleetOnDemandOption" }, "fleetSpotOption": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttributeFleetSpotOption:getInstancePoolPoolInfoInstancePoolFleetAttributeFleetSpotOption" }, "launchTemplateOverrides": { "type": "array", "items": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttributeLaunchTemplateOverride:getInstancePoolPoolInfoInstancePoolFleetAttributeLaunchTemplateOverride" } } }, "type": "object", "required": [ "launchTemplateOverrides" ] }, "databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttributeFleetOnDemandOption:getInstancePoolPoolInfoInstancePoolFleetAttributeFleetOnDemandOption": { "properties": { "allocationStrategy": { "type": "string" }, "instancePoolsToUseCount": { "type": "integer" } }, "type": "object", "required": [ "allocationStrategy" ] }, "databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttributeFleetSpotOption:getInstancePoolPoolInfoInstancePoolFleetAttributeFleetSpotOption": { "properties": { "allocationStrategy": { "type": "string" }, "instancePoolsToUseCount": { "type": "integer" } }, "type": "object", "required": [ "allocationStrategy" ] }, "databricks:index/getInstancePoolPoolInfoInstancePoolFleetAttributeLaunchTemplateOverride:getInstancePoolPoolInfoInstancePoolFleetAttributeLaunchTemplateOverride": { "properties": { "availabilityZone": { "type": "string" }, "instanceType": { "type": "string" } }, "type": "object", "required": [ "availabilityZone", "instanceType" ] }, "databricks:index/getInstancePoolPoolInfoNodeTypeFlexibility:getInstancePoolPoolInfoNodeTypeFlexibility": { "properties": { "alternateNodeTypeIds": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "alternateNodeTypeIds" ] }, "databricks:index/getInstancePoolPoolInfoPreloadedDockerImage:getInstancePoolPoolInfoPreloadedDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getInstancePoolPoolInfoPreloadedDockerImageBasicAuth:getInstancePoolPoolInfoPreloadedDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getInstancePoolPoolInfoPreloadedDockerImageBasicAuth:getInstancePoolPoolInfoPreloadedDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/getInstancePoolPoolInfoStats:getInstancePoolPoolInfoStats": { "properties": { "idleCount": { "type": "integer" }, "pendingIdleCount": { "type": "integer" }, "pendingUsedCount": { "type": "integer" }, "usedCount": { "type": "integer" } }, "type": "object" }, "databricks:index/getInstancePoolProviderConfig:getInstancePoolProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getInstanceProfilesInstanceProfile:getInstanceProfilesInstanceProfile": { "properties": { "arn": { "type": "string", "description": "ARN of the instance profile.\n" }, "isMeta": { "type": "boolean", "description": "Whether the instance profile is a meta instance profile or not.\n" }, "name": { "type": "string", "description": "Name of the instance profile.\n" }, "roleArn": { "type": "string", "description": "ARN of the role attached to the instance profile.\n" } }, "type": "object", "required": [ "arn", "isMeta", "name", "roleArn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getInstanceProfilesProviderConfig:getInstanceProfilesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettings:getJobJobSettings": { "properties": { "createdTime": { "type": "integer" }, "creatorUserName": { "type": "string" }, "jobId": { "type": "integer" }, "runAsUserName": { "type": "string" }, "settings": { "$ref": "#/types/databricks:index/getJobJobSettingsSettings:getJobJobSettingsSettings" } }, "type": "object", "required": [ "runAsUserName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettings:getJobJobSettingsSettings": { "properties": { "continuous": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsContinuous:getJobJobSettingsSettingsContinuous" }, "dbtTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsDbtTask:getJobJobSettingsSettingsDbtTask" }, "deployment": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsDeployment:getJobJobSettingsSettingsDeployment" }, "description": { "type": "string" }, "editMode": { "type": "string" }, "emailNotifications": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsEmailNotifications:getJobJobSettingsSettingsEmailNotifications" }, "environments": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsEnvironment:getJobJobSettingsSettingsEnvironment" } }, "existingClusterId": { "type": "string" }, "format": { "type": "string" }, "gitSource": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsGitSource:getJobJobSettingsSettingsGitSource" }, "health": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsHealth:getJobJobSettingsSettingsHealth" }, "jobClusters": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobCluster:getJobJobSettingsSettingsJobCluster" } }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsLibrary:getJobJobSettingsSettingsLibrary" } }, "maxConcurrentRuns": { "type": "integer" }, "maxRetries": { "type": "integer" }, "minRetryIntervalMillis": { "type": "integer" }, "name": { "type": "string", "description": "the job name of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by id.\n" }, "newCluster": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewCluster:getJobJobSettingsSettingsNewCluster" }, "notebookTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNotebookTask:getJobJobSettingsSettingsNotebookTask" }, "notificationSettings": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNotificationSettings:getJobJobSettingsSettingsNotificationSettings" }, "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsParameter:getJobJobSettingsSettingsParameter" } }, "pipelineTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsPipelineTask:getJobJobSettingsSettingsPipelineTask" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsPythonWheelTask:getJobJobSettingsSettingsPythonWheelTask" }, "queue": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsQueue:getJobJobSettingsSettingsQueue" }, "retryOnTimeout": { "type": "boolean" }, "runAs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsRunAs:getJobJobSettingsSettingsRunAs" }, "runJobTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsRunJobTask:getJobJobSettingsSettingsRunJobTask" }, "schedule": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsSchedule:getJobJobSettingsSettingsSchedule" }, "sparkJarTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsSparkJarTask:getJobJobSettingsSettingsSparkJarTask" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsSparkPythonTask:getJobJobSettingsSettingsSparkPythonTask" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsSparkSubmitTask:getJobJobSettingsSettingsSparkSubmitTask" }, "tags": { "type": "object", "additionalProperties": { "type": "string" } }, "tasks": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTask:getJobJobSettingsSettingsTask" } }, "timeoutSeconds": { "type": "integer" }, "trigger": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTrigger:getJobJobSettingsSettingsTrigger" }, "webhookNotifications": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsWebhookNotifications:getJobJobSettingsSettingsWebhookNotifications" } }, "type": "object", "required": [ "format", "runAs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsContinuous:getJobJobSettingsSettingsContinuous": { "properties": { "pauseStatus": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsDbtTask:getJobJobSettingsSettingsDbtTask": { "properties": { "catalog": { "type": "string" }, "commands": { "type": "array", "items": { "type": "string" } }, "profilesDirectory": { "type": "string" }, "projectDirectory": { "type": "string" }, "schema": { "type": "string" }, "source": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "commands" ] }, "databricks:index/getJobJobSettingsSettingsDeployment:getJobJobSettingsSettingsDeployment": { "properties": { "deploymentId": { "type": "string" }, "kind": { "type": "string" }, "metadataFilePath": { "type": "string" }, "versionId": { "type": "string" } }, "type": "object", "required": [ "kind" ] }, "databricks:index/getJobJobSettingsSettingsEmailNotifications:getJobJobSettingsSettingsEmailNotifications": { "properties": { "noAlertForSkippedRuns": { "type": "boolean" }, "onDurationWarningThresholdExceededs": { "type": "array", "items": { "type": "string" } }, "onFailures": { "type": "array", "items": { "type": "string" } }, "onStarts": { "type": "array", "items": { "type": "string" } }, "onStreamingBacklogExceededs": { "type": "array", "items": { "type": "string" } }, "onSuccesses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsEnvironment:getJobJobSettingsSettingsEnvironment": { "properties": { "environmentKey": { "type": "string" }, "spec": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsEnvironmentSpec:getJobJobSettingsSettingsEnvironmentSpec" } }, "type": "object", "required": [ "environmentKey" ] }, "databricks:index/getJobJobSettingsSettingsEnvironmentSpec:getJobJobSettingsSettingsEnvironmentSpec": { "properties": { "baseEnvironment": { "type": "string" }, "client": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "environmentVersion": { "type": "string" }, "javaDependencies": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsGitSource:getJobJobSettingsSettingsGitSource": { "properties": { "branch": { "type": "string" }, "commit": { "type": "string" }, "jobSource": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsGitSourceJobSource:getJobJobSettingsSettingsGitSourceJobSource" }, "provider": { "type": "string" }, "tag": { "type": "string" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getJobJobSettingsSettingsGitSourceJobSource:getJobJobSettingsSettingsGitSourceJobSource": { "properties": { "dirtyState": { "type": "string" }, "importFromGitBranch": { "type": "string" }, "jobConfigPath": { "type": "string" } }, "type": "object", "required": [ "importFromGitBranch", "jobConfigPath" ] }, "databricks:index/getJobJobSettingsSettingsHealth:getJobJobSettingsSettingsHealth": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsHealthRule:getJobJobSettingsSettingsHealthRule" } } }, "type": "object", "required": [ "rules" ] }, "databricks:index/getJobJobSettingsSettingsHealthRule:getJobJobSettingsSettingsHealthRule": { "properties": { "metric": { "type": "string" }, "op": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "metric", "op", "value" ] }, "databricks:index/getJobJobSettingsSettingsJobCluster:getJobJobSettingsSettingsJobCluster": { "properties": { "jobClusterKey": { "type": "string" }, "newCluster": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewCluster:getJobJobSettingsSettingsJobClusterNewCluster" } }, "type": "object", "required": [ "jobClusterKey", "newCluster" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewCluster:getJobJobSettingsSettingsJobClusterNewCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterAutoscale:getJobJobSettingsSettingsJobClusterNewClusterAutoscale" }, "autoterminationMinutes": { "type": "integer" }, "awsAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterAwsAttributes:getJobJobSettingsSettingsJobClusterNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterAzureAttributes:getJobJobSettingsSettingsJobClusterNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterLogConf:getJobJobSettingsSettingsJobClusterNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfo:getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterDockerImage:getJobJobSettingsSettingsJobClusterNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterGcpAttributes:getJobJobSettingsSettingsJobClusterNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScript:getJobJobSettingsSettingsJobClusterNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "workloadType": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterWorkloadType:getJobJobSettingsSettingsJobClusterNewClusterWorkloadType" } }, "type": "object", "required": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "numWorkers" ], "language": { "nodejs": { "requiredInputs": [ "numWorkers" ] } } }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterAutoscale:getJobJobSettingsSettingsJobClusterNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterAwsAttributes:getJobJobSettingsSettingsJobClusterNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterAzureAttributes:getJobJobSettingsSettingsJobClusterNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterLogConf:getJobJobSettingsSettingsJobClusterNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfS3:getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfS3" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfS3:getJobJobSettingsSettingsJobClusterNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfo:getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsJobClusterNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterDockerImage:getJobJobSettingsSettingsJobClusterNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsJobClusterNewClusterDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsJobClusterNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterGcpAttributes:getJobJobSettingsSettingsJobClusterNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScript:getJobJobSettingsSettingsJobClusterNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptAbfss:getJobJobSettingsSettingsJobClusterNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptDbfs:getJobJobSettingsSettingsJobClusterNewClusterInitScriptDbfs" }, "file": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptFile:getJobJobSettingsSettingsJobClusterNewClusterInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptGcs:getJobJobSettingsSettingsJobClusterNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptS3:getJobJobSettingsSettingsJobClusterNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptVolumes:getJobJobSettingsSettingsJobClusterNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptWorkspace:getJobJobSettingsSettingsJobClusterNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptAbfss:getJobJobSettingsSettingsJobClusterNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptDbfs:getJobJobSettingsSettingsJobClusterNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptFile:getJobJobSettingsSettingsJobClusterNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptGcs:getJobJobSettingsSettingsJobClusterNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptS3:getJobJobSettingsSettingsJobClusterNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptVolumes:getJobJobSettingsSettingsJobClusterNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterInitScriptWorkspace:getJobJobSettingsSettingsJobClusterNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterWorkloadType:getJobJobSettingsSettingsJobClusterNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsJobClusterNewClusterWorkloadTypeClients:getJobJobSettingsSettingsJobClusterNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/getJobJobSettingsSettingsJobClusterNewClusterWorkloadTypeClients:getJobJobSettingsSettingsJobClusterNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsLibrary:getJobJobSettingsSettingsLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsLibraryCran:getJobJobSettingsSettingsLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsLibraryMaven:getJobJobSettingsSettingsLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsLibraryProviderConfig:getJobJobSettingsSettingsLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsLibraryPypi:getJobJobSettingsSettingsLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "required": [ "providerConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsLibraryCran:getJobJobSettingsSettingsLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getJobJobSettingsSettingsLibraryMaven:getJobJobSettingsSettingsLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/getJobJobSettingsSettingsLibraryProviderConfig:getJobJobSettingsSettingsLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsLibraryPypi:getJobJobSettingsSettingsLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getJobJobSettingsSettingsNewCluster:getJobJobSettingsSettingsNewCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterAutoscale:getJobJobSettingsSettingsNewClusterAutoscale" }, "autoterminationMinutes": { "type": "integer" }, "awsAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterAwsAttributes:getJobJobSettingsSettingsNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterAzureAttributes:getJobJobSettingsSettingsNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterClusterLogConf:getJobJobSettingsSettingsNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterClusterMountInfo:getJobJobSettingsSettingsNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterDockerImage:getJobJobSettingsSettingsNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterGcpAttributes:getJobJobSettingsSettingsNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScript:getJobJobSettingsSettingsNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "workloadType": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterWorkloadType:getJobJobSettingsSettingsNewClusterWorkloadType" } }, "type": "object", "required": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "numWorkers" ], "language": { "nodejs": { "requiredInputs": [ "numWorkers" ] } } }, "databricks:index/getJobJobSettingsSettingsNewClusterAutoscale:getJobJobSettingsSettingsNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNewClusterAwsAttributes:getJobJobSettingsSettingsNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNewClusterAzureAttributes:getJobJobSettingsSettingsNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNewClusterClusterLogConf:getJobJobSettingsSettingsNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterClusterLogConfS3:getJobJobSettingsSettingsNewClusterClusterLogConfS3" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterClusterLogConfS3:getJobJobSettingsSettingsNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterClusterMountInfo:getJobJobSettingsSettingsNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterDockerImage:getJobJobSettingsSettingsNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsNewClusterDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterGcpAttributes:getJobJobSettingsSettingsNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScript:getJobJobSettingsSettingsNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptAbfss:getJobJobSettingsSettingsNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptDbfs:getJobJobSettingsSettingsNewClusterInitScriptDbfs" }, "file": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptFile:getJobJobSettingsSettingsNewClusterInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptGcs:getJobJobSettingsSettingsNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptS3:getJobJobSettingsSettingsNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptVolumes:getJobJobSettingsSettingsNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterInitScriptWorkspace:getJobJobSettingsSettingsNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptAbfss:getJobJobSettingsSettingsNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptDbfs:getJobJobSettingsSettingsNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptFile:getJobJobSettingsSettingsNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptGcs:getJobJobSettingsSettingsNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptS3:getJobJobSettingsSettingsNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptVolumes:getJobJobSettingsSettingsNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterInitScriptWorkspace:getJobJobSettingsSettingsNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterWorkloadType:getJobJobSettingsSettingsNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsNewClusterWorkloadTypeClients:getJobJobSettingsSettingsNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/getJobJobSettingsSettingsNewClusterWorkloadTypeClients:getJobJobSettingsSettingsNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsNotebookTask:getJobJobSettingsSettingsNotebookTask": { "properties": { "baseParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "notebookPath": { "type": "string" }, "source": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "notebookPath" ] }, "databricks:index/getJobJobSettingsSettingsNotificationSettings:getJobJobSettingsSettingsNotificationSettings": { "properties": { "noAlertForCanceledRuns": { "type": "boolean" }, "noAlertForSkippedRuns": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsParameter:getJobJobSettingsSettingsParameter": { "properties": { "default": { "type": "string" }, "name": { "type": "string", "description": "the job name of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by id.\n" } }, "type": "object", "required": [ "default", "name" ] }, "databricks:index/getJobJobSettingsSettingsPipelineTask:getJobJobSettingsSettingsPipelineTask": { "properties": { "fullRefresh": { "type": "boolean" }, "pipelineId": { "type": "string" } }, "type": "object", "required": [ "pipelineId" ] }, "databricks:index/getJobJobSettingsSettingsPythonWheelTask:getJobJobSettingsSettingsPythonWheelTask": { "properties": { "entryPoint": { "type": "string" }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "packageName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsQueue:getJobJobSettingsSettingsQueue": { "properties": { "enabled": { "type": "boolean" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/getJobJobSettingsSettingsRunAs:getJobJobSettingsSettingsRunAs": { "properties": { "servicePrincipalName": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsRunJobTask:getJobJobSettingsSettingsRunJobTask": { "properties": { "jobId": { "type": "integer" }, "jobParameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "jobId" ] }, "databricks:index/getJobJobSettingsSettingsSchedule:getJobJobSettingsSettingsSchedule": { "properties": { "pauseStatus": { "type": "string" }, "quartzCronExpression": { "type": "string" }, "timezoneId": { "type": "string" } }, "type": "object", "required": [ "quartzCronExpression", "timezoneId" ] }, "databricks:index/getJobJobSettingsSettingsSparkJarTask:getJobJobSettingsSettingsSparkJarTask": { "properties": { "jarUri": { "type": "string" }, "mainClassName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsSparkPythonTask:getJobJobSettingsSettingsSparkPythonTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" } }, "pythonFile": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "pythonFile" ] }, "databricks:index/getJobJobSettingsSettingsSparkSubmitTask:getJobJobSettingsSettingsSparkSubmitTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTask:getJobJobSettingsSettingsTask": { "properties": { "conditionTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskConditionTask:getJobJobSettingsSettingsTaskConditionTask" }, "dashboardTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskDashboardTask:getJobJobSettingsSettingsTaskDashboardTask" }, "dbtTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskDbtTask:getJobJobSettingsSettingsTaskDbtTask" }, "dependsOns": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskDependsOn:getJobJobSettingsSettingsTaskDependsOn" } }, "description": { "type": "string" }, "emailNotifications": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskEmailNotifications:getJobJobSettingsSettingsTaskEmailNotifications" }, "environmentKey": { "type": "string" }, "existingClusterId": { "type": "string" }, "forEachTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTask:getJobJobSettingsSettingsTaskForEachTask" }, "health": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskHealth:getJobJobSettingsSettingsTaskHealth" }, "jobClusterKey": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskLibrary:getJobJobSettingsSettingsTaskLibrary" } }, "maxRetries": { "type": "integer" }, "minRetryIntervalMillis": { "type": "integer" }, "newCluster": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewCluster:getJobJobSettingsSettingsTaskNewCluster" }, "notebookTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNotebookTask:getJobJobSettingsSettingsTaskNotebookTask" }, "notificationSettings": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNotificationSettings:getJobJobSettingsSettingsTaskNotificationSettings" }, "pipelineTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskPipelineTask:getJobJobSettingsSettingsTaskPipelineTask" }, "powerBiTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskPowerBiTask:getJobJobSettingsSettingsTaskPowerBiTask" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskPythonWheelTask:getJobJobSettingsSettingsTaskPythonWheelTask" }, "retryOnTimeout": { "type": "boolean" }, "runIf": { "type": "string" }, "runJobTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskRunJobTask:getJobJobSettingsSettingsTaskRunJobTask" }, "sparkJarTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSparkJarTask:getJobJobSettingsSettingsTaskSparkJarTask" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSparkPythonTask:getJobJobSettingsSettingsTaskSparkPythonTask" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSparkSubmitTask:getJobJobSettingsSettingsTaskSparkSubmitTask" }, "sqlTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTask:getJobJobSettingsSettingsTaskSqlTask" }, "taskKey": { "type": "string" }, "timeoutSeconds": { "type": "integer" }, "webhookNotifications": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskWebhookNotifications:getJobJobSettingsSettingsTaskWebhookNotifications" } }, "type": "object", "required": [ "retryOnTimeout", "taskKey" ], "language": { "nodejs": { "requiredInputs": [ "taskKey" ] } } }, "databricks:index/getJobJobSettingsSettingsTaskConditionTask:getJobJobSettingsSettingsTaskConditionTask": { "properties": { "left": { "type": "string" }, "op": { "type": "string" }, "right": { "type": "string" } }, "type": "object", "required": [ "left", "op", "right" ] }, "databricks:index/getJobJobSettingsSettingsTaskDashboardTask:getJobJobSettingsSettingsTaskDashboardTask": { "properties": { "dashboardId": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "subscription": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskDashboardTaskSubscription:getJobJobSettingsSettingsTaskDashboardTaskSubscription" }, "warehouseId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskDashboardTaskSubscription:getJobJobSettingsSettingsTaskDashboardTaskSubscription": { "properties": { "customSubject": { "type": "string" }, "paused": { "type": "boolean" }, "subscribers": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskDashboardTaskSubscriptionSubscriber:getJobJobSettingsSettingsTaskDashboardTaskSubscriptionSubscriber" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskDashboardTaskSubscriptionSubscriber:getJobJobSettingsSettingsTaskDashboardTaskSubscriptionSubscriber": { "properties": { "destinationId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskDbtTask:getJobJobSettingsSettingsTaskDbtTask": { "properties": { "catalog": { "type": "string" }, "commands": { "type": "array", "items": { "type": "string" } }, "profilesDirectory": { "type": "string" }, "projectDirectory": { "type": "string" }, "schema": { "type": "string" }, "source": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "commands" ] }, "databricks:index/getJobJobSettingsSettingsTaskDependsOn:getJobJobSettingsSettingsTaskDependsOn": { "properties": { "outcome": { "type": "string" }, "taskKey": { "type": "string" } }, "type": "object", "required": [ "taskKey" ] }, "databricks:index/getJobJobSettingsSettingsTaskEmailNotifications:getJobJobSettingsSettingsTaskEmailNotifications": { "properties": { "noAlertForSkippedRuns": { "type": "boolean" }, "onDurationWarningThresholdExceededs": { "type": "array", "items": { "type": "string" } }, "onFailures": { "type": "array", "items": { "type": "string" } }, "onStarts": { "type": "array", "items": { "type": "string" } }, "onStreamingBacklogExceededs": { "type": "array", "items": { "type": "string" } }, "onSuccesses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTask:getJobJobSettingsSettingsTaskForEachTask": { "properties": { "concurrency": { "type": "integer" }, "inputs": { "type": "string" }, "task": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTask:getJobJobSettingsSettingsTaskForEachTaskTask" } }, "type": "object", "required": [ "inputs", "task" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTask:getJobJobSettingsSettingsTaskForEachTaskTask": { "properties": { "conditionTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskConditionTask:getJobJobSettingsSettingsTaskForEachTaskTaskConditionTask" }, "dashboardTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTask:getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTask" }, "dbtTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDbtTask:getJobJobSettingsSettingsTaskForEachTaskTaskDbtTask" }, "dependsOns": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDependsOn:getJobJobSettingsSettingsTaskForEachTaskTaskDependsOn" } }, "description": { "type": "string" }, "emailNotifications": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskEmailNotifications:getJobJobSettingsSettingsTaskForEachTaskTaskEmailNotifications" }, "environmentKey": { "type": "string" }, "existingClusterId": { "type": "string" }, "health": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskHealth:getJobJobSettingsSettingsTaskForEachTaskTaskHealth" }, "jobClusterKey": { "type": "string" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibrary:getJobJobSettingsSettingsTaskForEachTaskTaskLibrary" } }, "maxRetries": { "type": "integer" }, "minRetryIntervalMillis": { "type": "integer" }, "newCluster": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewCluster:getJobJobSettingsSettingsTaskForEachTaskTaskNewCluster" }, "notebookTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNotebookTask:getJobJobSettingsSettingsTaskForEachTaskTaskNotebookTask" }, "notificationSettings": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNotificationSettings:getJobJobSettingsSettingsTaskForEachTaskTaskNotificationSettings" }, "pipelineTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPipelineTask:getJobJobSettingsSettingsTaskForEachTaskTaskPipelineTask" }, "powerBiTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTask:getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTask" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPythonWheelTask:getJobJobSettingsSettingsTaskForEachTaskTaskPythonWheelTask" }, "retryOnTimeout": { "type": "boolean" }, "runIf": { "type": "string" }, "runJobTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskRunJobTask:getJobJobSettingsSettingsTaskForEachTaskTaskRunJobTask" }, "sparkJarTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSparkJarTask:getJobJobSettingsSettingsTaskForEachTaskTaskSparkJarTask" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSparkPythonTask:getJobJobSettingsSettingsTaskForEachTaskTaskSparkPythonTask" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSparkSubmitTask:getJobJobSettingsSettingsTaskForEachTaskTaskSparkSubmitTask" }, "sqlTask": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTask:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTask" }, "taskKey": { "type": "string" }, "timeoutSeconds": { "type": "integer" }, "webhookNotifications": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotifications:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotifications" } }, "type": "object", "required": [ "retryOnTimeout", "taskKey" ], "language": { "nodejs": { "requiredInputs": [ "taskKey" ] } } }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskConditionTask:getJobJobSettingsSettingsTaskForEachTaskTaskConditionTask": { "properties": { "left": { "type": "string" }, "op": { "type": "string" }, "right": { "type": "string" } }, "type": "object", "required": [ "left", "op", "right" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTask:getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTask": { "properties": { "dashboardId": { "type": "string" }, "filters": { "type": "object", "additionalProperties": { "type": "string" } }, "subscription": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscription:getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscription" }, "warehouseId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscription:getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscription": { "properties": { "customSubject": { "type": "string" }, "paused": { "type": "boolean" }, "subscribers": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber:getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber:getJobJobSettingsSettingsTaskForEachTaskTaskDashboardTaskSubscriptionSubscriber": { "properties": { "destinationId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDbtTask:getJobJobSettingsSettingsTaskForEachTaskTaskDbtTask": { "properties": { "catalog": { "type": "string" }, "commands": { "type": "array", "items": { "type": "string" } }, "profilesDirectory": { "type": "string" }, "projectDirectory": { "type": "string" }, "schema": { "type": "string" }, "source": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "commands" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskDependsOn:getJobJobSettingsSettingsTaskForEachTaskTaskDependsOn": { "properties": { "outcome": { "type": "string" }, "taskKey": { "type": "string" } }, "type": "object", "required": [ "taskKey" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskEmailNotifications:getJobJobSettingsSettingsTaskForEachTaskTaskEmailNotifications": { "properties": { "noAlertForSkippedRuns": { "type": "boolean" }, "onDurationWarningThresholdExceededs": { "type": "array", "items": { "type": "string" } }, "onFailures": { "type": "array", "items": { "type": "string" } }, "onStarts": { "type": "array", "items": { "type": "string" } }, "onStreamingBacklogExceededs": { "type": "array", "items": { "type": "string" } }, "onSuccesses": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskHealth:getJobJobSettingsSettingsTaskForEachTaskTaskHealth": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskHealthRule:getJobJobSettingsSettingsTaskForEachTaskTaskHealthRule" } } }, "type": "object", "required": [ "rules" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskHealthRule:getJobJobSettingsSettingsTaskForEachTaskTaskHealthRule": { "properties": { "metric": { "type": "string" }, "op": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "metric", "op", "value" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibrary:getJobJobSettingsSettingsTaskForEachTaskTaskLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryCran:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryMaven:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryProviderConfig:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryPypi:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "required": [ "providerConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryCran:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryMaven:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryProviderConfig:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskLibraryPypi:getJobJobSettingsSettingsTaskForEachTaskTaskLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewCluster:getJobJobSettingsSettingsTaskForEachTaskTaskNewCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAutoscale:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAutoscale" }, "autoterminationMinutes": { "type": "integer" }, "awsAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAwsAttributes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAzureAttributes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConf:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfo:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImage:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterGcpAttributes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScript:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "workloadType": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadType:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadType" } }, "type": "object", "required": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "numWorkers" ], "language": { "nodejs": { "requiredInputs": [ "numWorkers" ] } } }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAutoscale:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAwsAttributes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAzureAttributes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConf:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfS3:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfS3" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfS3:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfo:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImage:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterGcpAttributes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScript:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptAbfss:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptDbfs:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptDbfs" }, "file": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptFile:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptGcs:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptS3:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptVolumes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptWorkspace:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptAbfss:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptDbfs:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptFile:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptGcs:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptS3:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptVolumes:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptWorkspace:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadType:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadTypeClients:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadTypeClients:getJobJobSettingsSettingsTaskForEachTaskTaskNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNotebookTask:getJobJobSettingsSettingsTaskForEachTaskTaskNotebookTask": { "properties": { "baseParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "notebookPath": { "type": "string" }, "source": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "notebookPath" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskNotificationSettings:getJobJobSettingsSettingsTaskForEachTaskTaskNotificationSettings": { "properties": { "alertOnLastAttempt": { "type": "boolean" }, "noAlertForCanceledRuns": { "type": "boolean" }, "noAlertForSkippedRuns": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPipelineTask:getJobJobSettingsSettingsTaskForEachTaskTaskPipelineTask": { "properties": { "fullRefresh": { "type": "boolean" }, "pipelineId": { "type": "string" } }, "type": "object", "required": [ "pipelineId" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTask:getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTask": { "properties": { "connectionResourceName": { "type": "string" }, "powerBiModel": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskPowerBiModel:getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskPowerBiModel" }, "refreshAfterUpdate": { "type": "boolean" }, "tables": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskTable:getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskTable" } }, "warehouseId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskPowerBiModel:getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskPowerBiModel": { "properties": { "authenticationMethod": { "type": "string" }, "modelName": { "type": "string" }, "overwriteExisting": { "type": "boolean" }, "storageMode": { "type": "string" }, "workspaceName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskTable:getJobJobSettingsSettingsTaskForEachTaskTaskPowerBiTaskTable": { "properties": { "catalog": { "type": "string" }, "name": { "type": "string", "description": "the job name of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by id.\n" }, "schema": { "type": "string" }, "storageMode": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskPythonWheelTask:getJobJobSettingsSettingsTaskForEachTaskTaskPythonWheelTask": { "properties": { "entryPoint": { "type": "string" }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "packageName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskRunJobTask:getJobJobSettingsSettingsTaskForEachTaskTaskRunJobTask": { "properties": { "jobId": { "type": "integer" }, "jobParameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "jobId" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSparkJarTask:getJobJobSettingsSettingsTaskForEachTaskTaskSparkJarTask": { "properties": { "jarUri": { "type": "string" }, "mainClassName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSparkPythonTask:getJobJobSettingsSettingsTaskForEachTaskTaskSparkPythonTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" } }, "pythonFile": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "pythonFile" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSparkSubmitTask:getJobJobSettingsSettingsTaskForEachTaskTaskSparkSubmitTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTask:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTask": { "properties": { "alert": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlert:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlert" }, "dashboard": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboard:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboard" }, "file": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskFile:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskFile" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "query": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskQuery:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskQuery" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "warehouseId" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlert:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlert": { "properties": { "alertId": { "type": "string" }, "pauseSubscriptions": { "type": "boolean" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlertSubscription:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlertSubscription" } } }, "type": "object", "required": [ "alertId" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlertSubscription:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskAlertSubscription": { "properties": { "destinationId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboard:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboard": { "properties": { "customSubject": { "type": "string" }, "dashboardId": { "type": "string" }, "pauseSubscriptions": { "type": "boolean" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboardSubscription:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboardSubscription" } } }, "type": "object", "required": [ "dashboardId" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboardSubscription:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskDashboardSubscription": { "properties": { "destinationId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskFile:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskFile": { "properties": { "path": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "path" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskQuery:getJobJobSettingsSettingsTaskForEachTaskTaskSqlTaskQuery": { "properties": { "queryId": { "type": "string" } }, "type": "object", "required": [ "queryId" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotifications:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotifications": { "properties": { "onDurationWarningThresholdExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded" } }, "onFailures": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnFailure:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnFailure" } }, "onStarts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStart:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStart" } }, "onStreamingBacklogExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded" } }, "onSuccesses": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnSuccess:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnSuccess" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnDurationWarningThresholdExceeded": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnFailure:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnFailure": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStart:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStart": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnStreamingBacklogExceeded": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnSuccess:getJobJobSettingsSettingsTaskForEachTaskTaskWebhookNotificationsOnSuccess": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskHealth:getJobJobSettingsSettingsTaskHealth": { "properties": { "rules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskHealthRule:getJobJobSettingsSettingsTaskHealthRule" } } }, "type": "object", "required": [ "rules" ] }, "databricks:index/getJobJobSettingsSettingsTaskHealthRule:getJobJobSettingsSettingsTaskHealthRule": { "properties": { "metric": { "type": "string" }, "op": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "metric", "op", "value" ] }, "databricks:index/getJobJobSettingsSettingsTaskLibrary:getJobJobSettingsSettingsTaskLibrary": { "properties": { "cran": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskLibraryCran:getJobJobSettingsSettingsTaskLibraryCran" }, "egg": { "type": "string", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskLibraryMaven:getJobJobSettingsSettingsTaskLibraryMaven" }, "providerConfig": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskLibraryProviderConfig:getJobJobSettingsSettingsTaskLibraryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskLibraryPypi:getJobJobSettingsSettingsTaskLibraryPypi" }, "requirements": { "type": "string" }, "whl": { "type": "string" } }, "type": "object", "required": [ "providerConfig" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsTaskLibraryCran:getJobJobSettingsSettingsTaskLibraryCran": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getJobJobSettingsSettingsTaskLibraryMaven:getJobJobSettingsSettingsTaskLibraryMaven": { "properties": { "coordinates": { "type": "string" }, "exclusions": { "type": "array", "items": { "type": "string" } }, "repo": { "type": "string" } }, "type": "object", "required": [ "coordinates" ] }, "databricks:index/getJobJobSettingsSettingsTaskLibraryProviderConfig:getJobJobSettingsSettingsTaskLibraryProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobJobSettingsSettingsTaskLibraryPypi:getJobJobSettingsSettingsTaskLibraryPypi": { "properties": { "package": { "type": "string" }, "repo": { "type": "string" } }, "type": "object", "required": [ "package" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewCluster:getJobJobSettingsSettingsTaskNewCluster": { "properties": { "applyPolicyDefaultValues": { "type": "boolean" }, "autoscale": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterAutoscale:getJobJobSettingsSettingsTaskNewClusterAutoscale" }, "autoterminationMinutes": { "type": "integer" }, "awsAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterAwsAttributes:getJobJobSettingsSettingsTaskNewClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterAzureAttributes:getJobJobSettingsSettingsTaskNewClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterLogConf:getJobJobSettingsSettingsTaskNewClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterMountInfo:getJobJobSettingsSettingsTaskNewClusterClusterMountInfo" } }, "clusterName": { "type": "string" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" } }, "dataSecurityMode": { "type": "string" }, "dockerImage": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterDockerImage:getJobJobSettingsSettingsTaskNewClusterDockerImage" }, "driverInstancePoolId": { "type": "string" }, "driverNodeTypeId": { "type": "string" }, "enableElasticDisk": { "type": "boolean" }, "enableLocalDiskEncryption": { "type": "boolean" }, "gcpAttributes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterGcpAttributes:getJobJobSettingsSettingsTaskNewClusterGcpAttributes" }, "idempotencyToken": { "type": "string" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScript:getJobJobSettingsSettingsTaskNewClusterInitScript" } }, "instancePoolId": { "type": "string" }, "nodeTypeId": { "type": "string" }, "numWorkers": { "type": "integer" }, "policyId": { "type": "string" }, "runtimeEngine": { "type": "string" }, "singleUserName": { "type": "string" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" } }, "sparkVersion": { "type": "string" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" } }, "workloadType": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterWorkloadType:getJobJobSettingsSettingsTaskNewClusterWorkloadType" } }, "type": "object", "required": [ "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "numWorkers" ], "language": { "nodejs": { "requiredInputs": [ "numWorkers" ] } } }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterAutoscale:getJobJobSettingsSettingsTaskNewClusterAutoscale": { "properties": { "maxWorkers": { "type": "integer" }, "minWorkers": { "type": "integer" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterAwsAttributes:getJobJobSettingsSettingsTaskNewClusterAwsAttributes": { "properties": { "availability": { "type": "string" }, "ebsVolumeCount": { "type": "integer" }, "ebsVolumeSize": { "type": "integer" }, "ebsVolumeType": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "instanceProfileArn": { "type": "string" }, "spotBidPricePercent": { "type": "integer" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterAzureAttributes:getJobJobSettingsSettingsTaskNewClusterAzureAttributes": { "properties": { "availability": { "type": "string" }, "firstOnDemand": { "type": "integer" }, "spotBidMaxPrice": { "type": "number" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterLogConf:getJobJobSettingsSettingsTaskNewClusterClusterLogConf": { "properties": { "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsTaskNewClusterClusterLogConfDbfs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterLogConfS3:getJobJobSettingsSettingsTaskNewClusterClusterLogConfS3" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterLogConfDbfs:getJobJobSettingsSettingsTaskNewClusterClusterLogConfDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterLogConfS3:getJobJobSettingsSettingsTaskNewClusterClusterLogConfS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterMountInfo:getJobJobSettingsSettingsTaskNewClusterClusterMountInfo": { "properties": { "localMountDirPath": { "type": "string" }, "networkFilesystemInfo": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsTaskNewClusterClusterMountInfoNetworkFilesystemInfo" }, "remoteMountDirPath": { "type": "string" } }, "type": "object", "required": [ "localMountDirPath", "networkFilesystemInfo" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterClusterMountInfoNetworkFilesystemInfo:getJobJobSettingsSettingsTaskNewClusterClusterMountInfoNetworkFilesystemInfo": { "properties": { "mountOptions": { "type": "string" }, "serverAddress": { "type": "string" } }, "type": "object", "required": [ "serverAddress" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterDockerImage:getJobJobSettingsSettingsTaskNewClusterDockerImage": { "properties": { "basicAuth": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsTaskNewClusterDockerImageBasicAuth" }, "url": { "type": "string" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterDockerImageBasicAuth:getJobJobSettingsSettingsTaskNewClusterDockerImageBasicAuth": { "properties": { "password": { "type": "string", "secret": true }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "username" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterGcpAttributes:getJobJobSettingsSettingsTaskNewClusterGcpAttributes": { "properties": { "availability": { "type": "string" }, "bootDiskSize": { "type": "integer" }, "googleServiceAccount": { "type": "string" }, "localSsdCount": { "type": "integer" }, "usePreemptibleExecutors": { "type": "boolean" }, "zoneId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScript:getJobJobSettingsSettingsTaskNewClusterInitScript": { "properties": { "abfss": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptAbfss:getJobJobSettingsSettingsTaskNewClusterInitScriptAbfss" }, "dbfs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptDbfs:getJobJobSettingsSettingsTaskNewClusterInitScriptDbfs" }, "file": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptFile:getJobJobSettingsSettingsTaskNewClusterInitScriptFile" }, "gcs": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptGcs:getJobJobSettingsSettingsTaskNewClusterInitScriptGcs" }, "s3": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptS3:getJobJobSettingsSettingsTaskNewClusterInitScriptS3" }, "volumes": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptVolumes:getJobJobSettingsSettingsTaskNewClusterInitScriptVolumes" }, "workspace": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptWorkspace:getJobJobSettingsSettingsTaskNewClusterInitScriptWorkspace" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptAbfss:getJobJobSettingsSettingsTaskNewClusterInitScriptAbfss": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptDbfs:getJobJobSettingsSettingsTaskNewClusterInitScriptDbfs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptFile:getJobJobSettingsSettingsTaskNewClusterInitScriptFile": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptGcs:getJobJobSettingsSettingsTaskNewClusterInitScriptGcs": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptS3:getJobJobSettingsSettingsTaskNewClusterInitScriptS3": { "properties": { "cannedAcl": { "type": "string" }, "destination": { "type": "string" }, "enableEncryption": { "type": "boolean" }, "encryptionType": { "type": "string" }, "endpoint": { "type": "string" }, "kmsKey": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptVolumes:getJobJobSettingsSettingsTaskNewClusterInitScriptVolumes": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterInitScriptWorkspace:getJobJobSettingsSettingsTaskNewClusterInitScriptWorkspace": { "properties": { "destination": { "type": "string" } }, "type": "object", "required": [ "destination" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterWorkloadType:getJobJobSettingsSettingsTaskNewClusterWorkloadType": { "properties": { "clients": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskNewClusterWorkloadTypeClients:getJobJobSettingsSettingsTaskNewClusterWorkloadTypeClients" } }, "type": "object", "required": [ "clients" ] }, "databricks:index/getJobJobSettingsSettingsTaskNewClusterWorkloadTypeClients:getJobJobSettingsSettingsTaskNewClusterWorkloadTypeClients": { "properties": { "jobs": { "type": "boolean" }, "notebooks": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskNotebookTask:getJobJobSettingsSettingsTaskNotebookTask": { "properties": { "baseParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "notebookPath": { "type": "string" }, "source": { "type": "string" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "notebookPath" ] }, "databricks:index/getJobJobSettingsSettingsTaskNotificationSettings:getJobJobSettingsSettingsTaskNotificationSettings": { "properties": { "alertOnLastAttempt": { "type": "boolean" }, "noAlertForCanceledRuns": { "type": "boolean" }, "noAlertForSkippedRuns": { "type": "boolean" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskPipelineTask:getJobJobSettingsSettingsTaskPipelineTask": { "properties": { "fullRefresh": { "type": "boolean" }, "pipelineId": { "type": "string" } }, "type": "object", "required": [ "pipelineId" ] }, "databricks:index/getJobJobSettingsSettingsTaskPowerBiTask:getJobJobSettingsSettingsTaskPowerBiTask": { "properties": { "connectionResourceName": { "type": "string" }, "powerBiModel": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskPowerBiTaskPowerBiModel:getJobJobSettingsSettingsTaskPowerBiTaskPowerBiModel" }, "refreshAfterUpdate": { "type": "boolean" }, "tables": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskPowerBiTaskTable:getJobJobSettingsSettingsTaskPowerBiTaskTable" } }, "warehouseId": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskPowerBiTaskPowerBiModel:getJobJobSettingsSettingsTaskPowerBiTaskPowerBiModel": { "properties": { "authenticationMethod": { "type": "string" }, "modelName": { "type": "string" }, "overwriteExisting": { "type": "boolean" }, "storageMode": { "type": "string" }, "workspaceName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskPowerBiTaskTable:getJobJobSettingsSettingsTaskPowerBiTaskTable": { "properties": { "catalog": { "type": "string" }, "name": { "type": "string", "description": "the job name of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by id.\n" }, "schema": { "type": "string" }, "storageMode": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskPythonWheelTask:getJobJobSettingsSettingsTaskPythonWheelTask": { "properties": { "entryPoint": { "type": "string" }, "namedParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "packageName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskRunJobTask:getJobJobSettingsSettingsTaskRunJobTask": { "properties": { "jobId": { "type": "integer" }, "jobParameters": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "jobId" ] }, "databricks:index/getJobJobSettingsSettingsTaskSparkJarTask:getJobJobSettingsSettingsTaskSparkJarTask": { "properties": { "jarUri": { "type": "string" }, "mainClassName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskSparkPythonTask:getJobJobSettingsSettingsTaskSparkPythonTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" } }, "pythonFile": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "pythonFile" ] }, "databricks:index/getJobJobSettingsSettingsTaskSparkSubmitTask:getJobJobSettingsSettingsTaskSparkSubmitTask": { "properties": { "parameters": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskSqlTask:getJobJobSettingsSettingsTaskSqlTask": { "properties": { "alert": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTaskAlert:getJobJobSettingsSettingsTaskSqlTaskAlert" }, "dashboard": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTaskDashboard:getJobJobSettingsSettingsTaskSqlTaskDashboard" }, "file": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTaskFile:getJobJobSettingsSettingsTaskSqlTaskFile" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "query": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTaskQuery:getJobJobSettingsSettingsTaskSqlTaskQuery" }, "warehouseId": { "type": "string" } }, "type": "object", "required": [ "warehouseId" ] }, "databricks:index/getJobJobSettingsSettingsTaskSqlTaskAlert:getJobJobSettingsSettingsTaskSqlTaskAlert": { "properties": { "alertId": { "type": "string" }, "pauseSubscriptions": { "type": "boolean" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTaskAlertSubscription:getJobJobSettingsSettingsTaskSqlTaskAlertSubscription" } } }, "type": "object", "required": [ "alertId" ] }, "databricks:index/getJobJobSettingsSettingsTaskSqlTaskAlertSubscription:getJobJobSettingsSettingsTaskSqlTaskAlertSubscription": { "properties": { "destinationId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskSqlTaskDashboard:getJobJobSettingsSettingsTaskSqlTaskDashboard": { "properties": { "customSubject": { "type": "string" }, "dashboardId": { "type": "string" }, "pauseSubscriptions": { "type": "boolean" }, "subscriptions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskSqlTaskDashboardSubscription:getJobJobSettingsSettingsTaskSqlTaskDashboardSubscription" } } }, "type": "object", "required": [ "dashboardId" ] }, "databricks:index/getJobJobSettingsSettingsTaskSqlTaskDashboardSubscription:getJobJobSettingsSettingsTaskSqlTaskDashboardSubscription": { "properties": { "destinationId": { "type": "string" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskSqlTaskFile:getJobJobSettingsSettingsTaskSqlTaskFile": { "properties": { "path": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "path" ] }, "databricks:index/getJobJobSettingsSettingsTaskSqlTaskQuery:getJobJobSettingsSettingsTaskSqlTaskQuery": { "properties": { "queryId": { "type": "string" } }, "type": "object", "required": [ "queryId" ] }, "databricks:index/getJobJobSettingsSettingsTaskWebhookNotifications:getJobJobSettingsSettingsTaskWebhookNotifications": { "properties": { "onDurationWarningThresholdExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnDurationWarningThresholdExceeded:getJobJobSettingsSettingsTaskWebhookNotificationsOnDurationWarningThresholdExceeded" } }, "onFailures": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnFailure:getJobJobSettingsSettingsTaskWebhookNotificationsOnFailure" } }, "onStarts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnStart:getJobJobSettingsSettingsTaskWebhookNotificationsOnStart" } }, "onStreamingBacklogExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnStreamingBacklogExceeded:getJobJobSettingsSettingsTaskWebhookNotificationsOnStreamingBacklogExceeded" } }, "onSuccesses": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnSuccess:getJobJobSettingsSettingsTaskWebhookNotificationsOnSuccess" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnDurationWarningThresholdExceeded:getJobJobSettingsSettingsTaskWebhookNotificationsOnDurationWarningThresholdExceeded": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnFailure:getJobJobSettingsSettingsTaskWebhookNotificationsOnFailure": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnStart:getJobJobSettingsSettingsTaskWebhookNotificationsOnStart": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnStreamingBacklogExceeded:getJobJobSettingsSettingsTaskWebhookNotificationsOnStreamingBacklogExceeded": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTaskWebhookNotificationsOnSuccess:getJobJobSettingsSettingsTaskWebhookNotificationsOnSuccess": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsTrigger:getJobJobSettingsSettingsTrigger": { "properties": { "fileArrival": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTriggerFileArrival:getJobJobSettingsSettingsTriggerFileArrival" }, "pauseStatus": { "type": "string" }, "periodic": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTriggerPeriodic:getJobJobSettingsSettingsTriggerPeriodic" }, "tableUpdate": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsTriggerTableUpdate:getJobJobSettingsSettingsTriggerTableUpdate" } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsTriggerFileArrival:getJobJobSettingsSettingsTriggerFileArrival": { "properties": { "minTimeBetweenTriggersSeconds": { "type": "integer" }, "url": { "type": "string" }, "waitAfterLastChangeSeconds": { "type": "integer" } }, "type": "object", "required": [ "url" ] }, "databricks:index/getJobJobSettingsSettingsTriggerPeriodic:getJobJobSettingsSettingsTriggerPeriodic": { "properties": { "interval": { "type": "integer" }, "unit": { "type": "string" } }, "type": "object", "required": [ "interval", "unit" ] }, "databricks:index/getJobJobSettingsSettingsTriggerTableUpdate:getJobJobSettingsSettingsTriggerTableUpdate": { "properties": { "condition": { "type": "string" }, "minTimeBetweenTriggersSeconds": { "type": "integer" }, "tableNames": { "type": "array", "items": { "type": "string" } }, "waitAfterLastChangeSeconds": { "type": "integer" } }, "type": "object", "required": [ "tableNames" ] }, "databricks:index/getJobJobSettingsSettingsWebhookNotifications:getJobJobSettingsSettingsWebhookNotifications": { "properties": { "onDurationWarningThresholdExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnDurationWarningThresholdExceeded:getJobJobSettingsSettingsWebhookNotificationsOnDurationWarningThresholdExceeded" } }, "onFailures": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnFailure:getJobJobSettingsSettingsWebhookNotificationsOnFailure" } }, "onStarts": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnStart:getJobJobSettingsSettingsWebhookNotificationsOnStart" } }, "onStreamingBacklogExceededs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnStreamingBacklogExceeded:getJobJobSettingsSettingsWebhookNotificationsOnStreamingBacklogExceeded" } }, "onSuccesses": { "type": "array", "items": { "$ref": "#/types/databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnSuccess:getJobJobSettingsSettingsWebhookNotificationsOnSuccess" } } }, "type": "object" }, "databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnDurationWarningThresholdExceeded:getJobJobSettingsSettingsWebhookNotificationsOnDurationWarningThresholdExceeded": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnFailure:getJobJobSettingsSettingsWebhookNotificationsOnFailure": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnStart:getJobJobSettingsSettingsWebhookNotificationsOnStart": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnStreamingBacklogExceeded:getJobJobSettingsSettingsWebhookNotificationsOnStreamingBacklogExceeded": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobJobSettingsSettingsWebhookNotificationsOnSuccess:getJobJobSettingsSettingsWebhookNotificationsOnSuccess": { "properties": { "id": { "type": "string", "description": "the id of\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eif the resource was matched by name.\n" } }, "type": "object", "required": [ "id" ] }, "databricks:index/getJobProviderConfig:getJobProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getJobsProviderConfig:getJobsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourceFileTable:getKnowledgeAssistantKnowledgeSourceFileTable": { "properties": { "fileCol": { "type": "string", "description": "(string) - The name of the column containing BINARY file content to be indexed\n" }, "tableName": { "type": "string", "description": "(string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}\n" } }, "type": "object", "required": [ "fileCol", "tableName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourceFiles:getKnowledgeAssistantKnowledgeSourceFiles": { "properties": { "path": { "type": "string", "description": "(string) - A UC volume path that includes a list of files\n" } }, "type": "object", "required": [ "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourceIndex:getKnowledgeAssistantKnowledgeSourceIndex": { "properties": { "docUriCol": { "type": "string", "description": "(string) - The column that specifies a link or reference to where the information came from\n" }, "indexName": { "type": "string", "description": "(string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}\n" }, "textCol": { "type": "string", "description": "(string) - The column that includes the document text for retrieval\n" } }, "type": "object", "required": [ "docUriCol", "indexName", "textCol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourceProviderConfig:getKnowledgeAssistantKnowledgeSourceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSource:getKnowledgeAssistantKnowledgeSourcesKnowledgeSource": { "properties": { "createTime": { "type": "string", "description": "(string) - Timestamp when this knowledge source was created\n" }, "description": { "type": "string", "description": "(string) - Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "displayName": { "type": "string", "description": "(string) - Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "fileTable": { "$ref": "#/types/databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFileTable:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFileTable", "description": "(FileTableSpec)\n" }, "files": { "$ref": "#/types/databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFiles:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFiles", "description": "(FilesSpec)\n" }, "id": { "type": "string", "description": "(string)\n" }, "index": { "$ref": "#/types/databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceIndex:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceIndex", "description": "(IndexSpec)\n" }, "knowledgeCutoffTime": { "type": "string", "description": "(string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested\n" }, "name": { "type": "string", "description": "(string) - Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceProviderConfig:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "(string) - The type of the source: \"index\", \"files\", or \u003cspan pulumi-lang-nodejs=\"\"fileTable\"\" pulumi-lang-dotnet=\"\"FileTable\"\" pulumi-lang-go=\"\"fileTable\"\" pulumi-lang-python=\"\"file_table\"\" pulumi-lang-yaml=\"\"fileTable\"\" pulumi-lang-java=\"\"fileTable\"\" pulumi-lang-hcl=\"\"file_table\"\"\u003e\"fileTable\"\u003c/span\u003e.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored\n" }, "state": { "type": "string", "description": "(string) - Possible values are: `FAILED_UPDATE`, `UPDATED`, `UPDATING`\n" } }, "type": "object", "required": [ "createTime", "description", "displayName", "fileTable", "files", "id", "index", "knowledgeCutoffTime", "name", "sourceType", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFileTable:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFileTable": { "properties": { "fileCol": { "type": "string", "description": "(string) - The name of the column containing BINARY file content to be indexed\n" }, "tableName": { "type": "string", "description": "(string) - Full UC name of the table, in the format of {CATALOG}.{SCHEMA}.{TABLE_NAME}\n" } }, "type": "object", "required": [ "fileCol", "tableName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFiles:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceFiles": { "properties": { "path": { "type": "string", "description": "(string) - A UC volume path that includes a list of files\n" } }, "type": "object", "required": [ "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceIndex:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceIndex": { "properties": { "docUriCol": { "type": "string", "description": "(string) - The column that specifies a link or reference to where the information came from\n" }, "indexName": { "type": "string", "description": "(string) - Full UC name of the vector search index, in the format of {CATALOG}.{SCHEMA}.{INDEX_NAME}\n" }, "textCol": { "type": "string", "description": "(string) - The column that includes the document text for retrieval\n" } }, "type": "object", "required": [ "docUriCol", "indexName", "textCol" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceProviderConfig:getKnowledgeAssistantKnowledgeSourcesKnowledgeSourceProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantKnowledgeSourcesProviderConfig:getKnowledgeAssistantKnowledgeSourcesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantProviderConfig:getKnowledgeAssistantProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantsKnowledgeAssistant:getKnowledgeAssistantsKnowledgeAssistant": { "properties": { "createTime": { "type": "string", "description": "(string) - Creation timestamp\n" }, "creator": { "type": "string", "description": "(string) - The creator of the Knowledge Assistant\n" }, "description": { "type": "string", "description": "(string) - Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "displayName": { "type": "string", "description": "(string) - The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "endpointName": { "type": "string", "description": "(string) - The name of the knowledge assistant agent endpoint\n" }, "errorInfo": { "type": "string", "description": "(string) - Error details when the Knowledge Assistant is in FAILED state\n" }, "experimentId": { "type": "string", "description": "(string) - The MLflow experiment ID\n" }, "id": { "type": "string", "description": "(string, deprecated) - Deprecated: use\u003cspan pulumi-lang-nodejs=\" knowledgeAssistantId \" pulumi-lang-dotnet=\" KnowledgeAssistantId \" pulumi-lang-go=\" knowledgeAssistantId \" pulumi-lang-python=\" knowledge_assistant_id \" pulumi-lang-yaml=\" knowledgeAssistantId \" pulumi-lang-java=\" knowledgeAssistantId \" pulumi-lang-hcl=\" knowledge_assistant_id \"\u003e knowledgeAssistantId \u003c/span\u003einstead\n" }, "instructions": { "type": "string", "description": "(string) - Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in\u003cspan pulumi-lang-nodejs=\" updateMask \" pulumi-lang-dotnet=\" UpdateMask \" pulumi-lang-go=\" updateMask \" pulumi-lang-python=\" update_mask \" pulumi-lang-yaml=\" updateMask \" pulumi-lang-java=\" updateMask \" pulumi-lang-hcl=\" update_mask \"\u003e updateMask \u003c/span\u003eto\nmodify it\n" }, "name": { "type": "string", "description": "(string) - The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getKnowledgeAssistantsKnowledgeAssistantProviderConfig:getKnowledgeAssistantsKnowledgeAssistantProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "state": { "type": "string", "description": "(string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: `ACTIVE`, `CREATING`, `FAILED`\n" } }, "type": "object", "required": [ "createTime", "creator", "description", "displayName", "endpointName", "errorInfo", "experimentId", "id", "instructions", "name", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantsKnowledgeAssistantProviderConfig:getKnowledgeAssistantsKnowledgeAssistantProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getKnowledgeAssistantsProviderConfig:getKnowledgeAssistantsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMaterializedFeaturesFeatureTagProviderConfig:getMaterializedFeaturesFeatureTagProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMaterializedFeaturesFeatureTagsFeatureTag:getMaterializedFeaturesFeatureTagsFeatureTag": { "properties": { "key": { "type": "string", "description": "(string)\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getMaterializedFeaturesFeatureTagsFeatureTagProviderConfig:getMaterializedFeaturesFeatureTagsFeatureTagProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "value": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMaterializedFeaturesFeatureTagsFeatureTagProviderConfig:getMaterializedFeaturesFeatureTagsFeatureTagProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMaterializedFeaturesFeatureTagsProviderConfig:getMaterializedFeaturesFeatureTagsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMetastoreMetastoreInfo:getMetastoreMetastoreInfo": { "properties": { "cloud": { "type": "string", "description": "Cloud vendor of the metastore home shard (e.g., \u003cspan pulumi-lang-nodejs=\"`aws`\" pulumi-lang-dotnet=\"`Aws`\" pulumi-lang-go=\"`aws`\" pulumi-lang-python=\"`aws`\" pulumi-lang-yaml=\"`aws`\" pulumi-lang-java=\"`aws`\" pulumi-lang-hcl=\"`aws`\"\u003e`aws`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`azure`\" pulumi-lang-dotnet=\"`Azure`\" pulumi-lang-go=\"`azure`\" pulumi-lang-python=\"`azure`\" pulumi-lang-yaml=\"`azure`\" pulumi-lang-java=\"`azure`\" pulumi-lang-hcl=\"`azure`\"\u003e`azure`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gcp`\" pulumi-lang-dotnet=\"`Gcp`\" pulumi-lang-go=\"`gcp`\" pulumi-lang-python=\"`gcp`\" pulumi-lang-yaml=\"`gcp`\" pulumi-lang-java=\"`gcp`\" pulumi-lang-hcl=\"`gcp`\"\u003e`gcp`\u003c/span\u003e).\n" }, "createdAt": { "type": "integer", "description": "Time at which the metastore was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of metastore creator.\n" }, "defaultDataAccessConfigId": { "type": "string", "description": "Unique identifier of the metastore's default data access configuration.\n" }, "deltaSharingOrganizationName": { "type": "string", "description": "The organization name of a Delta Sharing entity. This field is used for Databricks to Databricks sharing.\n" }, "deltaSharingRecipientTokenLifetimeInSeconds": { "type": "integer", "description": "Used to set expiration duration in seconds on recipient data access tokens.\n" }, "deltaSharingScope": { "type": "string", "description": "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.\n" }, "externalAccessEnabled": { "type": "boolean", "description": "Whether to allow non-DBR clients to directly access entities under the metastore.\n" }, "globalMetastoreId": { "type": "string", "description": "Globally unique metastore ID across clouds and regions, of the form `cloud:region:metastore_id`.\n" }, "metastoreId": { "type": "string", "description": "ID of the metastore\n" }, "name": { "type": "string", "description": "Name of the metastore\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the metastore owner.\n" }, "privilegeModelVersion": { "type": "string", "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).\n" }, "region": { "type": "string", "description": "Region of the metastore\n" }, "storageRoot": { "type": "string", "description": "Path on cloud storage account, where managed \u003cspan pulumi-lang-nodejs=\"`databricks.Table`\" pulumi-lang-dotnet=\"`databricks.Table`\" pulumi-lang-go=\"`Table`\" pulumi-lang-python=\"`Table`\" pulumi-lang-yaml=\"`databricks.Table`\" pulumi-lang-java=\"`databricks.Table`\" pulumi-lang-hcl=\"`databricks_table`\"\u003e`databricks.Table`\u003c/span\u003e are stored.\n" }, "storageRootCredentialId": { "type": "string", "description": "UUID of storage credential to access the metastore storage_root.\n" }, "storageRootCredentialName": { "type": "string", "description": "Name of the storage credential to access the metastore storage_root.\n" }, "updatedAt": { "type": "integer", "description": "Time at which the metastore was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the metastore.\n" } }, "type": "object" }, "databricks:index/getMlflowExperimentProviderConfig:getMlflowExperimentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMlflowExperimentTag:getMlflowExperimentTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getMlflowModelLatestVersion:getMlflowModelLatestVersion": { "properties": { "creationTimestamp": { "type": "integer" }, "currentStage": { "type": "string" }, "description": { "type": "string", "description": "User-specified description for the object.\n" }, "lastUpdatedTimestamp": { "type": "integer" }, "name": { "type": "string", "description": "Name of the registered model.\n" }, "runId": { "type": "string" }, "runLink": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "statusMessage": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getMlflowModelLatestVersionTag:getMlflowModelLatestVersionTag" }, "description": "Array of tags associated with the model.\n" }, "userId": { "type": "string", "description": "The username of the user that created the object.\n" }, "version": { "type": "string" } }, "type": "object" }, "databricks:index/getMlflowModelLatestVersionTag:getMlflowModelLatestVersionTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getMlflowModelProviderConfig:getMlflowModelProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMlflowModelTag:getMlflowModelTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getMlflowModelsProviderConfig:getMlflowModelsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMwsCredentialsProviderConfig:getMwsCredentialsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Ignored. This data source always operates against the account configured on the provider.\n", "deprecationMessage": "workspace_id is ignored for account-only resources." } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfig:getMwsNetworkConnectivityConfigEgressConfig": { "properties": { "defaultRules": { "$ref": "#/types/databricks:index/getMwsNetworkConnectivityConfigEgressConfigDefaultRules:getMwsNetworkConnectivityConfigEgressConfigDefaultRules", "description": "Array of default rules.\n" }, "targetRules": { "$ref": "#/types/databricks:index/getMwsNetworkConnectivityConfigEgressConfigTargetRules:getMwsNetworkConnectivityConfigEgressConfigTargetRules", "description": "Array of target rules.\n" } }, "type": "object" }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfigDefaultRules:getMwsNetworkConnectivityConfigEgressConfigDefaultRules": { "properties": { "awsStableIpRule": { "$ref": "#/types/databricks:index/getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule:getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule", "description": "The stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace.\n" }, "azureServiceEndpointRule": { "$ref": "#/types/databricks:index/getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule:getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule", "description": "Array of Azure service endpoint rules.\n" } }, "type": "object" }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule:getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAwsStableIpRule": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "The list of stable IP CIDR blocks from which Databricks network traffic originates when accessing your resources.\n" } }, "type": "object" }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule:getMwsNetworkConnectivityConfigEgressConfigDefaultRulesAzureServiceEndpointRule": { "properties": { "subnets": { "type": "array", "items": { "type": "string" }, "description": "Array of strings representing the subnet IDs.\n" }, "targetRegion": { "type": "string", "description": "The target region for the service endpoint.\n" }, "targetServices": { "type": "array", "items": { "type": "string" }, "description": "Array of target services.\n" } }, "type": "object" }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfigTargetRules:getMwsNetworkConnectivityConfigEgressConfigTargetRules": { "properties": { "awsPrivateEndpointRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getMwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule:getMwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule" } }, "azurePrivateEndpointRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/getMwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule:getMwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule" }, "description": "Array of private endpoint rule objects.\n" } }, "type": "object" }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule:getMwsNetworkConnectivityConfigEgressConfigTargetRulesAwsPrivateEndpointRule": { "properties": { "accountId": { "type": "string", "description": "The Databricks account ID associated with this network configuration.\n" }, "connectionState": { "type": "string", "description": "The current status of this private endpoint.\n" }, "creationTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean", "description": "Whether this private endpoint is deactivated.\n" }, "deactivatedAt": { "type": "integer", "description": "Time in epoch milliseconds when this object was deactivated.\n" }, "domainNames": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "endpointService": { "type": "string" }, "errorMessage": { "type": "string" }, "networkConnectivityConfigId": { "type": "string", "description": "The Databricks network connectivity configuration ID.\n" }, "resourceNames": { "type": "array", "items": { "type": "string" } }, "ruleId": { "type": "string", "description": "The ID of a private endpoint rule.\n" }, "updatedTime": { "type": "integer", "description": "Time in epoch milliseconds when the network was updated.\n" }, "vpcEndpointId": { "type": "string" } }, "type": "object" }, "databricks:index/getMwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule:getMwsNetworkConnectivityConfigEgressConfigTargetRulesAzurePrivateEndpointRule": { "properties": { "connectionState": { "type": "string", "description": "The current status of this private endpoint.\n" }, "creationTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean", "description": "Whether this private endpoint is deactivated.\n" }, "deactivatedAt": { "type": "integer", "description": "Time in epoch milliseconds when this object was deactivated.\n" }, "domainNames": { "type": "array", "items": { "type": "string" } }, "endpointName": { "type": "string", "description": "The name of the Azure private endpoint resource.\n" }, "errorMessage": { "type": "string" }, "groupId": { "type": "string", "description": "The sub-resource type (group ID) of the target resource.\n" }, "networkConnectivityConfigId": { "type": "string", "description": "The Databricks network connectivity configuration ID.\n" }, "resourceId": { "type": "string", "description": "The Azure resource ID of the target resource.\n" }, "ruleId": { "type": "string", "description": "The ID of a private endpoint rule.\n" }, "updatedTime": { "type": "integer", "description": "Time in epoch milliseconds when the network was updated.\n" } }, "type": "object" }, "databricks:index/getMwsWorkspacesProviderConfig:getMwsWorkspacesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Ignored. This data source always operates against the account configured on the provider.\n", "deprecationMessage": "workspace_id is ignored for account-only resources." } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getNodeTypeProviderConfig:getNodeTypeProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getNotebookPathsNotebookPathList:getNotebookPathsNotebookPathList": { "properties": { "language": { "type": "string" }, "path": { "type": "string", "description": "Path to workspace directory\n" } }, "type": "object" }, "databricks:index/getNotebookPathsProviderConfig:getNotebookPathsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getNotebookProviderConfig:getNotebookProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getNotificationDestinationsNotificationDestination:getNotificationDestinationsNotificationDestination": { "properties": { "destinationType": { "type": "string", "description": "The type of the notification destination. Possible values are `EMAIL`, `MICROSOFT_TEAMS`, `PAGERDUTY`, `SLACK`, or `WEBHOOK`.\n" }, "displayName": { "type": "string", "description": "The display name of the Notification Destination.\n" }, "id": { "type": "string", "description": "The unique ID of the Notification Destination.\n" } }, "type": "object" }, "databricks:index/getNotificationDestinationsProviderConfig:getNotificationDestinationsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getOnlineStoreProviderConfig:getOnlineStoreProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getOnlineStoresOnlineStore:getOnlineStoresOnlineStore": { "properties": { "capacity": { "type": "string", "description": "(string) - The capacity of the online store. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\"\n" }, "creationTime": { "type": "string", "description": "(string) - The timestamp when the online store was created\n" }, "creator": { "type": "string", "description": "(string) - The email of the creator of the online store\n" }, "name": { "type": "string", "description": "(string) - The name of the online store. This is the unique identifier for the online store\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getOnlineStoresOnlineStoreProviderConfig:getOnlineStoresOnlineStoreProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "readReplicaCount": { "type": "integer", "description": "(integer) - The number of read replicas for the online store. Defaults to 0\n" }, "state": { "type": "string", "description": "(string) - The current state of the online store. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`\n" }, "usagePolicyId": { "type": "string", "description": "(string) - The usage policy applied to the online store to track billing\n" } }, "type": "object", "required": [ "capacity", "creationTime", "creator", "name", "readReplicaCount", "state", "usagePolicyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getOnlineStoresOnlineStoreProviderConfig:getOnlineStoresOnlineStoreProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getOnlineStoresProviderConfig:getOnlineStoresProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPipelinesProviderConfig:getPipelinesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfoColumnMask:getPolicyInfoColumnMask": { "properties": { "functionName": { "type": "string", "description": "(string) - The fully qualified name of the row filter function.\nThe function is called on each row of the target table. It should return a boolean value\nindicating whether the row should be visible to the user.\nRequired on create and update\n" }, "onColumn": { "type": "string", "description": "(string) - The alias of the column to be masked. The alias must refer to one of matched columns.\nThe values of the column is passed to the column mask function as the first argument.\nRequired on create and update\n" }, "usings": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPolicyInfoColumnMaskUsing:getPolicyInfoColumnMaskUsing" }, "description": "(list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function.\nThe type of each column should match the positional argument of the row filter function\n" } }, "type": "object", "required": [ "functionName", "onColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfoColumnMaskUsing:getPolicyInfoColumnMaskUsing": { "properties": { "alias": { "type": "string", "description": "(string) - Optional alias of the matched column\n" }, "constant": { "type": "string", "description": "(string) - A constant literal\n" } }, "type": "object" }, "databricks:index/getPolicyInfoMatchColumn:getPolicyInfoMatchColumn": { "properties": { "alias": { "type": "string", "description": "(string) - Optional alias of the matched column\n" }, "condition": { "type": "string", "description": "(string) - The condition expression used to match a table column\n" } }, "type": "object" }, "databricks:index/getPolicyInfoProviderConfig:getPolicyInfoProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfoRowFilter:getPolicyInfoRowFilter": { "properties": { "functionName": { "type": "string", "description": "(string) - The fully qualified name of the row filter function.\nThe function is called on each row of the target table. It should return a boolean value\nindicating whether the row should be visible to the user.\nRequired on create and update\n" }, "usings": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPolicyInfoRowFilterUsing:getPolicyInfoRowFilterUsing" }, "description": "(list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function.\nThe type of each column should match the positional argument of the row filter function\n" } }, "type": "object", "required": [ "functionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfoRowFilterUsing:getPolicyInfoRowFilterUsing": { "properties": { "alias": { "type": "string", "description": "(string) - Optional alias of the matched column\n" }, "constant": { "type": "string", "description": "(string) - A constant literal\n" } }, "type": "object" }, "databricks:index/getPolicyInfosPolicy:getPolicyInfosPolicy": { "properties": { "columnMask": { "$ref": "#/types/databricks:index/getPolicyInfosPolicyColumnMask:getPolicyInfosPolicyColumnMask", "description": "(ColumnMaskOptions) - Options for column mask policies. Valid only if \u003cspan pulumi-lang-nodejs=\"`policyType`\" pulumi-lang-dotnet=\"`PolicyType`\" pulumi-lang-go=\"`policyType`\" pulumi-lang-python=\"`policy_type`\" pulumi-lang-yaml=\"`policyType`\" pulumi-lang-java=\"`policyType`\" pulumi-lang-hcl=\"`policy_type`\"\u003e`policyType`\u003c/span\u003e is `POLICY_TYPE_COLUMN_MASK`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole\n" }, "comment": { "type": "string", "description": "(string) - Optional description of the policy\n" }, "createdAt": { "type": "integer", "description": "(integer) - Time at which the policy was created, in epoch milliseconds. Output only\n" }, "createdBy": { "type": "string", "description": "(string) - Username of the user who created the policy. Output only\n" }, "exceptPrincipals": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Optional list of user or group names that should be excluded from the policy\n" }, "forSecurableType": { "type": "string", "description": "(string) - Type of securables that the policy should take effect on.\nOnly `TABLE` is supported at this moment.\nRequired on create and optional on update. Possible values are: `CATALOG`, `CLEAN_ROOM`, `CONNECTION`, `CREDENTIAL`, `EXTERNAL_LOCATION`, `EXTERNAL_METADATA`, `FUNCTION`, `METASTORE`, `PIPELINE`, `PROVIDER`, `RECIPIENT`, `SCHEMA`, `SHARE`, `STAGING_TABLE`, `STORAGE_CREDENTIAL`, `TABLE`, `VOLUME`\n" }, "id": { "type": "string", "description": "(string) - Unique identifier of the policy. This field is output only and is generated by the system\n" }, "matchColumns": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPolicyInfosPolicyMatchColumn:getPolicyInfosPolicyMatchColumn" }, "description": "(list of MatchColumn) - Optional list of condition expressions used to match table columns.\nOnly valid when \u003cspan pulumi-lang-nodejs=\"`forSecurableType`\" pulumi-lang-dotnet=\"`ForSecurableType`\" pulumi-lang-go=\"`forSecurableType`\" pulumi-lang-python=\"`for_securable_type`\" pulumi-lang-yaml=\"`forSecurableType`\" pulumi-lang-java=\"`forSecurableType`\" pulumi-lang-hcl=\"`for_securable_type`\"\u003e`forSecurableType`\u003c/span\u003e is `TABLE`.\nWhen specified, the policy only applies to tables whose columns satisfy all match conditions\n" }, "name": { "type": "string", "description": "(string) - Name of the policy. Required on create and optional on update.\nTo rename the policy, set \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e to a different value on update\n" }, "onSecurableFullname": { "type": "string", "description": "Required. The fully qualified name of securable to list policies for\n" }, "onSecurableType": { "type": "string", "description": "Required. The type of the securable to list policies for\n" }, "policyType": { "type": "string", "description": "(string) - Type of the policy. Required on create. Possible values are: `POLICY_TYPE_COLUMN_MASK`, `POLICY_TYPE_ROW_FILTER`\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getPolicyInfosPolicyProviderConfig:getPolicyInfosPolicyProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "rowFilter": { "$ref": "#/types/databricks:index/getPolicyInfosPolicyRowFilter:getPolicyInfosPolicyRowFilter", "description": "(RowFilterOptions) - Options for row filter policies. Valid only if \u003cspan pulumi-lang-nodejs=\"`policyType`\" pulumi-lang-dotnet=\"`PolicyType`\" pulumi-lang-go=\"`policyType`\" pulumi-lang-python=\"`policy_type`\" pulumi-lang-yaml=\"`policyType`\" pulumi-lang-java=\"`policyType`\" pulumi-lang-hcl=\"`policy_type`\"\u003e`policyType`\u003c/span\u003e is `POLICY_TYPE_ROW_FILTER`.\nRequired on create and optional on update. When specified on update,\nthe new options will replace the existing options as a whole\n" }, "toPrincipals": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of user or group names that the policy applies to.\nRequired on create and optional on update\n" }, "updatedAt": { "type": "integer", "description": "(integer) - Time at which the policy was last modified, in epoch milliseconds. Output only\n" }, "updatedBy": { "type": "string", "description": "(string) - Username of the user who last modified the policy. Output only\n" }, "whenCondition": { "type": "string", "description": "(string) - Optional condition when the policy should take effect\n" } }, "type": "object", "required": [ "columnMask", "comment", "createdAt", "createdBy", "exceptPrincipals", "forSecurableType", "id", "matchColumns", "name", "onSecurableFullname", "onSecurableType", "policyType", "rowFilter", "toPrincipals", "updatedAt", "updatedBy", "whenCondition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfosPolicyColumnMask:getPolicyInfosPolicyColumnMask": { "properties": { "functionName": { "type": "string", "description": "(string) - The fully qualified name of the row filter function.\nThe function is called on each row of the target table. It should return a boolean value\nindicating whether the row should be visible to the user.\nRequired on create and update\n" }, "onColumn": { "type": "string", "description": "(string) - The alias of the column to be masked. The alias must refer to one of matched columns.\nThe values of the column is passed to the column mask function as the first argument.\nRequired on create and update\n" }, "usings": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPolicyInfosPolicyColumnMaskUsing:getPolicyInfosPolicyColumnMaskUsing" }, "description": "(list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function.\nThe type of each column should match the positional argument of the row filter function\n" } }, "type": "object", "required": [ "functionName", "onColumn" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfosPolicyColumnMaskUsing:getPolicyInfosPolicyColumnMaskUsing": { "properties": { "alias": { "type": "string", "description": "(string) - Optional alias of the matched column\n" }, "constant": { "type": "string", "description": "(string) - A constant literal\n" } }, "type": "object" }, "databricks:index/getPolicyInfosPolicyMatchColumn:getPolicyInfosPolicyMatchColumn": { "properties": { "alias": { "type": "string", "description": "(string) - Optional alias of the matched column\n" }, "condition": { "type": "string", "description": "(string) - The condition expression used to match a table column\n" } }, "type": "object" }, "databricks:index/getPolicyInfosPolicyProviderConfig:getPolicyInfosPolicyProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfosPolicyRowFilter:getPolicyInfosPolicyRowFilter": { "properties": { "functionName": { "type": "string", "description": "(string) - The fully qualified name of the row filter function.\nThe function is called on each row of the target table. It should return a boolean value\nindicating whether the row should be visible to the user.\nRequired on create and update\n" }, "usings": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPolicyInfosPolicyRowFilterUsing:getPolicyInfosPolicyRowFilterUsing" }, "description": "(list of FunctionArgument) - Optional list of column aliases or constant literals to be passed as arguments to the row filter function.\nThe type of each column should match the positional argument of the row filter function\n" } }, "type": "object", "required": [ "functionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPolicyInfosPolicyRowFilterUsing:getPolicyInfosPolicyRowFilterUsing": { "properties": { "alias": { "type": "string", "description": "(string) - Optional alias of the matched column\n" }, "constant": { "type": "string", "description": "(string) - A constant literal\n" } }, "type": "object" }, "databricks:index/getPolicyInfosProviderConfig:getPolicyInfosProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresBranchProviderConfig:getPostgresBranchProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresBranchSpec:getPostgresBranchSpec": { "properties": { "expireTime": { "type": "string", "description": "(string) - Absolute expiration time for the branch. Empty if expiration is disabled\n" }, "isProtected": { "type": "boolean", "description": "(boolean) - Whether the branch is protected\n" }, "noExpiry": { "type": "boolean", "description": "(boolean) - Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or\u003cspan pulumi-lang-nodejs=\" expireTime \" pulumi-lang-dotnet=\" ExpireTime \" pulumi-lang-go=\" expireTime \" pulumi-lang-python=\" expire_time \" pulumi-lang-yaml=\" expireTime \" pulumi-lang-java=\" expireTime \" pulumi-lang-hcl=\" expire_time \"\u003e expireTime \u003c/span\u003einstead.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`expireTime`\" pulumi-lang-dotnet=\"`ExpireTime`\" pulumi-lang-go=\"`expireTime`\" pulumi-lang-python=\"`expire_time`\" pulumi-lang-yaml=\"`expireTime`\" pulumi-lang-java=\"`expireTime`\" pulumi-lang-hcl=\"`expire_time`\"\u003e`expireTime`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`ttl`\" pulumi-lang-dotnet=\"`Ttl`\" pulumi-lang-go=\"`ttl`\" pulumi-lang-python=\"`ttl`\" pulumi-lang-yaml=\"`ttl`\" pulumi-lang-java=\"`ttl`\" pulumi-lang-hcl=\"`ttl`\"\u003e`ttl`\u003c/span\u003e. When updating, use `spec.expiration` in the update_mask\n" }, "sourceBranch": { "type": "string", "description": "(string) - The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "sourceBranchLsn": { "type": "string", "description": "(string) - The Log Sequence Number (LSN) on the source branch from which this branch was created\n" }, "sourceBranchTime": { "type": "string", "description": "(string) - The point in time on the source branch from which this branch was created\n" }, "ttl": { "type": "string", "description": "(string) - Relative time-to-live duration. When set, the branch will expire at\u003cspan pulumi-lang-nodejs=\" creationTime \" pulumi-lang-dotnet=\" CreationTime \" pulumi-lang-go=\" creationTime \" pulumi-lang-python=\" creation_time \" pulumi-lang-yaml=\" creationTime \" pulumi-lang-java=\" creationTime \" pulumi-lang-hcl=\" creation_time \"\u003e creationTime \u003c/span\u003e+ ttl.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`expireTime`\" pulumi-lang-dotnet=\"`ExpireTime`\" pulumi-lang-go=\"`expireTime`\" pulumi-lang-python=\"`expire_time`\" pulumi-lang-yaml=\"`expireTime`\" pulumi-lang-java=\"`expireTime`\" pulumi-lang-hcl=\"`expire_time`\"\u003e`expireTime`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`noExpiry`\" pulumi-lang-dotnet=\"`NoExpiry`\" pulumi-lang-go=\"`noExpiry`\" pulumi-lang-python=\"`no_expiry`\" pulumi-lang-yaml=\"`noExpiry`\" pulumi-lang-java=\"`noExpiry`\" pulumi-lang-hcl=\"`no_expiry`\"\u003e`noExpiry`\u003c/span\u003e. When updating, use `spec.expiration` in the update_mask\n" } }, "type": "object" }, "databricks:index/getPostgresBranchStatus:getPostgresBranchStatus": { "properties": { "branchId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "currentState": { "type": "string", "description": "(string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: `ARCHIVED`, `DELETED`, `IMPORTING`, `INIT`, `READY`, `RESETTING`\n" }, "default": { "type": "boolean", "description": "(boolean) - Whether the branch is the project's default branch\n" }, "deleteTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch was deleted.\nEmpty if the branch is not deleted\n" }, "expireTime": { "type": "string", "description": "(string) - Absolute expiration time for the branch. Empty if expiration is disabled\n" }, "isProtected": { "type": "boolean", "description": "(boolean) - Whether the branch is protected\n" }, "logicalSizeBytes": { "type": "integer", "description": "(integer) - The logical size of the branch\n" }, "pendingState": { "type": "string", "description": "(string) - The pending state of the branch, if a state transition is in progress. Possible values are: `ARCHIVED`, `DELETED`, `IMPORTING`, `INIT`, `READY`, `RESETTING`\n" }, "purgeTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch is scheduled to be purged.\nEmpty if the branch is not deleted, otherwise set to a timestamp in the future\n" }, "sourceBranch": { "type": "string", "description": "(string) - The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "sourceBranchLsn": { "type": "string", "description": "(string) - The Log Sequence Number (LSN) on the source branch from which this branch was created\n" }, "sourceBranchTime": { "type": "string", "description": "(string) - The point in time on the source branch from which this branch was created\n" }, "stateChangeTime": { "type": "string", "description": "(string) - A timestamp indicating when the \u003cspan pulumi-lang-nodejs=\"`currentState`\" pulumi-lang-dotnet=\"`CurrentState`\" pulumi-lang-go=\"`currentState`\" pulumi-lang-python=\"`current_state`\" pulumi-lang-yaml=\"`currentState`\" pulumi-lang-java=\"`currentState`\" pulumi-lang-hcl=\"`current_state`\"\u003e`currentState`\u003c/span\u003e began\n" } }, "type": "object", "required": [ "branchId", "currentState", "default", "deleteTime", "expireTime", "isProtected", "logicalSizeBytes", "pendingState", "purgeTime", "sourceBranch", "sourceBranchLsn", "sourceBranchTime", "stateChangeTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresBranchesBranch:getPostgresBranchesBranch": { "properties": { "createTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch was created\n" }, "name": { "type": "string", "description": "(string) - Output only. The full resource path of the branch.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "parent": { "type": "string", "description": "The Project that owns this collection of branches.\nFormat: projects/{project_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getPostgresBranchesBranchProviderConfig:getPostgresBranchesBranchProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/getPostgresBranchesBranchSpec:getPostgresBranchesBranchSpec", "description": "(BranchSpec) - The spec contains the branch configuration\n" }, "status": { "$ref": "#/types/databricks:index/getPostgresBranchesBranchStatus:getPostgresBranchesBranchStatus", "description": "(BranchStatus) - The current status of a Branch\n" }, "uid": { "type": "string", "description": "(string) - System-generated unique ID for the branch\n" }, "updateTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch was last updated\n" } }, "type": "object", "required": [ "createTime", "name", "parent", "spec", "status", "uid", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresBranchesBranchProviderConfig:getPostgresBranchesBranchProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresBranchesBranchSpec:getPostgresBranchesBranchSpec": { "properties": { "expireTime": { "type": "string", "description": "(string) - Absolute expiration time for the branch. Empty if expiration is disabled\n" }, "isProtected": { "type": "boolean", "description": "(boolean) - Whether the branch is protected\n" }, "noExpiry": { "type": "boolean", "description": "(boolean) - Explicitly disable expiration. When set to true, the branch will not expire.\nIf set to false, the request is invalid; provide either ttl or\u003cspan pulumi-lang-nodejs=\" expireTime \" pulumi-lang-dotnet=\" ExpireTime \" pulumi-lang-go=\" expireTime \" pulumi-lang-python=\" expire_time \" pulumi-lang-yaml=\" expireTime \" pulumi-lang-java=\" expireTime \" pulumi-lang-hcl=\" expire_time \"\u003e expireTime \u003c/span\u003einstead.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`expireTime`\" pulumi-lang-dotnet=\"`ExpireTime`\" pulumi-lang-go=\"`expireTime`\" pulumi-lang-python=\"`expire_time`\" pulumi-lang-yaml=\"`expireTime`\" pulumi-lang-java=\"`expireTime`\" pulumi-lang-hcl=\"`expire_time`\"\u003e`expireTime`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`ttl`\" pulumi-lang-dotnet=\"`Ttl`\" pulumi-lang-go=\"`ttl`\" pulumi-lang-python=\"`ttl`\" pulumi-lang-yaml=\"`ttl`\" pulumi-lang-java=\"`ttl`\" pulumi-lang-hcl=\"`ttl`\"\u003e`ttl`\u003c/span\u003e. When updating, use `spec.expiration` in the update_mask\n" }, "sourceBranch": { "type": "string", "description": "(string) - The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "sourceBranchLsn": { "type": "string", "description": "(string) - The Log Sequence Number (LSN) on the source branch from which this branch was created\n" }, "sourceBranchTime": { "type": "string", "description": "(string) - The point in time on the source branch from which this branch was created\n" }, "ttl": { "type": "string", "description": "(string) - Relative time-to-live duration. When set, the branch will expire at\u003cspan pulumi-lang-nodejs=\" creationTime \" pulumi-lang-dotnet=\" CreationTime \" pulumi-lang-go=\" creationTime \" pulumi-lang-python=\" creation_time \" pulumi-lang-yaml=\" creationTime \" pulumi-lang-java=\" creationTime \" pulumi-lang-hcl=\" creation_time \"\u003e creationTime \u003c/span\u003e+ ttl.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`expireTime`\" pulumi-lang-dotnet=\"`ExpireTime`\" pulumi-lang-go=\"`expireTime`\" pulumi-lang-python=\"`expire_time`\" pulumi-lang-yaml=\"`expireTime`\" pulumi-lang-java=\"`expireTime`\" pulumi-lang-hcl=\"`expire_time`\"\u003e`expireTime`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`noExpiry`\" pulumi-lang-dotnet=\"`NoExpiry`\" pulumi-lang-go=\"`noExpiry`\" pulumi-lang-python=\"`no_expiry`\" pulumi-lang-yaml=\"`noExpiry`\" pulumi-lang-java=\"`noExpiry`\" pulumi-lang-hcl=\"`no_expiry`\"\u003e`noExpiry`\u003c/span\u003e. When updating, use `spec.expiration` in the update_mask\n" } }, "type": "object" }, "databricks:index/getPostgresBranchesBranchStatus:getPostgresBranchesBranchStatus": { "properties": { "branchId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "currentState": { "type": "string", "description": "(string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: `ARCHIVED`, `DELETED`, `IMPORTING`, `INIT`, `READY`, `RESETTING`\n" }, "default": { "type": "boolean", "description": "(boolean) - Whether the branch is the project's default branch\n" }, "deleteTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch was deleted.\nEmpty if the branch is not deleted\n" }, "expireTime": { "type": "string", "description": "(string) - Absolute expiration time for the branch. Empty if expiration is disabled\n" }, "isProtected": { "type": "boolean", "description": "(boolean) - Whether the branch is protected\n" }, "logicalSizeBytes": { "type": "integer", "description": "(integer) - The logical size of the branch\n" }, "pendingState": { "type": "string", "description": "(string) - The pending state of the branch, if a state transition is in progress. Possible values are: `ARCHIVED`, `DELETED`, `IMPORTING`, `INIT`, `READY`, `RESETTING`\n" }, "purgeTime": { "type": "string", "description": "(string) - A timestamp indicating when the branch is scheduled to be purged.\nEmpty if the branch is not deleted, otherwise set to a timestamp in the future\n" }, "sourceBranch": { "type": "string", "description": "(string) - The name of the source branch from which this branch was created.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "sourceBranchLsn": { "type": "string", "description": "(string) - The Log Sequence Number (LSN) on the source branch from which this branch was created\n" }, "sourceBranchTime": { "type": "string", "description": "(string) - The point in time on the source branch from which this branch was created\n" }, "stateChangeTime": { "type": "string", "description": "(string) - A timestamp indicating when the \u003cspan pulumi-lang-nodejs=\"`currentState`\" pulumi-lang-dotnet=\"`CurrentState`\" pulumi-lang-go=\"`currentState`\" pulumi-lang-python=\"`current_state`\" pulumi-lang-yaml=\"`currentState`\" pulumi-lang-java=\"`currentState`\" pulumi-lang-hcl=\"`current_state`\"\u003e`currentState`\u003c/span\u003e began\n" } }, "type": "object", "required": [ "branchId", "currentState", "default", "deleteTime", "expireTime", "isProtected", "logicalSizeBytes", "pendingState", "purgeTime", "sourceBranch", "sourceBranchLsn", "sourceBranchTime", "stateChangeTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresBranchesProviderConfig:getPostgresBranchesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresCatalogProviderConfig:getPostgresCatalogProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresCatalogSpec:getPostgresCatalogSpec": { "properties": { "branch": { "type": "string", "description": "(string) - The resource path of the branch associated with the catalog.\n" }, "createDatabaseIfMissing": { "type": "boolean", "description": "(boolean) - If set to true, the specified\u003cspan pulumi-lang-nodejs=\" postgresDatabase \" pulumi-lang-dotnet=\" PostgresDatabase \" pulumi-lang-go=\" postgresDatabase \" pulumi-lang-python=\" postgres_database \" pulumi-lang-yaml=\" postgresDatabase \" pulumi-lang-java=\" postgresDatabase \" pulumi-lang-hcl=\" postgres_database \"\u003e postgresDatabase \u003c/span\u003eis created on behalf of the calling user\nif it does not already exist. In this case, the calling user has a role created for\nthem in Postgres if they do not already have one.\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database associated with the catalog\n" } }, "type": "object", "required": [ "createDatabaseIfMissing", "postgresDatabase" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresCatalogStatus:getPostgresCatalogStatus": { "properties": { "branch": { "type": "string", "description": "(string) - The resource path of the branch associated with the catalog.\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database associated with the catalog\n" }, "project": { "type": "string", "description": "(string) - The resource path of the project associated with the catalog.\n" } }, "type": "object", "required": [ "branch", "postgresDatabase", "project" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresDatabaseProviderConfig:getPostgresDatabaseProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresDatabaseSpec:getPostgresDatabaseSpec": { "properties": { "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database\n" }, "role": { "type": "string", "description": "(string) - The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n" } }, "type": "object" }, "databricks:index/getPostgresDatabaseStatus:getPostgresDatabaseStatus": { "properties": { "databaseId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database\n" }, "role": { "type": "string", "description": "(string) - The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n" } }, "type": "object", "required": [ "databaseId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresDatabasesDatabase:getPostgresDatabasesDatabase": { "properties": { "createTime": { "type": "string", "description": "(string) - A timestamp indicating when the database was created\n" }, "name": { "type": "string", "description": "(string) - The resource name of the database.\nFormat: projects/{project_id}/branches/{branch_id}/databases/{database_id}\n" }, "parent": { "type": "string", "description": "The Branch that owns this collection of databases.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getPostgresDatabasesDatabaseProviderConfig:getPostgresDatabasesDatabaseProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/getPostgresDatabasesDatabaseSpec:getPostgresDatabasesDatabaseSpec", "description": "(DatabaseDatabaseSpec) - The desired state of the Database\n" }, "status": { "$ref": "#/types/databricks:index/getPostgresDatabasesDatabaseStatus:getPostgresDatabasesDatabaseStatus", "description": "(DatabaseDatabaseStatus) - The observed state of the Database\n" }, "updateTime": { "type": "string", "description": "(string) - A timestamp indicating when the database was last updated\n" } }, "type": "object", "required": [ "createTime", "name", "parent", "spec", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresDatabasesDatabaseProviderConfig:getPostgresDatabasesDatabaseProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresDatabasesDatabaseSpec:getPostgresDatabasesDatabaseSpec": { "properties": { "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database\n" }, "role": { "type": "string", "description": "(string) - The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n" } }, "type": "object" }, "databricks:index/getPostgresDatabasesDatabaseStatus:getPostgresDatabasesDatabaseStatus": { "properties": { "databaseId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The name of the Postgres database\n" }, "role": { "type": "string", "description": "(string) - The name of the role that owns the database.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n" } }, "type": "object", "required": [ "databaseId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresDatabasesProviderConfig:getPostgresDatabasesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointProviderConfig:getPostgresEndpointProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointSpec:getPostgresEndpointSpec": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units\n" }, "disabled": { "type": "boolean", "description": "(boolean) - Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action\n" }, "endpointType": { "type": "string", "description": "(string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: `ENDPOINT_TYPE_READ_ONLY`, `ENDPOINT_TYPE_READ_WRITE`\n" }, "group": { "$ref": "#/types/databricks:index/getPostgresEndpointSpecGroup:getPostgresEndpointSpecGroup", "description": "(EndpointGroupStatus) - Details on the HA configuration of the endpoint\n" }, "noSuspension": { "type": "boolean", "description": "(boolean) - When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.suspension` in the update_mask\n" }, "settings": { "$ref": "#/types/databricks:index/getPostgresEndpointSpecSettings:getPostgresEndpointSpecSettings", "description": "(EndpointSettings)\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended\n" } }, "type": "object", "required": [ "endpointType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointSpecGroup:getPostgresEndpointSpecGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1\n" }, "max": { "type": "integer", "description": "(integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "(integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointSpecSettings:getPostgresEndpointSpecSettings": { "properties": { "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" } }, "type": "object" }, "databricks:index/getPostgresEndpointStatus:getPostgresEndpointStatus": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units\n" }, "currentState": { "type": "string", "description": "(string) - Possible values are: `ACTIVE`, `DEGRADED`, `IDLE`, `INIT`\n" }, "disabled": { "type": "boolean", "description": "(boolean) - Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action\n" }, "endpointId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "endpointType": { "type": "string", "description": "(string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: `ENDPOINT_TYPE_READ_ONLY`, `ENDPOINT_TYPE_READ_WRITE`\n" }, "group": { "$ref": "#/types/databricks:index/getPostgresEndpointStatusGroup:getPostgresEndpointStatusGroup", "description": "(EndpointGroupStatus) - Details on the HA configuration of the endpoint\n" }, "hosts": { "$ref": "#/types/databricks:index/getPostgresEndpointStatusHosts:getPostgresEndpointStatusHosts", "description": "(EndpointHosts) - Contains host information for connecting to the endpoint\n" }, "pendingState": { "type": "string", "description": "(string) - Possible values are: `ACTIVE`, `DEGRADED`, `IDLE`, `INIT`\n" }, "settings": { "$ref": "#/types/databricks:index/getPostgresEndpointStatusSettings:getPostgresEndpointStatusSettings", "description": "(EndpointSettings)\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended\n" } }, "type": "object", "required": [ "autoscalingLimitMaxCu", "autoscalingLimitMinCu", "currentState", "disabled", "endpointId", "endpointType", "group", "hosts", "pendingState", "settings", "suspendTimeoutDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointStatusGroup:getPostgresEndpointStatusGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1\n" }, "max": { "type": "integer", "description": "(integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "(integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "enableReadableSecondaries", "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointStatusHosts:getPostgresEndpointStatusHosts": { "properties": { "host": { "type": "string", "description": "(string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects\nto the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations\n" }, "readOnlyHost": { "type": "string", "description": "(string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,\nthis attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined\nif the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled\n" } }, "type": "object", "required": [ "host", "readOnlyHost" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointStatusSettings:getPostgresEndpointStatusSettings": { "properties": { "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" } }, "type": "object" }, "databricks:index/getPostgresEndpointsEndpoint:getPostgresEndpointsEndpoint": { "properties": { "createTime": { "type": "string", "description": "(string) - A timestamp indicating when the compute endpoint was created\n" }, "name": { "type": "string", "description": "(string) - Output only. The full resource path of the endpoint.\nFormat: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}\n" }, "parent": { "type": "string", "description": "The Branch that owns this collection of endpoints.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointProviderConfig:getPostgresEndpointsEndpointProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointSpec:getPostgresEndpointsEndpointSpec", "description": "(EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state\n" }, "status": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointStatus:getPostgresEndpointsEndpointStatus", "description": "(EndpointStatus) - Current operational status of the compute endpoint\n" }, "uid": { "type": "string", "description": "(string) - System-generated unique ID for the endpoint\n" }, "updateTime": { "type": "string", "description": "(string) - A timestamp indicating when the compute endpoint was last updated\n" } }, "type": "object", "required": [ "createTime", "name", "parent", "spec", "status", "uid", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointProviderConfig:getPostgresEndpointsEndpointProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointSpec:getPostgresEndpointsEndpointSpec": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units\n" }, "disabled": { "type": "boolean", "description": "(boolean) - Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action\n" }, "endpointType": { "type": "string", "description": "(string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: `ENDPOINT_TYPE_READ_ONLY`, `ENDPOINT_TYPE_READ_WRITE`\n" }, "group": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointSpecGroup:getPostgresEndpointsEndpointSpecGroup", "description": "(EndpointGroupStatus) - Details on the HA configuration of the endpoint\n" }, "noSuspension": { "type": "boolean", "description": "(boolean) - When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.suspension` in the update_mask\n" }, "settings": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointSpecSettings:getPostgresEndpointsEndpointSpecSettings", "description": "(EndpointSettings)\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended\n" } }, "type": "object", "required": [ "endpointType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointSpecGroup:getPostgresEndpointsEndpointSpecGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1\n" }, "max": { "type": "integer", "description": "(integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "(integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointSpecSettings:getPostgresEndpointsEndpointSpecSettings": { "properties": { "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" } }, "type": "object" }, "databricks:index/getPostgresEndpointsEndpointStatus:getPostgresEndpointsEndpointStatus": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. The maximum value is 64.\nThe difference between the minimum and maximum Compute Units (max - min) must not exceed 16\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units\n" }, "currentState": { "type": "string", "description": "(string) - Possible values are: `ACTIVE`, `DEGRADED`, `IDLE`, `INIT`\n" }, "disabled": { "type": "boolean", "description": "(boolean) - Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action\n" }, "endpointId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "endpointType": { "type": "string", "description": "(string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: `ENDPOINT_TYPE_READ_ONLY`, `ENDPOINT_TYPE_READ_WRITE`\n" }, "group": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointStatusGroup:getPostgresEndpointsEndpointStatusGroup", "description": "(EndpointGroupStatus) - Details on the HA configuration of the endpoint\n" }, "hosts": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointStatusHosts:getPostgresEndpointsEndpointStatusHosts", "description": "(EndpointHosts) - Contains host information for connecting to the endpoint\n" }, "pendingState": { "type": "string", "description": "(string) - Possible values are: `ACTIVE`, `DEGRADED`, `IDLE`, `INIT`\n" }, "settings": { "$ref": "#/types/databricks:index/getPostgresEndpointsEndpointStatusSettings:getPostgresEndpointsEndpointStatusSettings", "description": "(EndpointSettings)\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended\n" } }, "type": "object", "required": [ "autoscalingLimitMaxCu", "autoscalingLimitMinCu", "currentState", "disabled", "endpointId", "endpointType", "group", "hosts", "pendingState", "settings", "suspendTimeoutDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointStatusGroup:getPostgresEndpointsEndpointStatusGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured\nby specifying size.max \u003e 1\n" }, "max": { "type": "integer", "description": "(integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "(integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "enableReadableSecondaries", "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointStatusHosts:getPostgresEndpointsEndpointStatusHosts": { "properties": { "host": { "type": "string", "description": "(string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects\nto the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations\n" }, "readOnlyHost": { "type": "string", "description": "(string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,\nthis attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined\nif the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled\n" } }, "type": "object", "required": [ "host", "readOnlyHost" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresEndpointsEndpointStatusSettings:getPostgresEndpointsEndpointStatusSettings": { "properties": { "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" } }, "type": "object" }, "databricks:index/getPostgresEndpointsProviderConfig:getPostgresEndpointsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectInitialEndpointSpec:getPostgresProjectInitialEndpointSpec": { "properties": { "group": { "$ref": "#/types/databricks:index/getPostgresProjectInitialEndpointSpecGroup:getPostgresProjectInitialEndpointSpecGroup", "description": "(EndpointGroupSpec) - Settings for HA configuration of the endpoint\n" } }, "type": "object" }, "databricks:index/getPostgresProjectInitialEndpointSpecGroup:getPostgresProjectInitialEndpointSpecGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1\n" }, "max": { "type": "integer", "description": "(integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "(integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectProviderConfig:getPostgresProjectProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectSpec:getPostgresProjectSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "(string) - The budget policy that is applied to the project\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPostgresProjectSpecCustomTag:getPostgresProjectSpecCustomTag" }, "description": "(list of ProjectCustomTag) - The effective custom tags associated with the project\n" }, "defaultBranch": { "type": "string", "description": "(string) - The full resource path of the default branch of the project\n" }, "defaultEndpointSettings": { "$ref": "#/types/databricks:index/getPostgresProjectSpecDefaultEndpointSettings:getPostgresProjectSpecDefaultEndpointSettings", "description": "(ProjectDefaultEndpointSettings) - The effective default endpoint settings\n" }, "displayName": { "type": "string", "description": "(string) - The effective human-readable project name\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on all endpoints in this project\n" }, "historyRetentionDuration": { "type": "string", "description": "(string) - The effective number of seconds to retain the shared history for point in time recovery\n" }, "pgVersion": { "type": "integer", "description": "(integer) - The effective major Postgres version number\n" } }, "type": "object" }, "databricks:index/getPostgresProjectSpecCustomTag:getPostgresProjectSpecCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getPostgresProjectSpecDefaultEndpointSettings:getPostgresProjectSpecDefaultEndpointSettings": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. Minimum value is 0.5\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units. Minimum value is 0.5\n" }, "noSuspension": { "type": "boolean", "description": "(boolean) - When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" }, "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`noSuspension`\" pulumi-lang-dotnet=\"`NoSuspension`\" pulumi-lang-go=\"`noSuspension`\" pulumi-lang-python=\"`no_suspension`\" pulumi-lang-yaml=\"`noSuspension`\" pulumi-lang-java=\"`noSuspension`\" pulumi-lang-hcl=\"`no_suspension`\"\u003e`noSuspension`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" } }, "type": "object" }, "databricks:index/getPostgresProjectStatus:getPostgresProjectStatus": { "properties": { "branchLogicalSizeLimitBytes": { "type": "integer", "description": "(integer) - The logical size limit for a branch\n" }, "budgetPolicyId": { "type": "string", "description": "(string) - The budget policy that is applied to the project\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPostgresProjectStatusCustomTag:getPostgresProjectStatusCustomTag" }, "description": "(list of ProjectCustomTag) - The effective custom tags associated with the project\n" }, "defaultBranch": { "type": "string", "description": "(string) - The full resource path of the default branch of the project\n" }, "defaultEndpointSettings": { "$ref": "#/types/databricks:index/getPostgresProjectStatusDefaultEndpointSettings:getPostgresProjectStatusDefaultEndpointSettings", "description": "(ProjectDefaultEndpointSettings) - The effective default endpoint settings\n" }, "displayName": { "type": "string", "description": "(string) - The effective human-readable project name\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on all endpoints in this project\n" }, "historyRetentionDuration": { "type": "string", "description": "(string) - The effective number of seconds to retain the shared history for point in time recovery\n" }, "owner": { "type": "string", "description": "(string) - The email of the project owner\n" }, "pgVersion": { "type": "integer", "description": "(integer) - The effective major Postgres version number\n" }, "projectId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "syntheticStorageSizeBytes": { "type": "integer", "description": "(integer) - The current space occupied by the project in storage\n" } }, "type": "object", "required": [ "branchLogicalSizeLimitBytes", "budgetPolicyId", "customTags", "defaultBranch", "defaultEndpointSettings", "displayName", "enablePgNativeLogin", "historyRetentionDuration", "owner", "pgVersion", "projectId", "syntheticStorageSizeBytes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectStatusCustomTag:getPostgresProjectStatusCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getPostgresProjectStatusDefaultEndpointSettings:getPostgresProjectStatusDefaultEndpointSettings": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. Minimum value is 0.5\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units. Minimum value is 0.5\n" }, "noSuspension": { "type": "boolean", "description": "(boolean) - When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" }, "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`noSuspension`\" pulumi-lang-dotnet=\"`NoSuspension`\" pulumi-lang-go=\"`noSuspension`\" pulumi-lang-python=\"`no_suspension`\" pulumi-lang-yaml=\"`noSuspension`\" pulumi-lang-java=\"`noSuspension`\" pulumi-lang-hcl=\"`no_suspension`\"\u003e`noSuspension`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProject:getPostgresProjectsProject": { "properties": { "createTime": { "type": "string", "description": "(string) - A timestamp indicating when the project was created\n" }, "deleteTime": { "type": "string", "description": "(string) - A timestamp indicating when the project was soft-deleted.\nEmpty if the project is not deleted, otherwise set to a timestamp in the past\n" }, "initialEndpointSpec": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectInitialEndpointSpec:getPostgresProjectsProjectInitialEndpointSpec", "description": "(InitialEndpointSpec) - Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly\ncreated project. If omitted, the initial endpoint created will have default settings, without high availability\nconfigured. This field does not apply to any endpoints created after project creation. Use\nspec.default_endpoint_settings to configure default settings for endpoints created after project creation\n" }, "name": { "type": "string", "description": "(string) - Output only. The full resource path of the project.\nFormat: projects/{project_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectProviderConfig:getPostgresProjectsProjectProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeTime": { "type": "string", "description": "(string) - A timestamp indicating when the project is scheduled for permanent deletion.\nEmpty if the project is not deleted, otherwise set to a timestamp in the future\n" }, "spec": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectSpec:getPostgresProjectsProjectSpec", "description": "(ProjectSpec) - The spec contains the project configuration, including display_name,\u003cspan pulumi-lang-nodejs=\" pgVersion \" pulumi-lang-dotnet=\" PgVersion \" pulumi-lang-go=\" pgVersion \" pulumi-lang-python=\" pg_version \" pulumi-lang-yaml=\" pgVersion \" pulumi-lang-java=\" pgVersion \" pulumi-lang-hcl=\" pg_version \"\u003e pgVersion \u003c/span\u003e(Postgres version), history_retention_duration, and default_endpoint_settings\n" }, "status": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectStatus:getPostgresProjectsProjectStatus", "description": "(ProjectStatus) - The current status of a Project\n" }, "uid": { "type": "string", "description": "(string) - System-generated unique ID for the project\n" }, "updateTime": { "type": "string", "description": "(string) - A timestamp indicating when the project was last updated\n" } }, "type": "object", "required": [ "createTime", "deleteTime", "initialEndpointSpec", "name", "purgeTime", "spec", "status", "uid", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectsProjectInitialEndpointSpec:getPostgresProjectsProjectInitialEndpointSpec": { "properties": { "group": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectInitialEndpointSpecGroup:getPostgresProjectsProjectInitialEndpointSpecGroup", "description": "(EndpointGroupSpec) - Settings for HA configuration of the endpoint\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProjectInitialEndpointSpecGroup:getPostgresProjectsProjectInitialEndpointSpecGroup": { "properties": { "enableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where\nsize.max \u003e 1\n" }, "max": { "type": "integer", "description": "(integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single\ncompute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to\ntrue on the EndpointSpec\n" }, "min": { "type": "integer", "description": "(integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater\nthan or equal to 1\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectsProjectProviderConfig:getPostgresProjectsProjectProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectsProjectSpec:getPostgresProjectsProjectSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "(string) - The budget policy that is applied to the project\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectSpecCustomTag:getPostgresProjectsProjectSpecCustomTag" }, "description": "(list of ProjectCustomTag) - The effective custom tags associated with the project\n" }, "defaultBranch": { "type": "string", "description": "(string) - The full resource path of the default branch of the project\n" }, "defaultEndpointSettings": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectSpecDefaultEndpointSettings:getPostgresProjectsProjectSpecDefaultEndpointSettings", "description": "(ProjectDefaultEndpointSettings) - The effective default endpoint settings\n" }, "displayName": { "type": "string", "description": "(string) - The effective human-readable project name\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on all endpoints in this project\n" }, "historyRetentionDuration": { "type": "string", "description": "(string) - The effective number of seconds to retain the shared history for point in time recovery\n" }, "pgVersion": { "type": "integer", "description": "(integer) - The effective major Postgres version number\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProjectSpecCustomTag:getPostgresProjectsProjectSpecCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProjectSpecDefaultEndpointSettings:getPostgresProjectsProjectSpecDefaultEndpointSettings": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. Minimum value is 0.5\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units. Minimum value is 0.5\n" }, "noSuspension": { "type": "boolean", "description": "(boolean) - When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" }, "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`noSuspension`\" pulumi-lang-dotnet=\"`NoSuspension`\" pulumi-lang-go=\"`noSuspension`\" pulumi-lang-python=\"`no_suspension`\" pulumi-lang-yaml=\"`noSuspension`\" pulumi-lang-java=\"`noSuspension`\" pulumi-lang-hcl=\"`no_suspension`\"\u003e`noSuspension`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProjectStatus:getPostgresProjectsProjectStatus": { "properties": { "branchLogicalSizeLimitBytes": { "type": "integer", "description": "(integer) - The logical size limit for a branch\n" }, "budgetPolicyId": { "type": "string", "description": "(string) - The budget policy that is applied to the project\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectStatusCustomTag:getPostgresProjectsProjectStatusCustomTag" }, "description": "(list of ProjectCustomTag) - The effective custom tags associated with the project\n" }, "defaultBranch": { "type": "string", "description": "(string) - The full resource path of the default branch of the project\n" }, "defaultEndpointSettings": { "$ref": "#/types/databricks:index/getPostgresProjectsProjectStatusDefaultEndpointSettings:getPostgresProjectsProjectStatusDefaultEndpointSettings", "description": "(ProjectDefaultEndpointSettings) - The effective default endpoint settings\n" }, "displayName": { "type": "string", "description": "(string) - The effective human-readable project name\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether to enable PG native password login on all endpoints in this project\n" }, "historyRetentionDuration": { "type": "string", "description": "(string) - The effective number of seconds to retain the shared history for point in time recovery\n" }, "owner": { "type": "string", "description": "(string) - The email of the project owner\n" }, "pgVersion": { "type": "integer", "description": "(integer) - The effective major Postgres version number\n" }, "projectId": { "type": "string", "description": "(string) - Part of the resource name\n" }, "syntheticStorageSizeBytes": { "type": "integer", "description": "(integer) - The current space occupied by the project in storage\n" } }, "type": "object", "required": [ "branchLogicalSizeLimitBytes", "budgetPolicyId", "customTags", "defaultBranch", "defaultEndpointSettings", "displayName", "enablePgNativeLogin", "historyRetentionDuration", "owner", "pgVersion", "projectId", "syntheticStorageSizeBytes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresProjectsProjectStatusCustomTag:getPostgresProjectsProjectStatusCustomTag": { "properties": { "key": { "type": "string", "description": "(string) - The key of the custom tag\n" }, "value": { "type": "string", "description": "(string) - The value of the custom tag\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProjectStatusDefaultEndpointSettings:getPostgresProjectsProjectStatusDefaultEndpointSettings": { "properties": { "autoscalingLimitMaxCu": { "type": "number", "description": "(number) - The maximum number of Compute Units. Minimum value is 0.5\n" }, "autoscalingLimitMinCu": { "type": "number", "description": "(number) - The minimum number of Compute Units. Minimum value is 0.5\n" }, "noSuspension": { "type": "boolean", "description": "(boolean) - When set to true, explicitly disables automatic suspension (never suspend).\nShould be set to true when provided.\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`suspendTimeoutDuration`\" pulumi-lang-dotnet=\"`SuspendTimeoutDuration`\" pulumi-lang-go=\"`suspendTimeoutDuration`\" pulumi-lang-python=\"`suspend_timeout_duration`\" pulumi-lang-yaml=\"`suspendTimeoutDuration`\" pulumi-lang-java=\"`suspendTimeoutDuration`\" pulumi-lang-hcl=\"`suspend_timeout_duration`\"\u003e`suspendTimeoutDuration`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" }, "pgSettings": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(object) - A raw representation of Postgres settings\n" }, "suspendTimeoutDuration": { "type": "string", "description": "(string) - Duration of inactivity after which the compute endpoint is automatically suspended.\nIf specified should be between 60s and 604800s (1 minute to 1 week).\nMutually exclusive with \u003cspan pulumi-lang-nodejs=\"`noSuspension`\" pulumi-lang-dotnet=\"`NoSuspension`\" pulumi-lang-go=\"`noSuspension`\" pulumi-lang-python=\"`no_suspension`\" pulumi-lang-yaml=\"`noSuspension`\" pulumi-lang-java=\"`noSuspension`\" pulumi-lang-hcl=\"`no_suspension`\"\u003e`noSuspension`\u003c/span\u003e. When updating, use `spec.project_default_settings.suspension` in the update_mask\n" } }, "type": "object" }, "databricks:index/getPostgresProjectsProviderConfig:getPostgresProjectsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRoleProviderConfig:getPostgresRoleProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRoleSpec:getPostgresRoleSpec": { "properties": { "attributes": { "$ref": "#/types/databricks:index/getPostgresRoleSpecAttributes:getPostgresRoleSpecAttributes", "description": "(RoleAttributes) - The PG role attributes associated with the role\n" }, "authMethod": { "type": "string", "description": "(string) - Possible values are: `LAKEBASE_OAUTH_V1`, `NO_LOGIN`, `PG_PASSWORD_SCRAM_SHA_256`\n" }, "identityType": { "type": "string", "description": "(string) - The type of the role. Possible values are: `GROUP`, `SERVICE_PRINCIPAL`, `USER`\n" }, "membershipRoles": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - An enum value for a standard role that this role is a member of\n" }, "postgresRole": { "type": "string", "description": "(string) - The name of the Postgres role\n" } }, "type": "object" }, "databricks:index/getPostgresRoleSpecAttributes:getPostgresRoleSpecAttributes": { "properties": { "bypassrls": { "type": "boolean", "description": "(boolean)\n" }, "createdb": { "type": "boolean", "description": "(boolean)\n" }, "createrole": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getPostgresRoleStatus:getPostgresRoleStatus": { "properties": { "attributes": { "$ref": "#/types/databricks:index/getPostgresRoleStatusAttributes:getPostgresRoleStatusAttributes", "description": "(RoleAttributes) - The PG role attributes associated with the role\n" }, "authMethod": { "type": "string", "description": "(string) - Possible values are: `LAKEBASE_OAUTH_V1`, `NO_LOGIN`, `PG_PASSWORD_SCRAM_SHA_256`\n" }, "identityType": { "type": "string", "description": "(string) - The type of the role. Possible values are: `GROUP`, `SERVICE_PRINCIPAL`, `USER`\n" }, "membershipRoles": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - An enum value for a standard role that this role is a member of\n" }, "postgresRole": { "type": "string", "description": "(string) - The name of the Postgres role\n" }, "roleId": { "type": "string", "description": "(string) - Part of the resource name\n" } }, "type": "object", "required": [ "roleId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRoleStatusAttributes:getPostgresRoleStatusAttributes": { "properties": { "bypassrls": { "type": "boolean", "description": "(boolean)\n" }, "createdb": { "type": "boolean", "description": "(boolean)\n" }, "createrole": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getPostgresRolesProviderConfig:getPostgresRolesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRolesRole:getPostgresRolesRole": { "properties": { "createTime": { "type": "string", "description": "(string)\n" }, "name": { "type": "string", "description": "(string) - Output only. The full resource path of the role.\nFormat: projects/{project_id}/branches/{branch_id}/roles/{role_id}\n" }, "parent": { "type": "string", "description": "The Branch that owns this collection of roles.\nFormat: projects/{project_id}/branches/{branch_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getPostgresRolesRoleProviderConfig:getPostgresRolesRoleProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/getPostgresRolesRoleSpec:getPostgresRolesRoleSpec", "description": "(RoleRoleSpec) - The spec contains the role configuration, including identity type, authentication method, and role attributes\n" }, "status": { "$ref": "#/types/databricks:index/getPostgresRolesRoleStatus:getPostgresRolesRoleStatus", "description": "(RoleRoleStatus) - Current status of the role, including its identity type, authentication method, and role attributes\n" }, "updateTime": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "createTime", "name", "parent", "spec", "status", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRolesRoleProviderConfig:getPostgresRolesRoleProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRolesRoleSpec:getPostgresRolesRoleSpec": { "properties": { "attributes": { "$ref": "#/types/databricks:index/getPostgresRolesRoleSpecAttributes:getPostgresRolesRoleSpecAttributes", "description": "(RoleAttributes) - The PG role attributes associated with the role\n" }, "authMethod": { "type": "string", "description": "(string) - Possible values are: `LAKEBASE_OAUTH_V1`, `NO_LOGIN`, `PG_PASSWORD_SCRAM_SHA_256`\n" }, "identityType": { "type": "string", "description": "(string) - The type of the role. Possible values are: `GROUP`, `SERVICE_PRINCIPAL`, `USER`\n" }, "membershipRoles": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - An enum value for a standard role that this role is a member of\n" }, "postgresRole": { "type": "string", "description": "(string) - The name of the Postgres role\n" } }, "type": "object" }, "databricks:index/getPostgresRolesRoleSpecAttributes:getPostgresRolesRoleSpecAttributes": { "properties": { "bypassrls": { "type": "boolean", "description": "(boolean)\n" }, "createdb": { "type": "boolean", "description": "(boolean)\n" }, "createrole": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getPostgresRolesRoleStatus:getPostgresRolesRoleStatus": { "properties": { "attributes": { "$ref": "#/types/databricks:index/getPostgresRolesRoleStatusAttributes:getPostgresRolesRoleStatusAttributes", "description": "(RoleAttributes) - The PG role attributes associated with the role\n" }, "authMethod": { "type": "string", "description": "(string) - Possible values are: `LAKEBASE_OAUTH_V1`, `NO_LOGIN`, `PG_PASSWORD_SCRAM_SHA_256`\n" }, "identityType": { "type": "string", "description": "(string) - The type of the role. Possible values are: `GROUP`, `SERVICE_PRINCIPAL`, `USER`\n" }, "membershipRoles": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - An enum value for a standard role that this role is a member of\n" }, "postgresRole": { "type": "string", "description": "(string) - The name of the Postgres role\n" }, "roleId": { "type": "string", "description": "(string) - Part of the resource name\n" } }, "type": "object", "required": [ "roleId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresRolesRoleStatusAttributes:getPostgresRolesRoleStatusAttributes": { "properties": { "bypassrls": { "type": "boolean", "description": "(boolean)\n" }, "createdb": { "type": "boolean", "description": "(boolean)\n" }, "createrole": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getPostgresSyncedTableProviderConfig:getPostgresSyncedTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresSyncedTableSpec:getPostgresSyncedTableSpec": { "properties": { "branch": { "type": "string", "description": "(string) - The full resource name the branch associated with the table.\n" }, "createDatabaseObjectsIfMissing": { "type": "boolean", "description": "(boolean) - If true, the synced table's logical database and schema resources in PG\nwill be created if they do not already exist.\nThe request will fail if this is false and the database/schema do not exist.\n" }, "existingPipelineId": { "type": "string", "description": "(string) - ID of an existing pipeline to bin-pack this synced table into.\nAt most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n" }, "newPipelineSpec": { "$ref": "#/types/databricks:index/getPostgresSyncedTableSpecNewPipelineSpec:getPostgresSyncedTableSpecNewPipelineSpec", "description": "(NewPipelineSpec) - Specification for creating a new pipeline.\nAt most one of\u003cspan pulumi-lang-nodejs=\" existingPipelineId \" pulumi-lang-dotnet=\" ExistingPipelineId \" pulumi-lang-go=\" existingPipelineId \" pulumi-lang-python=\" existing_pipeline_id \" pulumi-lang-yaml=\" existingPipelineId \" pulumi-lang-java=\" existingPipelineId \" pulumi-lang-hcl=\" existing_pipeline_id \"\u003e existingPipelineId \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" newPipelineSpec \" pulumi-lang-dotnet=\" NewPipelineSpec \" pulumi-lang-go=\" newPipelineSpec \" pulumi-lang-python=\" new_pipeline_spec \" pulumi-lang-yaml=\" newPipelineSpec \" pulumi-lang-java=\" newPipelineSpec \" pulumi-lang-hcl=\" new_pipeline_spec \"\u003e newPipelineSpec \u003c/span\u003eshould be defined.\n" }, "postgresDatabase": { "type": "string", "description": "(string) - The Postgres database name where the synced table will be created in.\n" }, "primaryKeyColumns": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - Primary Key columns to be used for data insert/update in the destination\n" }, "schedulingPolicy": { "type": "string", "description": "(string) - Scheduling policy of the underlying pipeline. Possible values are: `CONTINUOUS`, `SNAPSHOT`, `TRIGGERED`\n" }, "sourceTableFullName": { "type": "string", "description": "(string) - Three-part (catalog, schema, table) name of the source Delta table.\n" }, "timeseriesKey": { "type": "string", "description": "(string) - Time series key to deduplicate (tie-break) rows with the same primary key\n" } }, "type": "object" }, "databricks:index/getPostgresSyncedTableSpecNewPipelineSpec:getPostgresSyncedTableSpecNewPipelineSpec": { "properties": { "budgetPolicyId": { "type": "string", "description": "(string) - Budget policy to set on the newly created pipeline\n" }, "storageCatalog": { "type": "string", "description": "(string) - UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be a standard catalog where the user has permissions to create Delta tables\n" }, "storageSchema": { "type": "string", "description": "(string) - UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).\nThis needs to be in the standard catalog where the user has permissions to create Delta tables\n" } }, "type": "object" }, "databricks:index/getPostgresSyncedTableStatus:getPostgresSyncedTableStatus": { "properties": { "detailedState": { "type": "string", "description": "(string) - The state of the synced table. Possible values are: `SYNCED_TABLE_OFFLINE`, `SYNCED_TABLE_OFFLINE_FAILED`, `SYNCED_TABLE_ONLINE`, `SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE`, `SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE`, `SYNCED_TABLE_ONLINE_PIPELINE_FAILED`, `SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE`, `SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES`, `SYNCED_TABLE_PROVISIONING`, `SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT`, `SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES`\n" }, "lastProcessedCommitVersion": { "type": "integer", "description": "(integer) - The last source table Delta version that was successfully synced to the synced table\n" }, "lastSync": { "$ref": "#/types/databricks:index/getPostgresSyncedTableStatusLastSync:getPostgresSyncedTableStatusLastSync", "description": "(SyncedTablePosition) - Summary of the last successful synchronization from source to destination\n" }, "lastSyncTime": { "type": "string", "description": "(string) - The end timestamp of the last time any data was synchronized from the source table to the synced\ntable. This is when the data is available in the synced table\n" }, "message": { "type": "string", "description": "(string) - A text description of the current state of the synced table\n" }, "ongoingSyncProgress": { "$ref": "#/types/databricks:index/getPostgresSyncedTableStatusOngoingSyncProgress:getPostgresSyncedTableStatusOngoingSyncProgress", "description": "(SyncedTablePipelineProgress)\n" }, "pipelineId": { "type": "string", "description": "(string) - ID of the associated pipeline\n" }, "project": { "type": "string", "description": "(string) - The full resource name of the project associated with the table.\n" }, "provisioningPhase": { "type": "string", "description": "(string) - The current phase of the data synchronization pipeline. Possible values are: `PROVISIONING_PHASE_INDEX_SCAN`, `PROVISIONING_PHASE_INDEX_SORT`, `PROVISIONING_PHASE_MAIN`\n" }, "unityCatalogProvisioningState": { "type": "string", "description": "(string) - The provisioning state of the synced table entity in Unity Catalog. Possible values are: `ACTIVE`, `DEGRADED`, `DELETING`, `FAILED`, `PROVISIONING`, `UPDATING`\n" } }, "type": "object", "required": [ "detailedState", "lastProcessedCommitVersion", "lastSync", "lastSyncTime", "message", "ongoingSyncProgress", "pipelineId", "project", "provisioningPhase", "unityCatalogProvisioningState" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresSyncedTableStatusLastSync:getPostgresSyncedTableStatusLastSync": { "properties": { "deltaTableSyncInfo": { "$ref": "#/types/databricks:index/getPostgresSyncedTableStatusLastSyncDeltaTableSyncInfo:getPostgresSyncedTableStatusLastSyncDeltaTableSyncInfo", "description": "(DeltaTableSyncInfo)\n" }, "syncEndTime": { "type": "string", "description": "(string) - The end timestamp of the most recent successful synchronization.\nThis is the time when the data is available in the synced table\n" }, "syncStartTime": { "type": "string", "description": "(string) - The starting timestamp of the most recent successful synchronization from the source table\nto the destination (synced) table.\nNote this is the starting timestamp of the sync operation, not the end time.\nE.g., for a batch, this is the time when the sync operation started\n" } }, "type": "object", "required": [ "deltaTableSyncInfo", "syncEndTime", "syncStartTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresSyncedTableStatusLastSyncDeltaTableSyncInfo:getPostgresSyncedTableStatusLastSyncDeltaTableSyncInfo": { "properties": { "deltaCommitTime": { "type": "string", "description": "(string) - The timestamp when the above Delta version was committed in the source Delta table.\nNote: This is the Delta commit time, not the time the data was written to the synced table\n" }, "deltaCommitVersion": { "type": "integer", "description": "(integer) - The Delta Lake commit version that was last successfully synced\n" } }, "type": "object", "required": [ "deltaCommitTime", "deltaCommitVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getPostgresSyncedTableStatusOngoingSyncProgress:getPostgresSyncedTableStatusOngoingSyncProgress": { "properties": { "estimatedCompletionTimeSeconds": { "type": "number", "description": "(number) - The estimated time remaining to complete this update in seconds\n" }, "latestVersionCurrentlyProcessing": { "type": "integer", "description": "(integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not\nhave completely processed this version yet\n" }, "syncProgressCompletion": { "type": "number", "description": "(number) - The completion ratio of this update. This is a number between 0 and 1\n" }, "syncedRowCount": { "type": "integer", "description": "(integer) - The number of rows that have been synced in this update\n" }, "totalRowCount": { "type": "integer", "description": "(integer) - The total number of rows that need to be synced in this update. This number may be an estimate\n" } }, "type": "object", "required": [ "estimatedCompletionTimeSeconds", "latestVersionCurrentlyProcessing", "syncProgressCompletion", "syncedRowCount", "totalRowCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorV2AnomalyDetectionConfig:getQualityMonitorV2AnomalyDetectionConfig": { "properties": { "excludedTableFullNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of fully qualified table names to exclude from anomaly detection\n" }, "lastRunId": { "type": "string", "description": "(string) - Run id of the last run of the workflow\n" }, "latestRunStatus": { "type": "string", "description": "(string) - The status of the last run of the workflow. Possible values are: `ANOMALY_DETECTION_RUN_STATUS_CANCELED`, `ANOMALY_DETECTION_RUN_STATUS_FAILED`, `ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED`, `ANOMALY_DETECTION_RUN_STATUS_PENDING`, `ANOMALY_DETECTION_RUN_STATUS_RUNNING`, `ANOMALY_DETECTION_RUN_STATUS_SUCCESS`, `ANOMALY_DETECTION_RUN_STATUS_UNKNOWN`, `ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR`\n" } }, "type": "object", "required": [ "lastRunId", "latestRunStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorV2ProviderConfig:getQualityMonitorV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorV2ValidityCheckConfiguration:getQualityMonitorV2ValidityCheckConfiguration": { "properties": { "name": { "type": "string", "description": "(string) - Can be set by system. Does not need to be user facing\n" }, "percentNullValidityCheck": { "$ref": "#/types/databricks:index/getQualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck:getQualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck", "description": "(PercentNullValidityCheck)\n" }, "rangeValidityCheck": { "$ref": "#/types/databricks:index/getQualityMonitorV2ValidityCheckConfigurationRangeValidityCheck:getQualityMonitorV2ValidityCheckConfigurationRangeValidityCheck", "description": "(RangeValidityCheck)\n" }, "uniquenessValidityCheck": { "$ref": "#/types/databricks:index/getQualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck:getQualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck", "description": "(UniquenessValidityCheck)\n" } }, "type": "object" }, "databricks:index/getQualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck:getQualityMonitorV2ValidityCheckConfigurationPercentNullValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column names to check for uniqueness\n" }, "upperBound": { "type": "number", "description": "(number) - Upper bound for the range\n" } }, "type": "object" }, "databricks:index/getQualityMonitorV2ValidityCheckConfigurationRangeValidityCheck:getQualityMonitorV2ValidityCheckConfigurationRangeValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column names to check for uniqueness\n" }, "lowerBound": { "type": "number", "description": "(number) - Lower bound for the range\n" }, "upperBound": { "type": "number", "description": "(number) - Upper bound for the range\n" } }, "type": "object" }, "databricks:index/getQualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck:getQualityMonitorV2ValidityCheckConfigurationUniquenessValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column names to check for uniqueness\n" } }, "type": "object" }, "databricks:index/getQualityMonitorsV2ProviderConfig:getQualityMonitorsV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorsV2QualityMonitor:getQualityMonitorsV2QualityMonitor": { "properties": { "anomalyDetectionConfig": { "$ref": "#/types/databricks:index/getQualityMonitorsV2QualityMonitorAnomalyDetectionConfig:getQualityMonitorsV2QualityMonitorAnomalyDetectionConfig", "description": "(AnomalyDetectionConfig)\n" }, "objectId": { "type": "string", "description": "(string) - The uuid of the request object. For example, schema id\n" }, "objectType": { "type": "string", "description": "(string) - The type of the monitored object. Can be one of the following: schema\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getQualityMonitorsV2QualityMonitorProviderConfig:getQualityMonitorsV2QualityMonitorProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "validityCheckConfigurations": { "type": "array", "items": { "$ref": "#/types/databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfiguration:getQualityMonitorsV2QualityMonitorValidityCheckConfiguration" }, "description": "(list of ValidityCheckConfiguration) - Validity check configurations for anomaly detection\n" } }, "type": "object", "required": [ "anomalyDetectionConfig", "objectId", "objectType", "validityCheckConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorsV2QualityMonitorAnomalyDetectionConfig:getQualityMonitorsV2QualityMonitorAnomalyDetectionConfig": { "properties": { "excludedTableFullNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of fully qualified table names to exclude from anomaly detection\n" }, "lastRunId": { "type": "string", "description": "(string) - Run id of the last run of the workflow\n" }, "latestRunStatus": { "type": "string", "description": "(string) - The status of the last run of the workflow. Possible values are: `ANOMALY_DETECTION_RUN_STATUS_CANCELED`, `ANOMALY_DETECTION_RUN_STATUS_FAILED`, `ANOMALY_DETECTION_RUN_STATUS_JOB_DELETED`, `ANOMALY_DETECTION_RUN_STATUS_PENDING`, `ANOMALY_DETECTION_RUN_STATUS_RUNNING`, `ANOMALY_DETECTION_RUN_STATUS_SUCCESS`, `ANOMALY_DETECTION_RUN_STATUS_UNKNOWN`, `ANOMALY_DETECTION_RUN_STATUS_WORKSPACE_MISMATCH_ERROR`\n" } }, "type": "object", "required": [ "lastRunId", "latestRunStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorsV2QualityMonitorProviderConfig:getQualityMonitorsV2QualityMonitorProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfiguration:getQualityMonitorsV2QualityMonitorValidityCheckConfiguration": { "properties": { "name": { "type": "string", "description": "(string) - Can be set by system. Does not need to be user facing\n" }, "percentNullValidityCheck": { "$ref": "#/types/databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfigurationPercentNullValidityCheck:getQualityMonitorsV2QualityMonitorValidityCheckConfigurationPercentNullValidityCheck", "description": "(PercentNullValidityCheck)\n" }, "rangeValidityCheck": { "$ref": "#/types/databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfigurationRangeValidityCheck:getQualityMonitorsV2QualityMonitorValidityCheckConfigurationRangeValidityCheck", "description": "(RangeValidityCheck)\n" }, "uniquenessValidityCheck": { "$ref": "#/types/databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfigurationUniquenessValidityCheck:getQualityMonitorsV2QualityMonitorValidityCheckConfigurationUniquenessValidityCheck", "description": "(UniquenessValidityCheck)\n" } }, "type": "object" }, "databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfigurationPercentNullValidityCheck:getQualityMonitorsV2QualityMonitorValidityCheckConfigurationPercentNullValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column names to check for uniqueness\n" }, "upperBound": { "type": "number", "description": "(number) - Upper bound for the range\n" } }, "type": "object" }, "databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfigurationRangeValidityCheck:getQualityMonitorsV2QualityMonitorValidityCheckConfigurationRangeValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column names to check for uniqueness\n" }, "lowerBound": { "type": "number", "description": "(number) - Lower bound for the range\n" }, "upperBound": { "type": "number", "description": "(number) - Upper bound for the range\n" } }, "type": "object" }, "databricks:index/getQualityMonitorsV2QualityMonitorValidityCheckConfigurationUniquenessValidityCheck:getQualityMonitorsV2QualityMonitorValidityCheckConfigurationUniquenessValidityCheck": { "properties": { "columnNames": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - List of column names to check for uniqueness\n" } }, "type": "object" }, "databricks:index/getRegisteredModelModelInfo:getRegisteredModelModelInfo": { "properties": { "aliases": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelModelInfoAlias:getRegisteredModelModelInfoAlias" }, "description": "the list of aliases associated with this model. Each item is object consisting of following attributes:\n" }, "browseOnly": { "type": "boolean" }, "catalogName": { "type": "string", "description": "The name of the catalog where the schema and the registered model reside.\n" }, "comment": { "type": "string", "description": "The comment attached to the registered model.\n" }, "createdAt": { "type": "integer", "description": "the Unix timestamp at the model's creation\n" }, "createdBy": { "type": "string", "description": "the identifier of the user who created the model\n" }, "fullName": { "type": "string", "description": "The fully-qualified name of the registered model (`catalog_name.schema_name.name`).\n" }, "metastoreId": { "type": "string", "description": "the unique identifier of the metastore\n" }, "name": { "type": "string", "description": "The name of the registered model.\n" }, "owner": { "type": "string", "description": "Name of the registered model owner.\n" }, "schemaName": { "type": "string", "description": "The name of the schema where the registered model resides.\n" }, "storageLocation": { "type": "string", "description": "The storage location under which model version data files are stored.\n" }, "updatedAt": { "type": "integer", "description": "the timestamp of the last time changes were made to the model\n" }, "updatedBy": { "type": "string", "description": "the identifier of the user who updated the model last time\n" } }, "type": "object" }, "databricks:index/getRegisteredModelModelInfoAlias:getRegisteredModelModelInfoAlias": { "properties": { "aliasName": { "type": "string", "description": "string with the name of alias\n" }, "catalogName": { "type": "string", "description": "The name of the catalog where the schema and the registered model reside.\n" }, "id": { "type": "string" }, "modelName": { "type": "string" }, "schemaName": { "type": "string", "description": "The name of the schema where the registered model resides.\n" }, "versionNum": { "type": "integer", "description": "associated model version\n" } }, "type": "object" }, "databricks:index/getRegisteredModelProviderConfig:getRegisteredModelProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getRegisteredModelVersionsModelVersion:getRegisteredModelVersionsModelVersion": { "properties": { "aliases": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionAlias:getRegisteredModelVersionsModelVersionAlias" }, "description": "the list of aliases associated with this model. Each item is object consisting of following attributes:\n" }, "catalogName": { "type": "string", "description": "The name of the catalog where the schema and the registered model reside.\n" }, "comment": { "type": "string", "description": "The comment attached to the registered model.\n" }, "createdAt": { "type": "integer", "description": "the Unix timestamp at the model's creation\n" }, "createdBy": { "type": "string", "description": "the identifier of the user who created the model\n" }, "id": { "type": "string", "description": "The unique identifier of the model version\n" }, "metastoreId": { "type": "string", "description": "the unique identifier of the metastore\n" }, "modelName": { "type": "string" }, "modelVersionDependencies": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependency:getRegisteredModelVersionsModelVersionModelVersionDependency" }, "description": "block describing model version dependencies, for feature-store packaged models. Consists of following attributes:\n" }, "runId": { "type": "string", "description": "MLflow run ID used when creating the model version, if \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e was generated by an experiment run stored in an MLflow tracking server\n" }, "runWorkspaceId": { "type": "integer", "description": "ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable\n" }, "schemaName": { "type": "string", "description": "The name of the schema where the registered model resides.\n" }, "source": { "type": "string", "description": "URI indicating the location of the source artifacts (files) for the model version.\n" }, "status": { "type": "string", "description": "Current status of the model version.\n" }, "storageLocation": { "type": "string", "description": "The storage location under which model version data files are stored.\n" }, "updatedAt": { "type": "integer", "description": "the timestamp of the last time changes were made to the model\n" }, "updatedBy": { "type": "string", "description": "the identifier of the user who updated the model last time\n" }, "version": { "type": "integer", "description": "Integer model version number, used to reference the model version in API requests.\n" } }, "type": "object" }, "databricks:index/getRegisteredModelVersionsModelVersionAlias:getRegisteredModelVersionsModelVersionAlias": { "properties": { "aliasName": { "type": "string", "description": "string with the name of alias\n" }, "catalogName": { "type": "string", "description": "The name of the catalog where the schema and the registered model reside.\n" }, "id": { "type": "string", "description": "The unique identifier of the model version\n" }, "modelName": { "type": "string" }, "schemaName": { "type": "string", "description": "The name of the schema where the registered model resides.\n" }, "versionNum": { "type": "integer", "description": "associated model version\n" } }, "type": "object" }, "databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependency:getRegisteredModelVersionsModelVersionModelVersionDependency": { "properties": { "dependencies": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependency:getRegisteredModelVersionsModelVersionModelVersionDependencyDependency" }, "description": "list of dependencies consisting of following attributes:\n" } }, "type": "object" }, "databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependency:getRegisteredModelVersionsModelVersionModelVersionDependencyDependency": { "properties": { "connections": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyConnection:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyConnection" } }, "credentials": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyCredential:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyCredential" } }, "functions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction" }, "description": "A function that is dependent on a SQL object:\n" }, "tables": { "type": "array", "items": { "$ref": "#/types/databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable" }, "description": "A table that is dependent on a SQL object\n" } }, "type": "object" }, "databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyConnection:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyConnection": { "properties": { "connectionName": { "type": "string" } }, "type": "object" }, "databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyCredential:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyCredential": { "properties": { "credentialName": { "type": "string" } }, "type": "object" }, "databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyFunction": { "properties": { "functionFullName": { "type": "string", "description": "Full name of the dependent function\n" } }, "type": "object", "required": [ "functionFullName" ] }, "databricks:index/getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable:getRegisteredModelVersionsModelVersionModelVersionDependencyDependencyTable": { "properties": { "tableFullName": { "type": "string", "description": "Full name of the dependent table\n" } }, "type": "object", "required": [ "tableFullName" ] }, "databricks:index/getRegisteredModelVersionsProviderConfig:getRegisteredModelVersionsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getRfaAccessRequestDestinationsDestination:getRfaAccessRequestDestinationsDestination": { "properties": { "destinationId": { "type": "string", "description": "(string) - The identifier for the destination. This is the email address for EMAIL destinations, the URL for URL destinations,\nor the unique Databricks notification destination ID for all other external destinations\n" }, "destinationType": { "type": "string", "description": "(string) - The type of the destination. Possible values are: `EMAIL`, `GENERIC_WEBHOOK`, `MICROSOFT_TEAMS`, `SLACK`, `URL`\n" }, "specialDestination": { "type": "string", "description": "(string) - This field is used to denote whether the destination is the email of the owner of the securable object.\nThe special destination cannot be assigned to a securable and only represents the default destination of the securable.\nThe securable types that support default special destinations are: \"catalog\", \u003cspan pulumi-lang-nodejs=\"\"externalLocation\"\" pulumi-lang-dotnet=\"\"ExternalLocation\"\" pulumi-lang-go=\"\"externalLocation\"\" pulumi-lang-python=\"\"external_location\"\" pulumi-lang-yaml=\"\"externalLocation\"\" pulumi-lang-java=\"\"externalLocation\"\" pulumi-lang-hcl=\"\"external_location\"\"\u003e\"externalLocation\"\u003c/span\u003e, \"connection\", \"credential\", and \"metastore\".\nThe **destination_type** of a **special_destination** is always EMAIL. Possible values are: `SPECIAL_DESTINATION_CATALOG_OWNER`, `SPECIAL_DESTINATION_CONNECTION_OWNER`, `SPECIAL_DESTINATION_CREDENTIAL_OWNER`, `SPECIAL_DESTINATION_EXTERNAL_LOCATION_OWNER`, `SPECIAL_DESTINATION_METASTORE_OWNER`\n" } }, "type": "object" }, "databricks:index/getRfaAccessRequestDestinationsDestinationSourceSecurable:getRfaAccessRequestDestinationsDestinationSourceSecurable": { "properties": { "fullName": { "type": "string", "description": "The full name of the securable. Redundant with the name in the securable object, but necessary for Pulumi integration\n" }, "providerShare": { "type": "string", "description": "(string) - Optional. The name of the Share object that contains the securable when the securable is\ngetting shared in D2D Delta Sharing\n" }, "type": { "type": "string", "description": "(string) - Required. The type of securable (catalog/schema/table).\nOptional if\u003cspan pulumi-lang-nodejs=\" resourceName \" pulumi-lang-dotnet=\" ResourceName \" pulumi-lang-go=\" resourceName \" pulumi-lang-python=\" resource_name \" pulumi-lang-yaml=\" resourceName \" pulumi-lang-java=\" resourceName \" pulumi-lang-hcl=\" resource_name \"\u003e resourceName \u003c/span\u003eis present. Possible values are: `CATALOG`, `CLEAN_ROOM`, `CONNECTION`, `CREDENTIAL`, `EXTERNAL_LOCATION`, `EXTERNAL_METADATA`, `FUNCTION`, `METASTORE`, `PIPELINE`, `PROVIDER`, `RECIPIENT`, `SCHEMA`, `SHARE`, `STAGING_TABLE`, `STORAGE_CREDENTIAL`, `TABLE`, `VOLUME`\n" } }, "type": "object" }, "databricks:index/getRfaAccessRequestDestinationsProviderConfig:getRfaAccessRequestDestinationsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getRfaAccessRequestDestinationsSecurable:getRfaAccessRequestDestinationsSecurable": { "properties": { "fullName": { "type": "string", "description": "The full name of the securable. Redundant with the name in the securable object, but necessary for Pulumi integration\n" }, "providerShare": { "type": "string", "description": "(string) - Optional. The name of the Share object that contains the securable when the securable is\ngetting shared in D2D Delta Sharing\n" }, "type": { "type": "string", "description": "(string) - Required. The type of securable (catalog/schema/table).\nOptional if\u003cspan pulumi-lang-nodejs=\" resourceName \" pulumi-lang-dotnet=\" ResourceName \" pulumi-lang-go=\" resourceName \" pulumi-lang-python=\" resource_name \" pulumi-lang-yaml=\" resourceName \" pulumi-lang-java=\" resourceName \" pulumi-lang-hcl=\" resource_name \"\u003e resourceName \u003c/span\u003eis present. Possible values are: `CATALOG`, `CLEAN_ROOM`, `CONNECTION`, `CREDENTIAL`, `EXTERNAL_LOCATION`, `EXTERNAL_METADATA`, `FUNCTION`, `METASTORE`, `PIPELINE`, `PROVIDER`, `RECIPIENT`, `SCHEMA`, `SHARE`, `STAGING_TABLE`, `STORAGE_CREDENTIAL`, `TABLE`, `VOLUME`\n" } }, "type": "object" }, "databricks:index/getSchemaProviderConfig:getSchemaProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSchemaSchemaInfo:getSchemaSchemaInfo": { "properties": { "browseOnly": { "type": "boolean", "description": "indicates whether the principal is limited to retrieving metadata for the schema through the BROWSE privilege.\n" }, "catalogName": { "type": "string", "description": "the name of the catalog where the schema is.\n" }, "catalogType": { "type": "string", "description": "the type of the parent catalog.\n" }, "comment": { "type": "string", "description": "the comment attached to the volume\n" }, "createdAt": { "type": "integer", "description": "time at which this schema was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "username of schema creator.\n" }, "effectivePredictiveOptimizationFlag": { "$ref": "#/types/databricks:index/getSchemaSchemaInfoEffectivePredictiveOptimizationFlag:getSchemaSchemaInfoEffectivePredictiveOptimizationFlag", "description": "information about actual state of predictive optimization.\n" }, "enablePredictiveOptimization": { "type": "string", "description": "whether predictive optimization should be enabled for this object and objects under it.\n" }, "fullName": { "type": "string", "description": "the two-level (fully qualified) name of the schema\n" }, "metastoreId": { "type": "string", "description": "the unique identifier of the metastore\n" }, "name": { "type": "string", "description": "a fully qualified name of databricks_schema: *\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e*\n" }, "owner": { "type": "string", "description": "the identifier of the user who owns the schema\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "map of properties set on the schema\n" }, "schemaId": { "type": "string", "description": "the unique identifier of the schema\n" }, "storageLocation": { "type": "string", "description": "the storage location on the cloud.\n" }, "storageRoot": { "type": "string", "description": "storage root URL for managed tables within schema.\n" }, "updatedAt": { "type": "integer", "description": "the timestamp of the last time changes were made to the schema\n" }, "updatedBy": { "type": "string", "description": "the identifier of the user who updated the schema last time\n" } }, "type": "object" }, "databricks:index/getSchemaSchemaInfoEffectivePredictiveOptimizationFlag:getSchemaSchemaInfoEffectivePredictiveOptimizationFlag": { "properties": { "inheritedFromName": { "type": "string" }, "inheritedFromType": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "value" ] }, "databricks:index/getSchemasProviderConfig:getSchemasProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSecretUcProviderConfig:getSecretUcProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSecretUcsProviderConfig:getSecretUcsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSecretUcsSecret:getSecretUcsSecret": { "properties": { "browseOnly": { "type": "boolean", "description": "(boolean) - Indicates whether the principal is limited to retrieving metadata for the associated object\nthrough the **BROWSE** privilege when **include_browse** is enabled in the request\n" }, "catalogName": { "type": "string", "description": "The name of the catalog under which to list secrets. Both **catalog_name** and\n**schema_name** must be specified together\n" }, "comment": { "type": "string", "description": "(string) - User-provided free-form text description of the secret\n" }, "createTime": { "type": "string", "description": "(string) - The time at which this secret was created\n" }, "createdBy": { "type": "string", "description": "(string) - The principal that created the secret\n" }, "effectiveOwner": { "type": "string", "description": "(string) - The effective owner of the secret, which may differ from the directly-set **owner** due to\ninheritance\n" }, "effectiveValue": { "type": "string", "description": "(string) - The secret value. Only populated in responses when you have the **READ_SECRET**\nprivilege and **include_value** is set to true in the request. The maximum size is 60 KiB\n" }, "expireTime": { "type": "string", "description": "(string) - User-provided expiration time of the secret. This field indicates when the secret should no\nlonger be used and may be displayed as a warning in the UI. It is purely informational and\ndoes not trigger any automatic actions or affect the secret's lifecycle\n" }, "externalSecretId": { "type": "string", "description": "(string)\n" }, "fullName": { "type": "string", "description": "(string) - The three-level (fully qualified) name of the secret, in the form of **catalog_name.schema_name.secret_name**\n" }, "metastoreId": { "type": "string", "description": "(string) - Unique identifier of the metastore hosting the secret\n" }, "name": { "type": "string", "description": "(string) - The name of the secret, relative to its parent schema\n" }, "owner": { "type": "string", "description": "(string) - The owner of the secret. Defaults to the creating principal on creation. Can be updated to\ntransfer ownership of the secret to another principal\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getSecretUcsSecretProviderConfig:getSecretUcsSecretProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "schemaName": { "type": "string", "description": "The name of the schema under which to list secrets. Both **catalog_name** and\n**schema_name** must be specified together\n" }, "updateTime": { "type": "string", "description": "(string) - The time at which this secret was last updated\n" }, "updatedBy": { "type": "string", "description": "(string) - The principal that last updated the secret\n" }, "value": { "type": "string", "description": "(string) - The secret value to store. This field is input-only and is not returned in responses — use\nthe **effective_value** field (via GetSecret with **include_value** set to true) to read the\nsecret value. The maximum size is 60 KiB (pre-encryption). Accepted content includes\npasswords, tokens, keys, and other sensitive credential data\n" } }, "type": "object", "required": [ "browseOnly", "catalogName", "comment", "createTime", "createdBy", "effectiveOwner", "effectiveValue", "expireTime", "externalSecretId", "fullName", "metastoreId", "name", "owner", "schemaName", "updateTime", "updatedBy", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSecretUcsSecretProviderConfig:getSecretUcsSecretProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getServicePrincipalFederationPoliciesPolicy:getServicePrincipalFederationPoliciesPolicy": { "properties": { "createTime": { "type": "string", "description": "(string) - Creation time of the federation policy\n" }, "description": { "type": "string", "description": "(string) - Description of the federation policy\n" }, "name": { "type": "string", "description": "(string) - Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL\n" }, "oidcPolicy": { "$ref": "#/types/databricks:index/getServicePrincipalFederationPoliciesPolicyOidcPolicy:getServicePrincipalFederationPoliciesPolicyOidcPolicy", "description": "(OidcFederationPolicy)\n" }, "policyId": { "type": "string", "description": "(string) - The ID of the federation policy. Output only\n" }, "servicePrincipalId": { "type": "integer", "description": "The service principal id for the federation policy\n" }, "uid": { "type": "string", "description": "(string) - Unique, immutable id of the federation policy\n" }, "updateTime": { "type": "string", "description": "(string) - Last update time of the federation policy\n" } }, "type": "object", "required": [ "createTime", "description", "name", "oidcPolicy", "policyId", "servicePrincipalId", "uid", "updateTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getServicePrincipalFederationPoliciesPolicyOidcPolicy:getServicePrincipalFederationPoliciesPolicyOidcPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id\n" }, "issuer": { "type": "string", "description": "(string) - The required token issuer, as specified in the 'iss' claim of federated tokens\n" }, "jwksJson": { "type": "string", "description": "(string) - The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri \" pulumi-lang-dotnet=\" JwksUri \" pulumi-lang-go=\" jwksUri \" pulumi-lang-python=\" jwks_uri \" pulumi-lang-yaml=\" jwksUri \" pulumi-lang-java=\" jwksUri \" pulumi-lang-hcl=\" jwks_uri \"\u003e jwksUri \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson\n\" pulumi-lang-dotnet=\" JwksJson\n\" pulumi-lang-go=\" jwksJson\n\" pulumi-lang-python=\" jwks_json\n\" pulumi-lang-yaml=\" jwksJson\n\" pulumi-lang-java=\" jwksJson\n\" pulumi-lang-hcl=\" jwks_json\n\"\u003e jwksJson\n\u003c/span\u003eare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys\n" }, "jwksUri": { "type": "string", "description": "(string) - URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri\n\" pulumi-lang-dotnet=\" JwksUri\n\" pulumi-lang-go=\" jwksUri\n\" pulumi-lang-python=\" jwks_uri\n\" pulumi-lang-yaml=\" jwksUri\n\" pulumi-lang-java=\" jwksUri\n\" pulumi-lang-hcl=\" jwks_uri\n\"\u003e jwksUri\n\u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson \" pulumi-lang-dotnet=\" JwksJson \" pulumi-lang-go=\" jwksJson \" pulumi-lang-python=\" jwks_json \" pulumi-lang-yaml=\" jwksJson \" pulumi-lang-java=\" jwksJson \" pulumi-lang-hcl=\" jwks_json \"\u003e jwksJson \u003c/span\u003eare both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys\n" }, "subject": { "type": "string", "description": "(string) - The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies\n" }, "subjectClaim": { "type": "string", "description": "(string) - The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'\n" } }, "type": "object" }, "databricks:index/getServicePrincipalFederationPolicyOidcPolicy:getServicePrincipalFederationPolicyOidcPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The allowed token audiences, as specified in the 'aud' claim of federated tokens.\nThe audience identifier is intended to represent the recipient of the token.\nCan be any non-empty string value. As long as the audience in the token matches\nat least one audience in the policy, the token is considered a match. If audiences\nis unspecified, defaults to your Databricks account id\n" }, "issuer": { "type": "string", "description": "(string) - The required token issuer, as specified in the 'iss' claim of federated tokens\n" }, "jwksJson": { "type": "string", "description": "(string) - The public keys used to validate the signature of federated tokens, in JWKS format.\nMost use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri \" pulumi-lang-dotnet=\" JwksUri \" pulumi-lang-go=\" jwksUri \" pulumi-lang-python=\" jwks_uri \" pulumi-lang-yaml=\" jwksUri \" pulumi-lang-java=\" jwksUri \" pulumi-lang-hcl=\" jwks_uri \"\u003e jwksUri \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson\n\" pulumi-lang-dotnet=\" JwksJson\n\" pulumi-lang-go=\" jwksJson\n\" pulumi-lang-python=\" jwks_json\n\" pulumi-lang-yaml=\" jwksJson\n\" pulumi-lang-java=\" jwksJson\n\" pulumi-lang-hcl=\" jwks_json\n\"\u003e jwksJson\n\u003c/span\u003eare both unspecified (recommended), Databricks automatically fetches the public\nkeys from your issuer’s well known endpoint. Databricks strongly recommends\nrelying on your issuer’s well known endpoint for discovering public keys\n" }, "jwksUri": { "type": "string", "description": "(string) - URL of the public keys used to validate the signature of federated tokens, in\nJWKS format. Most use cases should not need to specify this field. If\u003cspan pulumi-lang-nodejs=\" jwksUri\n\" pulumi-lang-dotnet=\" JwksUri\n\" pulumi-lang-go=\" jwksUri\n\" pulumi-lang-python=\" jwks_uri\n\" pulumi-lang-yaml=\" jwksUri\n\" pulumi-lang-java=\" jwksUri\n\" pulumi-lang-hcl=\" jwks_uri\n\"\u003e jwksUri\n\u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" jwksJson \" pulumi-lang-dotnet=\" JwksJson \" pulumi-lang-go=\" jwksJson \" pulumi-lang-python=\" jwks_json \" pulumi-lang-yaml=\" jwksJson \" pulumi-lang-java=\" jwksJson \" pulumi-lang-hcl=\" jwks_json \"\u003e jwksJson \u003c/span\u003eare both unspecified (recommended), Databricks automatically\nfetches the public keys from your issuer’s well known endpoint. Databricks\nstrongly recommends relying on your issuer’s well known endpoint for discovering\npublic keys\n" }, "subject": { "type": "string", "description": "(string) - The required token subject, as specified in the subject claim of federated tokens.\nMust be specified for service principal federation policies. Must not be specified\nfor account federation policies\n" }, "subjectClaim": { "type": "string", "description": "(string) - The claim that contains the subject of the token. If unspecified, the default value\nis 'sub'\n" } }, "type": "object" }, "databricks:index/getServicePrincipalProviderConfig:getServicePrincipalProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getServicePrincipalsProviderConfig:getServicePrincipalsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getServicePrincipalsServicePrincipal:getServicePrincipalsServicePrincipal": { "properties": { "aclPrincipalId": { "type": "string", "description": "identifier for use in databricks_access_control_rule_set, e.g. `servicePrincipals/00000000-0000-0000-0000-000000000000`.\n" }, "active": { "type": "boolean", "description": "Whether service principal is active or not.\n" }, "applicationId": { "type": "string", "description": "Application ID of the service principal.\n" }, "displayName": { "type": "string", "description": "Display name of the service principal, e.g. `Foo SPN`.\n" }, "externalId": { "type": "string", "description": "ID of the service principal in an external identity provider.\n" }, "home": { "type": "string", "description": "Home folder of the service principal, e.g. `/Users/11111111-2222-3333-4444-555666777888`.\n" }, "id": { "type": "string", "description": "The id of the service principal (SCIM ID).\n" }, "repos": { "type": "string", "description": "Repos location of the service principal, e.g. `/Repos/11111111-2222-3333-4444-555666777888`.\n" }, "scimId": { "type": "string", "description": "same as \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e.\n" }, "spId": { "type": "string" } }, "type": "object", "required": [ "aclPrincipalId", "active", "applicationId", "displayName", "externalId", "home", "id", "repos", "scimId", "spId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getServingEndpointsEndpoint:getServingEndpointsEndpoint": { "properties": { "aiGateways": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGateway:getServingEndpointsEndpointAiGateway" }, "description": "A block with AI Gateway configuration for the serving endpoint.\n" }, "budgetPolicyId": { "type": "string" }, "configs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfig:getServingEndpointsEndpointConfig" }, "description": "The model serving endpoint configuration.\n" }, "creationTimestamp": { "type": "integer" }, "creator": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "lastUpdatedTimestamp": { "type": "integer" }, "name": { "type": "string", "description": "The name of the model serving endpoint.\n" }, "states": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointState:getServingEndpointsEndpointState" } }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointTag:getServingEndpointsEndpointTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" }, "task": { "type": "string" }, "usagePolicyId": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGateway:getServingEndpointsEndpointAiGateway": { "properties": { "fallbackConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayFallbackConfig:getServingEndpointsEndpointAiGatewayFallbackConfig" } }, "guardrails": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayGuardrail:getServingEndpointsEndpointAiGatewayGuardrail" } }, "inferenceTableConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayInferenceTableConfig:getServingEndpointsEndpointAiGatewayInferenceTableConfig" } }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayRateLimit:getServingEndpointsEndpointAiGatewayRateLimit" }, "description": "A list of rate limit blocks to be applied to the serving endpoint.\n" }, "usageTrackingConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayUsageTrackingConfig:getServingEndpointsEndpointAiGatewayUsageTrackingConfig" } } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayFallbackConfig:getServingEndpointsEndpointAiGatewayFallbackConfig": { "properties": { "enabled": { "type": "boolean" } }, "type": "object", "required": [ "enabled" ] }, "databricks:index/getServingEndpointsEndpointAiGatewayGuardrail:getServingEndpointsEndpointAiGatewayGuardrail": { "properties": { "inputProperties": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayGuardrailInputProperty:getServingEndpointsEndpointAiGatewayGuardrailInputProperty" } }, "outputs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayGuardrailOutput:getServingEndpointsEndpointAiGatewayGuardrailOutput" } } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayGuardrailInputProperty:getServingEndpointsEndpointAiGatewayGuardrailInputProperty": { "properties": { "invalidKeywords": { "type": "array", "items": { "type": "string" } }, "piis": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayGuardrailInputPropertyPii:getServingEndpointsEndpointAiGatewayGuardrailInputPropertyPii" } }, "safety": { "type": "boolean" }, "validTopics": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayGuardrailInputPropertyPii:getServingEndpointsEndpointAiGatewayGuardrailInputPropertyPii": { "properties": { "behavior": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayGuardrailOutput:getServingEndpointsEndpointAiGatewayGuardrailOutput": { "properties": { "invalidKeywords": { "type": "array", "items": { "type": "string" } }, "piis": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointAiGatewayGuardrailOutputPii:getServingEndpointsEndpointAiGatewayGuardrailOutputPii" } }, "safety": { "type": "boolean" }, "validTopics": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayGuardrailOutputPii:getServingEndpointsEndpointAiGatewayGuardrailOutputPii": { "properties": { "behavior": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayInferenceTableConfig:getServingEndpointsEndpointAiGatewayInferenceTableConfig": { "properties": { "catalogName": { "type": "string" }, "enabled": { "type": "boolean" }, "schemaName": { "type": "string" }, "tableNamePrefix": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointAiGatewayRateLimit:getServingEndpointsEndpointAiGatewayRateLimit": { "properties": { "calls": { "type": "integer" }, "key": { "type": "string" }, "principal": { "type": "string" }, "renewalPeriod": { "type": "string" }, "tokens": { "type": "integer" } }, "type": "object", "required": [ "renewalPeriod" ] }, "databricks:index/getServingEndpointsEndpointAiGatewayUsageTrackingConfig:getServingEndpointsEndpointAiGatewayUsageTrackingConfig": { "properties": { "enabled": { "type": "boolean" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfig:getServingEndpointsEndpointConfig": { "properties": { "servedEntities": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntity:getServingEndpointsEndpointConfigServedEntity" } }, "servedModels": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedModel:getServingEndpointsEndpointConfigServedModel" } } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntity:getServingEndpointsEndpointConfigServedEntity": { "properties": { "entityName": { "type": "string" }, "entityVersion": { "type": "string" }, "externalModels": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModel:getServingEndpointsEndpointConfigServedEntityExternalModel" } }, "foundationModels": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityFoundationModel:getServingEndpointsEndpointConfigServedEntityFoundationModel" } }, "name": { "type": "string", "description": "The name of the model serving endpoint.\n" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModel:getServingEndpointsEndpointConfigServedEntityExternalModel": { "properties": { "ai21labsConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelAi21labsConfig:getServingEndpointsEndpointConfigServedEntityExternalModelAi21labsConfig" } }, "amazonBedrockConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelAmazonBedrockConfig:getServingEndpointsEndpointConfigServedEntityExternalModelAmazonBedrockConfig" } }, "anthropicConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelAnthropicConfig:getServingEndpointsEndpointConfigServedEntityExternalModelAnthropicConfig" } }, "cohereConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCohereConfig:getServingEndpointsEndpointConfigServedEntityExternalModelCohereConfig" } }, "customProviderConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfig:getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfig" } }, "databricksModelServingConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelDatabricksModelServingConfig:getServingEndpointsEndpointConfigServedEntityExternalModelDatabricksModelServingConfig" } }, "googleCloudVertexAiConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelGoogleCloudVertexAiConfig:getServingEndpointsEndpointConfigServedEntityExternalModelGoogleCloudVertexAiConfig" } }, "name": { "type": "string", "description": "The name of the model serving endpoint.\n" }, "openaiConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelOpenaiConfig:getServingEndpointsEndpointConfigServedEntityExternalModelOpenaiConfig" } }, "palmConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelPalmConfig:getServingEndpointsEndpointConfigServedEntityExternalModelPalmConfig" } }, "provider": { "type": "string" }, "task": { "type": "string" } }, "type": "object", "required": [ "name", "provider", "task" ] }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelAi21labsConfig:getServingEndpointsEndpointConfigServedEntityExternalModelAi21labsConfig": { "properties": { "ai21labsApiKey": { "type": "string" }, "ai21labsApiKeyPlaintext": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelAmazonBedrockConfig:getServingEndpointsEndpointConfigServedEntityExternalModelAmazonBedrockConfig": { "properties": { "awsAccessKeyId": { "type": "string" }, "awsAccessKeyIdPlaintext": { "type": "string" }, "awsRegion": { "type": "string" }, "awsSecretAccessKey": { "type": "string" }, "awsSecretAccessKeyPlaintext": { "type": "string" }, "bedrockProvider": { "type": "string" }, "instanceProfileArn": { "type": "string" } }, "type": "object", "required": [ "awsRegion", "bedrockProvider" ] }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelAnthropicConfig:getServingEndpointsEndpointConfigServedEntityExternalModelAnthropicConfig": { "properties": { "anthropicApiKey": { "type": "string" }, "anthropicApiKeyPlaintext": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCohereConfig:getServingEndpointsEndpointConfigServedEntityExternalModelCohereConfig": { "properties": { "cohereApiBase": { "type": "string" }, "cohereApiKey": { "type": "string" }, "cohereApiKeyPlaintext": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfig:getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfig": { "properties": { "apiKeyAuths": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth:getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth" } }, "bearerTokenAuths": { "type": "array", "items": { "$ref": "#/types/databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth:getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth" } }, "customProviderUrl": { "type": "string" } }, "type": "object", "required": [ "customProviderUrl" ] }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth:getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigApiKeyAuth": { "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "valuePlaintext": { "type": "string" } }, "type": "object", "required": [ "key" ] }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth:getServingEndpointsEndpointConfigServedEntityExternalModelCustomProviderConfigBearerTokenAuth": { "properties": { "token": { "type": "string" }, "tokenPlaintext": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelDatabricksModelServingConfig:getServingEndpointsEndpointConfigServedEntityExternalModelDatabricksModelServingConfig": { "properties": { "databricksApiToken": { "type": "string" }, "databricksApiTokenPlaintext": { "type": "string" }, "databricksWorkspaceUrl": { "type": "string" } }, "type": "object", "required": [ "databricksWorkspaceUrl" ] }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelGoogleCloudVertexAiConfig:getServingEndpointsEndpointConfigServedEntityExternalModelGoogleCloudVertexAiConfig": { "properties": { "privateKey": { "type": "string" }, "privateKeyPlaintext": { "type": "string" }, "projectId": { "type": "string" }, "region": { "type": "string" } }, "type": "object", "required": [ "projectId", "region" ] }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelOpenaiConfig:getServingEndpointsEndpointConfigServedEntityExternalModelOpenaiConfig": { "properties": { "microsoftEntraClientId": { "type": "string" }, "microsoftEntraClientSecret": { "type": "string" }, "microsoftEntraClientSecretPlaintext": { "type": "string" }, "microsoftEntraTenantId": { "type": "string" }, "openaiApiBase": { "type": "string" }, "openaiApiKey": { "type": "string" }, "openaiApiKeyPlaintext": { "type": "string" }, "openaiApiType": { "type": "string" }, "openaiApiVersion": { "type": "string" }, "openaiDeploymentName": { "type": "string" }, "openaiOrganization": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityExternalModelPalmConfig:getServingEndpointsEndpointConfigServedEntityExternalModelPalmConfig": { "properties": { "palmApiKey": { "type": "string" }, "palmApiKeyPlaintext": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedEntityFoundationModel:getServingEndpointsEndpointConfigServedEntityFoundationModel": { "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "docs": { "type": "string" }, "name": { "type": "string", "description": "The name of the model serving endpoint.\n" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointConfigServedModel:getServingEndpointsEndpointConfigServedModel": { "properties": { "modelName": { "type": "string" }, "modelVersion": { "type": "string" }, "name": { "type": "string", "description": "The name of the model serving endpoint.\n" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointState:getServingEndpointsEndpointState": { "properties": { "configUpdate": { "type": "string" }, "ready": { "type": "string" } }, "type": "object" }, "databricks:index/getServingEndpointsEndpointTag:getServingEndpointsEndpointTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key" ] }, "databricks:index/getServingEndpointsProviderConfig:getServingEndpointsProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getShareObject:getShareObject": { "properties": { "addedAt": { "type": "integer" }, "addedBy": { "type": "string" }, "cdfEnabled": { "type": "boolean" }, "comment": { "type": "string", "description": "Description about the object.\n" }, "content": { "type": "string" }, "dataObjectType": { "type": "string", "description": "Type of the object.\n" }, "effectiveCdfEnabled": { "type": "boolean" }, "effectiveHistoryDataSharingStatus": { "type": "string" }, "effectiveSharedAs": { "type": "string" }, "effectiveStartVersion": { "type": "integer" }, "effectiveStringSharedAs": { "type": "string" }, "historyDataSharingStatus": { "type": "string" }, "name": { "type": "string", "description": "The name of the share\n" }, "partitions": { "type": "array", "items": { "$ref": "#/types/databricks:index/getShareObjectPartition:getShareObjectPartition" } }, "sharedAs": { "type": "string" }, "startVersion": { "type": "integer" }, "status": { "type": "string" }, "stringSharedAs": { "type": "string" } }, "type": "object", "required": [ "addedAt", "addedBy", "effectiveCdfEnabled", "effectiveHistoryDataSharingStatus", "effectiveSharedAs", "effectiveStartVersion", "effectiveStringSharedAs", "name", "status" ], "language": { "nodejs": { "requiredInputs": [ "name" ] } } }, "databricks:index/getShareObjectPartition:getShareObjectPartition": { "properties": { "values": { "type": "array", "items": { "$ref": "#/types/databricks:index/getShareObjectPartitionValue:getShareObjectPartitionValue" } } }, "type": "object" }, "databricks:index/getShareObjectPartitionValue:getShareObjectPartitionValue": { "properties": { "name": { "type": "string", "description": "The name of the share\n" }, "op": { "type": "string" }, "recipientPropertyKey": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getShareProviderConfig:getShareProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSharesProviderConfig:getSharesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSparkVersionProviderConfig:getSparkVersionProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSqlWarehouseChannel:getSqlWarehouseChannel": { "properties": { "dbsqlVersion": { "type": "string" }, "name": { "type": "string", "description": "Name of the SQL warehouse to search (case-sensitive).\n" } }, "type": "object" }, "databricks:index/getSqlWarehouseHealth:getSqlWarehouseHealth": { "properties": { "details": { "type": "string" }, "failureReason": { "$ref": "#/types/databricks:index/getSqlWarehouseHealthFailureReason:getSqlWarehouseHealthFailureReason" }, "message": { "type": "string" }, "status": { "type": "string" }, "summary": { "type": "string" } }, "type": "object" }, "databricks:index/getSqlWarehouseHealthFailureReason:getSqlWarehouseHealthFailureReason": { "properties": { "code": { "type": "string" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string" } }, "type": "object" }, "databricks:index/getSqlWarehouseOdbcParams:getSqlWarehouseOdbcParams": { "properties": { "hostname": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "integer" }, "protocol": { "type": "string" } }, "type": "object" }, "databricks:index/getSqlWarehouseProviderConfig:getSqlWarehouseProviderConfig": { "properties": { "workspaceId": { "type": "string" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSqlWarehouseTags:getSqlWarehouseTags": { "properties": { "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/getSqlWarehouseTagsCustomTag:getSqlWarehouseTagsCustomTag" } } }, "type": "object" }, "databricks:index/getSqlWarehouseTagsCustomTag:getSqlWarehouseTagsCustomTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getSqlWarehousesProviderConfig:getSqlWarehousesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getStorageCredentialProviderConfig:getStorageCredentialProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getStorageCredentialStorageCredentialInfo:getStorageCredentialStorageCredentialInfo": { "properties": { "awsIamRole": { "$ref": "#/types/databricks:index/getStorageCredentialStorageCredentialInfoAwsIamRole:getStorageCredentialStorageCredentialInfoAwsIamRole", "description": "credential details for AWS:\n" }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/getStorageCredentialStorageCredentialInfoAzureManagedIdentity:getStorageCredentialStorageCredentialInfoAzureManagedIdentity", "description": "managed identity credential details for Azure\n" }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/getStorageCredentialStorageCredentialInfoAzureServicePrincipal:getStorageCredentialStorageCredentialInfoAzureServicePrincipal", "description": "service principal credential details for Azure:\n" }, "cloudflareApiToken": { "$ref": "#/types/databricks:index/getStorageCredentialStorageCredentialInfoCloudflareApiToken:getStorageCredentialStorageCredentialInfoCloudflareApiToken" }, "comment": { "type": "string" }, "createdAt": { "type": "integer", "description": "Time at which this catalog was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of catalog creator.\n" }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/getStorageCredentialStorageCredentialInfoDatabricksGcpServiceAccount:getStorageCredentialStorageCredentialInfoDatabricksGcpServiceAccount", "description": "credential details for GCP:\n" }, "fullName": { "type": "string" }, "id": { "type": "string", "description": "Unique ID of storage credential.\n" }, "isolationMode": { "type": "string" }, "metastoreId": { "type": "string", "description": "Unique identifier of the parent Metastore.\n" }, "name": { "type": "string", "description": "The name of the storage credential\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the storage credential owner.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the storage credential is only usable for read operations.\n" }, "updatedAt": { "type": "integer", "description": "Time at which this catalog was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified catalog.\n" }, "usedForManagedStorage": { "type": "boolean" } }, "type": "object" }, "databricks:index/getStorageCredentialStorageCredentialInfoAwsIamRole:getStorageCredentialStorageCredentialInfoAwsIamRole": { "properties": { "externalId": { "type": "string", "description": "(output only) - The external ID used in role assumption to prevent confused deputy problem.\n" }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access, of the form `arn:aws:iam::1234567890:role/MyRole-AJJHDSKSDF`\n" }, "unityCatalogIamArn": { "type": "string", "description": "(output only) - The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.\n" } }, "type": "object", "required": [ "roleArn" ] }, "databricks:index/getStorageCredentialStorageCredentialInfoAzureManagedIdentity:getStorageCredentialStorageCredentialInfoAzureManagedIdentity": { "properties": { "accessConnectorId": { "type": "string", "description": "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`.\n" }, "credentialId": { "type": "string" }, "managedIdentityId": { "type": "string", "description": "The Resource ID of the Azure User Assigned Managed Identity associated with Azure Databricks Access Connector, of the form `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-name/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-managed-identity-name`.\n" } }, "type": "object", "required": [ "accessConnectorId" ] }, "databricks:index/getStorageCredentialStorageCredentialInfoAzureServicePrincipal:getStorageCredentialStorageCredentialInfoAzureServicePrincipal": { "properties": { "applicationId": { "type": "string", "description": "The application ID of the application registration within the referenced AAD tenant\n" }, "clientSecret": { "type": "string" }, "directoryId": { "type": "string", "description": "The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application\n" } }, "type": "object", "required": [ "applicationId", "clientSecret", "directoryId" ] }, "databricks:index/getStorageCredentialStorageCredentialInfoCloudflareApiToken:getStorageCredentialStorageCredentialInfoCloudflareApiToken": { "properties": { "accessKeyId": { "type": "string" }, "accountId": { "type": "string" }, "secretAccessKey": { "type": "string" } }, "type": "object", "required": [ "accessKeyId", "accountId", "secretAccessKey" ] }, "databricks:index/getStorageCredentialStorageCredentialInfoDatabricksGcpServiceAccount:getStorageCredentialStorageCredentialInfoDatabricksGcpServiceAccount": { "properties": { "credentialId": { "type": "string" }, "email": { "type": "string", "description": "The email of the GCP service account created, to be granted access to relevant buckets.\n" } }, "type": "object" }, "databricks:index/getStorageCredentialsProviderConfig:getStorageCredentialsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentProviderConfig:getSupervisorAgentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolApp:getSupervisorAgentToolApp": { "properties": { "name": { "type": "string", "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolGenieSpace:getSupervisorAgentToolGenieSpace": { "properties": { "id": { "type": "string", "description": "(string, deprecated) - Deprecated: use\u003cspan pulumi-lang-nodejs=\" spaceId \" pulumi-lang-dotnet=\" SpaceId \" pulumi-lang-go=\" spaceId \" pulumi-lang-python=\" space_id \" pulumi-lang-yaml=\" spaceId \" pulumi-lang-java=\" spaceId \" pulumi-lang-hcl=\" space_id \"\u003e spaceId \u003c/span\u003einstead. Still REQUIRED for backward compatibility\nuntil a future API version removes it\n" } }, "type": "object", "required": [ "id" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolKnowledgeAssistant:getSupervisorAgentToolKnowledgeAssistant": { "properties": { "knowledgeAssistantId": { "type": "string", "description": "(string) - The ID of the knowledge assistant\n" }, "servingEndpointName": { "type": "string", "description": "(string, deprecated) - Deprecated: use\u003cspan pulumi-lang-nodejs=\" knowledgeAssistantId \" pulumi-lang-dotnet=\" KnowledgeAssistantId \" pulumi-lang-go=\" knowledgeAssistantId \" pulumi-lang-python=\" knowledge_assistant_id \" pulumi-lang-yaml=\" knowledgeAssistantId \" pulumi-lang-java=\" knowledgeAssistantId \" pulumi-lang-hcl=\" knowledge_assistant_id \"\u003e knowledgeAssistantId \u003c/span\u003einstead\n" } }, "type": "object", "required": [ "knowledgeAssistantId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolProviderConfig:getSupervisorAgentToolProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolUcConnection:getSupervisorAgentToolUcConnection": { "properties": { "name": { "type": "string", "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolUcFunction:getSupervisorAgentToolUcFunction": { "properties": { "name": { "type": "string", "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolVolume:getSupervisorAgentToolVolume": { "properties": { "name": { "type": "string", "description": "Full resource name:\nsupervisor-agents/{supervisor_agent_id}/tools/{tool_id}\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsProviderConfig:getSupervisorAgentToolsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsTool:getSupervisorAgentToolsTool": { "properties": { "app": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolApp:getSupervisorAgentToolsToolApp", "description": "(App)\n" }, "description": { "type": "string", "description": "(string) - Description of what this tool does (user-facing)\n" }, "genieSpace": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolGenieSpace:getSupervisorAgentToolsToolGenieSpace", "description": "(GenieSpace)\n" }, "id": { "type": "string", "description": "(string, deprecated) - Deprecated: use\u003cspan pulumi-lang-nodejs=\" spaceId \" pulumi-lang-dotnet=\" SpaceId \" pulumi-lang-go=\" spaceId \" pulumi-lang-python=\" space_id \" pulumi-lang-yaml=\" spaceId \" pulumi-lang-java=\" spaceId \" pulumi-lang-hcl=\" space_id \"\u003e spaceId \u003c/span\u003einstead. Still REQUIRED for backward compatibility\nuntil a future API version removes it\n" }, "knowledgeAssistant": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolKnowledgeAssistant:getSupervisorAgentToolsToolKnowledgeAssistant", "description": "(KnowledgeAssistant)\n" }, "name": { "type": "string", "description": "(string) - Full uc volume name\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolProviderConfig:getSupervisorAgentToolsToolProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "toolId": { "type": "string", "description": "(string) - User specified id of the Tool\n" }, "toolType": { "type": "string", "description": "(string) - Tool type. Must be one of: \u003cspan pulumi-lang-nodejs=\"\"genieSpace\"\" pulumi-lang-dotnet=\"\"GenieSpace\"\" pulumi-lang-go=\"\"genieSpace\"\" pulumi-lang-python=\"\"genie_space\"\" pulumi-lang-yaml=\"\"genieSpace\"\" pulumi-lang-java=\"\"genieSpace\"\" pulumi-lang-hcl=\"\"genie_space\"\"\u003e\"genieSpace\"\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"\"knowledgeAssistant\"\" pulumi-lang-dotnet=\"\"KnowledgeAssistant\"\" pulumi-lang-go=\"\"knowledgeAssistant\"\" pulumi-lang-python=\"\"knowledge_assistant\"\" pulumi-lang-yaml=\"\"knowledgeAssistant\"\" pulumi-lang-java=\"\"knowledgeAssistant\"\" pulumi-lang-hcl=\"\"knowledge_assistant\"\"\u003e\"knowledgeAssistant\"\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"\"ucFunction\"\" pulumi-lang-dotnet=\"\"UcFunction\"\" pulumi-lang-go=\"\"ucFunction\"\" pulumi-lang-python=\"\"uc_function\"\" pulumi-lang-yaml=\"\"ucFunction\"\" pulumi-lang-java=\"\"ucFunction\"\" pulumi-lang-hcl=\"\"uc_function\"\"\u003e\"ucFunction\"\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"\"ucConnection\"\" pulumi-lang-dotnet=\"\"UcConnection\"\" pulumi-lang-go=\"\"ucConnection\"\" pulumi-lang-python=\"\"uc_connection\"\" pulumi-lang-yaml=\"\"ucConnection\"\" pulumi-lang-java=\"\"ucConnection\"\" pulumi-lang-hcl=\"\"uc_connection\"\"\u003e\"ucConnection\"\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"\"ucMcp\"\" pulumi-lang-dotnet=\"\"UcMcp\"\" pulumi-lang-go=\"\"ucMcp\"\" pulumi-lang-python=\"\"uc_mcp\"\" pulumi-lang-yaml=\"\"ucMcp\"\" pulumi-lang-java=\"\"ucMcp\"\" pulumi-lang-hcl=\"\"uc_mcp\"\"\u003e\"ucMcp\"\u003c/span\u003e, \"app\", \"volume\", \"dashboard\", \u003cspan pulumi-lang-nodejs=\"\"servingEndpoint\"\" pulumi-lang-dotnet=\"\"ServingEndpoint\"\" pulumi-lang-go=\"\"servingEndpoint\"\" pulumi-lang-python=\"\"serving_endpoint\"\" pulumi-lang-yaml=\"\"servingEndpoint\"\" pulumi-lang-java=\"\"servingEndpoint\"\" pulumi-lang-hcl=\"\"serving_endpoint\"\"\u003e\"servingEndpoint\"\u003c/span\u003e, \"table\", \u003cspan pulumi-lang-nodejs=\"\"vectorSearchIndex\"\" pulumi-lang-dotnet=\"\"VectorSearchIndex\"\" pulumi-lang-go=\"\"vectorSearchIndex\"\" pulumi-lang-python=\"\"vector_search_index\"\" pulumi-lang-yaml=\"\"vectorSearchIndex\"\" pulumi-lang-java=\"\"vectorSearchIndex\"\" pulumi-lang-hcl=\"\"vector_search_index\"\"\u003e\"vectorSearchIndex\"\u003c/span\u003e, \"catalog\", \"schema\", \u003cspan pulumi-lang-nodejs=\"\"supervisorAgent\"\" pulumi-lang-dotnet=\"\"SupervisorAgent\"\" pulumi-lang-go=\"\"supervisorAgent\"\" pulumi-lang-python=\"\"supervisor_agent\"\" pulumi-lang-yaml=\"\"supervisorAgent\"\" pulumi-lang-java=\"\"supervisorAgent\"\" pulumi-lang-hcl=\"\"supervisor_agent\"\"\u003e\"supervisorAgent\"\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"\"webSearch\"\" pulumi-lang-dotnet=\"\"WebSearch\"\" pulumi-lang-go=\"\"webSearch\"\" pulumi-lang-python=\"\"web_search\"\" pulumi-lang-yaml=\"\"webSearch\"\" pulumi-lang-java=\"\"webSearch\"\" pulumi-lang-hcl=\"\"web_search\"\"\u003e\"webSearch\"\u003c/span\u003e, \"skill\". The legacy values \u003cspan pulumi-lang-nodejs=\"\"lakeviewDashboard\"\" pulumi-lang-dotnet=\"\"LakeviewDashboard\"\" pulumi-lang-go=\"\"lakeviewDashboard\"\" pulumi-lang-python=\"\"lakeview_dashboard\"\" pulumi-lang-yaml=\"\"lakeviewDashboard\"\" pulumi-lang-java=\"\"lakeviewDashboard\"\" pulumi-lang-hcl=\"\"lakeview_dashboard\"\"\u003e\"lakeviewDashboard\"\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"\"ucTable\"\" pulumi-lang-dotnet=\"\"UcTable\"\" pulumi-lang-go=\"\"ucTable\"\" pulumi-lang-python=\"\"uc_table\"\" pulumi-lang-yaml=\"\"ucTable\"\" pulumi-lang-java=\"\"ucTable\"\" pulumi-lang-hcl=\"\"uc_table\"\"\u003e\"ucTable\"\u003c/span\u003e are also accepted and remain equivalent to \"dashboard\" and \"table\" respectively\n" }, "ucConnection": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolUcConnection:getSupervisorAgentToolsToolUcConnection", "description": "(UcConnection)\n" }, "ucFunction": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolUcFunction:getSupervisorAgentToolsToolUcFunction", "description": "(UcFunction)\n" }, "volume": { "$ref": "#/types/databricks:index/getSupervisorAgentToolsToolVolume:getSupervisorAgentToolsToolVolume", "description": "(Volume)\n" } }, "type": "object", "required": [ "app", "description", "genieSpace", "id", "knowledgeAssistant", "name", "toolId", "toolType", "ucConnection", "ucFunction", "volume" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolApp:getSupervisorAgentToolsToolApp": { "properties": { "name": { "type": "string", "description": "(string) - Full uc volume name\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolGenieSpace:getSupervisorAgentToolsToolGenieSpace": { "properties": { "id": { "type": "string", "description": "(string, deprecated) - Deprecated: use\u003cspan pulumi-lang-nodejs=\" spaceId \" pulumi-lang-dotnet=\" SpaceId \" pulumi-lang-go=\" spaceId \" pulumi-lang-python=\" space_id \" pulumi-lang-yaml=\" spaceId \" pulumi-lang-java=\" spaceId \" pulumi-lang-hcl=\" space_id \"\u003e spaceId \u003c/span\u003einstead. Still REQUIRED for backward compatibility\nuntil a future API version removes it\n" } }, "type": "object", "required": [ "id" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolKnowledgeAssistant:getSupervisorAgentToolsToolKnowledgeAssistant": { "properties": { "knowledgeAssistantId": { "type": "string", "description": "(string) - The ID of the knowledge assistant\n" }, "servingEndpointName": { "type": "string", "description": "(string, deprecated) - Deprecated: use\u003cspan pulumi-lang-nodejs=\" knowledgeAssistantId \" pulumi-lang-dotnet=\" KnowledgeAssistantId \" pulumi-lang-go=\" knowledgeAssistantId \" pulumi-lang-python=\" knowledge_assistant_id \" pulumi-lang-yaml=\" knowledgeAssistantId \" pulumi-lang-java=\" knowledgeAssistantId \" pulumi-lang-hcl=\" knowledge_assistant_id \"\u003e knowledgeAssistantId \u003c/span\u003einstead\n" } }, "type": "object", "required": [ "knowledgeAssistantId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolProviderConfig:getSupervisorAgentToolsToolProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolUcConnection:getSupervisorAgentToolsToolUcConnection": { "properties": { "name": { "type": "string", "description": "(string) - Full uc volume name\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolUcFunction:getSupervisorAgentToolsToolUcFunction": { "properties": { "name": { "type": "string", "description": "(string) - Full uc volume name\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentToolsToolVolume:getSupervisorAgentToolsToolVolume": { "properties": { "name": { "type": "string", "description": "(string) - Full uc volume name\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentsProviderConfig:getSupervisorAgentsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentsSupervisorAgent:getSupervisorAgentsSupervisorAgent": { "properties": { "createTime": { "type": "string", "description": "(string) - Creation timestamp\n" }, "creator": { "type": "string", "description": "(string) - The creator of the Supervisor Agent\n" }, "description": { "type": "string", "description": "(string) - Description of what this agent can do (user-facing)\n" }, "displayName": { "type": "string", "description": "(string) - The display name of the Supervisor Agent, unique at workspace level\n" }, "endpointName": { "type": "string", "description": "(string) - The name of the supervisor agent's serving endpoint\n" }, "experimentId": { "type": "string", "description": "(string) - The MLflow experiment ID\n" }, "id": { "type": "string", "description": "(string, deprecated) - Deprecated: Use\u003cspan pulumi-lang-nodejs=\" supervisorAgentId \" pulumi-lang-dotnet=\" SupervisorAgentId \" pulumi-lang-go=\" supervisorAgentId \" pulumi-lang-python=\" supervisor_agent_id \" pulumi-lang-yaml=\" supervisorAgentId \" pulumi-lang-java=\" supervisorAgentId \" pulumi-lang-hcl=\" supervisor_agent_id \"\u003e supervisorAgentId \u003c/span\u003einstead\n" }, "instructions": { "type": "string", "description": "(string) - Optional natural-language instructions for the supervisor agent\n" }, "name": { "type": "string", "description": "(string) - The resource name of the SupervisorAgent.\nFormat: supervisor-agents/{supervisor_agent_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getSupervisorAgentsSupervisorAgentProviderConfig:getSupervisorAgentsSupervisorAgentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "supervisorAgentId": { "type": "string", "description": "(string) - The universally unique identifier (UUID) of the Supervisor Agent\n" } }, "type": "object", "required": [ "createTime", "creator", "description", "displayName", "endpointName", "experimentId", "id", "instructions", "name", "supervisorAgentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getSupervisorAgentsSupervisorAgentProviderConfig:getSupervisorAgentsSupervisorAgentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTableProviderConfig:getTableProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTableTableInfo:getTableTableInfo": { "properties": { "accessPoint": { "type": "string" }, "browseOnly": { "type": "boolean" }, "catalogName": { "type": "string", "description": "Name of parent catalog.\n" }, "columns": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTableTableInfoColumn:getTableTableInfoColumn" }, "description": "Array of ColumnInfo objects of the table's columns\n" }, "comment": { "type": "string", "description": "Free-form text description\n" }, "createdAt": { "type": "integer" }, "createdBy": { "type": "string" }, "dataAccessConfigurationId": { "type": "string" }, "dataSourceFormat": { "type": "string", "description": "Table format, e.g. DELTA, CSV, JSON\n" }, "deletedAt": { "type": "integer" }, "deltaRuntimePropertiesKvpairs": { "$ref": "#/types/databricks:index/getTableTableInfoDeltaRuntimePropertiesKvpairs:getTableTableInfoDeltaRuntimePropertiesKvpairs" }, "effectivePredictiveOptimizationFlag": { "$ref": "#/types/databricks:index/getTableTableInfoEffectivePredictiveOptimizationFlag:getTableTableInfoEffectivePredictiveOptimizationFlag" }, "enablePredictiveOptimization": { "type": "string" }, "encryptionDetails": { "$ref": "#/types/databricks:index/getTableTableInfoEncryptionDetails:getTableTableInfoEncryptionDetails" }, "fullName": { "type": "string" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Full name of the databricks_table: _\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e_\n" }, "owner": { "type": "string", "description": "Current owner of the table\n" }, "pipelineId": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } }, "rowFilter": { "$ref": "#/types/databricks:index/getTableTableInfoRowFilter:getTableTableInfoRowFilter" }, "schemaName": { "type": "string", "description": "Name of parent schema relative to its parent catalog.\n" }, "securableKindManifest": { "$ref": "#/types/databricks:index/getTableTableInfoSecurableKindManifest:getTableTableInfoSecurableKindManifest" }, "sqlPath": { "type": "string" }, "storageCredentialName": { "type": "string" }, "storageLocation": { "type": "string" }, "tableConstraints": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTableTableInfoTableConstraint:getTableTableInfoTableConstraint" } }, "tableId": { "type": "string", "description": "The unique identifier of the table.\n" }, "tableType": { "type": "string", "description": "Table type, e.g. MANAGED, EXTERNAL, VIEW\n" }, "updatedAt": { "type": "integer" }, "updatedBy": { "type": "string" }, "viewDefinition": { "type": "string", "description": "View definition SQL (when \u003cspan pulumi-lang-nodejs=\"`tableType`\" pulumi-lang-dotnet=\"`TableType`\" pulumi-lang-go=\"`tableType`\" pulumi-lang-python=\"`table_type`\" pulumi-lang-yaml=\"`tableType`\" pulumi-lang-java=\"`tableType`\" pulumi-lang-hcl=\"`table_type`\"\u003e`tableType`\u003c/span\u003e is VIEW, MATERIALIZED_VIEW, or STREAMING_TABLE)\n" }, "viewDependencies": { "$ref": "#/types/databricks:index/getTableTableInfoViewDependencies:getTableTableInfoViewDependencies", "description": "View dependencies (when \u003cspan pulumi-lang-nodejs=\"`tableType`\" pulumi-lang-dotnet=\"`TableType`\" pulumi-lang-go=\"`tableType`\" pulumi-lang-python=\"`table_type`\" pulumi-lang-yaml=\"`tableType`\" pulumi-lang-java=\"`tableType`\" pulumi-lang-hcl=\"`table_type`\"\u003e`tableType`\u003c/span\u003e is VIEW or MATERIALIZED_VIEW, STREAMING_TABLE)\n" } }, "type": "object" }, "databricks:index/getTableTableInfoColumn:getTableTableInfoColumn": { "properties": { "comment": { "type": "string", "description": "Free-form text description\n" }, "mask": { "$ref": "#/types/databricks:index/getTableTableInfoColumnMask:getTableTableInfoColumnMask" }, "name": { "type": "string", "description": "Full name of the databricks_table: _\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e_\n" }, "nullable": { "type": "boolean" }, "partitionIndex": { "type": "integer" }, "position": { "type": "integer" }, "typeIntervalType": { "type": "string" }, "typeJson": { "type": "string" }, "typeName": { "type": "string" }, "typePrecision": { "type": "integer" }, "typeScale": { "type": "integer" }, "typeText": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoColumnMask:getTableTableInfoColumnMask": { "properties": { "functionName": { "type": "string" }, "usingArguments": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTableTableInfoColumnMaskUsingArgument:getTableTableInfoColumnMaskUsingArgument" } }, "usingColumnNames": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "databricks:index/getTableTableInfoColumnMaskUsingArgument:getTableTableInfoColumnMaskUsingArgument": { "properties": { "column": { "type": "string" }, "constant": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoDeltaRuntimePropertiesKvpairs:getTableTableInfoDeltaRuntimePropertiesKvpairs": { "properties": { "deltaRuntimeProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "deltaRuntimeProperties" ] }, "databricks:index/getTableTableInfoEffectivePredictiveOptimizationFlag:getTableTableInfoEffectivePredictiveOptimizationFlag": { "properties": { "inheritedFromName": { "type": "string" }, "inheritedFromType": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "value" ] }, "databricks:index/getTableTableInfoEncryptionDetails:getTableTableInfoEncryptionDetails": { "properties": { "sseEncryptionDetails": { "$ref": "#/types/databricks:index/getTableTableInfoEncryptionDetailsSseEncryptionDetails:getTableTableInfoEncryptionDetailsSseEncryptionDetails" } }, "type": "object" }, "databricks:index/getTableTableInfoEncryptionDetailsSseEncryptionDetails:getTableTableInfoEncryptionDetailsSseEncryptionDetails": { "properties": { "algorithm": { "type": "string" }, "awsKmsKeyArn": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoRowFilter:getTableTableInfoRowFilter": { "properties": { "functionName": { "type": "string" }, "inputArguments": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTableTableInfoRowFilterInputArgument:getTableTableInfoRowFilterInputArgument" } }, "inputColumnNames": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "functionName", "inputColumnNames" ] }, "databricks:index/getTableTableInfoRowFilterInputArgument:getTableTableInfoRowFilterInputArgument": { "properties": { "column": { "type": "string" }, "constant": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoSecurableKindManifest:getTableTableInfoSecurableKindManifest": { "properties": { "assignablePrivileges": { "type": "array", "items": { "type": "string" } }, "capabilities": { "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTableTableInfoSecurableKindManifestOption:getTableTableInfoSecurableKindManifestOption" } }, "securableKind": { "type": "string" }, "securableType": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoSecurableKindManifestOption:getTableTableInfoSecurableKindManifestOption": { "properties": { "allowedValues": { "type": "array", "items": { "type": "string" } }, "defaultValue": { "type": "string" }, "description": { "type": "string" }, "hint": { "type": "string" }, "isCopiable": { "type": "boolean" }, "isCreatable": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isLoggable": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isSecret": { "type": "boolean" }, "isUpdatable": { "type": "boolean" }, "name": { "type": "string", "description": "Full name of the databricks_table: _\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e_\n" }, "oauthStage": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoTableConstraint:getTableTableInfoTableConstraint": { "properties": { "foreignKeyConstraint": { "$ref": "#/types/databricks:index/getTableTableInfoTableConstraintForeignKeyConstraint:getTableTableInfoTableConstraintForeignKeyConstraint" }, "namedTableConstraint": { "$ref": "#/types/databricks:index/getTableTableInfoTableConstraintNamedTableConstraint:getTableTableInfoTableConstraintNamedTableConstraint" }, "primaryKeyConstraint": { "$ref": "#/types/databricks:index/getTableTableInfoTableConstraintPrimaryKeyConstraint:getTableTableInfoTableConstraintPrimaryKeyConstraint" } }, "type": "object" }, "databricks:index/getTableTableInfoTableConstraintForeignKeyConstraint:getTableTableInfoTableConstraintForeignKeyConstraint": { "properties": { "childColumns": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "description": "Full name of the databricks_table: _\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e_\n" }, "parentColumns": { "type": "array", "items": { "type": "string" } }, "parentTable": { "type": "string" }, "rely": { "type": "boolean" } }, "type": "object", "required": [ "childColumns", "name", "parentColumns", "parentTable" ] }, "databricks:index/getTableTableInfoTableConstraintNamedTableConstraint:getTableTableInfoTableConstraintNamedTableConstraint": { "properties": { "name": { "type": "string", "description": "Full name of the databricks_table: _\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e_\n" } }, "type": "object", "required": [ "name" ] }, "databricks:index/getTableTableInfoTableConstraintPrimaryKeyConstraint:getTableTableInfoTableConstraintPrimaryKeyConstraint": { "properties": { "childColumns": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string", "description": "Full name of the databricks_table: _\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e_\n" }, "rely": { "type": "boolean" }, "timeseriesColumns": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "childColumns", "name" ] }, "databricks:index/getTableTableInfoViewDependencies:getTableTableInfoViewDependencies": { "properties": { "dependencies": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTableTableInfoViewDependenciesDependency:getTableTableInfoViewDependenciesDependency" } } }, "type": "object" }, "databricks:index/getTableTableInfoViewDependenciesDependency:getTableTableInfoViewDependenciesDependency": { "properties": { "connection": { "$ref": "#/types/databricks:index/getTableTableInfoViewDependenciesDependencyConnection:getTableTableInfoViewDependenciesDependencyConnection" }, "credential": { "$ref": "#/types/databricks:index/getTableTableInfoViewDependenciesDependencyCredential:getTableTableInfoViewDependenciesDependencyCredential" }, "function": { "$ref": "#/types/databricks:index/getTableTableInfoViewDependenciesDependencyFunction:getTableTableInfoViewDependenciesDependencyFunction" }, "table": { "$ref": "#/types/databricks:index/getTableTableInfoViewDependenciesDependencyTable:getTableTableInfoViewDependenciesDependencyTable" } }, "type": "object" }, "databricks:index/getTableTableInfoViewDependenciesDependencyConnection:getTableTableInfoViewDependenciesDependencyConnection": { "properties": { "connectionName": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoViewDependenciesDependencyCredential:getTableTableInfoViewDependenciesDependencyCredential": { "properties": { "credentialName": { "type": "string" } }, "type": "object" }, "databricks:index/getTableTableInfoViewDependenciesDependencyFunction:getTableTableInfoViewDependenciesDependencyFunction": { "properties": { "functionFullName": { "type": "string" } }, "type": "object", "required": [ "functionFullName" ] }, "databricks:index/getTableTableInfoViewDependenciesDependencyTable:getTableTableInfoViewDependenciesDependencyTable": { "properties": { "tableFullName": { "type": "string" } }, "type": "object", "required": [ "tableFullName" ] }, "databricks:index/getTablesProviderConfig:getTablesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTagPoliciesProviderConfig:getTagPoliciesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTagPoliciesTagPolicy:getTagPoliciesTagPolicy": { "properties": { "createTime": { "type": "string", "description": "(string) - Timestamp when the tag policy was created\n" }, "description": { "type": "string", "description": "(string)\n" }, "id": { "type": "string", "description": "(string)\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getTagPoliciesTagPolicyProviderConfig:getTagPoliciesTagPolicyProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "tagKey": { "type": "string", "description": "(string)\n" }, "updateTime": { "type": "string", "description": "(string) - Timestamp when the tag policy was last updated\n" }, "values": { "type": "array", "items": { "$ref": "#/types/databricks:index/getTagPoliciesTagPolicyValue:getTagPoliciesTagPolicyValue" }, "description": "(list of Value)\n" } }, "type": "object", "required": [ "createTime", "description", "id", "tagKey", "updateTime", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTagPoliciesTagPolicyProviderConfig:getTagPoliciesTagPolicyProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTagPoliciesTagPolicyValue:getTagPoliciesTagPolicyValue": { "properties": { "name": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTagPolicyProviderConfig:getTagPolicyProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getTagPolicyValue:getTagPolicyValue": { "properties": { "name": { "type": "string", "description": "(string)\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getUserProviderConfig:getUserProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getUsersProviderConfig:getUsersProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getUsersUser:getUsersUser": { "properties": { "active": { "type": "boolean", "description": "Boolean that represents if this user is active.\n" }, "displayName": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#/types/databricks:index/getUsersUserEmail:getUsersUserEmail" }, "description": "All the emails associated with the Databricks user.\n" }, "entitlements": { "type": "array", "items": { "$ref": "#/types/databricks:index/getUsersUserEntitlement:getUsersUserEntitlement" }, "description": "Entitlements assigned to the user.\n" }, "externalId": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/types/databricks:index/getUsersUserGroup:getUsersUserGroup" }, "description": "Indicates if the user is part of any groups.\n" }, "id": { "type": "string", "description": "The ID of the user.\n- `userName` - The username of the user.\n" }, "name": { "$ref": "#/types/databricks:index/getUsersUserName:getUsersUserName", "description": "- `givenName` - Given name of the Databricks user.\n- `familyName` - Family name of the Databricks user.\n- `displayName` - The display name of the user.\n" }, "roles": { "type": "array", "items": { "$ref": "#/types/databricks:index/getUsersUserRole:getUsersUserRole" }, "description": "Indicates if the user has any associated roles.\n" }, "schemas": { "type": "array", "items": { "type": "string" }, "description": "The schema of the user.\n- `externalId` - Reserved for future use.\n" }, "userName": { "type": "string" } }, "type": "object" }, "databricks:index/getUsersUserEmail:getUsersUserEmail": { "properties": { "display": { "type": "string" }, "primary": { "type": "boolean" }, "ref": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getUsersUserEntitlement:getUsersUserEntitlement": { "properties": { "display": { "type": "string" }, "primary": { "type": "boolean" }, "ref": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getUsersUserGroup:getUsersUserGroup": { "properties": { "display": { "type": "string" }, "primary": { "type": "boolean" }, "ref": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getUsersUserName:getUsersUserName": { "properties": { "familyName": { "type": "string" }, "givenName": { "type": "string" } }, "type": "object" }, "databricks:index/getUsersUserRole:getUsersUserRole": { "properties": { "display": { "type": "string" }, "primary": { "type": "boolean" }, "ref": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "databricks:index/getViewsProviderConfig:getViewsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getVolumeProviderConfig:getVolumeProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getVolumeVolumeInfo:getVolumeVolumeInfo": { "properties": { "accessPoint": { "type": "string", "description": "the AWS access point to use when accessing s3 bucket for this volume's external location\n" }, "browseOnly": { "type": "boolean", "description": "indicates whether the principal is limited to retrieving metadata for the volume through the BROWSE privilege when\u003cspan pulumi-lang-nodejs=\" includeBrowse \" pulumi-lang-dotnet=\" IncludeBrowse \" pulumi-lang-go=\" includeBrowse \" pulumi-lang-python=\" include_browse \" pulumi-lang-yaml=\" includeBrowse \" pulumi-lang-java=\" includeBrowse \" pulumi-lang-hcl=\" include_browse \"\u003e includeBrowse \u003c/span\u003eis enabled in the request.\n" }, "catalogName": { "type": "string", "description": "the name of the catalog where the schema and the volume are\n" }, "comment": { "type": "string", "description": "the comment attached to the volume\n" }, "createdAt": { "type": "integer", "description": "the Unix timestamp at the volume's creation\n" }, "createdBy": { "type": "string", "description": "the identifier of the user who created the volume\n" }, "encryptionDetails": { "$ref": "#/types/databricks:index/getVolumeVolumeInfoEncryptionDetails:getVolumeVolumeInfoEncryptionDetails", "description": "encryption options that apply to clients connecting to cloud storage\n" }, "fullName": { "type": "string", "description": "the three-level (fully qualified) name of the volume\n" }, "metastoreId": { "type": "string", "description": "the unique identifier of the metastore\n" }, "name": { "type": "string", "description": "a fully qualified name of databricks_volume: *\u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e.\u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e*\n" }, "owner": { "type": "string", "description": "the identifier of the user who owns the volume\n" }, "schemaName": { "type": "string", "description": "the name of the schema where the volume is\n" }, "storageLocation": { "type": "string", "description": "the storage location on the cloud\n" }, "updatedAt": { "type": "integer", "description": "the timestamp of the last time changes were made to the volume\n" }, "updatedBy": { "type": "string", "description": "the identifier of the user who updated the volume last time\n" }, "volumeId": { "type": "string", "description": "the unique identifier of the volume\n" }, "volumeType": { "type": "string", "description": "whether the volume is `MANAGED` or `EXTERNAL`\n" } }, "type": "object" }, "databricks:index/getVolumeVolumeInfoEncryptionDetails:getVolumeVolumeInfoEncryptionDetails": { "properties": { "sseEncryptionDetails": { "$ref": "#/types/databricks:index/getVolumeVolumeInfoEncryptionDetailsSseEncryptionDetails:getVolumeVolumeInfoEncryptionDetailsSseEncryptionDetails" } }, "type": "object" }, "databricks:index/getVolumeVolumeInfoEncryptionDetailsSseEncryptionDetails:getVolumeVolumeInfoEncryptionDetailsSseEncryptionDetails": { "properties": { "algorithm": { "type": "string" }, "awsKmsKeyArn": { "type": "string" } }, "type": "object" }, "databricks:index/getVolumesProviderConfig:getVolumesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWarehousesDefaultWarehouseOverrideProviderConfig:getWarehousesDefaultWarehouseOverrideProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWarehousesDefaultWarehouseOverridesDefaultWarehouseOverride:getWarehousesDefaultWarehouseOverridesDefaultWarehouseOverride": { "properties": { "defaultWarehouseOverrideId": { "type": "string", "description": "(string) - The ID component of the resource name (user ID)\n" }, "name": { "type": "string", "description": "(string) - The resource name of the default warehouse override.\nFormat: default-warehouse-overrides/{default_warehouse_override_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getWarehousesDefaultWarehouseOverridesDefaultWarehouseOverrideProviderConfig:getWarehousesDefaultWarehouseOverridesDefaultWarehouseOverrideProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "type": { "type": "string", "description": "(string) - The type of override behavior. Possible values are: `CUSTOM`, `LAST_SELECTED`\n" }, "warehouseId": { "type": "string", "description": "(string) - The specific warehouse ID when type is CUSTOM.\nNot set for LAST_SELECTED type\n" } }, "type": "object", "required": [ "defaultWarehouseOverrideId", "name", "type", "warehouseId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWarehousesDefaultWarehouseOverridesDefaultWarehouseOverrideProviderConfig:getWarehousesDefaultWarehouseOverridesDefaultWarehouseOverrideProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWarehousesDefaultWarehouseOverridesProviderConfig:getWarehousesDefaultWarehouseOverridesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceEntityTagAssignmentProviderConfig:getWorkspaceEntityTagAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceEntityTagAssignmentsProviderConfig:getWorkspaceEntityTagAssignmentsProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceEntityTagAssignmentsTagAssignment:getWorkspaceEntityTagAssignmentsTagAssignment": { "properties": { "entityId": { "type": "string", "description": "The identifier of the entity to which the tag is assigned. For apps, the\u003cspan pulumi-lang-nodejs=\" entityId \" pulumi-lang-dotnet=\" EntityId \" pulumi-lang-go=\" entityId \" pulumi-lang-python=\" entity_id \" pulumi-lang-yaml=\" entityId \" pulumi-lang-java=\" entityId \" pulumi-lang-hcl=\" entity_id \"\u003e entityId \u003c/span\u003eis the app name\n" }, "entityType": { "type": "string", "description": "The type of entity to which the tag is assigned. Allowed values are apps, dashboards, geniespaces, notebooks\n" }, "providerConfig": { "$ref": "#/types/databricks:index/getWorkspaceEntityTagAssignmentsTagAssignmentProviderConfig:getWorkspaceEntityTagAssignmentsTagAssignmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "tagKey": { "type": "string", "description": "(string) - The key of the tag. The characters , . : / - = and leading/trailing spaces are not allowed\n" }, "tagValue": { "type": "string", "description": "(string) - The value of the tag\n" } }, "type": "object", "required": [ "entityId", "entityType", "tagKey", "tagValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceEntityTagAssignmentsTagAssignmentProviderConfig:getWorkspaceEntityTagAssignmentsTagAssignmentProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2AibiDashboardEmbeddingAccessPolicy:getWorkspaceSettingV2AibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2AibiDashboardEmbeddingApprovedDomains:getWorkspaceSettingV2AibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2AllowedAppsUserApiScopes:getWorkspaceSettingV2AllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspace:getWorkspaceSettingV2AutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean", "description": "(boolean)\n" }, "enabled": { "type": "boolean", "description": "(boolean)\n" }, "enablementDetails": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails", "description": "(ClusterAutoRestartMessageEnablementDetails)\n" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow", "description": "(ClusterAutoRestartMessageMaintenanceWindow)\n" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "(boolean) - The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule", "description": "(ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "(string) - Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "(string) - Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime", "description": "(ClusterAutoRestartMessageMaintenanceWindowWindowStartTime)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getWorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer", "description": "(integer)\n" }, "minutes": { "type": "integer", "description": "(integer)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2BooleanVal:getWorkspaceSettingV2BooleanVal": { "properties": { "value": { "type": "boolean", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2CollaborationPlatformConnectivity:getWorkspaceSettingV2CollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:getWorkspaceSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy": { "properties": { "accessPolicyType": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL_DOMAINS`, `ALLOW_APPROVED_DOMAINS`, `DENY_ALL_DOMAINS`\n" } }, "type": "object", "required": [ "accessPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:getWorkspaceSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains": { "properties": { "approvedDomains": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveAllowedAppsUserApiScopes:getWorkspaceSettingV2EffectiveAllowedAppsUserApiScopes": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspace:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspace": { "properties": { "canToggle": { "type": "boolean", "description": "(boolean)\n" }, "enabled": { "type": "boolean", "description": "(boolean)\n" }, "enablementDetails": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails", "description": "(ClusterAutoRestartMessageEnablementDetails)\n" }, "maintenanceWindow": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow", "description": "(ClusterAutoRestartMessageMaintenanceWindow)\n" }, "restartEvenIfNoUpdatesAvailable": { "type": "boolean", "description": "(boolean)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceEnablementDetails": { "properties": { "forcedForComplianceMode": { "type": "boolean", "description": "(boolean) - The feature is force enabled if compliance mode is active\n" }, "unavailableForDisabledEntitlement": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable)\n" }, "unavailableForNonEnterpriseTier": { "type": "boolean", "description": "(boolean) - The feature is unavailable if the customer doesn't have enterprise tier\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindow": { "properties": { "weekDayBasedSchedule": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule", "description": "(ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule": { "properties": { "dayOfWeek": { "type": "string", "description": "(string) - Possible values are: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`\n" }, "frequency": { "type": "string", "description": "(string) - Possible values are: `EVERY_WEEK`, `FIRST_AND_THIRD_OF_MONTH`, `FIRST_OF_MONTH`, `FOURTH_OF_MONTH`, `SECOND_AND_FOURTH_OF_MONTH`, `SECOND_OF_MONTH`, `THIRD_OF_MONTH`\n" }, "windowStartTime": { "$ref": "#/types/databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime", "description": "(ClusterAutoRestartMessageMaintenanceWindowWindowStartTime)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime:getWorkspaceSettingV2EffectiveAutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime": { "properties": { "hours": { "type": "integer", "description": "(integer)\n" }, "minutes": { "type": "integer", "description": "(integer)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveBooleanVal:getWorkspaceSettingV2EffectiveBooleanVal": { "properties": { "value": { "type": "boolean", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveCollaborationPlatformConnectivity:getWorkspaceSettingV2EffectiveCollaborationPlatformConnectivity": { "properties": { "connectivity": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `ALLOW_SLACK`, `ALLOW_TEAMS`, `DENY_ALL`\n" } }, "type": "object", "required": [ "connectivity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2EffectiveIntegerVal:getWorkspaceSettingV2EffectiveIntegerVal": { "properties": { "value": { "type": "integer", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveOperationalEmailCustomRecipient:getWorkspaceSettingV2EffectiveOperationalEmailCustomRecipient": { "properties": { "email": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectivePersonalCompute:getWorkspaceSettingV2EffectivePersonalCompute": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2EffectiveRestrictWorkspaceAdmins:getWorkspaceSettingV2EffectiveRestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "(boolean) - When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2EffectiveStringVal:getWorkspaceSettingV2EffectiveStringVal": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2IntegerVal:getWorkspaceSettingV2IntegerVal": { "properties": { "value": { "type": "integer", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2OperationalEmailCustomRecipient:getWorkspaceSettingV2OperationalEmailCustomRecipient": { "properties": { "email": { "type": "string", "description": "(string)\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2PersonalCompute:getWorkspaceSettingV2PersonalCompute": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getWorkspaceSettingV2ProviderConfig:getWorkspaceSettingV2ProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2RestrictWorkspaceAdmins:getWorkspaceSettingV2RestrictWorkspaceAdmins": { "properties": { "disableGovTagCreation": { "type": "boolean", "description": "(boolean) - When true, workspace admins cannot create governance tags.\nALLOW_ALL status does not override this; they are independent\n" }, "status": { "type": "string", "description": "(string) - Possible values are: `ALLOW_ALL`, `RESTRICT_TOKENS_AND_JOB_RUN_AS`\n" } }, "type": "object", "required": [ "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "databricks:index/getWorkspaceSettingV2StringVal:getWorkspaceSettingV2StringVal": { "properties": { "value": { "type": "string", "description": "(string) - Represents a generic string value\n" } }, "type": "object" }, "databricks:index/getZonesProviderConfig:getZonesProviderConfig": { "properties": { "workspaceId": { "type": "string", "description": "Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n" } }, "type": "object", "required": [ "workspaceId" ], "language": { "nodejs": { "requiredInputs": [] } } } }, "provider": { "description": "The provider type for the databricks package. By default, resources use package-wide configuration\nsettings, however an explicit `Provider` instance may be created and passed during resource\nconstruction to achieve fine-grained programmatic control over provider settings. See the\n[documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.\n", "properties": { "accountId": { "type": "string" }, "actionsIdTokenRequestToken": { "type": "string" }, "actionsIdTokenRequestUrl": { "type": "string" }, "audience": { "type": "string" }, "authType": { "type": "string" }, "azureClientId": { "type": "string" }, "azureClientSecret": { "type": "string", "secret": true }, "azureEnvironment": { "type": "string" }, "azureLoginAppId": { "type": "string" }, "azureTenantId": { "type": "string" }, "azureUseMsi": { "type": "boolean" }, "azureWorkspaceResourceId": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "cloud": { "type": "string" }, "clusterId": { "type": "string" }, "configFile": { "type": "string" }, "databricksCliPath": { "type": "string" }, "databricksIdTokenFilepath": { "type": "string" }, "debugHeaders": { "type": "boolean" }, "debugTruncateBytes": { "type": "integer" }, "disableOauthRefreshToken": { "type": "boolean" }, "discoveryUrl": { "type": "string" }, "googleCredentials": { "type": "string", "secret": true }, "googleServiceAccount": { "type": "string" }, "host": { "type": "string" }, "httpTimeoutSeconds": { "type": "integer" }, "metadataServiceUrl": { "type": "string", "secret": true }, "oauthCallbackPort": { "type": "integer" }, "oidcTokenEnv": { "type": "string" }, "password": { "type": "string", "secret": true }, "profile": { "type": "string" }, "rateLimit": { "type": "integer" }, "retryTimeoutSeconds": { "type": "integer" }, "scopes": { "type": "array", "items": { "type": "string" } }, "serverlessComputeId": { "type": "string" }, "skipVerify": { "type": "boolean" }, "token": { "type": "string", "secret": true }, "username": { "type": "string" }, "warehouseId": { "type": "string" }, "workspaceId": { "type": "string" } }, "inputProperties": { "accountId": { "type": "string" }, "actionsIdTokenRequestToken": { "type": "string" }, "actionsIdTokenRequestUrl": { "type": "string" }, "audience": { "type": "string" }, "authType": { "type": "string" }, "azureClientId": { "type": "string" }, "azureClientSecret": { "type": "string", "secret": true }, "azureEnvironment": { "type": "string" }, "azureLoginAppId": { "type": "string" }, "azureTenantId": { "type": "string" }, "azureUseMsi": { "type": "boolean" }, "azureWorkspaceResourceId": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "secret": true }, "cloud": { "type": "string" }, "clusterId": { "type": "string" }, "configFile": { "type": "string" }, "databricksCliPath": { "type": "string" }, "databricksIdTokenFilepath": { "type": "string" }, "debugHeaders": { "type": "boolean" }, "debugTruncateBytes": { "type": "integer" }, "disableOauthRefreshToken": { "type": "boolean" }, "discoveryUrl": { "type": "string" }, "googleCredentials": { "type": "string", "secret": true }, "googleServiceAccount": { "type": "string" }, "host": { "type": "string" }, "httpTimeoutSeconds": { "type": "integer" }, "metadataServiceUrl": { "type": "string", "secret": true }, "oauthCallbackPort": { "type": "integer" }, "oidcTokenEnv": { "type": "string" }, "password": { "type": "string", "secret": true }, "profile": { "type": "string" }, "rateLimit": { "type": "integer" }, "retryTimeoutSeconds": { "type": "integer" }, "scopes": { "type": "array", "items": { "type": "string" } }, "serverlessComputeId": { "type": "string" }, "skipVerify": { "type": "boolean" }, "token": { "type": "string", "secret": true }, "username": { "type": "string" }, "warehouseId": { "type": "string" }, "workspaceId": { "type": "string" } }, "methods": { "terraformConfig": "pulumi:providers:databricks/terraformConfig" } }, "resources": { "databricks:index/accessControlRuleSet:AccessControlRuleSet": { "description": "This resource allows you to manage access rules on Databricks account level resources. For convenience we allow accessing this resource through the Databricks account and workspace.\n\n\u003e This resource can be used with an account or workspace-level provider.\n\n\u003e Currently, we only support managing access rules on specific object resources (service principal, group, budget policies and account) through \u003cspan pulumi-lang-nodejs=\"`databricks.AccessControlRuleSet`\" pulumi-lang-dotnet=\"`databricks.AccessControlRuleSet`\" pulumi-lang-go=\"`AccessControlRuleSet`\" pulumi-lang-python=\"`AccessControlRuleSet`\" pulumi-lang-yaml=\"`databricks.AccessControlRuleSet`\" pulumi-lang-java=\"`databricks.AccessControlRuleSet`\" pulumi-lang-hcl=\"`databricks_access_control_rule_set`\"\u003e`databricks.AccessControlRuleSet`\u003c/span\u003e.\n\n\u003e \u003cspan pulumi-lang-nodejs=\"`databricks.AccessControlRuleSet`\" pulumi-lang-dotnet=\"`databricks.AccessControlRuleSet`\" pulumi-lang-go=\"`AccessControlRuleSet`\" pulumi-lang-python=\"`AccessControlRuleSet`\" pulumi-lang-yaml=\"`databricks.AccessControlRuleSet`\" pulumi-lang-java=\"`databricks.AccessControlRuleSet`\" pulumi-lang-hcl=\"`databricks_access_control_rule_set`\"\u003e`databricks.AccessControlRuleSet`\u003c/span\u003e cannot be used to manage access rules for resources supported by databricks_permissions. Refer to its documentation for more information.\n\n\u003e This resource is _authoritative_ for permissions on objects. Configuring this resource for an object will **OVERWRITE** any existing permissions of the same type unless imported, and changes made outside of Pulumi will be reset.\n\n## Service principal rule set usage\n\nThrough a Databricks workspace:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group\nconst ds = databricks.getGroup({\n displayName: \"Data Science\",\n});\nconst automationSp = new databricks.ServicePrincipal(\"automation_sp\", {displayName: \"SP_FOR_AUTOMATION\"});\nconst automationSpRuleSet = new databricks.AccessControlRuleSet(\"automation_sp_rule_set\", {\n name: pulumi.interpolate`accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default`,\n grantRules: [{\n principals: [ds.then(ds =\u003e ds.aclPrincipalId)],\n role: \"roles/servicePrincipal.user\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group\nds = databricks.get_group(display_name=\"Data Science\")\nautomation_sp = databricks.ServicePrincipal(\"automation_sp\", display_name=\"SP_FOR_AUTOMATION\")\nautomation_sp_rule_set = databricks.AccessControlRuleSet(\"automation_sp_rule_set\",\n name=automation_sp.application_id.apply(lambda application_id: f\"accounts/{account_id}/servicePrincipals/{application_id}/ruleSets/default\"),\n grant_rules=[{\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/servicePrincipal.user\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n var ds = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"Data Science\",\n });\n\n var automationSp = new Databricks.ServicePrincipal(\"automation_sp\", new()\n {\n DisplayName = \"SP_FOR_AUTOMATION\",\n });\n\n var automationSpRuleSet = new Databricks.AccessControlRuleSet(\"automation_sp_rule_set\", new()\n {\n Name = automationSp.ApplicationId.Apply(applicationId =\u003e $\"accounts/{accountId}/servicePrincipals/{applicationId}/ruleSets/default\"),\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.Apply(getGroupResult =\u003e getGroupResult.AclPrincipalId),\n },\n Role = \"roles/servicePrincipal.user\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group\n\t\tds, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"Data Science\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tautomationSp, err := databricks.NewServicePrincipal(ctx, \"automation_sp\", \u0026databricks.ServicePrincipalArgs{\n\t\t\tDisplayName: pulumi.String(\"SP_FOR_AUTOMATION\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"automation_sp_rule_set\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: automationSp.ApplicationId.ApplyT(func(applicationId string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"accounts/%v/servicePrincipals/%v/ruleSets/default\", accountId, applicationId), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(ds.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/servicePrincipal.user\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"ds\" {\n display_name = \"Data Science\"\n}\n\nresource \"databricks_serviceprincipal\" \"automation_sp\" {\n display_name = \"SP_FOR_AUTOMATION\"\n}\nresource \"databricks_accesscontrolruleset\" \"automation_sp_rule_set\" {\n name =\"accounts/${local.accountId}/servicePrincipals/${databricks_serviceprincipal.automation_sp.application_id}/ruleSets/default\"\n grant_rules {\n principals = [data.databricks_getgroup.ds.acl_principal_id]\n role = \"roles/servicePrincipal.user\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n// account level group\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.ServicePrincipal;\nimport com.pulumi.databricks.ServicePrincipalArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n final var ds = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n var automationSp = new ServicePrincipal(\"automationSp\", ServicePrincipalArgs.builder()\n .displayName(\"SP_FOR_AUTOMATION\")\n .build());\n\n var automationSpRuleSet = new AccessControlRuleSet(\"automationSpRuleSet\", AccessControlRuleSetArgs.builder()\n .name(automationSp.applicationId().applyValue(_applicationId -\u003e String.format(\"accounts/%s/servicePrincipals/%s/ruleSets/default\", accountId,_applicationId)))\n .grantRules(AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/servicePrincipal.user\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n automationSp:\n type: databricks:ServicePrincipal\n name: automation_sp\n properties:\n displayName: SP_FOR_AUTOMATION\n automationSpRuleSet:\n type: databricks:AccessControlRuleSet\n name: automation_sp_rule_set\n properties:\n name: accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default\n grantRules:\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/servicePrincipal.user\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n # account level group\n ds:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: Data Science\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nThrough AWS Databricks account:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group creation\nconst ds = new databricks.Group(\"ds\", {displayName: \"Data Science\"});\nconst automationSp = new databricks.ServicePrincipal(\"automation_sp\", {displayName: \"SP_FOR_AUTOMATION\"});\nconst automationSpRuleSet = new databricks.AccessControlRuleSet(\"automation_sp_rule_set\", {\n name: pulumi.interpolate`accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default`,\n grantRules: [{\n principals: [ds.aclPrincipalId],\n role: \"roles/servicePrincipal.user\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group creation\nds = databricks.Group(\"ds\", display_name=\"Data Science\")\nautomation_sp = databricks.ServicePrincipal(\"automation_sp\", display_name=\"SP_FOR_AUTOMATION\")\nautomation_sp_rule_set = databricks.AccessControlRuleSet(\"automation_sp_rule_set\",\n name=automation_sp.application_id.apply(lambda application_id: f\"accounts/{account_id}/servicePrincipals/{application_id}/ruleSets/default\"),\n grant_rules=[{\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/servicePrincipal.user\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group creation\n var ds = new Databricks.Group(\"ds\", new()\n {\n DisplayName = \"Data Science\",\n });\n\n var automationSp = new Databricks.ServicePrincipal(\"automation_sp\", new()\n {\n DisplayName = \"SP_FOR_AUTOMATION\",\n });\n\n var automationSpRuleSet = new Databricks.AccessControlRuleSet(\"automation_sp_rule_set\", new()\n {\n Name = automationSp.ApplicationId.Apply(applicationId =\u003e $\"accounts/{accountId}/servicePrincipals/{applicationId}/ruleSets/default\"),\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.AclPrincipalId,\n },\n Role = \"roles/servicePrincipal.user\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group creation\n\t\tds, err := databricks.NewGroup(ctx, \"ds\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Data Science\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tautomationSp, err := databricks.NewServicePrincipal(ctx, \"automation_sp\", \u0026databricks.ServicePrincipalArgs{\n\t\t\tDisplayName: pulumi.String(\"SP_FOR_AUTOMATION\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"automation_sp_rule_set\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: automationSp.ApplicationId.ApplyT(func(applicationId string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"accounts/%v/servicePrincipals/%v/ruleSets/default\", accountId, applicationId), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tds.AclPrincipalId,\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/servicePrincipal.user\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n// account level group creation\nresource \"databricks_group\" \"ds\" {\n display_name = \"Data Science\"\n}\nresource \"databricks_serviceprincipal\" \"automation_sp\" {\n display_name = \"SP_FOR_AUTOMATION\"\n}\nresource \"databricks_accesscontrolruleset\" \"automation_sp_rule_set\" {\n name =\"accounts/${local.accountId}/servicePrincipals/${databricks_serviceprincipal.automation_sp.application_id}/ruleSets/default\"\n grant_rules {\n principals = [databricks_group.ds.acl_principal_id]\n role = \"roles/servicePrincipal.user\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.ServicePrincipal;\nimport com.pulumi.databricks.ServicePrincipalArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group creation\n var ds = new Group(\"ds\", GroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n var automationSp = new ServicePrincipal(\"automationSp\", ServicePrincipalArgs.builder()\n .displayName(\"SP_FOR_AUTOMATION\")\n .build());\n\n var automationSpRuleSet = new AccessControlRuleSet(\"automationSpRuleSet\", AccessControlRuleSetArgs.builder()\n .name(automationSp.applicationId().applyValue(_applicationId -\u003e String.format(\"accounts/%s/servicePrincipals/%s/ruleSets/default\", accountId,_applicationId)))\n .grantRules(AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/servicePrincipal.user\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n # account level group creation\n ds:\n type: databricks:Group\n properties:\n displayName: Data Science\n automationSp:\n type: databricks:ServicePrincipal\n name: automation_sp\n properties:\n displayName: SP_FOR_AUTOMATION\n automationSpRuleSet:\n type: databricks:AccessControlRuleSet\n name: automation_sp_rule_set\n properties:\n name: accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default\n grantRules:\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/servicePrincipal.user\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nThrough Azure Databricks account:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group creation\nconst ds = new databricks.Group(\"ds\", {displayName: \"Data Science\"});\nconst automationSp = new databricks.ServicePrincipal(\"automation_sp\", {\n applicationId: \"00000000-0000-0000-0000-000000000000\",\n displayName: \"SP_FOR_AUTOMATION\",\n});\nconst automationSpRuleSet = new databricks.AccessControlRuleSet(\"automation_sp_rule_set\", {\n name: pulumi.interpolate`accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default`,\n grantRules: [{\n principals: [ds.aclPrincipalId],\n role: \"roles/servicePrincipal.user\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group creation\nds = databricks.Group(\"ds\", display_name=\"Data Science\")\nautomation_sp = databricks.ServicePrincipal(\"automation_sp\",\n application_id=\"00000000-0000-0000-0000-000000000000\",\n display_name=\"SP_FOR_AUTOMATION\")\nautomation_sp_rule_set = databricks.AccessControlRuleSet(\"automation_sp_rule_set\",\n name=automation_sp.application_id.apply(lambda application_id: f\"accounts/{account_id}/servicePrincipals/{application_id}/ruleSets/default\"),\n grant_rules=[{\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/servicePrincipal.user\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group creation\n var ds = new Databricks.Group(\"ds\", new()\n {\n DisplayName = \"Data Science\",\n });\n\n var automationSp = new Databricks.ServicePrincipal(\"automation_sp\", new()\n {\n ApplicationId = \"00000000-0000-0000-0000-000000000000\",\n DisplayName = \"SP_FOR_AUTOMATION\",\n });\n\n var automationSpRuleSet = new Databricks.AccessControlRuleSet(\"automation_sp_rule_set\", new()\n {\n Name = automationSp.ApplicationId.Apply(applicationId =\u003e $\"accounts/{accountId}/servicePrincipals/{applicationId}/ruleSets/default\"),\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.AclPrincipalId,\n },\n Role = \"roles/servicePrincipal.user\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group creation\n\t\tds, err := databricks.NewGroup(ctx, \"ds\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Data Science\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tautomationSp, err := databricks.NewServicePrincipal(ctx, \"automation_sp\", \u0026databricks.ServicePrincipalArgs{\n\t\t\tApplicationId: pulumi.String(\"00000000-0000-0000-0000-000000000000\"),\n\t\t\tDisplayName: pulumi.String(\"SP_FOR_AUTOMATION\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"automation_sp_rule_set\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: automationSp.ApplicationId.ApplyT(func(applicationId string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"accounts/%v/servicePrincipals/%v/ruleSets/default\", accountId, applicationId), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tds.AclPrincipalId,\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/servicePrincipal.user\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n// account level group creation\nresource \"databricks_group\" \"ds\" {\n display_name = \"Data Science\"\n}\nresource \"databricks_serviceprincipal\" \"automation_sp\" {\n application_id = \"00000000-0000-0000-0000-000000000000\"\n display_name = \"SP_FOR_AUTOMATION\"\n}\nresource \"databricks_accesscontrolruleset\" \"automation_sp_rule_set\" {\n name =\"accounts/${local.accountId}/servicePrincipals/${databricks_serviceprincipal.automation_sp.application_id}/ruleSets/default\"\n grant_rules {\n principals = [databricks_group.ds.acl_principal_id]\n role = \"roles/servicePrincipal.user\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.ServicePrincipal;\nimport com.pulumi.databricks.ServicePrincipalArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group creation\n var ds = new Group(\"ds\", GroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n var automationSp = new ServicePrincipal(\"automationSp\", ServicePrincipalArgs.builder()\n .applicationId(\"00000000-0000-0000-0000-000000000000\")\n .displayName(\"SP_FOR_AUTOMATION\")\n .build());\n\n var automationSpRuleSet = new AccessControlRuleSet(\"automationSpRuleSet\", AccessControlRuleSetArgs.builder()\n .name(automationSp.applicationId().applyValue(_applicationId -\u003e String.format(\"accounts/%s/servicePrincipals/%s/ruleSets/default\", accountId,_applicationId)))\n .grantRules(AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/servicePrincipal.user\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n # account level group creation\n ds:\n type: databricks:Group\n properties:\n displayName: Data Science\n automationSp:\n type: databricks:ServicePrincipal\n name: automation_sp\n properties:\n applicationId: 00000000-0000-0000-0000-000000000000\n displayName: SP_FOR_AUTOMATION\n automationSpRuleSet:\n type: databricks:AccessControlRuleSet\n name: automation_sp_rule_set\n properties:\n name: accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default\n grantRules:\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/servicePrincipal.user\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nThrough GCP Databricks account:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group creation\nconst ds = new databricks.Group(\"ds\", {displayName: \"Data Science\"});\nconst automationSp = new databricks.ServicePrincipal(\"automation_sp\", {displayName: \"SP_FOR_AUTOMATION\"});\nconst automationSpRuleSet = new databricks.AccessControlRuleSet(\"automation_sp_rule_set\", {\n name: pulumi.interpolate`accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default`,\n grantRules: [{\n principals: [ds.aclPrincipalId],\n role: \"roles/servicePrincipal.user\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group creation\nds = databricks.Group(\"ds\", display_name=\"Data Science\")\nautomation_sp = databricks.ServicePrincipal(\"automation_sp\", display_name=\"SP_FOR_AUTOMATION\")\nautomation_sp_rule_set = databricks.AccessControlRuleSet(\"automation_sp_rule_set\",\n name=automation_sp.application_id.apply(lambda application_id: f\"accounts/{account_id}/servicePrincipals/{application_id}/ruleSets/default\"),\n grant_rules=[{\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/servicePrincipal.user\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group creation\n var ds = new Databricks.Group(\"ds\", new()\n {\n DisplayName = \"Data Science\",\n });\n\n var automationSp = new Databricks.ServicePrincipal(\"automation_sp\", new()\n {\n DisplayName = \"SP_FOR_AUTOMATION\",\n });\n\n var automationSpRuleSet = new Databricks.AccessControlRuleSet(\"automation_sp_rule_set\", new()\n {\n Name = automationSp.ApplicationId.Apply(applicationId =\u003e $\"accounts/{accountId}/servicePrincipals/{applicationId}/ruleSets/default\"),\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.AclPrincipalId,\n },\n Role = \"roles/servicePrincipal.user\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group creation\n\t\tds, err := databricks.NewGroup(ctx, \"ds\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Data Science\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tautomationSp, err := databricks.NewServicePrincipal(ctx, \"automation_sp\", \u0026databricks.ServicePrincipalArgs{\n\t\t\tDisplayName: pulumi.String(\"SP_FOR_AUTOMATION\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"automation_sp_rule_set\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: automationSp.ApplicationId.ApplyT(func(applicationId string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"accounts/%v/servicePrincipals/%v/ruleSets/default\", accountId, applicationId), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tds.AclPrincipalId,\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/servicePrincipal.user\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n// account level group creation\nresource \"databricks_group\" \"ds\" {\n display_name = \"Data Science\"\n}\nresource \"databricks_serviceprincipal\" \"automation_sp\" {\n display_name = \"SP_FOR_AUTOMATION\"\n}\nresource \"databricks_accesscontrolruleset\" \"automation_sp_rule_set\" {\n name =\"accounts/${local.accountId}/servicePrincipals/${databricks_serviceprincipal.automation_sp.application_id}/ruleSets/default\"\n grant_rules {\n principals = [databricks_group.ds.acl_principal_id]\n role = \"roles/servicePrincipal.user\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.ServicePrincipal;\nimport com.pulumi.databricks.ServicePrincipalArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group creation\n var ds = new Group(\"ds\", GroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n var automationSp = new ServicePrincipal(\"automationSp\", ServicePrincipalArgs.builder()\n .displayName(\"SP_FOR_AUTOMATION\")\n .build());\n\n var automationSpRuleSet = new AccessControlRuleSet(\"automationSpRuleSet\", AccessControlRuleSetArgs.builder()\n .name(automationSp.applicationId().applyValue(_applicationId -\u003e String.format(\"accounts/%s/servicePrincipals/%s/ruleSets/default\", accountId,_applicationId)))\n .grantRules(AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/servicePrincipal.user\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n # account level group creation\n ds:\n type: databricks:Group\n properties:\n displayName: Data Science\n automationSp:\n type: databricks:ServicePrincipal\n name: automation_sp\n properties:\n displayName: SP_FOR_AUTOMATION\n automationSpRuleSet:\n type: databricks:AccessControlRuleSet\n name: automation_sp_rule_set\n properties:\n name: accounts/${accountId}/servicePrincipals/${automationSp.applicationId}/ruleSets/default\n grantRules:\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/servicePrincipal.user\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Group rule set usage\n\nRefer to the appropriate provider configuration as shown in the examples for service principal rule set.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group\nconst ds = databricks.getGroup({\n displayName: \"Data Science\",\n});\nconst john = databricks.getUser({\n userName: \"john.doe@example.com\",\n});\nconst dsGroupRuleSet = new databricks.AccessControlRuleSet(\"ds_group_rule_set\", {\n name: `accounts/${accountId}/groups/${dsDatabricksGroup.id}/ruleSets/default`,\n grantRules: [{\n principals: [john.then(john =\u003e john.aclPrincipalId)],\n role: \"roles/group.manager\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group\nds = databricks.get_group(display_name=\"Data Science\")\njohn = databricks.get_user(user_name=\"john.doe@example.com\")\nds_group_rule_set = databricks.AccessControlRuleSet(\"ds_group_rule_set\",\n name=f\"accounts/{account_id}/groups/{ds_databricks_group['id']}/ruleSets/default\",\n grant_rules=[{\n \"principals\": [john.acl_principal_id],\n \"role\": \"roles/group.manager\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n var ds = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"Data Science\",\n });\n\n var john = Databricks.GetUser.Invoke(new()\n {\n UserName = \"john.doe@example.com\",\n });\n\n var dsGroupRuleSet = new Databricks.AccessControlRuleSet(\"ds_group_rule_set\", new()\n {\n Name = $\"accounts/{accountId}/groups/{dsDatabricksGroup.Id}/ruleSets/default\",\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n john.Apply(getUserResult =\u003e getUserResult.AclPrincipalId),\n },\n Role = \"roles/group.manager\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group\n\t\t_, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"Data Science\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjohn, err := databricks.GetUser(ctx, \u0026databricks.LookupUserArgs{\n\t\t\tUserName: pulumi.StringRef(\"john.doe@example.com\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"ds_group_rule_set\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: pulumi.Sprintf(\"accounts/%v/groups/%v/ruleSets/default\", accountId, dsDatabricksGroup.Id),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(john.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/group.manager\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"ds\" {\n display_name = \"Data Science\"\n}\ndata \"databricks_getuser\" \"john\" {\n user_name = \"john.doe@example.com\"\n}\n\nresource \"databricks_accesscontrolruleset\" \"ds_group_rule_set\" {\n name =\"accounts/${local.accountId}/groups/${dsDatabricksGroup.id}/ruleSets/default\"\n grant_rules {\n principals = [data.databricks_getuser.john.acl_principal_id]\n role = \"roles/group.manager\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n// account level group\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.inputs.GetUserArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n final var ds = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n final var john = DatabricksFunctions.getUser(GetUserArgs.builder()\n .userName(\"john.doe@example.com\")\n .build());\n\n var dsGroupRuleSet = new AccessControlRuleSet(\"dsGroupRuleSet\", AccessControlRuleSetArgs.builder()\n .name(String.format(\"accounts/%s/groups/%s/ruleSets/default\", accountId,dsDatabricksGroup.id()))\n .grantRules(AccessControlRuleSetGrantRuleArgs.builder()\n .principals(john.aclPrincipalId())\n .role(\"roles/group.manager\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n dsGroupRuleSet:\n type: databricks:AccessControlRuleSet\n name: ds_group_rule_set\n properties:\n name: accounts/${accountId}/groups/${dsDatabricksGroup.id}/ruleSets/default\n grantRules:\n - principals:\n - ${john.aclPrincipalId}\n role: roles/group.manager\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n # account level group\n ds:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: Data Science\n john:\n fn::invoke:\n function: databricks:getUser\n arguments:\n userName: john.doe@example.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Account rule set usage\n\nRefer to the appropriate provider configuration as shown in the examples for service principal rule set.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group\nconst ds = databricks.getGroup({\n displayName: \"Data Science\",\n});\n// account level group\nconst marketplaceAdmins = databricks.getGroup({\n displayName: \"Marketplace Admins\",\n});\nconst john = databricks.getUser({\n userName: \"john.doe@example.com\",\n});\nconst accountRuleSet = new databricks.AccessControlRuleSet(\"account_rule_set\", {\n name: `accounts/${accountId}/ruleSets/default`,\n grantRules: [\n {\n principals: [john.then(john =\u003e john.aclPrincipalId)],\n role: \"roles/group.manager\",\n },\n {\n principals: [ds.then(ds =\u003e ds.aclPrincipalId)],\n role: \"roles/servicePrincipal.manager\",\n },\n {\n principals: [marketplaceAdmins.then(marketplaceAdmins =\u003e marketplaceAdmins.aclPrincipalId)],\n role: \"roles/marketplace.admin\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group\nds = databricks.get_group(display_name=\"Data Science\")\n# account level group\nmarketplace_admins = databricks.get_group(display_name=\"Marketplace Admins\")\njohn = databricks.get_user(user_name=\"john.doe@example.com\")\naccount_rule_set = databricks.AccessControlRuleSet(\"account_rule_set\",\n name=f\"accounts/{account_id}/ruleSets/default\",\n grant_rules=[\n {\n \"principals\": [john.acl_principal_id],\n \"role\": \"roles/group.manager\",\n },\n {\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/servicePrincipal.manager\",\n },\n {\n \"principals\": [marketplace_admins.acl_principal_id],\n \"role\": \"roles/marketplace.admin\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n var ds = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"Data Science\",\n });\n\n // account level group\n var marketplaceAdmins = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"Marketplace Admins\",\n });\n\n var john = Databricks.GetUser.Invoke(new()\n {\n UserName = \"john.doe@example.com\",\n });\n\n var accountRuleSet = new Databricks.AccessControlRuleSet(\"account_rule_set\", new()\n {\n Name = $\"accounts/{accountId}/ruleSets/default\",\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n john.Apply(getUserResult =\u003e getUserResult.AclPrincipalId),\n },\n Role = \"roles/group.manager\",\n },\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.Apply(getGroupResult =\u003e getGroupResult.AclPrincipalId),\n },\n Role = \"roles/servicePrincipal.manager\",\n },\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n marketplaceAdmins.Apply(getGroupResult =\u003e getGroupResult.AclPrincipalId),\n },\n Role = \"roles/marketplace.admin\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group\n\t\tds, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"Data Science\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// account level group\n\t\tmarketplaceAdmins, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"Marketplace Admins\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjohn, err := databricks.GetUser(ctx, \u0026databricks.LookupUserArgs{\n\t\t\tUserName: pulumi.StringRef(\"john.doe@example.com\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"account_rule_set\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: pulumi.Sprintf(\"accounts/%v/ruleSets/default\", accountId),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(john.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/group.manager\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(ds.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/servicePrincipal.manager\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(marketplaceAdmins.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/marketplace.admin\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"ds\" {\n display_name = \"Data Science\"\n}\ndata \"databricks_getgroup\" \"marketplaceAdmins\" {\n display_name = \"Marketplace Admins\"\n}\ndata \"databricks_getuser\" \"john\" {\n user_name = \"john.doe@example.com\"\n}\n\nresource \"databricks_accesscontrolruleset\" \"account_rule_set\" {\n name =\"accounts/${local.accountId}/ruleSets/default\"\n grant_rules {\n principals = [data.databricks_getuser.john.acl_principal_id]\n role = \"roles/group.manager\"\n }\n grant_rules {\n principals = [data.databricks_getgroup.ds.acl_principal_id]\n role = \"roles/servicePrincipal.manager\"\n }\n grant_rules {\n principals = [data.databricks_getgroup.marketplaceAdmins.acl_principal_id]\n role = \"roles/marketplace.admin\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n// account level group\n// account level group\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.inputs.GetUserArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n final var ds = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n // account level group\n final var marketplaceAdmins = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"Marketplace Admins\")\n .build());\n\n final var john = DatabricksFunctions.getUser(GetUserArgs.builder()\n .userName(\"john.doe@example.com\")\n .build());\n\n var accountRuleSet = new AccessControlRuleSet(\"accountRuleSet\", AccessControlRuleSetArgs.builder()\n .name(String.format(\"accounts/%s/ruleSets/default\", accountId))\n .grantRules( \n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(john.aclPrincipalId())\n .role(\"roles/group.manager\")\n .build(),\n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/servicePrincipal.manager\")\n .build(),\n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(marketplaceAdmins.aclPrincipalId())\n .role(\"roles/marketplace.admin\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n accountRuleSet:\n type: databricks:AccessControlRuleSet\n name: account_rule_set\n properties:\n name: accounts/${accountId}/ruleSets/default\n grantRules:\n - principals:\n - ${john.aclPrincipalId}\n role: roles/group.manager\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/servicePrincipal.manager\n - principals:\n - ${marketplaceAdmins.aclPrincipalId}\n role: roles/marketplace.admin\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n # account level group\n ds:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: Data Science\n # account level group\n marketplaceAdmins:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: Marketplace Admins\n john:\n fn::invoke:\n function: databricks:getUser\n arguments:\n userName: john.doe@example.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Budget policy usage\n\nAccess to budget policies could be controlled with this resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group\nconst ds = databricks.getGroup({\n displayName: \"Data Science\",\n});\nconst john = databricks.getUser({\n userName: \"john.doe@example.com\",\n});\nconst _this = new databricks.BudgetPolicy(\"this\", {\n policyName: \"data-science-budget-policy\",\n customTags: [{\n key: \"mykey\",\n value: \"myvalue\",\n }],\n});\nconst budgetPolicyUsage = new databricks.AccessControlRuleSet(\"budget_policy_usage\", {\n name: pulumi.interpolate`accounts/${accountId}/budgetPolicies/${_this.policyId}/ruleSets/default`,\n grantRules: [\n {\n principals: [john.then(john =\u003e john.aclPrincipalId)],\n role: \"roles/budgetPolicy.manager\",\n },\n {\n principals: [ds.then(ds =\u003e ds.aclPrincipalId)],\n role: \"roles/budgetPolicy.user\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group\nds = databricks.get_group(display_name=\"Data Science\")\njohn = databricks.get_user(user_name=\"john.doe@example.com\")\nthis = databricks.BudgetPolicy(\"this\",\n policy_name=\"data-science-budget-policy\",\n custom_tags=[{\n \"key\": \"mykey\",\n \"value\": \"myvalue\",\n }])\nbudget_policy_usage = databricks.AccessControlRuleSet(\"budget_policy_usage\",\n name=this.policy_id.apply(lambda policy_id: f\"accounts/{account_id}/budgetPolicies/{policy_id}/ruleSets/default\"),\n grant_rules=[\n {\n \"principals\": [john.acl_principal_id],\n \"role\": \"roles/budgetPolicy.manager\",\n },\n {\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/budgetPolicy.user\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n var ds = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"Data Science\",\n });\n\n var john = Databricks.GetUser.Invoke(new()\n {\n UserName = \"john.doe@example.com\",\n });\n\n var @this = new Databricks.BudgetPolicy(\"this\", new()\n {\n PolicyName = \"data-science-budget-policy\",\n CustomTags = new[]\n {\n new Databricks.Inputs.BudgetPolicyCustomTagArgs\n {\n Key = \"mykey\",\n Value = \"myvalue\",\n },\n },\n });\n\n var budgetPolicyUsage = new Databricks.AccessControlRuleSet(\"budget_policy_usage\", new()\n {\n Name = @this.PolicyId.Apply(policyId =\u003e $\"accounts/{accountId}/budgetPolicies/{policyId}/ruleSets/default\"),\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n john.Apply(getUserResult =\u003e getUserResult.AclPrincipalId),\n },\n Role = \"roles/budgetPolicy.manager\",\n },\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.Apply(getGroupResult =\u003e getGroupResult.AclPrincipalId),\n },\n Role = \"roles/budgetPolicy.user\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group\n\t\tds, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"Data Science\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjohn, err := databricks.GetUser(ctx, \u0026databricks.LookupUserArgs{\n\t\t\tUserName: pulumi.StringRef(\"john.doe@example.com\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := databricks.NewBudgetPolicy(ctx, \"this\", \u0026databricks.BudgetPolicyArgs{\n\t\t\tPolicyName: pulumi.String(\"data-science-budget-policy\"),\n\t\t\tCustomTags: databricks.BudgetPolicyCustomTagArray{\n\t\t\t\t\u0026databricks.BudgetPolicyCustomTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"mykey\"),\n\t\t\t\t\tValue: pulumi.String(\"myvalue\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"budget_policy_usage\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: this.PolicyId.ApplyT(func(policyId string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"accounts/%v/budgetPolicies/%v/ruleSets/default\", accountId, policyId), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(john.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/budgetPolicy.manager\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(ds.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/budgetPolicy.user\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"ds\" {\n display_name = \"Data Science\"\n}\ndata \"databricks_getuser\" \"john\" {\n user_name = \"john.doe@example.com\"\n}\n\nresource \"databricks_budgetpolicy\" \"this\" {\n policy_name = \"data-science-budget-policy\"\n custom_tags {\n key = \"mykey\"\n value = \"myvalue\"\n }\n}\nresource \"databricks_accesscontrolruleset\" \"budget_policy_usage\" {\n name =\"accounts/${local.accountId}/budgetPolicies/${databricks_budgetpolicy.this.policy_id}/ruleSets/default\"\n grant_rules {\n principals = [data.databricks_getuser.john.acl_principal_id]\n role = \"roles/budgetPolicy.manager\"\n }\n grant_rules {\n principals = [data.databricks_getgroup.ds.acl_principal_id]\n role = \"roles/budgetPolicy.user\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n// account level group\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.inputs.GetUserArgs;\nimport com.pulumi.databricks.BudgetPolicy;\nimport com.pulumi.databricks.BudgetPolicyArgs;\nimport com.pulumi.databricks.inputs.BudgetPolicyCustomTagArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n final var ds = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n final var john = DatabricksFunctions.getUser(GetUserArgs.builder()\n .userName(\"john.doe@example.com\")\n .build());\n\n var this_ = new BudgetPolicy(\"this\", BudgetPolicyArgs.builder()\n .policyName(\"data-science-budget-policy\")\n .customTags(BudgetPolicyCustomTagArgs.builder()\n .key(\"mykey\")\n .value(\"myvalue\")\n .build())\n .build());\n\n var budgetPolicyUsage = new AccessControlRuleSet(\"budgetPolicyUsage\", AccessControlRuleSetArgs.builder()\n .name(this_.policyId().applyValue(_policyId -\u003e String.format(\"accounts/%s/budgetPolicies/%s/ruleSets/default\", accountId,_policyId)))\n .grantRules( \n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(john.aclPrincipalId())\n .role(\"roles/budgetPolicy.manager\")\n .build(),\n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/budgetPolicy.user\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:BudgetPolicy\n properties:\n policyName: data-science-budget-policy\n customTags:\n - key: mykey\n value: myvalue\n budgetPolicyUsage:\n type: databricks:AccessControlRuleSet\n name: budget_policy_usage\n properties:\n name: accounts/${accountId}/budgetPolicies/${this.policyId}/ruleSets/default\n grantRules:\n - principals:\n - ${john.aclPrincipalId}\n role: roles/budgetPolicy.manager\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/budgetPolicy.user\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n # account level group\n ds:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: Data Science\n john:\n fn::invoke:\n function: databricks:getUser\n arguments:\n userName: john.doe@example.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Tag policy usage\n\nAccess to tag policies could be controlled with this resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst accountId = \"00000000-0000-0000-0000-000000000000\";\n// account level group\nconst ds = databricks.getGroup({\n displayName: \"Data Science\",\n});\nconst john = databricks.getUser({\n userName: \"john.doe@example.com\",\n});\nconst _this = new databricks.TagPolicy(\"this\", {\n tagKey: \"example_tag_key\",\n description: \"Example description.\",\n values: [\n {\n name: \"example_value_2\",\n },\n {\n name: \"example_value_3\",\n },\n ],\n});\nconst tagPolicyUsage = new databricks.AccessControlRuleSet(\"tag_policy_usage\", {\n name: pulumi.interpolate`accounts/${accountId}/tagPolicies/${_this.id}/ruleSets/default`,\n grantRules: [\n {\n principals: [john.then(john =\u003e john.aclPrincipalId)],\n role: \"roles/tagPolicy.manager\",\n },\n {\n principals: [ds.then(ds =\u003e ds.aclPrincipalId)],\n role: \"roles/tagPolicy.assigner\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naccount_id = \"00000000-0000-0000-0000-000000000000\"\n# account level group\nds = databricks.get_group(display_name=\"Data Science\")\njohn = databricks.get_user(user_name=\"john.doe@example.com\")\nthis = databricks.TagPolicy(\"this\",\n tag_key=\"example_tag_key\",\n description=\"Example description.\",\n values=[\n {\n \"name\": \"example_value_2\",\n },\n {\n \"name\": \"example_value_3\",\n },\n ])\ntag_policy_usage = databricks.AccessControlRuleSet(\"tag_policy_usage\",\n name=this.id.apply(lambda id: f\"accounts/{account_id}/tagPolicies/{id}/ruleSets/default\"),\n grant_rules=[\n {\n \"principals\": [john.acl_principal_id],\n \"role\": \"roles/tagPolicy.manager\",\n },\n {\n \"principals\": [ds.acl_principal_id],\n \"role\": \"roles/tagPolicy.assigner\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n var ds = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"Data Science\",\n });\n\n var john = Databricks.GetUser.Invoke(new()\n {\n UserName = \"john.doe@example.com\",\n });\n\n var @this = new Databricks.TagPolicy(\"this\", new()\n {\n TagKey = \"example_tag_key\",\n Description = \"Example description.\",\n Values = new[]\n {\n new Databricks.Inputs.TagPolicyValueArgs\n {\n Name = \"example_value_2\",\n },\n new Databricks.Inputs.TagPolicyValueArgs\n {\n Name = \"example_value_3\",\n },\n },\n });\n\n var tagPolicyUsage = new Databricks.AccessControlRuleSet(\"tag_policy_usage\", new()\n {\n Name = @this.Id.Apply(id =\u003e $\"accounts/{accountId}/tagPolicies/{id}/ruleSets/default\"),\n GrantRules = new[]\n {\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n john.Apply(getUserResult =\u003e getUserResult.AclPrincipalId),\n },\n Role = \"roles/tagPolicy.manager\",\n },\n new Databricks.Inputs.AccessControlRuleSetGrantRuleArgs\n {\n Principals = new[]\n {\n ds.Apply(getGroupResult =\u003e getGroupResult.AclPrincipalId),\n },\n Role = \"roles/tagPolicy.assigner\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\taccountId := \"00000000-0000-0000-0000-000000000000\"\n\t\t// account level group\n\t\tds, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"Data Science\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjohn, err := databricks.GetUser(ctx, \u0026databricks.LookupUserArgs{\n\t\t\tUserName: pulumi.StringRef(\"john.doe@example.com\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := databricks.NewTagPolicy(ctx, \"this\", \u0026databricks.TagPolicyArgs{\n\t\t\tTagKey: pulumi.String(\"example_tag_key\"),\n\t\t\tDescription: pulumi.String(\"Example description.\"),\n\t\t\tValues: databricks.TagPolicyValueArray{\n\t\t\t\t\u0026databricks.TagPolicyValueArgs{\n\t\t\t\t\tName: pulumi.String(\"example_value_2\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.TagPolicyValueArgs{\n\t\t\t\t\tName: pulumi.String(\"example_value_3\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAccessControlRuleSet(ctx, \"tag_policy_usage\", \u0026databricks.AccessControlRuleSetArgs{\n\t\t\tName: this.ID().ApplyT(func(id string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"accounts/%v/tagPolicies/%v/ruleSets/default\", accountId, id), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tGrantRules: databricks.AccessControlRuleSetGrantRuleArray{\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(john.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/tagPolicy.manager\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.AccessControlRuleSetGrantRuleArgs{\n\t\t\t\t\tPrincipals: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(ds.AclPrincipalId),\n\t\t\t\t\t},\n\t\t\t\t\tRole: pulumi.String(\"roles/tagPolicy.assigner\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"ds\" {\n display_name = \"Data Science\"\n}\ndata \"databricks_getuser\" \"john\" {\n user_name = \"john.doe@example.com\"\n}\n\nresource \"databricks_tagpolicy\" \"this\" {\n tag_key = \"example_tag_key\"\n description = \"Example description.\"\n values {\n name = \"example_value_2\"\n }\n values {\n name = \"example_value_3\"\n }\n}\nresource \"databricks_accesscontrolruleset\" \"tag_policy_usage\" {\n name =\"accounts/${local.accountId}/tagPolicies/${databricks_tagpolicy.this.id}/ruleSets/default\"\n grant_rules {\n principals = [data.databricks_getuser.john.acl_principal_id]\n role = \"roles/tagPolicy.manager\"\n }\n grant_rules {\n principals = [data.databricks_getgroup.ds.acl_principal_id]\n role = \"roles/tagPolicy.assigner\"\n }\n}\nlocals {\n accountId = \"00000000-0000-0000-0000-000000000000\"\n}\n// account level group\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.inputs.GetUserArgs;\nimport com.pulumi.databricks.TagPolicy;\nimport com.pulumi.databricks.TagPolicyArgs;\nimport com.pulumi.databricks.inputs.TagPolicyValueArgs;\nimport com.pulumi.databricks.AccessControlRuleSet;\nimport com.pulumi.databricks.AccessControlRuleSetArgs;\nimport com.pulumi.databricks.inputs.AccessControlRuleSetGrantRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var accountId = \"00000000-0000-0000-0000-000000000000\";\n\n // account level group\n final var ds = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"Data Science\")\n .build());\n\n final var john = DatabricksFunctions.getUser(GetUserArgs.builder()\n .userName(\"john.doe@example.com\")\n .build());\n\n var this_ = new TagPolicy(\"this\", TagPolicyArgs.builder()\n .tagKey(\"example_tag_key\")\n .description(\"Example description.\")\n .values( \n TagPolicyValueArgs.builder()\n .name(\"example_value_2\")\n .build(),\n TagPolicyValueArgs.builder()\n .name(\"example_value_3\")\n .build())\n .build());\n\n var tagPolicyUsage = new AccessControlRuleSet(\"tagPolicyUsage\", AccessControlRuleSetArgs.builder()\n .name(this_.id().applyValue(_id -\u003e String.format(\"accounts/%s/tagPolicies/%s/ruleSets/default\", accountId,_id)))\n .grantRules( \n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(john.aclPrincipalId())\n .role(\"roles/tagPolicy.manager\")\n .build(),\n AccessControlRuleSetGrantRuleArgs.builder()\n .principals(ds.aclPrincipalId())\n .role(\"roles/tagPolicy.assigner\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:TagPolicy\n properties:\n tagKey: example_tag_key\n description: Example description.\n values:\n - name: example_value_2\n - name: example_value_3\n tagPolicyUsage:\n type: databricks:AccessControlRuleSet\n name: tag_policy_usage\n properties:\n name: accounts/${accountId}/tagPolicies/${this.id}/ruleSets/default\n grantRules:\n - principals:\n - ${john.aclPrincipalId}\n role: roles/tagPolicy.manager\n - principals:\n - ${ds.aclPrincipalId}\n role: roles/tagPolicy.assigner\nvariables:\n accountId: 00000000-0000-0000-0000-000000000000\n # account level group\n ds:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: Data Science\n john:\n fn::invoke:\n function: databricks:getUser\n arguments:\n userName: john.doe@example.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group\n\" pulumi-lang-dotnet=\" databricks.Group\n\" pulumi-lang-go=\" Group\n\" pulumi-lang-python=\" Group\n\" pulumi-lang-yaml=\" databricks.Group\n\" pulumi-lang-java=\" databricks.Group\n\" pulumi-lang-hcl=\" databricks_group\n\"\u003e databricks.Group\n\u003c/span\u003e*\u003cspan pulumi-lang-nodejs=\" databricks.User\n\" pulumi-lang-dotnet=\" databricks.User\n\" pulumi-lang-go=\" User\n\" pulumi-lang-python=\" User\n\" pulumi-lang-yaml=\" databricks.User\n\" pulumi-lang-java=\" databricks.User\n\" pulumi-lang-hcl=\" databricks_user\n\"\u003e databricks.User\n\u003c/span\u003e*\u003cspan pulumi-lang-nodejs=\" databricks.ServicePrincipal\n\" pulumi-lang-dotnet=\" databricks.ServicePrincipal\n\" pulumi-lang-go=\" ServicePrincipal\n\" pulumi-lang-python=\" ServicePrincipal\n\" pulumi-lang-yaml=\" databricks.ServicePrincipal\n\" pulumi-lang-java=\" databricks.ServicePrincipal\n\" pulumi-lang-hcl=\" databricks_service_principal\n\"\u003e databricks.ServicePrincipal\n\u003c/span\u003e\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "etag": { "type": "string" }, "grantRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccessControlRuleSetGrantRule:AccessControlRuleSetGrantRule" }, "description": "The access control rules to be granted by this rule set, consisting of a set of principals and roles to be granted to them.\n\n\u003e Name uniquely identifies a rule set resource. Ensure all the\u003cspan pulumi-lang-nodejs=\" grantRules \" pulumi-lang-dotnet=\" GrantRules \" pulumi-lang-go=\" grantRules \" pulumi-lang-python=\" grant_rules \" pulumi-lang-yaml=\" grantRules \" pulumi-lang-java=\" grantRules \" pulumi-lang-hcl=\" grant_rules \"\u003e grantRules \u003c/span\u003eblocks for a rule set name are present in one \u003cspan pulumi-lang-nodejs=\"`databricks.AccessControlRuleSet`\" pulumi-lang-dotnet=\"`databricks.AccessControlRuleSet`\" pulumi-lang-go=\"`AccessControlRuleSet`\" pulumi-lang-python=\"`AccessControlRuleSet`\" pulumi-lang-yaml=\"`databricks.AccessControlRuleSet`\" pulumi-lang-java=\"`databricks.AccessControlRuleSet`\" pulumi-lang-hcl=\"`databricks_access_control_rule_set`\"\u003e`databricks.AccessControlRuleSet`\u003c/span\u003e resource block. Otherwise, after applying changes, users might lose their role assignment even if that was not intended.\n" }, "name": { "type": "string", "description": "Unique identifier of a rule set. The name determines the resource to which the rule set applies. **Changing the name recreates the resource!**. Currently, only default rule sets are supported. The following rule set formats are supported:\n* `accounts/{account_id}/ruleSets/default` - account-level access control.\n* `accounts/{account_id}/servicePrincipals/{service_principal_application_id}/ruleSets/default` - access control for a specific service principal.\n* `accounts/{account_id}/groups/{group_id}/ruleSets/default` - access control for a specific group.\n* `accounts/{account_id}/budgetPolicies/{budget_policy_id}/ruleSets/default` - access control for a specific budget policy.\n* `accounts/{account_id}/tagPolicies/{tag_policy_id}/ruleSets/default` - access control for a specific tag policy.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AccessControlRuleSetProviderConfig:AccessControlRuleSetProviderConfig" } }, "required": [ "etag", "name", "providerConfig" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "grantRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccessControlRuleSetGrantRule:AccessControlRuleSetGrantRule" }, "description": "The access control rules to be granted by this rule set, consisting of a set of principals and roles to be granted to them.\n\n\u003e Name uniquely identifies a rule set resource. Ensure all the\u003cspan pulumi-lang-nodejs=\" grantRules \" pulumi-lang-dotnet=\" GrantRules \" pulumi-lang-go=\" grantRules \" pulumi-lang-python=\" grant_rules \" pulumi-lang-yaml=\" grantRules \" pulumi-lang-java=\" grantRules \" pulumi-lang-hcl=\" grant_rules \"\u003e grantRules \u003c/span\u003eblocks for a rule set name are present in one \u003cspan pulumi-lang-nodejs=\"`databricks.AccessControlRuleSet`\" pulumi-lang-dotnet=\"`databricks.AccessControlRuleSet`\" pulumi-lang-go=\"`AccessControlRuleSet`\" pulumi-lang-python=\"`AccessControlRuleSet`\" pulumi-lang-yaml=\"`databricks.AccessControlRuleSet`\" pulumi-lang-java=\"`databricks.AccessControlRuleSet`\" pulumi-lang-hcl=\"`databricks_access_control_rule_set`\"\u003e`databricks.AccessControlRuleSet`\u003c/span\u003e resource block. Otherwise, after applying changes, users might lose their role assignment even if that was not intended.\n" }, "name": { "type": "string", "description": "Unique identifier of a rule set. The name determines the resource to which the rule set applies. **Changing the name recreates the resource!**. Currently, only default rule sets are supported. The following rule set formats are supported:\n* `accounts/{account_id}/ruleSets/default` - account-level access control.\n* `accounts/{account_id}/servicePrincipals/{service_principal_application_id}/ruleSets/default` - access control for a specific service principal.\n* `accounts/{account_id}/groups/{group_id}/ruleSets/default` - access control for a specific group.\n* `accounts/{account_id}/budgetPolicies/{budget_policy_id}/ruleSets/default` - access control for a specific budget policy.\n* `accounts/{account_id}/tagPolicies/{tag_policy_id}/ruleSets/default` - access control for a specific tag policy.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/AccessControlRuleSetProviderConfig:AccessControlRuleSetProviderConfig" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AccessControlRuleSet resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "etag": { "type": "string" }, "grantRules": { "type": "array", "items": { "$ref": "#/types/databricks:index/AccessControlRuleSetGrantRule:AccessControlRuleSetGrantRule" }, "description": "The access control rules to be granted by this rule set, consisting of a set of principals and roles to be granted to them.\n\n\u003e Name uniquely identifies a rule set resource. Ensure all the\u003cspan pulumi-lang-nodejs=\" grantRules \" pulumi-lang-dotnet=\" GrantRules \" pulumi-lang-go=\" grantRules \" pulumi-lang-python=\" grant_rules \" pulumi-lang-yaml=\" grantRules \" pulumi-lang-java=\" grantRules \" pulumi-lang-hcl=\" grant_rules \"\u003e grantRules \u003c/span\u003eblocks for a rule set name are present in one \u003cspan pulumi-lang-nodejs=\"`databricks.AccessControlRuleSet`\" pulumi-lang-dotnet=\"`databricks.AccessControlRuleSet`\" pulumi-lang-go=\"`AccessControlRuleSet`\" pulumi-lang-python=\"`AccessControlRuleSet`\" pulumi-lang-yaml=\"`databricks.AccessControlRuleSet`\" pulumi-lang-java=\"`databricks.AccessControlRuleSet`\" pulumi-lang-hcl=\"`databricks_access_control_rule_set`\"\u003e`databricks.AccessControlRuleSet`\u003c/span\u003e resource block. Otherwise, after applying changes, users might lose their role assignment even if that was not intended.\n" }, "name": { "type": "string", "description": "Unique identifier of a rule set. The name determines the resource to which the rule set applies. **Changing the name recreates the resource!**. Currently, only default rule sets are supported. The following rule set formats are supported:\n* `accounts/{account_id}/ruleSets/default` - account-level access control.\n* `accounts/{account_id}/servicePrincipals/{service_principal_application_id}/ruleSets/default` - access control for a specific service principal.\n* `accounts/{account_id}/groups/{group_id}/ruleSets/default` - access control for a specific group.\n* `accounts/{account_id}/budgetPolicies/{budget_policy_id}/ruleSets/default` - access control for a specific budget policy.\n* `accounts/{account_id}/tagPolicies/{tag_policy_id}/ruleSets/default` - access control for a specific tag policy.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/AccessControlRuleSetProviderConfig:AccessControlRuleSetProviderConfig" } }, "type": "object" } }, "databricks:index/accountFederationPolicy:AccountFederationPolicy": { "description": "[![GA](https://img.shields.io/badge/Release_Stage-GA-green)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/account/accountfederationpolicy)\n\nAccount federation policies allow users and service principals in your Databricks account to securely access Databricks APIs using tokens from your trusted identity providers (IdPs).\n\nToken federation policies eliminate the need to manage Databricks secrets, and allow you to centralize management of token issuance policies in your IdP. Databricks token federation policies are typically used in combination with [SCIM](https://www.terraform.io/admin/users-groups/scim/index.html), so users in your IdP are synchronized into your Databricks account.\n\nAn account federation policy specifies:\n* which IdP, or issuer, your Databricks account should accept tokens from\n* how to determine which Databricks user, or subject, a token is issued for\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.AccountFederationPolicy(\"this\", {\n policyId: \"my-policy\",\n oidcPolicy: {\n issuer: \"https://myidp.example.com\",\n subjectClaim: \"sub\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.AccountFederationPolicy(\"this\",\n policy_id=\"my-policy\",\n oidc_policy={\n \"issuer\": \"https://myidp.example.com\",\n \"subject_claim\": \"sub\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.AccountFederationPolicy(\"this\", new()\n {\n PolicyId = \"my-policy\",\n OidcPolicy = new Databricks.Inputs.AccountFederationPolicyOidcPolicyArgs\n {\n Issuer = \"https://myidp.example.com\",\n SubjectClaim = \"sub\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAccountFederationPolicy(ctx, \"this\", \u0026databricks.AccountFederationPolicyArgs{\n\t\t\tPolicyId: pulumi.String(\"my-policy\"),\n\t\t\tOidcPolicy: \u0026databricks.AccountFederationPolicyOidcPolicyArgs{\n\t\t\t\tIssuer: pulumi.String(\"https://myidp.example.com\"),\n\t\t\t\tSubjectClaim: pulumi.String(\"sub\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_accountfederationpolicy\" \"this\" {\n policy_id = \"my-policy\"\n oidc_policy = {\n issuer = \"https://myidp.example.com\"\n subject_claim = \"sub\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AccountFederationPolicy;\nimport com.pulumi.databricks.AccountFederationPolicyArgs;\nimport com.pulumi.databricks.inputs.AccountFederationPolicyOidcPolicyArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new AccountFederationPolicy(\"this\", AccountFederationPolicyArgs.builder()\n .policyId(\"my-policy\")\n .oidcPolicy(AccountFederationPolicyOidcPolicyArgs.builder()\n .issuer(\"https://myidp.example.com\")\n .subjectClaim(\"sub\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:AccountFederationPolicy\n properties:\n policyId: my-policy\n oidcPolicy:\n issuer: https://myidp.example.com\n subjectClaim: sub\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "createTime": { "type": "string", "description": "(string) - Creation time of the federation policy\n" }, "description": { "type": "string", "description": "Description of the federation policy\n" }, "name": { "type": "string", "description": "(string) - Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL\n" }, "oidcPolicy": { "$ref": "#/types/databricks:index/AccountFederationPolicyOidcPolicy:AccountFederationPolicyOidcPolicy" }, "policyId": { "type": "string", "description": "(string) - The ID of the federation policy. Output only\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies\n" }, "uid": { "type": "string", "description": "(string) - Unique, immutable id of the federation policy\n" }, "updateTime": { "type": "string", "description": "(string) - Last update time of the federation policy\n" } }, "required": [ "createTime", "name", "policyId", "servicePrincipalId", "uid", "updateTime" ], "inputProperties": { "description": { "type": "string", "description": "Description of the federation policy\n" }, "oidcPolicy": { "$ref": "#/types/databricks:index/AccountFederationPolicyOidcPolicy:AccountFederationPolicyOidcPolicy" }, "policyId": { "type": "string", "description": "(string) - The ID of the federation policy. Output only\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AccountFederationPolicy resources.\n", "properties": { "createTime": { "type": "string", "description": "(string) - Creation time of the federation policy\n" }, "description": { "type": "string", "description": "Description of the federation policy\n" }, "name": { "type": "string", "description": "(string) - Resource name for the federation policy. Example values include\n`accounts/\u003caccount-id\u003e/federationPolicies/my-federation-policy` for Account Federation Policies, and\n`accounts/\u003caccount-id\u003e/servicePrincipals/\u003cservice-principal-id\u003e/federationPolicies/my-federation-policy`\nfor Service Principal Federation Policies. Typically an output parameter, which does not need to be\nspecified in create or update requests. If specified in a request, must match the value in the\nrequest URL\n" }, "oidcPolicy": { "$ref": "#/types/databricks:index/AccountFederationPolicyOidcPolicy:AccountFederationPolicyOidcPolicy" }, "policyId": { "type": "string", "description": "(string) - The ID of the federation policy. Output only\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID that this federation policy applies to. Output only. Only set for service principal federation policies\n" }, "uid": { "type": "string", "description": "(string) - Unique, immutable id of the federation policy\n" }, "updateTime": { "type": "string", "description": "(string) - Last update time of the federation policy\n" } }, "type": "object" } }, "databricks:index/accountNetworkPolicy:AccountNetworkPolicy": { "description": "[![GA](https://img.shields.io/badge/Release_Stage-GA-green)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/account/networkpolicies)\n\nNetwork policies control which network destinations can be accessed from the Databricks environment. \n\nEach Databricks account includes a default policy named `default-policy`. This policy is:\n\n- Associated with any workspace lacking an explicit network policy assignment\n- Automatically associated with each newly created workspace\n- Reserved and cannot be deleted, but can be updated to customize the default network access rules for your account\n\nThe `default-policy` provides a baseline security configuration that ensures all workspaces have network access controls in place.\n\n\u003e **Note** This resource can only be used with an account-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst exampleNetworkPolicy = new databricks.AccountNetworkPolicy(\"example_network_policy\", {\n networkPolicyId: \"example-network-policy\",\n egress: {\n networkAccess: {\n restrictionMode: \"RESTRICTED_ACCESS\",\n allowedInternetDestinations: [{\n destination: \"example.com\",\n internetDestinationType: \"DNS_NAME\",\n }],\n allowedStorageDestinations: [{\n bucketName: \"example-aws-cloud-storage\",\n region: \"us-west-1\",\n storageDestinationType: \"AWS_S3\",\n }],\n policyEnforcement: {\n enforcementMode: \"ENFORCED\",\n },\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexample_network_policy = databricks.AccountNetworkPolicy(\"example_network_policy\",\n network_policy_id=\"example-network-policy\",\n egress={\n \"network_access\": {\n \"restriction_mode\": \"RESTRICTED_ACCESS\",\n \"allowed_internet_destinations\": [{\n \"destination\": \"example.com\",\n \"internet_destination_type\": \"DNS_NAME\",\n }],\n \"allowed_storage_destinations\": [{\n \"bucket_name\": \"example-aws-cloud-storage\",\n \"region\": \"us-west-1\",\n \"storage_destination_type\": \"AWS_S3\",\n }],\n \"policy_enforcement\": {\n \"enforcement_mode\": \"ENFORCED\",\n },\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var exampleNetworkPolicy = new Databricks.AccountNetworkPolicy(\"example_network_policy\", new()\n {\n NetworkPolicyId = \"example-network-policy\",\n Egress = new Databricks.Inputs.AccountNetworkPolicyEgressArgs\n {\n NetworkAccess = new Databricks.Inputs.AccountNetworkPolicyEgressNetworkAccessArgs\n {\n RestrictionMode = \"RESTRICTED_ACCESS\",\n AllowedInternetDestinations = new[]\n {\n new Databricks.Inputs.AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestinationArgs\n {\n Destination = \"example.com\",\n InternetDestinationType = \"DNS_NAME\",\n },\n },\n AllowedStorageDestinations = new[]\n {\n new Databricks.Inputs.AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestinationArgs\n {\n BucketName = \"example-aws-cloud-storage\",\n Region = \"us-west-1\",\n StorageDestinationType = \"AWS_S3\",\n },\n },\n PolicyEnforcement = new Databricks.Inputs.AccountNetworkPolicyEgressNetworkAccessPolicyEnforcementArgs\n {\n EnforcementMode = \"ENFORCED\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAccountNetworkPolicy(ctx, \"example_network_policy\", \u0026databricks.AccountNetworkPolicyArgs{\n\t\t\tNetworkPolicyId: pulumi.String(\"example-network-policy\"),\n\t\t\tEgress: \u0026databricks.AccountNetworkPolicyEgressArgs{\n\t\t\t\tNetworkAccess: \u0026databricks.AccountNetworkPolicyEgressNetworkAccessArgs{\n\t\t\t\t\tRestrictionMode: pulumi.String(\"RESTRICTED_ACCESS\"),\n\t\t\t\t\tAllowedInternetDestinations: databricks.AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestinationArray{\n\t\t\t\t\t\t\u0026databricks.AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestinationArgs{\n\t\t\t\t\t\t\tDestination: pulumi.String(\"example.com\"),\n\t\t\t\t\t\t\tInternetDestinationType: pulumi.String(\"DNS_NAME\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tAllowedStorageDestinations: databricks.AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestinationArray{\n\t\t\t\t\t\t\u0026databricks.AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestinationArgs{\n\t\t\t\t\t\t\tBucketName: pulumi.String(\"example-aws-cloud-storage\"),\n\t\t\t\t\t\t\tRegion: pulumi.String(\"us-west-1\"),\n\t\t\t\t\t\t\tStorageDestinationType: pulumi.String(\"AWS_S3\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tPolicyEnforcement: \u0026databricks.AccountNetworkPolicyEgressNetworkAccessPolicyEnforcementArgs{\n\t\t\t\t\t\tEnforcementMode: pulumi.String(\"ENFORCED\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_accountnetworkpolicy\" \"example_network_policy\" {\n network_policy_id = \"example-network-policy\"\n egress = {\n network_access = {\n restriction_mode = \"RESTRICTED_ACCESS\"\n allowed_internet_destinations = [{\n \"destination\" = \"example.com\"\n \"internetDestinationType\" = \"DNS_NAME\"\n }]\n allowed_storage_destinations = [{\n \"bucketName\" = \"example-aws-cloud-storage\"\n \"region\" = \"us-west-1\"\n \"storageDestinationType\" = \"AWS_S3\"\n }]\n policy_enforcement = {\n enforcement_mode = \"ENFORCED\"\n }\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AccountNetworkPolicy;\nimport com.pulumi.databricks.AccountNetworkPolicyArgs;\nimport com.pulumi.databricks.inputs.AccountNetworkPolicyEgressArgs;\nimport com.pulumi.databricks.inputs.AccountNetworkPolicyEgressNetworkAccessArgs;\nimport com.pulumi.databricks.inputs.AccountNetworkPolicyEgressNetworkAccessPolicyEnforcementArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var exampleNetworkPolicy = new AccountNetworkPolicy(\"exampleNetworkPolicy\", AccountNetworkPolicyArgs.builder()\n .networkPolicyId(\"example-network-policy\")\n .egress(AccountNetworkPolicyEgressArgs.builder()\n .networkAccess(AccountNetworkPolicyEgressNetworkAccessArgs.builder()\n .restrictionMode(\"RESTRICTED_ACCESS\")\n .allowedInternetDestinations(AccountNetworkPolicyEgressNetworkAccessAllowedInternetDestinationArgs.builder()\n .destination(\"example.com\")\n .internetDestinationType(\"DNS_NAME\")\n .build())\n .allowedStorageDestinations(AccountNetworkPolicyEgressNetworkAccessAllowedStorageDestinationArgs.builder()\n .bucketName(\"example-aws-cloud-storage\")\n .region(\"us-west-1\")\n .storageDestinationType(\"AWS_S3\")\n .build())\n .policyEnforcement(AccountNetworkPolicyEgressNetworkAccessPolicyEnforcementArgs.builder()\n .enforcementMode(\"ENFORCED\")\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n exampleNetworkPolicy:\n type: databricks:AccountNetworkPolicy\n name: example_network_policy\n properties:\n networkPolicyId: example-network-policy\n egress:\n networkAccess:\n restrictionMode: RESTRICTED_ACCESS\n allowedInternetDestinations:\n - destination: example.com\n internetDestinationType: DNS_NAME\n allowedStorageDestinations:\n - bucketName: example-aws-cloud-storage\n region: us-west-1\n storageDestinationType: AWS_S3\n policyEnforcement:\n enforcementMode: ENFORCED\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "accountId": { "type": "string", "description": "(string) - The associated account ID for this Network Policy object\n" }, "egress": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgress:AccountNetworkPolicyEgress", "description": "The network policies applying for egress traffic\n" }, "ingress": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngress:AccountNetworkPolicyIngress", "description": "The network policies applying for ingress traffic\n" }, "ingressDryRun": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRun:AccountNetworkPolicyIngressDryRun", "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests\n" }, "networkPolicyId": { "type": "string", "description": "The unique identifier for the network policy\n" } }, "required": [ "accountId" ], "inputProperties": { "accountId": { "type": "string", "description": "(string) - The associated account ID for this Network Policy object\n" }, "egress": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgress:AccountNetworkPolicyEgress", "description": "The network policies applying for egress traffic\n" }, "ingress": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngress:AccountNetworkPolicyIngress", "description": "The network policies applying for ingress traffic\n" }, "ingressDryRun": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRun:AccountNetworkPolicyIngressDryRun", "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests\n" }, "networkPolicyId": { "type": "string", "description": "The unique identifier for the network policy\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AccountNetworkPolicy resources.\n", "properties": { "accountId": { "type": "string", "description": "(string) - The associated account ID for this Network Policy object\n" }, "egress": { "$ref": "#/types/databricks:index/AccountNetworkPolicyEgress:AccountNetworkPolicyEgress", "description": "The network policies applying for egress traffic\n" }, "ingress": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngress:AccountNetworkPolicyIngress", "description": "The network policies applying for ingress traffic\n" }, "ingressDryRun": { "$ref": "#/types/databricks:index/AccountNetworkPolicyIngressDryRun:AccountNetworkPolicyIngressDryRun", "description": "The ingress policy for dry run mode. Dry run will always run even if the request\nis allowed by the ingress policy. When this field is set, the policy will be evaluated\nand emit logs only without blocking requests\n" }, "networkPolicyId": { "type": "string", "description": "The unique identifier for the network policy\n" } }, "type": "object" } }, "databricks:index/accountSettingUserPreferenceV2:AccountSettingUserPreferenceV2": { "description": "[![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/account/settingsv2)\n\nUser preference is a configurable value that determines how a feature or behavior works for a specific user within the Databricks platform.\n\nSee user settings-metadata API for list of user preferences that can be modified using this resource.\n\n\n## Example Usage\n\nSetting an account user preference:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst themeSetting = new databricks.index.AccountUserSettingV2(\"theme_setting\", {\n userId: \"\u003cuser-id\u003e\",\n name: \"enableDarkMode\",\n stringVal: {\n value: \"dark\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ntheme_setting = databricks.AccountUserSettingV2(\"theme_setting\",\n user_id=\u003cuser-id\u003e,\n name=enableDarkMode,\n string_val={\n value: dark,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var themeSetting = new Databricks.AccountUserSettingV2(\"theme_setting\", new()\n {\n UserId = \"\u003cuser-id\u003e\",\n Name = \"enableDarkMode\",\n StringVal = \n {\n { \"value\", \"dark\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAccountUserSettingV2(ctx, \"theme_setting\", \u0026databricks.AccountUserSettingV2Args{\n\t\t\tUserId: \"\u003cuser-id\u003e\",\n\t\t\tName: \"enableDarkMode\",\n\t\t\tStringVal: map[string]interface{}{\n\t\t\t\t\"value\": \"dark\",\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_accountusersettingv2\" \"theme_setting\" {\n user_id = \"\u003cuser-id\u003e\"\n name = \"enableDarkMode\"\n string_val = {\n \"value\" = \"dark\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AccountUserSettingV2;\nimport com.pulumi.databricks.AccountUserSettingV2Args;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var themeSetting = new AccountUserSettingV2(\"themeSetting\", AccountUserSettingV2Args.builder()\n .userId(\"\u003cuser-id\u003e\")\n .name(\"enableDarkMode\")\n .stringVal(Map.of(\"value\", \"dark\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n themeSetting:\n type: databricks:AccountUserSettingV2\n name: theme_setting\n properties:\n userId: \u003cuser-id\u003e\n name: enableDarkMode\n stringVal:\n value: dark\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nSetting a boolean user preference:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst enableLineNumbers = new databricks.index.AccountUserSettingV2(\"enable_line_numbers\", {\n userId: \"\u003cuser-id\u003e\",\n name: \"enableLineNumbers\",\n booleanVal: {\n value: true,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nenable_line_numbers = databricks.AccountUserSettingV2(\"enable_line_numbers\",\n user_id=\u003cuser-id\u003e,\n name=enableLineNumbers,\n boolean_val={\n value: True,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var enableLineNumbers = new Databricks.AccountUserSettingV2(\"enable_line_numbers\", new()\n {\n UserId = \"\u003cuser-id\u003e\",\n Name = \"enableLineNumbers\",\n BooleanVal = \n {\n { \"value\", true },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAccountUserSettingV2(ctx, \"enable_line_numbers\", \u0026databricks.AccountUserSettingV2Args{\n\t\t\tUserId: \"\u003cuser-id\u003e\",\n\t\t\tName: \"enableLineNumbers\",\n\t\t\tBooleanVal: map[string]interface{}{\n\t\t\t\t\"value\": true,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_accountusersettingv2\" \"enable_line_numbers\" {\n user_id = \"\u003cuser-id\u003e\"\n name = \"enableLineNumbers\"\n boolean_val = {\n \"value\" = true\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AccountUserSettingV2;\nimport com.pulumi.databricks.AccountUserSettingV2Args;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var enableLineNumbers = new AccountUserSettingV2(\"enableLineNumbers\", AccountUserSettingV2Args.builder()\n .userId(\"\u003cuser-id\u003e\")\n .name(\"enableLineNumbers\")\n .booleanVal(Map.of(\"value\", true))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n enableLineNumbers:\n type: databricks:AccountUserSettingV2\n name: enable_line_numbers\n properties:\n userId: \u003cuser-id\u003e\n name: enableLineNumbers\n booleanVal:\n value: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "booleanVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2BooleanVal:AccountSettingUserPreferenceV2BooleanVal" }, "effectiveBooleanVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2EffectiveBooleanVal:AccountSettingUserPreferenceV2EffectiveBooleanVal", "description": "(BooleanMessage)\n" }, "effectiveStringVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2EffectiveStringVal:AccountSettingUserPreferenceV2EffectiveStringVal", "description": "(StringMessage)\n" }, "name": { "type": "string", "description": "Name of the setting\n" }, "stringVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2StringVal:AccountSettingUserPreferenceV2StringVal" }, "userId": { "type": "string", "description": "User ID of the user\n" } }, "required": [ "effectiveBooleanVal", "effectiveStringVal", "name" ], "inputProperties": { "booleanVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2BooleanVal:AccountSettingUserPreferenceV2BooleanVal" }, "name": { "type": "string", "description": "Name of the setting\n" }, "stringVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2StringVal:AccountSettingUserPreferenceV2StringVal" }, "userId": { "type": "string", "description": "User ID of the user\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AccountSettingUserPreferenceV2 resources.\n", "properties": { "booleanVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2BooleanVal:AccountSettingUserPreferenceV2BooleanVal" }, "effectiveBooleanVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2EffectiveBooleanVal:AccountSettingUserPreferenceV2EffectiveBooleanVal", "description": "(BooleanMessage)\n" }, "effectiveStringVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2EffectiveStringVal:AccountSettingUserPreferenceV2EffectiveStringVal", "description": "(StringMessage)\n" }, "name": { "type": "string", "description": "Name of the setting\n" }, "stringVal": { "$ref": "#/types/databricks:index/AccountSettingUserPreferenceV2StringVal:AccountSettingUserPreferenceV2StringVal" }, "userId": { "type": "string", "description": "User ID of the user\n" } }, "type": "object" } }, "databricks:index/accountSettingV2:AccountSettingV2": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/account/settingsv2)\n\nSetting is a configurable value or control that determines how a feature or behavior works within the databricks platform.\n\n[//]: # (todo: add public link to metadata api after production doc link available)\nSee settings-metadata api for list of settings that can be modified using this resource. \n\n## Example Usage\n\nGetting an account level setting:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.AccountSettingV2(\"this\", {\n name: \"llm_proxy_partner_powered\",\n booleanVal: {\n value: false,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.AccountSettingV2(\"this\",\n name=\"llm_proxy_partner_powered\",\n boolean_val={\n \"value\": False,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.AccountSettingV2(\"this\", new()\n {\n Name = \"llm_proxy_partner_powered\",\n BooleanVal = new Databricks.Inputs.AccountSettingV2BooleanValArgs\n {\n Value = false,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAccountSettingV2(ctx, \"this\", \u0026databricks.AccountSettingV2Args{\n\t\t\tName: pulumi.String(\"llm_proxy_partner_powered\"),\n\t\t\tBooleanVal: \u0026databricks.AccountSettingV2BooleanValArgs{\n\t\t\t\tValue: pulumi.Bool(false),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_accountsettingv2\" \"this\" {\n name = \"llm_proxy_partner_powered\"\n boolean_val = {\n value = false\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AccountSettingV2;\nimport com.pulumi.databricks.AccountSettingV2Args;\nimport com.pulumi.databricks.inputs.AccountSettingV2BooleanValArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new AccountSettingV2(\"this\", AccountSettingV2Args.builder()\n .name(\"llm_proxy_partner_powered\")\n .booleanVal(AccountSettingV2BooleanValArgs.builder()\n .value(false)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:AccountSettingV2\n properties:\n name: llm_proxy_partner_powered\n booleanVal:\n value: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "aibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AccountSettingV2AibiDashboardEmbeddingAccessPolicy:AccountSettingV2AibiDashboardEmbeddingAccessPolicy", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" aibi_dashboard_embedding_access_policy \"\u003e aibiDashboardEmbeddingAccessPolicy \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" EffectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" effective_aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" effective_aibi_dashboard_embedding_access_policy \"\u003e effectiveAibiDashboardEmbeddingAccessPolicy \u003c/span\u003efor final setting value\n" }, "aibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AccountSettingV2AibiDashboardEmbeddingApprovedDomains:AccountSettingV2AibiDashboardEmbeddingApprovedDomains", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" aibi_dashboard_embedding_approved_domains \"\u003e aibiDashboardEmbeddingApprovedDomains \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" EffectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" effective_aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" effective_aibi_dashboard_embedding_approved_domains \"\u003e effectiveAibiDashboardEmbeddingApprovedDomains \u003c/span\u003efor final setting value\n" }, "allowedAppsUserApiScopes": { "$ref": "#/types/databricks:index/AccountSettingV2AllowedAppsUserApiScopes:AccountSettingV2AllowedAppsUserApiScopes", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" allowedAppsUserApiScopes \" pulumi-lang-dotnet=\" AllowedAppsUserApiScopes \" pulumi-lang-go=\" allowedAppsUserApiScopes \" pulumi-lang-python=\" allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" allowedAppsUserApiScopes \" pulumi-lang-java=\" allowedAppsUserApiScopes \" pulumi-lang-hcl=\" allowed_apps_user_api_scopes \"\u003e allowedAppsUserApiScopes \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-dotnet=\" EffectiveAllowedAppsUserApiScopes \" pulumi-lang-go=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-python=\" effective_allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-java=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-hcl=\" effective_allowed_apps_user_api_scopes \"\u003e effectiveAllowedAppsUserApiScopes \u003c/span\u003efor final setting value\n" }, "automaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspace:AccountSettingV2AutomaticClusterUpdateWorkspace", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" automaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" AutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" automaticClusterUpdateWorkspace \" pulumi-lang-python=\" automatic_cluster_update_workspace \" pulumi-lang-yaml=\" automaticClusterUpdateWorkspace \" pulumi-lang-java=\" automaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" automatic_cluster_update_workspace \"\u003e automaticClusterUpdateWorkspace \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" EffectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-python=\" effective_automatic_cluster_update_workspace \" pulumi-lang-yaml=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-java=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" effective_automatic_cluster_update_workspace \"\u003e effectiveAutomaticClusterUpdateWorkspace \u003c/span\u003efor final setting value\n" }, "booleanVal": { "$ref": "#/types/databricks:index/AccountSettingV2BooleanVal:AccountSettingV2BooleanVal", "description": "Setting value for boolean type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveBooleanVal \" pulumi-lang-dotnet=\" EffectiveBooleanVal \" pulumi-lang-go=\" effectiveBooleanVal \" pulumi-lang-python=\" effective_boolean_val \" pulumi-lang-yaml=\" effectiveBooleanVal \" pulumi-lang-java=\" effectiveBooleanVal \" pulumi-lang-hcl=\" effective_boolean_val \"\u003e effectiveBooleanVal \u003c/span\u003efor final setting value\n" }, "collaborationPlatformConnectivity": { "$ref": "#/types/databricks:index/AccountSettingV2CollaborationPlatformConnectivity:AccountSettingV2CollaborationPlatformConnectivity", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" collaborationPlatformConnectivity \" pulumi-lang-dotnet=\" CollaborationPlatformConnectivity \" pulumi-lang-go=\" collaborationPlatformConnectivity \" pulumi-lang-python=\" collaboration_platform_connectivity \" pulumi-lang-yaml=\" collaborationPlatformConnectivity \" pulumi-lang-java=\" collaborationPlatformConnectivity \" pulumi-lang-hcl=\" collaboration_platform_connectivity \"\u003e collaborationPlatformConnectivity \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-dotnet=\" EffectiveCollaborationPlatformConnectivity \" pulumi-lang-go=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-python=\" effective_collaboration_platform_connectivity \" pulumi-lang-yaml=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-java=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-hcl=\" effective_collaboration_platform_connectivity \"\u003e effectiveCollaborationPlatformConnectivity \u003c/span\u003efor final setting value\n" }, "effectiveAibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" aibi_dashboard_embedding_access_policy \"\u003e aibiDashboardEmbeddingAccessPolicy \u003c/span\u003esetting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy\n" }, "effectiveAibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" aibi_dashboard_embedding_approved_domains \"\u003e aibiDashboardEmbeddingApprovedDomains \u003c/span\u003esetting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains\n" }, "effectiveAllowedAppsUserApiScopes": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAllowedAppsUserApiScopes:AccountSettingV2EffectiveAllowedAppsUserApiScopes", "description": "(AllowedAppsUserApiScopesMessage) - Effective setting value for\u003cspan pulumi-lang-nodejs=\" allowedAppsUserApiScopes \" pulumi-lang-dotnet=\" AllowedAppsUserApiScopes \" pulumi-lang-go=\" allowedAppsUserApiScopes \" pulumi-lang-python=\" allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" allowedAppsUserApiScopes \" pulumi-lang-java=\" allowedAppsUserApiScopes \" pulumi-lang-hcl=\" allowed_apps_user_api_scopes \"\u003e allowedAppsUserApiScopes \u003c/span\u003esetting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes\n" }, "effectiveAutomaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" automaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" AutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" automaticClusterUpdateWorkspace \" pulumi-lang-python=\" automatic_cluster_update_workspace \" pulumi-lang-yaml=\" automaticClusterUpdateWorkspace \" pulumi-lang-java=\" automaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" automatic_cluster_update_workspace \"\u003e automaticClusterUpdateWorkspace \u003c/span\u003esetting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace\n" }, "effectiveBooleanVal": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveBooleanVal:AccountSettingV2EffectiveBooleanVal", "description": "(BooleanMessage) - Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val\n" }, "effectiveCollaborationPlatformConnectivity": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveCollaborationPlatformConnectivity:AccountSettingV2EffectiveCollaborationPlatformConnectivity", "description": "(CollaborationPlatformConnectivityMessage) - Effective setting value for\u003cspan pulumi-lang-nodejs=\" collaborationPlatformConnectivity \" pulumi-lang-dotnet=\" CollaborationPlatformConnectivity \" pulumi-lang-go=\" collaborationPlatformConnectivity \" pulumi-lang-python=\" collaboration_platform_connectivity \" pulumi-lang-yaml=\" collaborationPlatformConnectivity \" pulumi-lang-java=\" collaborationPlatformConnectivity \" pulumi-lang-hcl=\" collaboration_platform_connectivity \"\u003e collaborationPlatformConnectivity \u003c/span\u003esetting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity\n" }, "effectiveIntegerVal": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveIntegerVal:AccountSettingV2EffectiveIntegerVal", "description": "(IntegerMessage) - Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val\n" }, "effectiveOperationalEmailCustomRecipient": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveOperationalEmailCustomRecipient:AccountSettingV2EffectiveOperationalEmailCustomRecipient", "description": "(OperationalEmailCustomRecipientMessage) - Effective setting value for\u003cspan pulumi-lang-nodejs=\" operationalEmailCustomRecipient \" pulumi-lang-dotnet=\" OperationalEmailCustomRecipient \" pulumi-lang-go=\" operationalEmailCustomRecipient \" pulumi-lang-python=\" operational_email_custom_recipient \" pulumi-lang-yaml=\" operationalEmailCustomRecipient \" pulumi-lang-java=\" operationalEmailCustomRecipient \" pulumi-lang-hcl=\" operational_email_custom_recipient \"\u003e operationalEmailCustomRecipient \u003c/span\u003esetting. This is the final effective value of setting. To set a value use operational_email_custom_recipient\n" }, "effectivePersonalCompute": { "$ref": "#/types/databricks:index/AccountSettingV2EffectivePersonalCompute:AccountSettingV2EffectivePersonalCompute", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" personalCompute \" pulumi-lang-dotnet=\" PersonalCompute \" pulumi-lang-go=\" personalCompute \" pulumi-lang-python=\" personal_compute \" pulumi-lang-yaml=\" personalCompute \" pulumi-lang-java=\" personalCompute \" pulumi-lang-hcl=\" personal_compute \"\u003e personalCompute \u003c/span\u003esetting. This is the final effective value of setting. To set a value use personal_compute\n" }, "effectiveRestrictWorkspaceAdmins": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveRestrictWorkspaceAdmins:AccountSettingV2EffectiveRestrictWorkspaceAdmins", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" restrictWorkspaceAdmins \" pulumi-lang-dotnet=\" RestrictWorkspaceAdmins \" pulumi-lang-go=\" restrictWorkspaceAdmins \" pulumi-lang-python=\" restrict_workspace_admins \" pulumi-lang-yaml=\" restrictWorkspaceAdmins \" pulumi-lang-java=\" restrictWorkspaceAdmins \" pulumi-lang-hcl=\" restrict_workspace_admins \"\u003e restrictWorkspaceAdmins \u003c/span\u003esetting. This is the final effective value of setting. To set a value use restrict_workspace_admins\n" }, "effectiveStringVal": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveStringVal:AccountSettingV2EffectiveStringVal", "description": "(StringMessage) - Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val\n" }, "integerVal": { "$ref": "#/types/databricks:index/AccountSettingV2IntegerVal:AccountSettingV2IntegerVal", "description": "Setting value for integer type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveIntegerVal \" pulumi-lang-dotnet=\" EffectiveIntegerVal \" pulumi-lang-go=\" effectiveIntegerVal \" pulumi-lang-python=\" effective_integer_val \" pulumi-lang-yaml=\" effectiveIntegerVal \" pulumi-lang-java=\" effectiveIntegerVal \" pulumi-lang-hcl=\" effective_integer_val \"\u003e effectiveIntegerVal \u003c/span\u003efor final setting value\n" }, "name": { "type": "string", "description": "Name of the setting\n" }, "operationalEmailCustomRecipient": { "$ref": "#/types/databricks:index/AccountSettingV2OperationalEmailCustomRecipient:AccountSettingV2OperationalEmailCustomRecipient", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" operationalEmailCustomRecipient \" pulumi-lang-dotnet=\" OperationalEmailCustomRecipient \" pulumi-lang-go=\" operationalEmailCustomRecipient \" pulumi-lang-python=\" operational_email_custom_recipient \" pulumi-lang-yaml=\" operationalEmailCustomRecipient \" pulumi-lang-java=\" operationalEmailCustomRecipient \" pulumi-lang-hcl=\" operational_email_custom_recipient \"\u003e operationalEmailCustomRecipient \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-dotnet=\" EffectiveOperationalEmailCustomRecipient \" pulumi-lang-go=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-python=\" effective_operational_email_custom_recipient \" pulumi-lang-yaml=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-java=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-hcl=\" effective_operational_email_custom_recipient \"\u003e effectiveOperationalEmailCustomRecipient \u003c/span\u003efor final setting value\n" }, "personalCompute": { "$ref": "#/types/databricks:index/AccountSettingV2PersonalCompute:AccountSettingV2PersonalCompute", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" personalCompute \" pulumi-lang-dotnet=\" PersonalCompute \" pulumi-lang-go=\" personalCompute \" pulumi-lang-python=\" personal_compute \" pulumi-lang-yaml=\" personalCompute \" pulumi-lang-java=\" personalCompute \" pulumi-lang-hcl=\" personal_compute \"\u003e personalCompute \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectivePersonalCompute \" pulumi-lang-dotnet=\" EffectivePersonalCompute \" pulumi-lang-go=\" effectivePersonalCompute \" pulumi-lang-python=\" effective_personal_compute \" pulumi-lang-yaml=\" effectivePersonalCompute \" pulumi-lang-java=\" effectivePersonalCompute \" pulumi-lang-hcl=\" effective_personal_compute \"\u003e effectivePersonalCompute \u003c/span\u003efor final setting value\n" }, "restrictWorkspaceAdmins": { "$ref": "#/types/databricks:index/AccountSettingV2RestrictWorkspaceAdmins:AccountSettingV2RestrictWorkspaceAdmins", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" restrictWorkspaceAdmins \" pulumi-lang-dotnet=\" RestrictWorkspaceAdmins \" pulumi-lang-go=\" restrictWorkspaceAdmins \" pulumi-lang-python=\" restrict_workspace_admins \" pulumi-lang-yaml=\" restrictWorkspaceAdmins \" pulumi-lang-java=\" restrictWorkspaceAdmins \" pulumi-lang-hcl=\" restrict_workspace_admins \"\u003e restrictWorkspaceAdmins \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-dotnet=\" EffectiveRestrictWorkspaceAdmins \" pulumi-lang-go=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-python=\" effective_restrict_workspace_admins \" pulumi-lang-yaml=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-java=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-hcl=\" effective_restrict_workspace_admins \"\u003e effectiveRestrictWorkspaceAdmins \u003c/span\u003efor final setting value\n" }, "stringVal": { "$ref": "#/types/databricks:index/AccountSettingV2StringVal:AccountSettingV2StringVal", "description": "Setting value for string type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveStringVal \" pulumi-lang-dotnet=\" EffectiveStringVal \" pulumi-lang-go=\" effectiveStringVal \" pulumi-lang-python=\" effective_string_val \" pulumi-lang-yaml=\" effectiveStringVal \" pulumi-lang-java=\" effectiveStringVal \" pulumi-lang-hcl=\" effective_string_val \"\u003e effectiveStringVal \u003c/span\u003efor final setting value\n" } }, "required": [ "effectiveAllowedAppsUserApiScopes", "effectiveBooleanVal", "effectiveCollaborationPlatformConnectivity", "effectiveIntegerVal", "effectiveOperationalEmailCustomRecipient", "effectiveStringVal", "name" ], "inputProperties": { "aibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AccountSettingV2AibiDashboardEmbeddingAccessPolicy:AccountSettingV2AibiDashboardEmbeddingAccessPolicy", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" aibi_dashboard_embedding_access_policy \"\u003e aibiDashboardEmbeddingAccessPolicy \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" EffectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" effective_aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" effective_aibi_dashboard_embedding_access_policy \"\u003e effectiveAibiDashboardEmbeddingAccessPolicy \u003c/span\u003efor final setting value\n" }, "aibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AccountSettingV2AibiDashboardEmbeddingApprovedDomains:AccountSettingV2AibiDashboardEmbeddingApprovedDomains", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" aibi_dashboard_embedding_approved_domains \"\u003e aibiDashboardEmbeddingApprovedDomains \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" EffectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" effective_aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" effective_aibi_dashboard_embedding_approved_domains \"\u003e effectiveAibiDashboardEmbeddingApprovedDomains \u003c/span\u003efor final setting value\n" }, "allowedAppsUserApiScopes": { "$ref": "#/types/databricks:index/AccountSettingV2AllowedAppsUserApiScopes:AccountSettingV2AllowedAppsUserApiScopes", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" allowedAppsUserApiScopes \" pulumi-lang-dotnet=\" AllowedAppsUserApiScopes \" pulumi-lang-go=\" allowedAppsUserApiScopes \" pulumi-lang-python=\" allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" allowedAppsUserApiScopes \" pulumi-lang-java=\" allowedAppsUserApiScopes \" pulumi-lang-hcl=\" allowed_apps_user_api_scopes \"\u003e allowedAppsUserApiScopes \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-dotnet=\" EffectiveAllowedAppsUserApiScopes \" pulumi-lang-go=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-python=\" effective_allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-java=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-hcl=\" effective_allowed_apps_user_api_scopes \"\u003e effectiveAllowedAppsUserApiScopes \u003c/span\u003efor final setting value\n" }, "automaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspace:AccountSettingV2AutomaticClusterUpdateWorkspace", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" automaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" AutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" automaticClusterUpdateWorkspace \" pulumi-lang-python=\" automatic_cluster_update_workspace \" pulumi-lang-yaml=\" automaticClusterUpdateWorkspace \" pulumi-lang-java=\" automaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" automatic_cluster_update_workspace \"\u003e automaticClusterUpdateWorkspace \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" EffectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-python=\" effective_automatic_cluster_update_workspace \" pulumi-lang-yaml=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-java=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" effective_automatic_cluster_update_workspace \"\u003e effectiveAutomaticClusterUpdateWorkspace \u003c/span\u003efor final setting value\n" }, "booleanVal": { "$ref": "#/types/databricks:index/AccountSettingV2BooleanVal:AccountSettingV2BooleanVal", "description": "Setting value for boolean type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveBooleanVal \" pulumi-lang-dotnet=\" EffectiveBooleanVal \" pulumi-lang-go=\" effectiveBooleanVal \" pulumi-lang-python=\" effective_boolean_val \" pulumi-lang-yaml=\" effectiveBooleanVal \" pulumi-lang-java=\" effectiveBooleanVal \" pulumi-lang-hcl=\" effective_boolean_val \"\u003e effectiveBooleanVal \u003c/span\u003efor final setting value\n" }, "collaborationPlatformConnectivity": { "$ref": "#/types/databricks:index/AccountSettingV2CollaborationPlatformConnectivity:AccountSettingV2CollaborationPlatformConnectivity", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" collaborationPlatformConnectivity \" pulumi-lang-dotnet=\" CollaborationPlatformConnectivity \" pulumi-lang-go=\" collaborationPlatformConnectivity \" pulumi-lang-python=\" collaboration_platform_connectivity \" pulumi-lang-yaml=\" collaborationPlatformConnectivity \" pulumi-lang-java=\" collaborationPlatformConnectivity \" pulumi-lang-hcl=\" collaboration_platform_connectivity \"\u003e collaborationPlatformConnectivity \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-dotnet=\" EffectiveCollaborationPlatformConnectivity \" pulumi-lang-go=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-python=\" effective_collaboration_platform_connectivity \" pulumi-lang-yaml=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-java=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-hcl=\" effective_collaboration_platform_connectivity \"\u003e effectiveCollaborationPlatformConnectivity \u003c/span\u003efor final setting value\n" }, "effectiveAibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" aibi_dashboard_embedding_access_policy \"\u003e aibiDashboardEmbeddingAccessPolicy \u003c/span\u003esetting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy\n" }, "effectiveAibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" aibi_dashboard_embedding_approved_domains \"\u003e aibiDashboardEmbeddingApprovedDomains \u003c/span\u003esetting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains\n" }, "effectiveAutomaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" automaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" AutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" automaticClusterUpdateWorkspace \" pulumi-lang-python=\" automatic_cluster_update_workspace \" pulumi-lang-yaml=\" automaticClusterUpdateWorkspace \" pulumi-lang-java=\" automaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" automatic_cluster_update_workspace \"\u003e automaticClusterUpdateWorkspace \u003c/span\u003esetting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace\n" }, "effectivePersonalCompute": { "$ref": "#/types/databricks:index/AccountSettingV2EffectivePersonalCompute:AccountSettingV2EffectivePersonalCompute", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" personalCompute \" pulumi-lang-dotnet=\" PersonalCompute \" pulumi-lang-go=\" personalCompute \" pulumi-lang-python=\" personal_compute \" pulumi-lang-yaml=\" personalCompute \" pulumi-lang-java=\" personalCompute \" pulumi-lang-hcl=\" personal_compute \"\u003e personalCompute \u003c/span\u003esetting. This is the final effective value of setting. To set a value use personal_compute\n" }, "effectiveRestrictWorkspaceAdmins": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveRestrictWorkspaceAdmins:AccountSettingV2EffectiveRestrictWorkspaceAdmins", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" restrictWorkspaceAdmins \" pulumi-lang-dotnet=\" RestrictWorkspaceAdmins \" pulumi-lang-go=\" restrictWorkspaceAdmins \" pulumi-lang-python=\" restrict_workspace_admins \" pulumi-lang-yaml=\" restrictWorkspaceAdmins \" pulumi-lang-java=\" restrictWorkspaceAdmins \" pulumi-lang-hcl=\" restrict_workspace_admins \"\u003e restrictWorkspaceAdmins \u003c/span\u003esetting. This is the final effective value of setting. To set a value use restrict_workspace_admins\n" }, "integerVal": { "$ref": "#/types/databricks:index/AccountSettingV2IntegerVal:AccountSettingV2IntegerVal", "description": "Setting value for integer type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveIntegerVal \" pulumi-lang-dotnet=\" EffectiveIntegerVal \" pulumi-lang-go=\" effectiveIntegerVal \" pulumi-lang-python=\" effective_integer_val \" pulumi-lang-yaml=\" effectiveIntegerVal \" pulumi-lang-java=\" effectiveIntegerVal \" pulumi-lang-hcl=\" effective_integer_val \"\u003e effectiveIntegerVal \u003c/span\u003efor final setting value\n" }, "name": { "type": "string", "description": "Name of the setting\n" }, "operationalEmailCustomRecipient": { "$ref": "#/types/databricks:index/AccountSettingV2OperationalEmailCustomRecipient:AccountSettingV2OperationalEmailCustomRecipient", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" operationalEmailCustomRecipient \" pulumi-lang-dotnet=\" OperationalEmailCustomRecipient \" pulumi-lang-go=\" operationalEmailCustomRecipient \" pulumi-lang-python=\" operational_email_custom_recipient \" pulumi-lang-yaml=\" operationalEmailCustomRecipient \" pulumi-lang-java=\" operationalEmailCustomRecipient \" pulumi-lang-hcl=\" operational_email_custom_recipient \"\u003e operationalEmailCustomRecipient \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-dotnet=\" EffectiveOperationalEmailCustomRecipient \" pulumi-lang-go=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-python=\" effective_operational_email_custom_recipient \" pulumi-lang-yaml=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-java=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-hcl=\" effective_operational_email_custom_recipient \"\u003e effectiveOperationalEmailCustomRecipient \u003c/span\u003efor final setting value\n" }, "personalCompute": { "$ref": "#/types/databricks:index/AccountSettingV2PersonalCompute:AccountSettingV2PersonalCompute", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" personalCompute \" pulumi-lang-dotnet=\" PersonalCompute \" pulumi-lang-go=\" personalCompute \" pulumi-lang-python=\" personal_compute \" pulumi-lang-yaml=\" personalCompute \" pulumi-lang-java=\" personalCompute \" pulumi-lang-hcl=\" personal_compute \"\u003e personalCompute \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectivePersonalCompute \" pulumi-lang-dotnet=\" EffectivePersonalCompute \" pulumi-lang-go=\" effectivePersonalCompute \" pulumi-lang-python=\" effective_personal_compute \" pulumi-lang-yaml=\" effectivePersonalCompute \" pulumi-lang-java=\" effectivePersonalCompute \" pulumi-lang-hcl=\" effective_personal_compute \"\u003e effectivePersonalCompute \u003c/span\u003efor final setting value\n" }, "restrictWorkspaceAdmins": { "$ref": "#/types/databricks:index/AccountSettingV2RestrictWorkspaceAdmins:AccountSettingV2RestrictWorkspaceAdmins", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" restrictWorkspaceAdmins \" pulumi-lang-dotnet=\" RestrictWorkspaceAdmins \" pulumi-lang-go=\" restrictWorkspaceAdmins \" pulumi-lang-python=\" restrict_workspace_admins \" pulumi-lang-yaml=\" restrictWorkspaceAdmins \" pulumi-lang-java=\" restrictWorkspaceAdmins \" pulumi-lang-hcl=\" restrict_workspace_admins \"\u003e restrictWorkspaceAdmins \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-dotnet=\" EffectiveRestrictWorkspaceAdmins \" pulumi-lang-go=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-python=\" effective_restrict_workspace_admins \" pulumi-lang-yaml=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-java=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-hcl=\" effective_restrict_workspace_admins \"\u003e effectiveRestrictWorkspaceAdmins \u003c/span\u003efor final setting value\n" }, "stringVal": { "$ref": "#/types/databricks:index/AccountSettingV2StringVal:AccountSettingV2StringVal", "description": "Setting value for string type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveStringVal \" pulumi-lang-dotnet=\" EffectiveStringVal \" pulumi-lang-go=\" effectiveStringVal \" pulumi-lang-python=\" effective_string_val \" pulumi-lang-yaml=\" effectiveStringVal \" pulumi-lang-java=\" effectiveStringVal \" pulumi-lang-hcl=\" effective_string_val \"\u003e effectiveStringVal \u003c/span\u003efor final setting value\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AccountSettingV2 resources.\n", "properties": { "aibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AccountSettingV2AibiDashboardEmbeddingAccessPolicy:AccountSettingV2AibiDashboardEmbeddingAccessPolicy", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" aibi_dashboard_embedding_access_policy \"\u003e aibiDashboardEmbeddingAccessPolicy \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" EffectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" effective_aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" effectiveAibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" effective_aibi_dashboard_embedding_access_policy \"\u003e effectiveAibiDashboardEmbeddingAccessPolicy \u003c/span\u003efor final setting value\n" }, "aibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AccountSettingV2AibiDashboardEmbeddingApprovedDomains:AccountSettingV2AibiDashboardEmbeddingApprovedDomains", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" aibi_dashboard_embedding_approved_domains \"\u003e aibiDashboardEmbeddingApprovedDomains \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" EffectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" effective_aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" effectiveAibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" effective_aibi_dashboard_embedding_approved_domains \"\u003e effectiveAibiDashboardEmbeddingApprovedDomains \u003c/span\u003efor final setting value\n" }, "allowedAppsUserApiScopes": { "$ref": "#/types/databricks:index/AccountSettingV2AllowedAppsUserApiScopes:AccountSettingV2AllowedAppsUserApiScopes", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" allowedAppsUserApiScopes \" pulumi-lang-dotnet=\" AllowedAppsUserApiScopes \" pulumi-lang-go=\" allowedAppsUserApiScopes \" pulumi-lang-python=\" allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" allowedAppsUserApiScopes \" pulumi-lang-java=\" allowedAppsUserApiScopes \" pulumi-lang-hcl=\" allowed_apps_user_api_scopes \"\u003e allowedAppsUserApiScopes \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-dotnet=\" EffectiveAllowedAppsUserApiScopes \" pulumi-lang-go=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-python=\" effective_allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-java=\" effectiveAllowedAppsUserApiScopes \" pulumi-lang-hcl=\" effective_allowed_apps_user_api_scopes \"\u003e effectiveAllowedAppsUserApiScopes \u003c/span\u003efor final setting value\n" }, "automaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AccountSettingV2AutomaticClusterUpdateWorkspace:AccountSettingV2AutomaticClusterUpdateWorkspace", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" automaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" AutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" automaticClusterUpdateWorkspace \" pulumi-lang-python=\" automatic_cluster_update_workspace \" pulumi-lang-yaml=\" automaticClusterUpdateWorkspace \" pulumi-lang-java=\" automaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" automatic_cluster_update_workspace \"\u003e automaticClusterUpdateWorkspace \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" EffectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-python=\" effective_automatic_cluster_update_workspace \" pulumi-lang-yaml=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-java=\" effectiveAutomaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" effective_automatic_cluster_update_workspace \"\u003e effectiveAutomaticClusterUpdateWorkspace \u003c/span\u003efor final setting value\n" }, "booleanVal": { "$ref": "#/types/databricks:index/AccountSettingV2BooleanVal:AccountSettingV2BooleanVal", "description": "Setting value for boolean type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveBooleanVal \" pulumi-lang-dotnet=\" EffectiveBooleanVal \" pulumi-lang-go=\" effectiveBooleanVal \" pulumi-lang-python=\" effective_boolean_val \" pulumi-lang-yaml=\" effectiveBooleanVal \" pulumi-lang-java=\" effectiveBooleanVal \" pulumi-lang-hcl=\" effective_boolean_val \"\u003e effectiveBooleanVal \u003c/span\u003efor final setting value\n" }, "collaborationPlatformConnectivity": { "$ref": "#/types/databricks:index/AccountSettingV2CollaborationPlatformConnectivity:AccountSettingV2CollaborationPlatformConnectivity", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" collaborationPlatformConnectivity \" pulumi-lang-dotnet=\" CollaborationPlatformConnectivity \" pulumi-lang-go=\" collaborationPlatformConnectivity \" pulumi-lang-python=\" collaboration_platform_connectivity \" pulumi-lang-yaml=\" collaborationPlatformConnectivity \" pulumi-lang-java=\" collaborationPlatformConnectivity \" pulumi-lang-hcl=\" collaboration_platform_connectivity \"\u003e collaborationPlatformConnectivity \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-dotnet=\" EffectiveCollaborationPlatformConnectivity \" pulumi-lang-go=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-python=\" effective_collaboration_platform_connectivity \" pulumi-lang-yaml=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-java=\" effectiveCollaborationPlatformConnectivity \" pulumi-lang-hcl=\" effective_collaboration_platform_connectivity \"\u003e effectiveCollaborationPlatformConnectivity \u003c/span\u003efor final setting value\n" }, "effectiveAibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy:AccountSettingV2EffectiveAibiDashboardEmbeddingAccessPolicy", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingAccessPolicy \" pulumi-lang-go=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-python=\" aibi_dashboard_embedding_access_policy \" pulumi-lang-yaml=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-java=\" aibiDashboardEmbeddingAccessPolicy \" pulumi-lang-hcl=\" aibi_dashboard_embedding_access_policy \"\u003e aibiDashboardEmbeddingAccessPolicy \u003c/span\u003esetting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_access_policy\n" }, "effectiveAibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains:AccountSettingV2EffectiveAibiDashboardEmbeddingApprovedDomains", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-dotnet=\" AibiDashboardEmbeddingApprovedDomains \" pulumi-lang-go=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-python=\" aibi_dashboard_embedding_approved_domains \" pulumi-lang-yaml=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-java=\" aibiDashboardEmbeddingApprovedDomains \" pulumi-lang-hcl=\" aibi_dashboard_embedding_approved_domains \"\u003e aibiDashboardEmbeddingApprovedDomains \u003c/span\u003esetting. This is the final effective value of setting. To set a value use aibi_dashboard_embedding_approved_domains\n" }, "effectiveAllowedAppsUserApiScopes": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAllowedAppsUserApiScopes:AccountSettingV2EffectiveAllowedAppsUserApiScopes", "description": "(AllowedAppsUserApiScopesMessage) - Effective setting value for\u003cspan pulumi-lang-nodejs=\" allowedAppsUserApiScopes \" pulumi-lang-dotnet=\" AllowedAppsUserApiScopes \" pulumi-lang-go=\" allowedAppsUserApiScopes \" pulumi-lang-python=\" allowed_apps_user_api_scopes \" pulumi-lang-yaml=\" allowedAppsUserApiScopes \" pulumi-lang-java=\" allowedAppsUserApiScopes \" pulumi-lang-hcl=\" allowed_apps_user_api_scopes \"\u003e allowedAppsUserApiScopes \u003c/span\u003esetting. This is the final effective value of setting. To set a value use allowed_apps_user_api_scopes\n" }, "effectiveAutomaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace:AccountSettingV2EffectiveAutomaticClusterUpdateWorkspace", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" automaticClusterUpdateWorkspace \" pulumi-lang-dotnet=\" AutomaticClusterUpdateWorkspace \" pulumi-lang-go=\" automaticClusterUpdateWorkspace \" pulumi-lang-python=\" automatic_cluster_update_workspace \" pulumi-lang-yaml=\" automaticClusterUpdateWorkspace \" pulumi-lang-java=\" automaticClusterUpdateWorkspace \" pulumi-lang-hcl=\" automatic_cluster_update_workspace \"\u003e automaticClusterUpdateWorkspace \u003c/span\u003esetting. This is the final effective value of setting. To set a value use automatic_cluster_update_workspace\n" }, "effectiveBooleanVal": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveBooleanVal:AccountSettingV2EffectiveBooleanVal", "description": "(BooleanMessage) - Effective setting value for boolean type setting. This is the final effective value of setting. To set a value use boolean_val\n" }, "effectiveCollaborationPlatformConnectivity": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveCollaborationPlatformConnectivity:AccountSettingV2EffectiveCollaborationPlatformConnectivity", "description": "(CollaborationPlatformConnectivityMessage) - Effective setting value for\u003cspan pulumi-lang-nodejs=\" collaborationPlatformConnectivity \" pulumi-lang-dotnet=\" CollaborationPlatformConnectivity \" pulumi-lang-go=\" collaborationPlatformConnectivity \" pulumi-lang-python=\" collaboration_platform_connectivity \" pulumi-lang-yaml=\" collaborationPlatformConnectivity \" pulumi-lang-java=\" collaborationPlatformConnectivity \" pulumi-lang-hcl=\" collaboration_platform_connectivity \"\u003e collaborationPlatformConnectivity \u003c/span\u003esetting. This is the final effective value of setting. To set a value use collaboration_platform_connectivity\n" }, "effectiveIntegerVal": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveIntegerVal:AccountSettingV2EffectiveIntegerVal", "description": "(IntegerMessage) - Effective setting value for integer type setting. This is the final effective value of setting. To set a value use integer_val\n" }, "effectiveOperationalEmailCustomRecipient": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveOperationalEmailCustomRecipient:AccountSettingV2EffectiveOperationalEmailCustomRecipient", "description": "(OperationalEmailCustomRecipientMessage) - Effective setting value for\u003cspan pulumi-lang-nodejs=\" operationalEmailCustomRecipient \" pulumi-lang-dotnet=\" OperationalEmailCustomRecipient \" pulumi-lang-go=\" operationalEmailCustomRecipient \" pulumi-lang-python=\" operational_email_custom_recipient \" pulumi-lang-yaml=\" operationalEmailCustomRecipient \" pulumi-lang-java=\" operationalEmailCustomRecipient \" pulumi-lang-hcl=\" operational_email_custom_recipient \"\u003e operationalEmailCustomRecipient \u003c/span\u003esetting. This is the final effective value of setting. To set a value use operational_email_custom_recipient\n" }, "effectivePersonalCompute": { "$ref": "#/types/databricks:index/AccountSettingV2EffectivePersonalCompute:AccountSettingV2EffectivePersonalCompute", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" personalCompute \" pulumi-lang-dotnet=\" PersonalCompute \" pulumi-lang-go=\" personalCompute \" pulumi-lang-python=\" personal_compute \" pulumi-lang-yaml=\" personalCompute \" pulumi-lang-java=\" personalCompute \" pulumi-lang-hcl=\" personal_compute \"\u003e personalCompute \u003c/span\u003esetting. This is the final effective value of setting. To set a value use personal_compute\n" }, "effectiveRestrictWorkspaceAdmins": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveRestrictWorkspaceAdmins:AccountSettingV2EffectiveRestrictWorkspaceAdmins", "description": "Effective setting value for\u003cspan pulumi-lang-nodejs=\" restrictWorkspaceAdmins \" pulumi-lang-dotnet=\" RestrictWorkspaceAdmins \" pulumi-lang-go=\" restrictWorkspaceAdmins \" pulumi-lang-python=\" restrict_workspace_admins \" pulumi-lang-yaml=\" restrictWorkspaceAdmins \" pulumi-lang-java=\" restrictWorkspaceAdmins \" pulumi-lang-hcl=\" restrict_workspace_admins \"\u003e restrictWorkspaceAdmins \u003c/span\u003esetting. This is the final effective value of setting. To set a value use restrict_workspace_admins\n" }, "effectiveStringVal": { "$ref": "#/types/databricks:index/AccountSettingV2EffectiveStringVal:AccountSettingV2EffectiveStringVal", "description": "(StringMessage) - Effective setting value for string type setting. This is the final effective value of setting. To set a value use string_val\n" }, "integerVal": { "$ref": "#/types/databricks:index/AccountSettingV2IntegerVal:AccountSettingV2IntegerVal", "description": "Setting value for integer type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveIntegerVal \" pulumi-lang-dotnet=\" EffectiveIntegerVal \" pulumi-lang-go=\" effectiveIntegerVal \" pulumi-lang-python=\" effective_integer_val \" pulumi-lang-yaml=\" effectiveIntegerVal \" pulumi-lang-java=\" effectiveIntegerVal \" pulumi-lang-hcl=\" effective_integer_val \"\u003e effectiveIntegerVal \u003c/span\u003efor final setting value\n" }, "name": { "type": "string", "description": "Name of the setting\n" }, "operationalEmailCustomRecipient": { "$ref": "#/types/databricks:index/AccountSettingV2OperationalEmailCustomRecipient:AccountSettingV2OperationalEmailCustomRecipient", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" operationalEmailCustomRecipient \" pulumi-lang-dotnet=\" OperationalEmailCustomRecipient \" pulumi-lang-go=\" operationalEmailCustomRecipient \" pulumi-lang-python=\" operational_email_custom_recipient \" pulumi-lang-yaml=\" operationalEmailCustomRecipient \" pulumi-lang-java=\" operationalEmailCustomRecipient \" pulumi-lang-hcl=\" operational_email_custom_recipient \"\u003e operationalEmailCustomRecipient \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-dotnet=\" EffectiveOperationalEmailCustomRecipient \" pulumi-lang-go=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-python=\" effective_operational_email_custom_recipient \" pulumi-lang-yaml=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-java=\" effectiveOperationalEmailCustomRecipient \" pulumi-lang-hcl=\" effective_operational_email_custom_recipient \"\u003e effectiveOperationalEmailCustomRecipient \u003c/span\u003efor final setting value\n" }, "personalCompute": { "$ref": "#/types/databricks:index/AccountSettingV2PersonalCompute:AccountSettingV2PersonalCompute", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" personalCompute \" pulumi-lang-dotnet=\" PersonalCompute \" pulumi-lang-go=\" personalCompute \" pulumi-lang-python=\" personal_compute \" pulumi-lang-yaml=\" personalCompute \" pulumi-lang-java=\" personalCompute \" pulumi-lang-hcl=\" personal_compute \"\u003e personalCompute \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectivePersonalCompute \" pulumi-lang-dotnet=\" EffectivePersonalCompute \" pulumi-lang-go=\" effectivePersonalCompute \" pulumi-lang-python=\" effective_personal_compute \" pulumi-lang-yaml=\" effectivePersonalCompute \" pulumi-lang-java=\" effectivePersonalCompute \" pulumi-lang-hcl=\" effective_personal_compute \"\u003e effectivePersonalCompute \u003c/span\u003efor final setting value\n" }, "restrictWorkspaceAdmins": { "$ref": "#/types/databricks:index/AccountSettingV2RestrictWorkspaceAdmins:AccountSettingV2RestrictWorkspaceAdmins", "description": "Setting value for\u003cspan pulumi-lang-nodejs=\" restrictWorkspaceAdmins \" pulumi-lang-dotnet=\" RestrictWorkspaceAdmins \" pulumi-lang-go=\" restrictWorkspaceAdmins \" pulumi-lang-python=\" restrict_workspace_admins \" pulumi-lang-yaml=\" restrictWorkspaceAdmins \" pulumi-lang-java=\" restrictWorkspaceAdmins \" pulumi-lang-hcl=\" restrict_workspace_admins \"\u003e restrictWorkspaceAdmins \u003c/span\u003esetting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-dotnet=\" EffectiveRestrictWorkspaceAdmins \" pulumi-lang-go=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-python=\" effective_restrict_workspace_admins \" pulumi-lang-yaml=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-java=\" effectiveRestrictWorkspaceAdmins \" pulumi-lang-hcl=\" effective_restrict_workspace_admins \"\u003e effectiveRestrictWorkspaceAdmins \u003c/span\u003efor final setting value\n" }, "stringVal": { "$ref": "#/types/databricks:index/AccountSettingV2StringVal:AccountSettingV2StringVal", "description": "Setting value for string type setting. This is the setting value set by consumers, check\u003cspan pulumi-lang-nodejs=\" effectiveStringVal \" pulumi-lang-dotnet=\" EffectiveStringVal \" pulumi-lang-go=\" effectiveStringVal \" pulumi-lang-python=\" effective_string_val \" pulumi-lang-yaml=\" effectiveStringVal \" pulumi-lang-java=\" effectiveStringVal \" pulumi-lang-hcl=\" effective_string_val \"\u003e effectiveStringVal \u003c/span\u003efor final setting value\n" } }, "type": "object" } }, "databricks:index/aibiDashboardEmbeddingAccessPolicySetting:AibiDashboardEmbeddingAccessPolicySetting": { "description": "The \u003cspan pulumi-lang-nodejs=\"`databricks.AibiDashboardEmbeddingAccessPolicySetting`\" pulumi-lang-dotnet=\"`databricks.AibiDashboardEmbeddingAccessPolicySetting`\" pulumi-lang-go=\"`AibiDashboardEmbeddingAccessPolicySetting`\" pulumi-lang-python=\"`AibiDashboardEmbeddingAccessPolicySetting`\" pulumi-lang-yaml=\"`databricks.AibiDashboardEmbeddingAccessPolicySetting`\" pulumi-lang-java=\"`databricks.AibiDashboardEmbeddingAccessPolicySetting`\" pulumi-lang-hcl=\"`databricks_aibi_dashboard_embedding_access_policy_setting`\"\u003e`databricks.AibiDashboardEmbeddingAccessPolicySetting`\u003c/span\u003e resource allows you to control [embedding of AI/BI Dashboards](https://learn.microsoft.com/en-us/azure/databricks/dashboards/admin/#manage-dashboard-embedding) into other sites.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.AibiDashboardEmbeddingAccessPolicySetting(\"this\", {aibiDashboardEmbeddingAccessPolicy: {\n accessPolicyType: \"ALLOW_APPROVED_DOMAINS\",\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.AibiDashboardEmbeddingAccessPolicySetting(\"this\", aibi_dashboard_embedding_access_policy={\n \"access_policy_type\": \"ALLOW_APPROVED_DOMAINS\",\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.AibiDashboardEmbeddingAccessPolicySetting(\"this\", new()\n {\n AibiDashboardEmbeddingAccessPolicy = new Databricks.Inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs\n {\n AccessPolicyType = \"ALLOW_APPROVED_DOMAINS\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAibiDashboardEmbeddingAccessPolicySetting(ctx, \"this\", \u0026databricks.AibiDashboardEmbeddingAccessPolicySettingArgs{\n\t\t\tAibiDashboardEmbeddingAccessPolicy: \u0026databricks.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs{\n\t\t\t\tAccessPolicyType: pulumi.String(\"ALLOW_APPROVED_DOMAINS\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_aibidashboardembeddingaccesspolicysetting\" \"this\" {\n aibi_dashboard_embedding_access_policy = {\n access_policy_type = \"ALLOW_APPROVED_DOMAINS\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AibiDashboardEmbeddingAccessPolicySetting;\nimport com.pulumi.databricks.AibiDashboardEmbeddingAccessPolicySettingArgs;\nimport com.pulumi.databricks.inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new AibiDashboardEmbeddingAccessPolicySetting(\"this\", AibiDashboardEmbeddingAccessPolicySettingArgs.builder()\n .aibiDashboardEmbeddingAccessPolicy(AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs.builder()\n .accessPolicyType(\"ALLOW_APPROVED_DOMAINS\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:AibiDashboardEmbeddingAccessPolicySetting\n properties:\n aibiDashboardEmbeddingAccessPolicy:\n accessPolicyType: ALLOW_APPROVED_DOMAINS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n-\u003cspan pulumi-lang-nodejs=\" databricks.AibiDashboardEmbeddingApprovedDomainsSetting \" pulumi-lang-dotnet=\" databricks.AibiDashboardEmbeddingApprovedDomainsSetting \" pulumi-lang-go=\" AibiDashboardEmbeddingApprovedDomainsSetting \" pulumi-lang-python=\" AibiDashboardEmbeddingApprovedDomainsSetting \" pulumi-lang-yaml=\" databricks.AibiDashboardEmbeddingApprovedDomainsSetting \" pulumi-lang-java=\" databricks.AibiDashboardEmbeddingApprovedDomainsSetting \" pulumi-lang-hcl=\" databricks_aibi_dashboard_embedding_approved_domains_setting \"\u003e databricks.AibiDashboardEmbeddingApprovedDomainsSetting \u003c/span\u003eis used to control approved domains.\n\n", "properties": { "aibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy:AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingAccessPolicySettingProviderConfig:AibiDashboardEmbeddingAccessPolicySettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "required": [ "aibiDashboardEmbeddingAccessPolicy", "etag", "providerConfig", "settingName" ], "inputProperties": { "aibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy:AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingAccessPolicySettingProviderConfig:AibiDashboardEmbeddingAccessPolicySettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "requiredInputs": [ "aibiDashboardEmbeddingAccessPolicy" ], "stateInputs": { "description": "Input properties used for looking up and filtering AibiDashboardEmbeddingAccessPolicySetting resources.\n", "properties": { "aibiDashboardEmbeddingAccessPolicy": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy:AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicy", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingAccessPolicySettingProviderConfig:AibiDashboardEmbeddingAccessPolicySettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/aibiDashboardEmbeddingApprovedDomainsSetting:AibiDashboardEmbeddingApprovedDomainsSetting": { "description": "The \u003cspan pulumi-lang-nodejs=\"`databricks.AibiDashboardEmbeddingApprovedDomainsSetting`\" pulumi-lang-dotnet=\"`databricks.AibiDashboardEmbeddingApprovedDomainsSetting`\" pulumi-lang-go=\"`AibiDashboardEmbeddingApprovedDomainsSetting`\" pulumi-lang-python=\"`AibiDashboardEmbeddingApprovedDomainsSetting`\" pulumi-lang-yaml=\"`databricks.AibiDashboardEmbeddingApprovedDomainsSetting`\" pulumi-lang-java=\"`databricks.AibiDashboardEmbeddingApprovedDomainsSetting`\" pulumi-lang-hcl=\"`databricks_aibi_dashboard_embedding_approved_domains_setting`\"\u003e`databricks.AibiDashboardEmbeddingApprovedDomainsSetting`\u003c/span\u003e resource allows you to specify the list of domains allowed for [embedding of AI/BI Dashboards](https://learn.microsoft.com/en-us/azure/databricks/dashboards/admin/#manage-dashboard-embedding) into other sites.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.AibiDashboardEmbeddingAccessPolicySetting(\"this\", {aibiDashboardEmbeddingAccessPolicy: {\n accessPolicyType: \"ALLOW_APPROVED_DOMAINS\",\n}});\nconst thisAibiDashboardEmbeddingApprovedDomainsSetting = new databricks.AibiDashboardEmbeddingApprovedDomainsSetting(\"this\", {aibiDashboardEmbeddingApprovedDomains: {\n approvedDomains: [\"test.com\"],\n}}, {\n dependsOn: [_this],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.AibiDashboardEmbeddingAccessPolicySetting(\"this\", aibi_dashboard_embedding_access_policy={\n \"access_policy_type\": \"ALLOW_APPROVED_DOMAINS\",\n})\nthis_aibi_dashboard_embedding_approved_domains_setting = databricks.AibiDashboardEmbeddingApprovedDomainsSetting(\"this\", aibi_dashboard_embedding_approved_domains={\n \"approved_domains\": [\"test.com\"],\n},\nopts = pulumi.ResourceOptions(depends_on=[this]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.AibiDashboardEmbeddingAccessPolicySetting(\"this\", new()\n {\n AibiDashboardEmbeddingAccessPolicy = new Databricks.Inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs\n {\n AccessPolicyType = \"ALLOW_APPROVED_DOMAINS\",\n },\n });\n\n var thisAibiDashboardEmbeddingApprovedDomainsSetting = new Databricks.AibiDashboardEmbeddingApprovedDomainsSetting(\"this\", new()\n {\n AibiDashboardEmbeddingApprovedDomains = new Databricks.Inputs.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs\n {\n ApprovedDomains = new[]\n {\n \"test.com\",\n },\n },\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n @this,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewAibiDashboardEmbeddingAccessPolicySetting(ctx, \"this\", \u0026databricks.AibiDashboardEmbeddingAccessPolicySettingArgs{\n\t\t\tAibiDashboardEmbeddingAccessPolicy: \u0026databricks.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs{\n\t\t\t\tAccessPolicyType: pulumi.String(\"ALLOW_APPROVED_DOMAINS\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAibiDashboardEmbeddingApprovedDomainsSetting(ctx, \"this\", \u0026databricks.AibiDashboardEmbeddingApprovedDomainsSettingArgs{\n\t\t\tAibiDashboardEmbeddingApprovedDomains: \u0026databricks.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs{\n\t\t\t\tApprovedDomains: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"test.com\"),\n\t\t\t\t},\n\t\t\t},\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthis,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_aibidashboardembeddingaccesspolicysetting\" \"this\" {\n aibi_dashboard_embedding_access_policy = {\n access_policy_type = \"ALLOW_APPROVED_DOMAINS\"\n }\n}\nresource \"databricks_aibidashboardembeddingapproveddomainssetting\" \"this\" {\n depends_on = [databricks_aibidashboardembeddingaccesspolicysetting.this]\n aibi_dashboard_embedding_approved_domains = {\n approved_domains = [\"test.com\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AibiDashboardEmbeddingAccessPolicySetting;\nimport com.pulumi.databricks.AibiDashboardEmbeddingAccessPolicySettingArgs;\nimport com.pulumi.databricks.inputs.AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs;\nimport com.pulumi.databricks.AibiDashboardEmbeddingApprovedDomainsSetting;\nimport com.pulumi.databricks.AibiDashboardEmbeddingApprovedDomainsSettingArgs;\nimport com.pulumi.databricks.inputs.AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new AibiDashboardEmbeddingAccessPolicySetting(\"this\", AibiDashboardEmbeddingAccessPolicySettingArgs.builder()\n .aibiDashboardEmbeddingAccessPolicy(AibiDashboardEmbeddingAccessPolicySettingAibiDashboardEmbeddingAccessPolicyArgs.builder()\n .accessPolicyType(\"ALLOW_APPROVED_DOMAINS\")\n .build())\n .build());\n\n var thisAibiDashboardEmbeddingApprovedDomainsSetting = new AibiDashboardEmbeddingApprovedDomainsSetting(\"thisAibiDashboardEmbeddingApprovedDomainsSetting\", AibiDashboardEmbeddingApprovedDomainsSettingArgs.builder()\n .aibiDashboardEmbeddingApprovedDomains(AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomainsArgs.builder()\n .approvedDomains(\"test.com\")\n .build())\n .build(), CustomResourceOptions.builder()\n .dependsOn(this_)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:AibiDashboardEmbeddingAccessPolicySetting\n properties:\n aibiDashboardEmbeddingAccessPolicy:\n accessPolicyType: ALLOW_APPROVED_DOMAINS\n thisAibiDashboardEmbeddingApprovedDomainsSetting:\n type: databricks:AibiDashboardEmbeddingApprovedDomainsSetting\n name: this\n properties:\n aibiDashboardEmbeddingApprovedDomains:\n approvedDomains:\n - test.com\n options:\n dependsOn:\n - ${this}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n-\u003cspan pulumi-lang-nodejs=\" databricks.AibiDashboardEmbeddingAccessPolicySetting \" pulumi-lang-dotnet=\" databricks.AibiDashboardEmbeddingAccessPolicySetting \" pulumi-lang-go=\" AibiDashboardEmbeddingAccessPolicySetting \" pulumi-lang-python=\" AibiDashboardEmbeddingAccessPolicySetting \" pulumi-lang-yaml=\" databricks.AibiDashboardEmbeddingAccessPolicySetting \" pulumi-lang-java=\" databricks.AibiDashboardEmbeddingAccessPolicySetting \" pulumi-lang-hcl=\" databricks_aibi_dashboard_embedding_access_policy_setting \"\u003e databricks.AibiDashboardEmbeddingAccessPolicySetting \u003c/span\u003eis used to control embedding policy.\n\n", "properties": { "aibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains:AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig:AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "required": [ "aibiDashboardEmbeddingApprovedDomains", "etag", "providerConfig", "settingName" ], "inputProperties": { "aibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains:AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig:AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "requiredInputs": [ "aibiDashboardEmbeddingApprovedDomains" ], "stateInputs": { "description": "Input properties used for looking up and filtering AibiDashboardEmbeddingApprovedDomainsSetting resources.\n", "properties": { "aibiDashboardEmbeddingApprovedDomains": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains:AibiDashboardEmbeddingApprovedDomainsSettingAibiDashboardEmbeddingApprovedDomains", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig:AibiDashboardEmbeddingApprovedDomainsSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/alert:Alert": { "description": "This resource allows you to manage [Databricks SQL Alerts](https://docs.databricks.com/en/sql/user/alerts/index.html). It supersedes\u003cspan pulumi-lang-nodejs=\" databricks.SqlAlert \" pulumi-lang-dotnet=\" databricks.SqlAlert \" pulumi-lang-go=\" SqlAlert \" pulumi-lang-python=\" SqlAlert \" pulumi-lang-yaml=\" databricks.SqlAlert \" pulumi-lang-java=\" databricks.SqlAlert \" pulumi-lang-hcl=\" databricks_sql_alert \"\u003e databricks.SqlAlert \u003c/span\u003eresource - see migration guide below for more details.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sharedDir = new databricks.Directory(\"shared_dir\", {path: \"/Shared/Queries\"});\n// This will be replaced with new databricks_query resource\nconst _this = new databricks.Query(\"this\", {\n warehouseId: example.id,\n displayName: \"My Query Name\",\n queryText: \"SELECT 42 as value\",\n parentPath: sharedDir.path,\n});\nconst alert = new databricks.Alert(\"alert\", {\n queryId: _this.id,\n displayName: \"TF new alert\",\n parentPath: sharedDir.path,\n condition: {\n op: \"GREATER_THAN\",\n operand: {\n column: {\n name: \"value\",\n },\n },\n threshold: {\n value: {\n doubleValue: 42,\n },\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nshared_dir = databricks.Directory(\"shared_dir\", path=\"/Shared/Queries\")\n# This will be replaced with new databricks_query resource\nthis = databricks.Query(\"this\",\n warehouse_id=example[\"id\"],\n display_name=\"My Query Name\",\n query_text=\"SELECT 42 as value\",\n parent_path=shared_dir.path)\nalert = databricks.Alert(\"alert\",\n query_id=this.id,\n display_name=\"TF new alert\",\n parent_path=shared_dir.path,\n condition={\n \"op\": \"GREATER_THAN\",\n \"operand\": {\n \"column\": {\n \"name\": \"value\",\n },\n },\n \"threshold\": {\n \"value\": {\n \"double_value\": float(42),\n },\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sharedDir = new Databricks.Directory(\"shared_dir\", new()\n {\n Path = \"/Shared/Queries\",\n });\n\n // This will be replaced with new databricks_query resource\n var @this = new Databricks.Query(\"this\", new()\n {\n WarehouseId = example.Id,\n DisplayName = \"My Query Name\",\n QueryText = \"SELECT 42 as value\",\n ParentPath = sharedDir.Path,\n });\n\n var alert = new Databricks.Alert(\"alert\", new()\n {\n QueryId = @this.Id,\n DisplayName = \"TF new alert\",\n ParentPath = sharedDir.Path,\n Condition = new Databricks.Inputs.AlertConditionArgs\n {\n Op = \"GREATER_THAN\",\n Operand = new Databricks.Inputs.AlertConditionOperandArgs\n {\n Column = new Databricks.Inputs.AlertConditionOperandColumnArgs\n {\n Name = \"value\",\n },\n },\n Threshold = new Databricks.Inputs.AlertConditionThresholdArgs\n {\n Value = new Databricks.Inputs.AlertConditionThresholdValueArgs\n {\n DoubleValue = 42,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsharedDir, err := databricks.NewDirectory(ctx, \"shared_dir\", \u0026databricks.DirectoryArgs{\n\t\t\tPath: pulumi.String(\"/Shared/Queries\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// This will be replaced with new databricks_query resource\n\t\tthis, err := databricks.NewQuery(ctx, \"this\", \u0026databricks.QueryArgs{\n\t\t\tWarehouseId: pulumi.Any(example.Id),\n\t\t\tDisplayName: pulumi.String(\"My Query Name\"),\n\t\t\tQueryText: pulumi.String(\"SELECT 42 as value\"),\n\t\t\tParentPath: sharedDir.Path,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewAlert(ctx, \"alert\", \u0026databricks.AlertArgs{\n\t\t\tQueryId: this.ID(),\n\t\t\tDisplayName: pulumi.String(\"TF new alert\"),\n\t\t\tParentPath: sharedDir.Path,\n\t\t\tCondition: \u0026databricks.AlertConditionArgs{\n\t\t\t\tOp: pulumi.String(\"GREATER_THAN\"),\n\t\t\t\tOperand: \u0026databricks.AlertConditionOperandArgs{\n\t\t\t\t\tColumn: \u0026databricks.AlertConditionOperandColumnArgs{\n\t\t\t\t\t\tName: pulumi.String(\"value\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tThreshold: \u0026databricks.AlertConditionThresholdArgs{\n\t\t\t\t\tValue: \u0026databricks.AlertConditionThresholdValueArgs{\n\t\t\t\t\t\tDoubleValue: pulumi.Float64(42),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_directory\" \"shared_dir\" {\n path = \"/Shared/Queries\"\n}\n# This will be replaced with new databricks_query resource\nresource \"databricks_query\" \"this\" {\n warehouse_id = example.id\n display_name = \"My Query Name\"\n query_text = \"SELECT 42 as value\"\n parent_path = databricks_directory.shared_dir.path\n}\nresource \"databricks_alert\" \"alert\" {\n query_id = databricks_query.this.id\n display_name = \"TF new alert\"\n parent_path = databricks_directory.shared_dir.path\n condition = {\n op = \"GREATER_THAN\"\n operand = {\n column = {\n name = \"value\"\n }\n }\n threshold = {\n value = {\n double_value = 42\n }\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Directory;\nimport com.pulumi.databricks.DirectoryArgs;\nimport com.pulumi.databricks.Query;\nimport com.pulumi.databricks.QueryArgs;\nimport com.pulumi.databricks.Alert;\nimport com.pulumi.databricks.AlertArgs;\nimport com.pulumi.databricks.inputs.AlertConditionArgs;\nimport com.pulumi.databricks.inputs.AlertConditionOperandArgs;\nimport com.pulumi.databricks.inputs.AlertConditionOperandColumnArgs;\nimport com.pulumi.databricks.inputs.AlertConditionThresholdArgs;\nimport com.pulumi.databricks.inputs.AlertConditionThresholdValueArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sharedDir = new Directory(\"sharedDir\", DirectoryArgs.builder()\n .path(\"/Shared/Queries\")\n .build());\n\n // This will be replaced with new databricks_query resource\n var this_ = new Query(\"this\", QueryArgs.builder()\n .warehouseId(example.id())\n .displayName(\"My Query Name\")\n .queryText(\"SELECT 42 as value\")\n .parentPath(sharedDir.path())\n .build());\n\n var alert = new Alert(\"alert\", AlertArgs.builder()\n .queryId(this_.id())\n .displayName(\"TF new alert\")\n .parentPath(sharedDir.path())\n .condition(AlertConditionArgs.builder()\n .op(\"GREATER_THAN\")\n .operand(AlertConditionOperandArgs.builder()\n .column(AlertConditionOperandColumnArgs.builder()\n .name(\"value\")\n .build())\n .build())\n .threshold(AlertConditionThresholdArgs.builder()\n .value(AlertConditionThresholdValueArgs.builder()\n .doubleValue(42.0)\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sharedDir:\n type: databricks:Directory\n name: shared_dir\n properties:\n path: /Shared/Queries\n # This will be replaced with new databricks_query resource\n this:\n type: databricks:Query\n properties:\n warehouseId: ${example.id}\n displayName: My Query Name\n queryText: SELECT 42 as value\n parentPath: ${sharedDir.path}\n alert:\n type: databricks:Alert\n properties:\n queryId: ${this.id}\n displayName: TF new alert\n parentPath: ${sharedDir.path}\n condition:\n op: GREATER_THAN\n operand:\n column:\n name: value\n threshold:\n value:\n doubleValue: 42\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Migrating from \u003cspan pulumi-lang-nodejs=\"`databricks.SqlAlert`\" pulumi-lang-dotnet=\"`databricks.SqlAlert`\" pulumi-lang-go=\"`SqlAlert`\" pulumi-lang-python=\"`SqlAlert`\" pulumi-lang-yaml=\"`databricks.SqlAlert`\" pulumi-lang-java=\"`databricks.SqlAlert`\" pulumi-lang-hcl=\"`databricks_sql_alert`\"\u003e`databricks.SqlAlert`\u003c/span\u003e resource\n\nUnder the hood, the new resource uses the same data as the \u003cspan pulumi-lang-nodejs=\"`databricks.SqlAlert`\" pulumi-lang-dotnet=\"`databricks.SqlAlert`\" pulumi-lang-go=\"`SqlAlert`\" pulumi-lang-python=\"`SqlAlert`\" pulumi-lang-yaml=\"`databricks.SqlAlert`\" pulumi-lang-java=\"`databricks.SqlAlert`\" pulumi-lang-hcl=\"`databricks_sql_alert`\"\u003e`databricks.SqlAlert`\u003c/span\u003e, but is exposed via a different API. This means that we can migrate existing alerts without recreating them. \n\n\u003e It's also recommended to migrate to the \u003cspan pulumi-lang-nodejs=\"`databricks.Query`\" pulumi-lang-dotnet=\"`databricks.Query`\" pulumi-lang-go=\"`Query`\" pulumi-lang-python=\"`Query`\" pulumi-lang-yaml=\"`databricks.Query`\" pulumi-lang-java=\"`databricks.Query`\" pulumi-lang-hcl=\"`databricks_query`\"\u003e`databricks.Query`\u003c/span\u003e resource - see\u003cspan pulumi-lang-nodejs=\" databricks.Query \" pulumi-lang-dotnet=\" databricks.Query \" pulumi-lang-go=\" Query \" pulumi-lang-python=\" Query \" pulumi-lang-yaml=\" databricks.Query \" pulumi-lang-java=\" databricks.Query \" pulumi-lang-hcl=\" databricks_query \"\u003e databricks.Query \u003c/span\u003efor more details.\n\nThis operation is done in few steps:\n\n* Record the ID of existing \u003cspan pulumi-lang-nodejs=\"`databricks.SqlAlert`\" pulumi-lang-dotnet=\"`databricks.SqlAlert`\" pulumi-lang-go=\"`SqlAlert`\" pulumi-lang-python=\"`SqlAlert`\" pulumi-lang-yaml=\"`databricks.SqlAlert`\" pulumi-lang-java=\"`databricks.SqlAlert`\" pulumi-lang-hcl=\"`databricks_sql_alert`\"\u003e`databricks.SqlAlert`\u003c/span\u003e, for example, by executing the `terraform state show databricks_sql_alert.alert` command.\n* Create the code for the new implementation by performing the following changes:\n * the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e attribute is now named \u003cspan pulumi-lang-nodejs=\"`displayName`\" pulumi-lang-dotnet=\"`DisplayName`\" pulumi-lang-go=\"`displayName`\" pulumi-lang-python=\"`display_name`\" pulumi-lang-yaml=\"`displayName`\" pulumi-lang-java=\"`displayName`\" pulumi-lang-hcl=\"`display_name`\"\u003e`displayName`\u003c/span\u003e\n * the \u003cspan pulumi-lang-nodejs=\"`parent`\" pulumi-lang-dotnet=\"`Parent`\" pulumi-lang-go=\"`parent`\" pulumi-lang-python=\"`parent`\" pulumi-lang-yaml=\"`parent`\" pulumi-lang-java=\"`parent`\" pulumi-lang-hcl=\"`parent`\"\u003e`parent`\u003c/span\u003e (if exists) is renamed to \u003cspan pulumi-lang-nodejs=\"`parentPath`\" pulumi-lang-dotnet=\"`ParentPath`\" pulumi-lang-go=\"`parentPath`\" pulumi-lang-python=\"`parent_path`\" pulumi-lang-yaml=\"`parentPath`\" pulumi-lang-java=\"`parentPath`\" pulumi-lang-hcl=\"`parent_path`\"\u003e`parentPath`\u003c/span\u003e attribute and should be converted from `folders/object_id` to the actual path.\n * the \u003cspan pulumi-lang-nodejs=\"`options`\" pulumi-lang-dotnet=\"`Options`\" pulumi-lang-go=\"`options`\" pulumi-lang-python=\"`options`\" pulumi-lang-yaml=\"`options`\" pulumi-lang-java=\"`options`\" pulumi-lang-hcl=\"`options`\"\u003e`options`\u003c/span\u003e block is converted into the \u003cspan pulumi-lang-nodejs=\"`condition`\" pulumi-lang-dotnet=\"`Condition`\" pulumi-lang-go=\"`condition`\" pulumi-lang-python=\"`condition`\" pulumi-lang-yaml=\"`condition`\" pulumi-lang-java=\"`condition`\" pulumi-lang-hcl=\"`condition`\"\u003e`condition`\u003c/span\u003e block with the following changes:\n * the value of the \u003cspan pulumi-lang-nodejs=\"`op`\" pulumi-lang-dotnet=\"`Op`\" pulumi-lang-go=\"`op`\" pulumi-lang-python=\"`op`\" pulumi-lang-yaml=\"`op`\" pulumi-lang-java=\"`op`\" pulumi-lang-hcl=\"`op`\"\u003e`op`\u003c/span\u003e attribute should be converted from a mathematical operator into a string name, like, `\u003e` is becoming `GREATER_THAN`, `==` is becoming `EQUAL`, etc.\n * the \u003cspan pulumi-lang-nodejs=\"`column`\" pulumi-lang-dotnet=\"`Column`\" pulumi-lang-go=\"`column`\" pulumi-lang-python=\"`column`\" pulumi-lang-yaml=\"`column`\" pulumi-lang-java=\"`column`\" pulumi-lang-hcl=\"`column`\"\u003e`column`\u003c/span\u003e attribute is becoming the \u003cspan pulumi-lang-nodejs=\"`operand`\" pulumi-lang-dotnet=\"`Operand`\" pulumi-lang-go=\"`operand`\" pulumi-lang-python=\"`operand`\" pulumi-lang-yaml=\"`operand`\" pulumi-lang-java=\"`operand`\" pulumi-lang-hcl=\"`operand`\"\u003e`operand`\u003c/span\u003e block\n * the \u003cspan pulumi-lang-nodejs=\"`value`\" pulumi-lang-dotnet=\"`Value`\" pulumi-lang-go=\"`value`\" pulumi-lang-python=\"`value`\" pulumi-lang-yaml=\"`value`\" pulumi-lang-java=\"`value`\" pulumi-lang-hcl=\"`value`\"\u003e`value`\u003c/span\u003e attribute is becoming the \u003cspan pulumi-lang-nodejs=\"`threshold`\" pulumi-lang-dotnet=\"`Threshold`\" pulumi-lang-go=\"`threshold`\" pulumi-lang-python=\"`threshold`\" pulumi-lang-yaml=\"`threshold`\" pulumi-lang-java=\"`threshold`\" pulumi-lang-hcl=\"`threshold`\"\u003e`threshold`\u003c/span\u003e block. **Please note that the old implementation always used strings so you may have changes after import if you use \u003cspan pulumi-lang-nodejs=\"`doubleValue`\" pulumi-lang-dotnet=\"`DoubleValue`\" pulumi-lang-go=\"`doubleValue`\" pulumi-lang-python=\"`double_value`\" pulumi-lang-yaml=\"`doubleValue`\" pulumi-lang-java=\"`doubleValue`\" pulumi-lang-hcl=\"`double_value`\"\u003e`doubleValue`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`boolValue`\" pulumi-lang-dotnet=\"`BoolValue`\" pulumi-lang-go=\"`boolValue`\" pulumi-lang-python=\"`bool_value`\" pulumi-lang-yaml=\"`boolValue`\" pulumi-lang-java=\"`boolValue`\" pulumi-lang-hcl=\"`bool_value`\"\u003e`boolValue`\u003c/span\u003e inside the block.**\n * the \u003cspan pulumi-lang-nodejs=\"`rearm`\" pulumi-lang-dotnet=\"`Rearm`\" pulumi-lang-go=\"`rearm`\" pulumi-lang-python=\"`rearm`\" pulumi-lang-yaml=\"`rearm`\" pulumi-lang-java=\"`rearm`\" pulumi-lang-hcl=\"`rearm`\"\u003e`rearm`\u003c/span\u003e attribute is renamed to \u003cspan pulumi-lang-nodejs=\"`secondsToRetrigger`\" pulumi-lang-dotnet=\"`SecondsToRetrigger`\" pulumi-lang-go=\"`secondsToRetrigger`\" pulumi-lang-python=\"`seconds_to_retrigger`\" pulumi-lang-yaml=\"`secondsToRetrigger`\" pulumi-lang-java=\"`secondsToRetrigger`\" pulumi-lang-hcl=\"`seconds_to_retrigger`\"\u003e`secondsToRetrigger`\u003c/span\u003e.\n \nFor example, if we have the original \u003cspan pulumi-lang-nodejs=\"`databricks.SqlAlert`\" pulumi-lang-dotnet=\"`databricks.SqlAlert`\" pulumi-lang-go=\"`SqlAlert`\" pulumi-lang-python=\"`SqlAlert`\" pulumi-lang-yaml=\"`databricks.SqlAlert`\" pulumi-lang-java=\"`databricks.SqlAlert`\" pulumi-lang-hcl=\"`databricks_sql_alert`\"\u003e`databricks.SqlAlert`\u003c/span\u003e defined as:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst alert = new databricks.SqlAlert(\"alert\", {\n queryId: _this.id,\n name: \"My Alert\",\n parent: `folders/${sharedDir.objectId}`,\n options: {\n column: \"value\",\n op: \"\u003e\",\n value: \"42\",\n muted: false,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nalert = databricks.SqlAlert(\"alert\",\n query_id=this[\"id\"],\n name=\"My Alert\",\n parent=f\"folders/{shared_dir['objectId']}\",\n options={\n \"column\": \"value\",\n \"op\": \"\u003e\",\n \"value\": \"42\",\n \"muted\": False,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var alert = new Databricks.SqlAlert(\"alert\", new()\n {\n QueryId = @this.Id,\n Name = \"My Alert\",\n Parent = $\"folders/{sharedDir.ObjectId}\",\n Options = new Databricks.Inputs.SqlAlertOptionsArgs\n {\n Column = \"value\",\n Op = \"\u003e\",\n Value = \"42\",\n Muted = false,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewSqlAlert(ctx, \"alert\", \u0026databricks.SqlAlertArgs{\n\t\t\tQueryId: pulumi.Any(this.Id),\n\t\t\tName: pulumi.String(\"My Alert\"),\n\t\t\tParent: pulumi.Sprintf(\"folders/%v\", sharedDir.ObjectId),\n\t\t\tOptions: \u0026databricks.SqlAlertOptionsArgs{\n\t\t\t\tColumn: pulumi.String(\"value\"),\n\t\t\t\tOp: pulumi.String(\"\u003e\"),\n\t\t\t\tValue: pulumi.String(\"42\"),\n\t\t\t\tMuted: pulumi.Bool(false),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_sqlalert\" \"alert\" {\n query_id = this.id\n name = \"My Alert\"\n parent =\"folders/${sharedDir.objectId}\"\n options = {\n column = \"value\"\n op = \"\u003e\"\n value = \"42\"\n muted = false\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.SqlAlert;\nimport com.pulumi.databricks.SqlAlertArgs;\nimport com.pulumi.databricks.inputs.SqlAlertOptionsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var alert = new SqlAlert(\"alert\", SqlAlertArgs.builder()\n .queryId(this_.id())\n .name(\"My Alert\")\n .parent(String.format(\"folders/%s\", sharedDir.objectId()))\n .options(SqlAlertOptionsArgs.builder()\n .column(\"value\")\n .op(\"\u003e\")\n .value(\"42\")\n .muted(false)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n alert:\n type: databricks:SqlAlert\n properties:\n queryId: ${this.id}\n name: My Alert\n parent: folders/${sharedDir.objectId}\n options:\n column: value\n op: '\u003e'\n value: '42'\n muted: false\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nwe'll have a new resource defined as:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst alert = new databricks.Alert(\"alert\", {\n queryId: _this.id,\n displayName: \"My Alert\",\n parentPath: sharedDir.path,\n condition: {\n op: \"GREATER_THAN\",\n operand: {\n column: {\n name: \"value\",\n },\n },\n threshold: {\n value: {\n doubleValue: 42,\n },\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nalert = databricks.Alert(\"alert\",\n query_id=this[\"id\"],\n display_name=\"My Alert\",\n parent_path=shared_dir[\"path\"],\n condition={\n \"op\": \"GREATER_THAN\",\n \"operand\": {\n \"column\": {\n \"name\": \"value\",\n },\n },\n \"threshold\": {\n \"value\": {\n \"double_value\": float(42),\n },\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var alert = new Databricks.Alert(\"alert\", new()\n {\n QueryId = @this.Id,\n DisplayName = \"My Alert\",\n ParentPath = sharedDir.Path,\n Condition = new Databricks.Inputs.AlertConditionArgs\n {\n Op = \"GREATER_THAN\",\n Operand = new Databricks.Inputs.AlertConditionOperandArgs\n {\n Column = new Databricks.Inputs.AlertConditionOperandColumnArgs\n {\n Name = \"value\",\n },\n },\n Threshold = new Databricks.Inputs.AlertConditionThresholdArgs\n {\n Value = new Databricks.Inputs.AlertConditionThresholdValueArgs\n {\n DoubleValue = 42,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAlert(ctx, \"alert\", \u0026databricks.AlertArgs{\n\t\t\tQueryId: pulumi.Any(this.Id),\n\t\t\tDisplayName: pulumi.String(\"My Alert\"),\n\t\t\tParentPath: pulumi.Any(sharedDir.Path),\n\t\t\tCondition: \u0026databricks.AlertConditionArgs{\n\t\t\t\tOp: pulumi.String(\"GREATER_THAN\"),\n\t\t\t\tOperand: \u0026databricks.AlertConditionOperandArgs{\n\t\t\t\t\tColumn: \u0026databricks.AlertConditionOperandColumnArgs{\n\t\t\t\t\t\tName: pulumi.String(\"value\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tThreshold: \u0026databricks.AlertConditionThresholdArgs{\n\t\t\t\t\tValue: \u0026databricks.AlertConditionThresholdValueArgs{\n\t\t\t\t\t\tDoubleValue: pulumi.Float64(42),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_alert\" \"alert\" {\n query_id = this.id\n display_name = \"My Alert\"\n parent_path = sharedDir.path\n condition = {\n op = \"GREATER_THAN\"\n operand = {\n column = {\n name = \"value\"\n }\n }\n threshold = {\n value = {\n double_value = 42\n }\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Alert;\nimport com.pulumi.databricks.AlertArgs;\nimport com.pulumi.databricks.inputs.AlertConditionArgs;\nimport com.pulumi.databricks.inputs.AlertConditionOperandArgs;\nimport com.pulumi.databricks.inputs.AlertConditionOperandColumnArgs;\nimport com.pulumi.databricks.inputs.AlertConditionThresholdArgs;\nimport com.pulumi.databricks.inputs.AlertConditionThresholdValueArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var alert = new Alert(\"alert\", AlertArgs.builder()\n .queryId(this_.id())\n .displayName(\"My Alert\")\n .parentPath(sharedDir.path())\n .condition(AlertConditionArgs.builder()\n .op(\"GREATER_THAN\")\n .operand(AlertConditionOperandArgs.builder()\n .column(AlertConditionOperandColumnArgs.builder()\n .name(\"value\")\n .build())\n .build())\n .threshold(AlertConditionThresholdArgs.builder()\n .value(AlertConditionThresholdValueArgs.builder()\n .doubleValue(42.0)\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n alert:\n type: databricks:Alert\n properties:\n queryId: ${this.id}\n displayName: My Alert\n parentPath: ${sharedDir.path}\n condition:\n op: GREATER_THAN\n operand:\n column:\n name: value\n threshold:\n value:\n doubleValue: 42\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\u003cspan pulumi-lang-nodejs=\"\ndatabricks.Permissions \" pulumi-lang-dotnet=\"\ndatabricks.Permissions \" pulumi-lang-go=\"\nPermissions \" pulumi-lang-python=\"\nPermissions \" pulumi-lang-yaml=\"\ndatabricks.Permissions \" pulumi-lang-java=\"\ndatabricks.Permissions \" pulumi-lang-hcl=\"\ndatabricks_permissions \"\u003e\ndatabricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Manage*, *Edit*, *Run* or *View* individual alerts.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst alertUsage = new databricks.Permissions(\"alert_usage\", {\n sqlAlertId: alert.id,\n accessControls: [{\n groupName: \"users\",\n permissionLevel: \"CAN_RUN\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nalert_usage = databricks.Permissions(\"alert_usage\",\n sql_alert_id=alert[\"id\"],\n access_controls=[{\n \"group_name\": \"users\",\n \"permission_level\": \"CAN_RUN\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var alertUsage = new Databricks.Permissions(\"alert_usage\", new()\n {\n SqlAlertId = alert.Id,\n AccessControls = new[]\n {\n new Databricks.Inputs.PermissionsAccessControlArgs\n {\n GroupName = \"users\",\n PermissionLevel = \"CAN_RUN\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewPermissions(ctx, \"alert_usage\", \u0026databricks.PermissionsArgs{\n\t\t\tSqlAlertId: pulumi.Any(alert.Id),\n\t\t\tAccessControls: databricks.PermissionsAccessControlArray{\n\t\t\t\t\u0026databricks.PermissionsAccessControlArgs{\n\t\t\t\t\tGroupName: pulumi.String(\"users\"),\n\t\t\t\t\tPermissionLevel: pulumi.String(\"CAN_RUN\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_permissions\" \"alert_usage\" {\n sql_alert_id = alert.id\n access_controls {\n group_name = \"users\"\n permission_level = \"CAN_RUN\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Permissions;\nimport com.pulumi.databricks.PermissionsArgs;\nimport com.pulumi.databricks.inputs.PermissionsAccessControlArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var alertUsage = new Permissions(\"alertUsage\", PermissionsArgs.builder()\n .sqlAlertId(alert.id())\n .accessControls(PermissionsAccessControlArgs.builder()\n .groupName(\"users\")\n .permissionLevel(\"CAN_RUN\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n alertUsage:\n type: databricks:Permissions\n name: alert_usage\n properties:\n sqlAlertId: ${alert.id}\n accessControls:\n - groupName: users\n permissionLevel: CAN_RUN\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\u003cspan pulumi-lang-nodejs=\"\ndatabricks.Permissions \" pulumi-lang-dotnet=\"\ndatabricks.Permissions \" pulumi-lang-go=\"\nPermissions \" pulumi-lang-python=\"\nPermissions \" pulumi-lang-yaml=\"\ndatabricks.Permissions \" pulumi-lang-java=\"\ndatabricks.Permissions \" pulumi-lang-hcl=\"\ndatabricks_permissions \"\u003e\ndatabricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Manage*, *Edit*, *Run* or *View* individual alerts.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst alertUsage = new databricks.Permissions(\"alert_usage\", {\n sqlAlertId: alert.id,\n accessControls: [{\n groupName: \"users\",\n permissionLevel: \"CAN_RUN\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nalert_usage = databricks.Permissions(\"alert_usage\",\n sql_alert_id=alert[\"id\"],\n access_controls=[{\n \"group_name\": \"users\",\n \"permission_level\": \"CAN_RUN\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var alertUsage = new Databricks.Permissions(\"alert_usage\", new()\n {\n SqlAlertId = alert.Id,\n AccessControls = new[]\n {\n new Databricks.Inputs.PermissionsAccessControlArgs\n {\n GroupName = \"users\",\n PermissionLevel = \"CAN_RUN\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewPermissions(ctx, \"alert_usage\", \u0026databricks.PermissionsArgs{\n\t\t\tSqlAlertId: pulumi.Any(alert.Id),\n\t\t\tAccessControls: databricks.PermissionsAccessControlArray{\n\t\t\t\t\u0026databricks.PermissionsAccessControlArgs{\n\t\t\t\t\tGroupName: pulumi.String(\"users\"),\n\t\t\t\t\tPermissionLevel: pulumi.String(\"CAN_RUN\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_permissions\" \"alert_usage\" {\n sql_alert_id = alert.id\n access_controls {\n group_name = \"users\"\n permission_level = \"CAN_RUN\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Permissions;\nimport com.pulumi.databricks.PermissionsArgs;\nimport com.pulumi.databricks.inputs.PermissionsAccessControlArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var alertUsage = new Permissions(\"alertUsage\", PermissionsArgs.builder()\n .sqlAlertId(alert.id())\n .accessControls(PermissionsAccessControlArgs.builder()\n .groupName(\"users\")\n .permissionLevel(\"CAN_RUN\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n alertUsage:\n type: databricks:Permissions\n name: alert_usage\n properties:\n sqlAlertId: ${alert.id}\n accessControls:\n - groupName: users\n permissionLevel: CAN_RUN\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Query \" pulumi-lang-dotnet=\" databricks.Query \" pulumi-lang-go=\" Query \" pulumi-lang-python=\" Query \" pulumi-lang-yaml=\" databricks.Query \" pulumi-lang-java=\" databricks.Query \" pulumi-lang-hcl=\" databricks_query \"\u003e databricks.Query \u003c/span\u003eto manage [Databricks SQL Queries](https://docs.databricks.com/sql/user/queries/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.SqlEndpoint \" pulumi-lang-dotnet=\" databricks.SqlEndpoint \" pulumi-lang-go=\" SqlEndpoint \" pulumi-lang-python=\" SqlEndpoint \" pulumi-lang-yaml=\" databricks.SqlEndpoint \" pulumi-lang-java=\" databricks.SqlEndpoint \" pulumi-lang-hcl=\" databricks_sql_endpoint \"\u003e databricks.SqlEndpoint \u003c/span\u003eto manage [Databricks SQL Endpoints](https://docs.databricks.com/sql/admin/sql-endpoints.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Directory \" pulumi-lang-dotnet=\" databricks.Directory \" pulumi-lang-go=\" Directory \" pulumi-lang-python=\" Directory \" pulumi-lang-yaml=\" databricks.Directory \" pulumi-lang-java=\" databricks.Directory \" pulumi-lang-hcl=\" databricks_directory \"\u003e databricks.Directory \u003c/span\u003eto manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).\n\n", "properties": { "condition": { "$ref": "#/types/databricks:index/AlertCondition:AlertCondition", "description": "Trigger conditions of the alert. Block consists of the following attributes:\n" }, "createTime": { "type": "string", "description": "The timestamp string indicating when the alert was created.\n" }, "customBody": { "type": "string", "description": "Custom body of alert notification, if it exists. See [Alerts API reference](https://docs.databricks.com/en/sql/user/alerts/index.html) for custom templating instructions.\n" }, "customSubject": { "type": "string", "description": "Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See [Alerts API reference](https://docs.databricks.com/en/sql/user/alerts/index.html) for custom templating instructions.\n" }, "displayName": { "type": "string", "description": "Name of the alert.\n" }, "lifecycleState": { "type": "string", "description": "The workspace state of the alert. Used for tracking trashed status. (Possible values are `ACTIVE` or `TRASHED`).\n" }, "notifyOnOk": { "type": "boolean", "description": "Whether to notify alert subscribers when alert returns back to normal.\n" }, "ownerUserName": { "type": "string", "description": "Alert owner's username.\n" }, "parentPath": { "type": "string", "description": "The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AlertProviderConfig:AlertProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "queryId": { "type": "string", "description": "ID of the query evaluated by the alert.\n" }, "secondsToRetrigger": { "type": "integer", "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.\n" }, "state": { "type": "string", "description": "Current state of the alert's trigger status (`UNKNOWN`, `OK`, `TRIGGERED`). This field is set to `UNKNOWN` if the alert has not yet been evaluated or ran into an error during the last evaluation.\n" }, "triggerTime": { "type": "string", "description": "The timestamp string when the alert was last triggered if the alert has been triggered before.\n" }, "updateTime": { "type": "string", "description": "The timestamp string indicating when the alert was updated.\n" } }, "required": [ "condition", "createTime", "displayName", "lifecycleState", "providerConfig", "queryId", "state", "triggerTime", "updateTime" ], "inputProperties": { "condition": { "$ref": "#/types/databricks:index/AlertCondition:AlertCondition", "description": "Trigger conditions of the alert. Block consists of the following attributes:\n" }, "customBody": { "type": "string", "description": "Custom body of alert notification, if it exists. See [Alerts API reference](https://docs.databricks.com/en/sql/user/alerts/index.html) for custom templating instructions.\n" }, "customSubject": { "type": "string", "description": "Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See [Alerts API reference](https://docs.databricks.com/en/sql/user/alerts/index.html) for custom templating instructions.\n" }, "displayName": { "type": "string", "description": "Name of the alert.\n" }, "notifyOnOk": { "type": "boolean", "description": "Whether to notify alert subscribers when alert returns back to normal.\n" }, "ownerUserName": { "type": "string", "description": "Alert owner's username.\n" }, "parentPath": { "type": "string", "description": "The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/AlertProviderConfig:AlertProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "queryId": { "type": "string", "description": "ID of the query evaluated by the alert.\n" }, "secondsToRetrigger": { "type": "integer", "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.\n" } }, "requiredInputs": [ "condition", "displayName", "queryId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Alert resources.\n", "properties": { "condition": { "$ref": "#/types/databricks:index/AlertCondition:AlertCondition", "description": "Trigger conditions of the alert. Block consists of the following attributes:\n" }, "createTime": { "type": "string", "description": "The timestamp string indicating when the alert was created.\n" }, "customBody": { "type": "string", "description": "Custom body of alert notification, if it exists. See [Alerts API reference](https://docs.databricks.com/en/sql/user/alerts/index.html) for custom templating instructions.\n" }, "customSubject": { "type": "string", "description": "Custom subject of alert notification, if it exists. This includes email subject, Slack notification header, etc. See [Alerts API reference](https://docs.databricks.com/en/sql/user/alerts/index.html) for custom templating instructions.\n" }, "displayName": { "type": "string", "description": "Name of the alert.\n" }, "lifecycleState": { "type": "string", "description": "The workspace state of the alert. Used for tracking trashed status. (Possible values are `ACTIVE` or `TRASHED`).\n" }, "notifyOnOk": { "type": "boolean", "description": "Whether to notify alert subscribers when alert returns back to normal.\n" }, "ownerUserName": { "type": "string", "description": "Alert owner's username.\n" }, "parentPath": { "type": "string", "description": "The path to a workspace folder containing the alert. The default is the user's home folder. If changed, the alert will be recreated.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/AlertProviderConfig:AlertProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "queryId": { "type": "string", "description": "ID of the query evaluated by the alert.\n" }, "secondsToRetrigger": { "type": "integer", "description": "Number of seconds an alert must wait after being triggered to rearm itself. After rearming, it can be triggered again. If 0 or not specified, the alert will not be triggered again.\n" }, "state": { "type": "string", "description": "Current state of the alert's trigger status (`UNKNOWN`, `OK`, `TRIGGERED`). This field is set to `UNKNOWN` if the alert has not yet been evaluated or ran into an error during the last evaluation.\n" }, "triggerTime": { "type": "string", "description": "The timestamp string when the alert was last triggered if the alert has been triggered before.\n" }, "updateTime": { "type": "string", "description": "The timestamp string indicating when the alert was updated.\n" } }, "type": "object" } }, "databricks:index/alertV2:AlertV2": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/alertsv2)\n\nThe Alert v2 resource allows you to manage SQL alerts in Databricks SQL. Alerts monitor query results and notify you when specific conditions are met.\n\nAlerts run on a schedule and evaluate query results against defined thresholds. When an alert is triggered, notifications can be sent to specified users or destinations.\n\n## Example Usage\n\n### Basic Alert Example\nThis example creates a basic alert that monitors a query and sends notifications to a user when the value exceeds a threshold:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst basicAlert = new databricks.AlertV2(\"basic_alert\", {\n displayName: \"High Error Rate Alert\",\n queryText: \"SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\",\n warehouseId: \"a7066a8ef796be84\",\n parentPath: \"/Users/user@example.com\",\n evaluation: {\n source: {\n name: \"error_count\",\n display: \"Error Count\",\n aggregation: \"COUNT\",\n },\n comparisonOperator: \"GREATER_THAN\",\n threshold: {\n value: {\n doubleValue: 100,\n },\n },\n emptyResultState: \"OK\",\n notification: {\n subscriptions: [{\n userEmail: \"user@example.com\",\n }],\n notifyOnOk: true,\n },\n },\n schedule: {\n quartzCronSchedule: \"0 0/15 * * * ?\",\n timezoneId: \"America/Los_Angeles\",\n pauseStatus: \"UNPAUSED\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nbasic_alert = databricks.AlertV2(\"basic_alert\",\n display_name=\"High Error Rate Alert\",\n query_text=\"SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\",\n warehouse_id=\"a7066a8ef796be84\",\n parent_path=\"/Users/user@example.com\",\n evaluation={\n \"source\": {\n \"name\": \"error_count\",\n \"display\": \"Error Count\",\n \"aggregation\": \"COUNT\",\n },\n \"comparison_operator\": \"GREATER_THAN\",\n \"threshold\": {\n \"value\": {\n \"double_value\": float(100),\n },\n },\n \"empty_result_state\": \"OK\",\n \"notification\": {\n \"subscriptions\": [{\n \"user_email\": \"user@example.com\",\n }],\n \"notify_on_ok\": True,\n },\n },\n schedule={\n \"quartz_cron_schedule\": \"0 0/15 * * * ?\",\n \"timezone_id\": \"America/Los_Angeles\",\n \"pause_status\": \"UNPAUSED\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var basicAlert = new Databricks.AlertV2(\"basic_alert\", new()\n {\n DisplayName = \"High Error Rate Alert\",\n QueryText = \"SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\",\n WarehouseId = \"a7066a8ef796be84\",\n ParentPath = \"/Users/user@example.com\",\n Evaluation = new Databricks.Inputs.AlertV2EvaluationArgs\n {\n Source = new Databricks.Inputs.AlertV2EvaluationSourceArgs\n {\n Name = \"error_count\",\n Display = \"Error Count\",\n Aggregation = \"COUNT\",\n },\n ComparisonOperator = \"GREATER_THAN\",\n Threshold = new Databricks.Inputs.AlertV2EvaluationThresholdArgs\n {\n Value = new Databricks.Inputs.AlertV2EvaluationThresholdValueArgs\n {\n DoubleValue = 100,\n },\n },\n EmptyResultState = \"OK\",\n Notification = new Databricks.Inputs.AlertV2EvaluationNotificationArgs\n {\n Subscriptions = new[]\n {\n new Databricks.Inputs.AlertV2EvaluationNotificationSubscriptionArgs\n {\n UserEmail = \"user@example.com\",\n },\n },\n NotifyOnOk = true,\n },\n },\n Schedule = new Databricks.Inputs.AlertV2ScheduleArgs\n {\n QuartzCronSchedule = \"0 0/15 * * * ?\",\n TimezoneId = \"America/Los_Angeles\",\n PauseStatus = \"UNPAUSED\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAlertV2(ctx, \"basic_alert\", \u0026databricks.AlertV2Args{\n\t\t\tDisplayName: pulumi.String(\"High Error Rate Alert\"),\n\t\t\tQueryText: pulumi.String(\"SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\"),\n\t\t\tWarehouseId: pulumi.String(\"a7066a8ef796be84\"),\n\t\t\tParentPath: pulumi.String(\"/Users/user@example.com\"),\n\t\t\tEvaluation: \u0026databricks.AlertV2EvaluationArgs{\n\t\t\t\tSource: \u0026databricks.AlertV2EvaluationSourceArgs{\n\t\t\t\t\tName: pulumi.String(\"error_count\"),\n\t\t\t\t\tDisplay: pulumi.String(\"Error Count\"),\n\t\t\t\t\tAggregation: pulumi.String(\"COUNT\"),\n\t\t\t\t},\n\t\t\t\tComparisonOperator: pulumi.String(\"GREATER_THAN\"),\n\t\t\t\tThreshold: \u0026databricks.AlertV2EvaluationThresholdArgs{\n\t\t\t\t\tValue: \u0026databricks.AlertV2EvaluationThresholdValueArgs{\n\t\t\t\t\t\tDoubleValue: pulumi.Float64(100),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tEmptyResultState: pulumi.String(\"OK\"),\n\t\t\t\tNotification: \u0026databricks.AlertV2EvaluationNotificationArgs{\n\t\t\t\t\tSubscriptions: databricks.AlertV2EvaluationNotificationSubscriptionArray{\n\t\t\t\t\t\t\u0026databricks.AlertV2EvaluationNotificationSubscriptionArgs{\n\t\t\t\t\t\t\tUserEmail: pulumi.String(\"user@example.com\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tNotifyOnOk: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t\tSchedule: \u0026databricks.AlertV2ScheduleArgs{\n\t\t\t\tQuartzCronSchedule: pulumi.String(\"0 0/15 * * * ?\"),\n\t\t\t\tTimezoneId: pulumi.String(\"America/Los_Angeles\"),\n\t\t\t\tPauseStatus: pulumi.String(\"UNPAUSED\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_alertv2\" \"basic_alert\" {\n display_name = \"High Error Rate Alert\"\n query_text = \"SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\"\n warehouse_id = \"a7066a8ef796be84\"\n parent_path = \"/Users/user@example.com\"\n evaluation = {\n source = {\n name = \"error_count\"\n display = \"Error Count\"\n aggregation = \"COUNT\"\n }\n comparison_operator = \"GREATER_THAN\"\n threshold = {\n value = {\n double_value = 100\n }\n }\n empty_result_state = \"OK\"\n notification = {\n subscriptions = [{\n \"userEmail\" = \"user@example.com\"\n }]\n notify_on_ok = true\n }\n }\n schedule = {\n quartz_cron_schedule = \"0 0/15 * * * ?\"\n timezone_id = \"America/Los_Angeles\"\n pause_status = \"UNPAUSED\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AlertV2;\nimport com.pulumi.databricks.AlertV2Args;\nimport com.pulumi.databricks.inputs.AlertV2EvaluationArgs;\nimport com.pulumi.databricks.inputs.AlertV2EvaluationSourceArgs;\nimport com.pulumi.databricks.inputs.AlertV2EvaluationThresholdArgs;\nimport com.pulumi.databricks.inputs.AlertV2EvaluationThresholdValueArgs;\nimport com.pulumi.databricks.inputs.AlertV2EvaluationNotificationArgs;\nimport com.pulumi.databricks.inputs.AlertV2ScheduleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var basicAlert = new AlertV2(\"basicAlert\", AlertV2Args.builder()\n .displayName(\"High Error Rate Alert\")\n .queryText(\"SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\")\n .warehouseId(\"a7066a8ef796be84\")\n .parentPath(\"/Users/user@example.com\")\n .evaluation(AlertV2EvaluationArgs.builder()\n .source(AlertV2EvaluationSourceArgs.builder()\n .name(\"error_count\")\n .display(\"Error Count\")\n .aggregation(\"COUNT\")\n .build())\n .comparisonOperator(\"GREATER_THAN\")\n .threshold(AlertV2EvaluationThresholdArgs.builder()\n .value(AlertV2EvaluationThresholdValueArgs.builder()\n .doubleValue(100.0)\n .build())\n .build())\n .emptyResultState(\"OK\")\n .notification(AlertV2EvaluationNotificationArgs.builder()\n .subscriptions(AlertV2EvaluationNotificationSubscriptionArgs.builder()\n .userEmail(\"user@example.com\")\n .build())\n .notifyOnOk(true)\n .build())\n .build())\n .schedule(AlertV2ScheduleArgs.builder()\n .quartzCronSchedule(\"0 0/15 * * * ?\")\n .timezoneId(\"America/Los_Angeles\")\n .pauseStatus(\"UNPAUSED\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n basicAlert:\n type: databricks:AlertV2\n name: basic_alert\n properties:\n displayName: High Error Rate Alert\n queryText: SELECT count(*) as error_count FROM logs WHERE level = 'ERROR' AND timestamp \u003e now() - interval 1 hour\n warehouseId: a7066a8ef796be84\n parentPath: /Users/user@example.com\n evaluation:\n source:\n name: error_count\n display: Error Count\n aggregation: COUNT\n comparisonOperator: GREATER_THAN\n threshold:\n value:\n doubleValue: 100\n emptyResultState: OK\n notification:\n subscriptions:\n - userEmail: user@example.com\n notifyOnOk: true\n schedule:\n quartzCronSchedule: 0 0/15 * * * ?\n timezoneId: America/Los_Angeles\n pauseStatus: UNPAUSED\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "createTime": { "type": "string", "description": "(string) - The timestamp indicating when the alert was created\n" }, "customDescription": { "type": "string", "description": "Custom description for the alert. support mustache template\n" }, "customSummary": { "type": "string", "description": "Custom summary for the alert. support mustache template\n" }, "displayName": { "type": "string", "description": "The display name of the alert\n" }, "effectiveRunAs": { "$ref": "#/types/databricks:index/AlertV2EffectiveRunAs:AlertV2EffectiveRunAs", "description": "(AlertV2RunAs) - The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults\n" }, "evaluation": { "$ref": "#/types/databricks:index/AlertV2Evaluation:AlertV2Evaluation" }, "lifecycleState": { "type": "string", "description": "(string) - Indicates whether the query is trashed. Possible values are: `ACTIVE`, `DELETED`\n" }, "ownerUserName": { "type": "string", "description": "(string) - The owner's username. This field is set to \"Unavailable\" if the user has been deleted\n" }, "parentPath": { "type": "string", "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AlertV2ProviderConfig:AlertV2ProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeOnDelete": { "type": "boolean", "description": "Whether to permanently delete the alert. If not set, the alert will only be soft deleted\n" }, "queryText": { "type": "string", "description": "Text of the query to be run\n" }, "runAs": { "$ref": "#/types/databricks:index/AlertV2RunAs:AlertV2RunAs", "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set \u003cspan pulumi-lang-nodejs=\"`servicePrincipalName`\" pulumi-lang-dotnet=\"`ServicePrincipalName`\" pulumi-lang-go=\"`servicePrincipalName`\" pulumi-lang-python=\"`service_principal_name`\" pulumi-lang-yaml=\"`servicePrincipalName`\" pulumi-lang-java=\"`servicePrincipalName`\" pulumi-lang-hcl=\"`service_principal_name`\"\u003e`servicePrincipalName`\u003c/span\u003e to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user\n" }, "runAsUserName": { "type": "string", "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use \u003cspan pulumi-lang-nodejs=\"`runAs`\" pulumi-lang-dotnet=\"`RunAs`\" pulumi-lang-go=\"`runAs`\" pulumi-lang-python=\"`run_as`\" pulumi-lang-yaml=\"`runAs`\" pulumi-lang-java=\"`runAs`\" pulumi-lang-hcl=\"`run_as`\"\u003e`runAs`\u003c/span\u003e field instead. This field will be removed in a future release\n" }, "schedule": { "$ref": "#/types/databricks:index/AlertV2Schedule:AlertV2Schedule" }, "updateTime": { "type": "string", "description": "(string) - The timestamp indicating when the alert was updated\n" }, "warehouseId": { "type": "string", "description": "ID of the SQL warehouse attached to the alert\n" } }, "required": [ "createTime", "displayName", "effectiveRunAs", "evaluation", "lifecycleState", "ownerUserName", "providerConfig", "queryText", "schedule", "updateTime", "warehouseId" ], "inputProperties": { "customDescription": { "type": "string", "description": "Custom description for the alert. support mustache template\n" }, "customSummary": { "type": "string", "description": "Custom summary for the alert. support mustache template\n" }, "displayName": { "type": "string", "description": "The display name of the alert\n" }, "evaluation": { "$ref": "#/types/databricks:index/AlertV2Evaluation:AlertV2Evaluation" }, "parentPath": { "type": "string", "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AlertV2ProviderConfig:AlertV2ProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeOnDelete": { "type": "boolean", "description": "Whether to permanently delete the alert. If not set, the alert will only be soft deleted\n" }, "queryText": { "type": "string", "description": "Text of the query to be run\n" }, "runAs": { "$ref": "#/types/databricks:index/AlertV2RunAs:AlertV2RunAs", "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set \u003cspan pulumi-lang-nodejs=\"`servicePrincipalName`\" pulumi-lang-dotnet=\"`ServicePrincipalName`\" pulumi-lang-go=\"`servicePrincipalName`\" pulumi-lang-python=\"`service_principal_name`\" pulumi-lang-yaml=\"`servicePrincipalName`\" pulumi-lang-java=\"`servicePrincipalName`\" pulumi-lang-hcl=\"`service_principal_name`\"\u003e`servicePrincipalName`\u003c/span\u003e to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user\n" }, "runAsUserName": { "type": "string", "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use \u003cspan pulumi-lang-nodejs=\"`runAs`\" pulumi-lang-dotnet=\"`RunAs`\" pulumi-lang-go=\"`runAs`\" pulumi-lang-python=\"`run_as`\" pulumi-lang-yaml=\"`runAs`\" pulumi-lang-java=\"`runAs`\" pulumi-lang-hcl=\"`run_as`\"\u003e`runAs`\u003c/span\u003e field instead. This field will be removed in a future release\n" }, "schedule": { "$ref": "#/types/databricks:index/AlertV2Schedule:AlertV2Schedule" }, "warehouseId": { "type": "string", "description": "ID of the SQL warehouse attached to the alert\n" } }, "requiredInputs": [ "displayName", "evaluation", "queryText", "schedule", "warehouseId" ], "stateInputs": { "description": "Input properties used for looking up and filtering AlertV2 resources.\n", "properties": { "createTime": { "type": "string", "description": "(string) - The timestamp indicating when the alert was created\n" }, "customDescription": { "type": "string", "description": "Custom description for the alert. support mustache template\n" }, "customSummary": { "type": "string", "description": "Custom summary for the alert. support mustache template\n" }, "displayName": { "type": "string", "description": "The display name of the alert\n" }, "effectiveRunAs": { "$ref": "#/types/databricks:index/AlertV2EffectiveRunAs:AlertV2EffectiveRunAs", "description": "(AlertV2RunAs) - The actual identity that will be used to execute the alert.\nThis is an output-only field that shows the resolved run-as identity after applying\npermissions and defaults\n" }, "evaluation": { "$ref": "#/types/databricks:index/AlertV2Evaluation:AlertV2Evaluation" }, "lifecycleState": { "type": "string", "description": "(string) - Indicates whether the query is trashed. Possible values are: `ACTIVE`, `DELETED`\n" }, "ownerUserName": { "type": "string", "description": "(string) - The owner's username. This field is set to \"Unavailable\" if the user has been deleted\n" }, "parentPath": { "type": "string", "description": "The workspace path of the folder containing the alert. Can only be set on create, and cannot be updated\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AlertV2ProviderConfig:AlertV2ProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeOnDelete": { "type": "boolean", "description": "Whether to permanently delete the alert. If not set, the alert will only be soft deleted\n" }, "queryText": { "type": "string", "description": "Text of the query to be run\n" }, "runAs": { "$ref": "#/types/databricks:index/AlertV2RunAs:AlertV2RunAs", "description": "Specifies the identity that will be used to run the alert.\nThis field allows you to configure alerts to run as a specific user or service principal.\n- For user identity: Set \u003cspan pulumi-lang-nodejs=\"`userName`\" pulumi-lang-dotnet=\"`UserName`\" pulumi-lang-go=\"`userName`\" pulumi-lang-python=\"`user_name`\" pulumi-lang-yaml=\"`userName`\" pulumi-lang-java=\"`userName`\" pulumi-lang-hcl=\"`user_name`\"\u003e`userName`\u003c/span\u003e to the email of an active workspace user. Users can only set this to their own email.\n- For service principal: Set \u003cspan pulumi-lang-nodejs=\"`servicePrincipalName`\" pulumi-lang-dotnet=\"`ServicePrincipalName`\" pulumi-lang-go=\"`servicePrincipalName`\" pulumi-lang-python=\"`service_principal_name`\" pulumi-lang-yaml=\"`servicePrincipalName`\" pulumi-lang-java=\"`servicePrincipalName`\" pulumi-lang-hcl=\"`service_principal_name`\"\u003e`servicePrincipalName`\u003c/span\u003e to the application ID. Requires the `servicePrincipal/user` role.\nIf not specified, the alert will run as the request user\n" }, "runAsUserName": { "type": "string", "description": "The run as username or application ID of service principal.\nOn Create and Update, this field can be set to application ID of an active service principal. Setting this field requires the servicePrincipal/user role.\nDeprecated: Use \u003cspan pulumi-lang-nodejs=\"`runAs`\" pulumi-lang-dotnet=\"`RunAs`\" pulumi-lang-go=\"`runAs`\" pulumi-lang-python=\"`run_as`\" pulumi-lang-yaml=\"`runAs`\" pulumi-lang-java=\"`runAs`\" pulumi-lang-hcl=\"`run_as`\"\u003e`runAs`\u003c/span\u003e field instead. This field will be removed in a future release\n" }, "schedule": { "$ref": "#/types/databricks:index/AlertV2Schedule:AlertV2Schedule" }, "updateTime": { "type": "string", "description": "(string) - The timestamp indicating when the alert was updated\n" }, "warehouseId": { "type": "string", "description": "ID of the SQL warehouse attached to the alert\n" } }, "type": "object" } }, "databricks:index/app:App": { "description": "[Databricks Apps](https://docs.databricks.com/en/dev-tools/databricks-apps/index.html) run directly on a customer's Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on. This resource creates the application but does not handle app deployment, which should be handled separately as part of your CI/CD pipeline.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.App(\"this\", {\n name: \"my-custom-app\",\n description: \"My app\",\n resources: [\n {\n name: \"sql-warehouse\",\n sqlWarehouse: {\n id: \"e9ca293f79a74b5c\",\n permission: \"CAN_MANAGE\",\n },\n },\n {\n name: \"serving-endpoint\",\n servingEndpoint: {\n name: \"databricks-meta-llama-3-1-70b-instruct\",\n permission: \"CAN_MANAGE\",\n },\n },\n {\n name: \"job\",\n job: {\n id: \"1234\",\n permission: \"CAN_MANAGE\",\n },\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.App(\"this\",\n name=\"my-custom-app\",\n description=\"My app\",\n resources=[\n {\n \"name\": \"sql-warehouse\",\n \"sql_warehouse\": {\n \"id\": \"e9ca293f79a74b5c\",\n \"permission\": \"CAN_MANAGE\",\n },\n },\n {\n \"name\": \"serving-endpoint\",\n \"serving_endpoint\": {\n \"name\": \"databricks-meta-llama-3-1-70b-instruct\",\n \"permission\": \"CAN_MANAGE\",\n },\n },\n {\n \"name\": \"job\",\n \"job\": {\n \"id\": \"1234\",\n \"permission\": \"CAN_MANAGE\",\n },\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.App(\"this\", new()\n {\n Name = \"my-custom-app\",\n Description = \"My app\",\n Resources = new[]\n {\n new Databricks.Inputs.AppResourceArgs\n {\n Name = \"sql-warehouse\",\n SqlWarehouse = new Databricks.Inputs.AppResourceSqlWarehouseArgs\n {\n Id = \"e9ca293f79a74b5c\",\n Permission = \"CAN_MANAGE\",\n },\n },\n new Databricks.Inputs.AppResourceArgs\n {\n Name = \"serving-endpoint\",\n ServingEndpoint = new Databricks.Inputs.AppResourceServingEndpointArgs\n {\n Name = \"databricks-meta-llama-3-1-70b-instruct\",\n Permission = \"CAN_MANAGE\",\n },\n },\n new Databricks.Inputs.AppResourceArgs\n {\n Name = \"job\",\n Job = new Databricks.Inputs.AppResourceJobArgs\n {\n Id = \"1234\",\n Permission = \"CAN_MANAGE\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewApp(ctx, \"this\", \u0026databricks.AppArgs{\n\t\t\tName: pulumi.String(\"my-custom-app\"),\n\t\t\tDescription: pulumi.String(\"My app\"),\n\t\t\tResources: databricks.AppResourceArray{\n\t\t\t\t\u0026databricks.AppResourceArgs{\n\t\t\t\t\tName: pulumi.String(\"sql-warehouse\"),\n\t\t\t\t\tSqlWarehouse: \u0026databricks.AppResourceSqlWarehouseArgs{\n\t\t\t\t\t\tId: pulumi.String(\"e9ca293f79a74b5c\"),\n\t\t\t\t\t\tPermission: pulumi.String(\"CAN_MANAGE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.AppResourceArgs{\n\t\t\t\t\tName: pulumi.String(\"serving-endpoint\"),\n\t\t\t\t\tServingEndpoint: \u0026databricks.AppResourceServingEndpointArgs{\n\t\t\t\t\t\tName: pulumi.String(\"databricks-meta-llama-3-1-70b-instruct\"),\n\t\t\t\t\t\tPermission: pulumi.String(\"CAN_MANAGE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.AppResourceArgs{\n\t\t\t\t\tName: pulumi.String(\"job\"),\n\t\t\t\t\tJob: \u0026databricks.AppResourceJobArgs{\n\t\t\t\t\t\tId: pulumi.String(\"1234\"),\n\t\t\t\t\t\tPermission: pulumi.String(\"CAN_MANAGE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_app\" \"this\" {\n name = \"my-custom-app\"\n description = \"My app\"\n resources {\n name = \"sql-warehouse\"\n sql_warehouse = {\n id = \"e9ca293f79a74b5c\"\n permission = \"CAN_MANAGE\"\n }\n }\n resources {\n name = \"serving-endpoint\"\n serving_endpoint = {\n name = \"databricks-meta-llama-3-1-70b-instruct\"\n permission = \"CAN_MANAGE\"\n }\n }\n resources {\n name = \"job\"\n job = {\n id = \"1234\"\n permission = \"CAN_MANAGE\"\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.App;\nimport com.pulumi.databricks.AppArgs;\nimport com.pulumi.databricks.inputs.AppResourceArgs;\nimport com.pulumi.databricks.inputs.AppResourceSqlWarehouseArgs;\nimport com.pulumi.databricks.inputs.AppResourceServingEndpointArgs;\nimport com.pulumi.databricks.inputs.AppResourceJobArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new App(\"this\", AppArgs.builder()\n .name(\"my-custom-app\")\n .description(\"My app\")\n .resources( \n AppResourceArgs.builder()\n .name(\"sql-warehouse\")\n .sqlWarehouse(AppResourceSqlWarehouseArgs.builder()\n .id(\"e9ca293f79a74b5c\")\n .permission(\"CAN_MANAGE\")\n .build())\n .build(),\n AppResourceArgs.builder()\n .name(\"serving-endpoint\")\n .servingEndpoint(AppResourceServingEndpointArgs.builder()\n .name(\"databricks-meta-llama-3-1-70b-instruct\")\n .permission(\"CAN_MANAGE\")\n .build())\n .build(),\n AppResourceArgs.builder()\n .name(\"job\")\n .job(AppResourceJobArgs.builder()\n .id(\"1234\")\n .permission(\"CAN_MANAGE\")\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:App\n properties:\n name: my-custom-app\n description: My app\n resources:\n - name: sql-warehouse\n sqlWarehouse:\n id: e9ca293f79a74b5c\n permission: CAN_MANAGE\n - name: serving-endpoint\n servingEndpoint:\n name: databricks-meta-llama-3-1-70b-instruct\n permission: CAN_MANAGE\n - name: job\n job:\n id: '1234'\n permission: CAN_MANAGE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.SqlEndpoint \" pulumi-lang-dotnet=\" databricks.SqlEndpoint \" pulumi-lang-go=\" SqlEndpoint \" pulumi-lang-python=\" SqlEndpoint \" pulumi-lang-yaml=\" databricks.SqlEndpoint \" pulumi-lang-java=\" databricks.SqlEndpoint \" pulumi-lang-hcl=\" databricks_sql_endpoint \"\u003e databricks.SqlEndpoint \u003c/span\u003eto manage Databricks SQL [Endpoints](https://docs.databricks.com/sql/admin/sql-endpoints.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.ModelServing \" pulumi-lang-dotnet=\" databricks.ModelServing \" pulumi-lang-go=\" ModelServing \" pulumi-lang-python=\" ModelServing \" pulumi-lang-yaml=\" databricks.ModelServing \" pulumi-lang-java=\" databricks.ModelServing \" pulumi-lang-hcl=\" databricks_model_serving \"\u003e databricks.ModelServing \u003c/span\u003eto serve this model on a Databricks serving endpoint.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Secret \" pulumi-lang-dotnet=\" databricks.Secret \" pulumi-lang-go=\" Secret \" pulumi-lang-python=\" Secret \" pulumi-lang-yaml=\" databricks.Secret \" pulumi-lang-java=\" databricks.Secret \" pulumi-lang-hcl=\" databricks_secret \"\u003e databricks.Secret \u003c/span\u003eto manage [secrets](https://docs.databricks.com/security/secrets/index.html#secrets-user-guide) in Databricks workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eto manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code.\n\n", "properties": { "activeDeployment": { "$ref": "#/types/databricks:index/AppActiveDeployment:AppActiveDeployment", "description": "attribute - the active deployment of the app. A deployment is considered active when it has been deployed to the app compute.\n" }, "appStatus": { "$ref": "#/types/databricks:index/AppAppStatus:AppAppStatus", "description": "attribute\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this resource.\n" }, "computeMaxInstances": { "type": "integer" }, "computeMinInstances": { "type": "integer" }, "computeSize": { "type": "string", "description": "A string specifying compute size for the App. Possible values are `MEDIUM`, `LARGE`.\n" }, "computeStatus": { "$ref": "#/types/databricks:index/AppComputeStatus:AppComputeStatus", "description": "attribute\n" }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "defaultSourceCodePath": { "type": "string", "description": "The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.\n" }, "description": { "type": "string", "description": "The description of the app.\n" }, "effectiveBudgetPolicyId": { "type": "string", "description": "The effective budget policy ID.\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "The effective usage policy ID.\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of effective api scopes granted to the user access token.\n" }, "gitRepository": { "$ref": "#/types/databricks:index/AppGitRepository:AppGitRepository", "description": "Git repository configuration for app deployments (see below). When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).\n" }, "name": { "type": "string", "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.\n" }, "noCompute": { "type": "boolean" }, "oauth2AppClientId": { "type": "string", "description": "The OAuth2 client ID of the app's integration, set when the app uses user authorization.\n" }, "oauth2AppIntegrationId": { "type": "string", "description": "The unique ID of the OAuth2 integration associated with the app.\n" }, "pendingDeployment": { "$ref": "#/types/databricks:index/AppPendingDeployment:AppPendingDeployment", "description": "attribute - the pending deployment of the app. A deployment is considered pending when it is being prepared for deployment to the app compute. Schema is identical to \u003cspan pulumi-lang-nodejs=\"`activeDeployment`\" pulumi-lang-dotnet=\"`ActiveDeployment`\" pulumi-lang-go=\"`activeDeployment`\" pulumi-lang-python=\"`active_deployment`\" pulumi-lang-yaml=\"`activeDeployment`\" pulumi-lang-java=\"`activeDeployment`\" pulumi-lang-hcl=\"`active_deployment`\"\u003e`activeDeployment`\u003c/span\u003e.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppProviderConfig:AppProviderConfig" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppResource:AppResource" }, "description": "A list of resources that the app have access to.\n" }, "servicePrincipalClientId": { "type": "string", "description": "client_id (application_id) of the app service principal\n" }, "servicePrincipalId": { "type": "integer", "description": "id of the app service principal\n" }, "servicePrincipalName": { "type": "string", "description": "name of the app service principal\n" }, "space": { "type": "string" }, "telemetryExportDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppTelemetryExportDestination:AppTelemetryExportDestination" }, "description": "A list of destinations to which the app's telemetry (logs, metrics, traces) is exported (see below).\n" }, "thumbnailUrl": { "type": "string", "description": "The URL of the thumbnail image for the app.\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" }, "updater": { "type": "string", "description": "The email of the user that last updated the app.\n" }, "url": { "type": "string", "description": "The URL of the app once it is deployed.\n" }, "usagePolicyId": { "type": "string", "description": "The Usage Policy ID set for this resource.\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of api scopes granted to the user access token. See [REST API docs](https://docs.databricks.com/api/workspace/api/scopes) for full list of supported scopes.\n" } }, "required": [ "activeDeployment", "appStatus", "computeSize", "computeStatus", "createTime", "creator", "defaultSourceCodePath", "effectiveBudgetPolicyId", "effectiveUsagePolicyId", "effectiveUserApiScopes", "name", "oauth2AppClientId", "oauth2AppIntegrationId", "pendingDeployment", "providerConfig", "servicePrincipalClientId", "servicePrincipalId", "servicePrincipalName", "thumbnailUrl", "updateTime", "updater", "url" ], "inputProperties": { "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this resource.\n" }, "computeMaxInstances": { "type": "integer" }, "computeMinInstances": { "type": "integer" }, "computeSize": { "type": "string", "description": "A string specifying compute size for the App. Possible values are `MEDIUM`, `LARGE`.\n" }, "description": { "type": "string", "description": "The description of the app.\n" }, "gitRepository": { "$ref": "#/types/databricks:index/AppGitRepository:AppGitRepository", "description": "Git repository configuration for app deployments (see below). When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).\n" }, "name": { "type": "string", "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.\n" }, "noCompute": { "type": "boolean" }, "providerConfig": { "$ref": "#/types/databricks:index/AppProviderConfig:AppProviderConfig" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppResource:AppResource" }, "description": "A list of resources that the app have access to.\n" }, "space": { "type": "string" }, "telemetryExportDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppTelemetryExportDestination:AppTelemetryExportDestination" }, "description": "A list of destinations to which the app's telemetry (logs, metrics, traces) is exported (see below).\n" }, "usagePolicyId": { "type": "string", "description": "The Usage Policy ID set for this resource.\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of api scopes granted to the user access token. See [REST API docs](https://docs.databricks.com/api/workspace/api/scopes) for full list of supported scopes.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering App resources.\n", "properties": { "activeDeployment": { "$ref": "#/types/databricks:index/AppActiveDeployment:AppActiveDeployment", "description": "attribute - the active deployment of the app. A deployment is considered active when it has been deployed to the app compute.\n" }, "appStatus": { "$ref": "#/types/databricks:index/AppAppStatus:AppAppStatus", "description": "attribute\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this resource.\n" }, "computeMaxInstances": { "type": "integer" }, "computeMinInstances": { "type": "integer" }, "computeSize": { "type": "string", "description": "A string specifying compute size for the App. Possible values are `MEDIUM`, `LARGE`.\n" }, "computeStatus": { "$ref": "#/types/databricks:index/AppComputeStatus:AppComputeStatus", "description": "attribute\n" }, "createTime": { "type": "string", "description": "The creation time of the deployment.\n" }, "creator": { "type": "string", "description": "The email of the user that created the deployment.\n" }, "defaultSourceCodePath": { "type": "string", "description": "The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.\n" }, "description": { "type": "string", "description": "The description of the app.\n" }, "effectiveBudgetPolicyId": { "type": "string", "description": "The effective budget policy ID.\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "The effective usage policy ID.\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of effective api scopes granted to the user access token.\n" }, "gitRepository": { "$ref": "#/types/databricks:index/AppGitRepository:AppGitRepository", "description": "Git repository configuration for app deployments (see below). When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).\n" }, "name": { "type": "string", "description": "The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.\n" }, "noCompute": { "type": "boolean" }, "oauth2AppClientId": { "type": "string", "description": "The OAuth2 client ID of the app's integration, set when the app uses user authorization.\n" }, "oauth2AppIntegrationId": { "type": "string", "description": "The unique ID of the OAuth2 integration associated with the app.\n" }, "pendingDeployment": { "$ref": "#/types/databricks:index/AppPendingDeployment:AppPendingDeployment", "description": "attribute - the pending deployment of the app. A deployment is considered pending when it is being prepared for deployment to the app compute. Schema is identical to \u003cspan pulumi-lang-nodejs=\"`activeDeployment`\" pulumi-lang-dotnet=\"`ActiveDeployment`\" pulumi-lang-go=\"`activeDeployment`\" pulumi-lang-python=\"`active_deployment`\" pulumi-lang-yaml=\"`activeDeployment`\" pulumi-lang-java=\"`activeDeployment`\" pulumi-lang-hcl=\"`active_deployment`\"\u003e`activeDeployment`\u003c/span\u003e.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppProviderConfig:AppProviderConfig" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppResource:AppResource" }, "description": "A list of resources that the app have access to.\n" }, "servicePrincipalClientId": { "type": "string", "description": "client_id (application_id) of the app service principal\n" }, "servicePrincipalId": { "type": "integer", "description": "id of the app service principal\n" }, "servicePrincipalName": { "type": "string", "description": "name of the app service principal\n" }, "space": { "type": "string" }, "telemetryExportDestinations": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppTelemetryExportDestination:AppTelemetryExportDestination" }, "description": "A list of destinations to which the app's telemetry (logs, metrics, traces) is exported (see below).\n" }, "thumbnailUrl": { "type": "string", "description": "The URL of the thumbnail image for the app.\n" }, "updateTime": { "type": "string", "description": "The update time of the deployment.\n" }, "updater": { "type": "string", "description": "The email of the user that last updated the app.\n" }, "url": { "type": "string", "description": "The URL of the app once it is deployed.\n" }, "usagePolicyId": { "type": "string", "description": "The Usage Policy ID set for this resource.\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "A list of api scopes granted to the user access token. See [REST API docs](https://docs.databricks.com/api/workspace/api/scopes) for full list of supported scopes.\n" } }, "type": "object" } }, "databricks:index/appSpace:AppSpace": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/apps)\n\n", "properties": { "createTime": { "type": "string", "description": "(string) - The creation time of the app space. Formatted timestamp in ISO 6801\n" }, "creator": { "type": "string", "description": "(string) - The email of the user that created the app space\n" }, "description": { "type": "string", "description": "The description of the app space\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "(string) - The effective usage policy ID used by apps in the space\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The effective api scopes granted to the user access token\n" }, "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppSpaceProviderConfig:AppSpaceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppSpaceResource:AppSpaceResource" }, "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space\n" }, "servicePrincipalClientId": { "type": "string", "description": "(string) - The service principal client ID for the app space\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID for the app space\n" }, "servicePrincipalName": { "type": "string", "description": "(string) - The service principal name for the app space\n" }, "status": { "$ref": "#/types/databricks:index/AppSpaceStatus:AppSpaceStatus", "description": "(SpaceStatus) - The status of the app space\n" }, "updateTime": { "type": "string", "description": "(string) - The update time of the app space. Formatted timestamp in ISO 6801\n" }, "updater": { "type": "string", "description": "(string) - The email of the user that last updated the app space\n" }, "usagePolicyId": { "type": "string", "description": "The usage policy ID for managing cost at the space level\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "OAuth scopes for apps in the space\n" } }, "required": [ "createTime", "creator", "effectiveUsagePolicyId", "effectiveUserApiScopes", "name", "providerConfig", "servicePrincipalClientId", "servicePrincipalId", "servicePrincipalName", "status", "updateTime", "updater" ], "inputProperties": { "description": { "type": "string", "description": "The description of the app space\n" }, "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppSpaceProviderConfig:AppSpaceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppSpaceResource:AppSpaceResource" }, "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space\n" }, "usagePolicyId": { "type": "string", "description": "The usage policy ID for managing cost at the space level\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "OAuth scopes for apps in the space\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering AppSpace resources.\n", "properties": { "createTime": { "type": "string", "description": "(string) - The creation time of the app space. Formatted timestamp in ISO 6801\n" }, "creator": { "type": "string", "description": "(string) - The email of the user that created the app space\n" }, "description": { "type": "string", "description": "The description of the app space\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "(string) - The effective usage policy ID used by apps in the space\n" }, "effectiveUserApiScopes": { "type": "array", "items": { "type": "string" }, "description": "(list of string) - The effective api scopes granted to the user access token\n" }, "name": { "type": "string", "description": "The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens.\nIt must be unique within the workspace\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppSpaceProviderConfig:AppSpaceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/databricks:index/AppSpaceResource:AppSpaceResource" }, "description": "Resources for the app space. Resources configured at the space level are available to all apps in the space\n" }, "servicePrincipalClientId": { "type": "string", "description": "(string) - The service principal client ID for the app space\n" }, "servicePrincipalId": { "type": "integer", "description": "(integer) - The service principal ID for the app space\n" }, "servicePrincipalName": { "type": "string", "description": "(string) - The service principal name for the app space\n" }, "status": { "$ref": "#/types/databricks:index/AppSpaceStatus:AppSpaceStatus", "description": "(SpaceStatus) - The status of the app space\n" }, "updateTime": { "type": "string", "description": "(string) - The update time of the app space. Formatted timestamp in ISO 6801\n" }, "updater": { "type": "string", "description": "(string) - The email of the user that last updated the app space\n" }, "usagePolicyId": { "type": "string", "description": "The usage policy ID for managing cost at the space level\n" }, "userApiScopes": { "type": "array", "items": { "type": "string" }, "description": "OAuth scopes for apps in the space\n" } }, "type": "object" } }, "databricks:index/appsSettingsCustomTemplate:AppsSettingsCustomTemplate": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\nCustom App Templates store the metadata of custom app code hosted in an external Git repository, enabling users to reuse boilerplate code when creating apps.\n\n## Example Usage\n\n### Basic Example\n\nThis example creates a Custom Template in the workspace with the specified name.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.AppsSettingsCustomTemplate(\"this\", {\n name: \"my-custom-template\",\n description: \"A sample custom app template\",\n gitRepo: \"https://github.com/example/repo.git\",\n path: \"path-to-template\",\n gitProvider: \"github\",\n manifest: {\n version: 1,\n name: \"my-custom-app\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.AppsSettingsCustomTemplate(\"this\",\n name=\"my-custom-template\",\n description=\"A sample custom app template\",\n git_repo=\"https://github.com/example/repo.git\",\n path=\"path-to-template\",\n git_provider=\"github\",\n manifest={\n \"version\": 1,\n \"name\": \"my-custom-app\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.AppsSettingsCustomTemplate(\"this\", new()\n {\n Name = \"my-custom-template\",\n Description = \"A sample custom app template\",\n GitRepo = \"https://github.com/example/repo.git\",\n Path = \"path-to-template\",\n GitProvider = \"github\",\n Manifest = new Databricks.Inputs.AppsSettingsCustomTemplateManifestArgs\n {\n Version = 1,\n Name = \"my-custom-app\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAppsSettingsCustomTemplate(ctx, \"this\", \u0026databricks.AppsSettingsCustomTemplateArgs{\n\t\t\tName: pulumi.String(\"my-custom-template\"),\n\t\t\tDescription: pulumi.String(\"A sample custom app template\"),\n\t\t\tGitRepo: pulumi.String(\"https://github.com/example/repo.git\"),\n\t\t\tPath: pulumi.String(\"path-to-template\"),\n\t\t\tGitProvider: pulumi.String(\"github\"),\n\t\t\tManifest: \u0026databricks.AppsSettingsCustomTemplateManifestArgs{\n\t\t\t\tVersion: pulumi.Int(1),\n\t\t\t\tName: pulumi.String(\"my-custom-app\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_appssettingscustomtemplate\" \"this\" {\n name = \"my-custom-template\"\n description = \"A sample custom app template\"\n git_repo = \"https://github.com/example/repo.git\"\n path = \"path-to-template\"\n git_provider = \"github\"\n manifest = {\n version = 1\n name = \"my-custom-app\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AppsSettingsCustomTemplate;\nimport com.pulumi.databricks.AppsSettingsCustomTemplateArgs;\nimport com.pulumi.databricks.inputs.AppsSettingsCustomTemplateManifestArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new AppsSettingsCustomTemplate(\"this\", AppsSettingsCustomTemplateArgs.builder()\n .name(\"my-custom-template\")\n .description(\"A sample custom app template\")\n .gitRepo(\"https://github.com/example/repo.git\")\n .path(\"path-to-template\")\n .gitProvider(\"github\")\n .manifest(AppsSettingsCustomTemplateManifestArgs.builder()\n .version(1)\n .name(\"my-custom-app\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:AppsSettingsCustomTemplate\n properties:\n name: my-custom-template\n description: A sample custom app template\n gitRepo: https://github.com/example/repo.git\n path: path-to-template\n gitProvider: github\n manifest:\n version: 1\n name: my-custom-app\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example with API Scopes\n\nThis example creates a custom template that declares required user API scopes.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst apiScopesExample = new databricks.AppsSettingsCustomTemplate(\"api_scopes_example\", {\n name: \"my-api-template\",\n description: \"A template that requests user API scopes\",\n gitRepo: \"https://github.com/example/my-app.git\",\n path: \"templates/app\",\n gitProvider: \"github\",\n manifest: {\n version: 1,\n name: \"my-databricks-app\",\n description: \"This app requires the SQL API scope.\",\n userApiScopes: [\"sql\"],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\napi_scopes_example = databricks.AppsSettingsCustomTemplate(\"api_scopes_example\",\n name=\"my-api-template\",\n description=\"A template that requests user API scopes\",\n git_repo=\"https://github.com/example/my-app.git\",\n path=\"templates/app\",\n git_provider=\"github\",\n manifest={\n \"version\": 1,\n \"name\": \"my-databricks-app\",\n \"description\": \"This app requires the SQL API scope.\",\n \"user_api_scopes\": [\"sql\"],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var apiScopesExample = new Databricks.AppsSettingsCustomTemplate(\"api_scopes_example\", new()\n {\n Name = \"my-api-template\",\n Description = \"A template that requests user API scopes\",\n GitRepo = \"https://github.com/example/my-app.git\",\n Path = \"templates/app\",\n GitProvider = \"github\",\n Manifest = new Databricks.Inputs.AppsSettingsCustomTemplateManifestArgs\n {\n Version = 1,\n Name = \"my-databricks-app\",\n Description = \"This app requires the SQL API scope.\",\n UserApiScopes = new[]\n {\n \"sql\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAppsSettingsCustomTemplate(ctx, \"api_scopes_example\", \u0026databricks.AppsSettingsCustomTemplateArgs{\n\t\t\tName: pulumi.String(\"my-api-template\"),\n\t\t\tDescription: pulumi.String(\"A template that requests user API scopes\"),\n\t\t\tGitRepo: pulumi.String(\"https://github.com/example/my-app.git\"),\n\t\t\tPath: pulumi.String(\"templates/app\"),\n\t\t\tGitProvider: pulumi.String(\"github\"),\n\t\t\tManifest: \u0026databricks.AppsSettingsCustomTemplateManifestArgs{\n\t\t\t\tVersion: pulumi.Int(1),\n\t\t\t\tName: pulumi.String(\"my-databricks-app\"),\n\t\t\t\tDescription: pulumi.String(\"This app requires the SQL API scope.\"),\n\t\t\t\tUserApiScopes: []string{\n\t\t\t\t\t\"sql\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_appssettingscustomtemplate\" \"api_scopes_example\" {\n name = \"my-api-template\"\n description = \"A template that requests user API scopes\"\n git_repo = \"https://github.com/example/my-app.git\"\n path = \"templates/app\"\n git_provider = \"github\"\n manifest = {\n version = 1\n name = \"my-databricks-app\"\n description = \"This app requires the SQL API scope.\"\n user_api_scopes = [\"sql\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AppsSettingsCustomTemplate;\nimport com.pulumi.databricks.AppsSettingsCustomTemplateArgs;\nimport com.pulumi.databricks.inputs.AppsSettingsCustomTemplateManifestArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var apiScopesExample = new AppsSettingsCustomTemplate(\"apiScopesExample\", AppsSettingsCustomTemplateArgs.builder()\n .name(\"my-api-template\")\n .description(\"A template that requests user API scopes\")\n .gitRepo(\"https://github.com/example/my-app.git\")\n .path(\"templates/app\")\n .gitProvider(\"github\")\n .manifest(AppsSettingsCustomTemplateManifestArgs.builder()\n .version(1)\n .name(\"my-databricks-app\")\n .description(\"This app requires the SQL API scope.\")\n .userApiScopes(Arrays.asList(\"sql\"))\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n apiScopesExample:\n type: databricks:AppsSettingsCustomTemplate\n name: api_scopes_example\n properties:\n name: my-api-template\n description: A template that requests user API scopes\n gitRepo: https://github.com/example/my-app.git\n path: templates/app\n gitProvider: github\n manifest:\n version: 1\n name: my-databricks-app\n description: This app requires the SQL API scope.\n userApiScopes:\n - sql\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example with Resource Requirements\n\nThis example defines a template that requests specific workspace resources with permissions granted.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst resourcesExample = new databricks.AppsSettingsCustomTemplate(\"resources_example\", {\n name: \"my-resource-template\",\n description: \"Template that requires secret and SQL warehouse access\",\n gitRepo: \"https://github.com/example/resource-app.git\",\n path: \"resource-template\",\n gitProvider: \"github\",\n manifest: {\n version: 1,\n name: \"resource-consuming-app\",\n description: \"This app requires access to a secret and SQL warehouse.\",\n resourceSpecs: [\n {\n name: \"my-secret\",\n description: \"A secret needed by the app\",\n secretSpec: {\n permission: \"READ\",\n },\n },\n {\n name: \"warehouse\",\n description: \"Warehouse access\",\n sqlWarehouseSpec: {\n permission: \"CAN_USE\",\n },\n },\n ],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nresources_example = databricks.AppsSettingsCustomTemplate(\"resources_example\",\n name=\"my-resource-template\",\n description=\"Template that requires secret and SQL warehouse access\",\n git_repo=\"https://github.com/example/resource-app.git\",\n path=\"resource-template\",\n git_provider=\"github\",\n manifest={\n \"version\": 1,\n \"name\": \"resource-consuming-app\",\n \"description\": \"This app requires access to a secret and SQL warehouse.\",\n \"resource_specs\": [\n {\n \"name\": \"my-secret\",\n \"description\": \"A secret needed by the app\",\n \"secret_spec\": {\n \"permission\": \"READ\",\n },\n },\n {\n \"name\": \"warehouse\",\n \"description\": \"Warehouse access\",\n \"sql_warehouse_spec\": {\n \"permission\": \"CAN_USE\",\n },\n },\n ],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var resourcesExample = new Databricks.AppsSettingsCustomTemplate(\"resources_example\", new()\n {\n Name = \"my-resource-template\",\n Description = \"Template that requires secret and SQL warehouse access\",\n GitRepo = \"https://github.com/example/resource-app.git\",\n Path = \"resource-template\",\n GitProvider = \"github\",\n Manifest = new Databricks.Inputs.AppsSettingsCustomTemplateManifestArgs\n {\n Version = 1,\n Name = \"resource-consuming-app\",\n Description = \"This app requires access to a secret and SQL warehouse.\",\n ResourceSpecs = new[]\n {\n new Databricks.Inputs.AppsSettingsCustomTemplateManifestResourceSpecArgs\n {\n Name = \"my-secret\",\n Description = \"A secret needed by the app\",\n SecretSpec = new Databricks.Inputs.AppsSettingsCustomTemplateManifestResourceSpecSecretSpecArgs\n {\n Permission = \"READ\",\n },\n },\n new Databricks.Inputs.AppsSettingsCustomTemplateManifestResourceSpecArgs\n {\n Name = \"warehouse\",\n Description = \"Warehouse access\",\n SqlWarehouseSpec = new Databricks.Inputs.AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpecArgs\n {\n Permission = \"CAN_USE\",\n },\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewAppsSettingsCustomTemplate(ctx, \"resources_example\", \u0026databricks.AppsSettingsCustomTemplateArgs{\n\t\t\tName: pulumi.String(\"my-resource-template\"),\n\t\t\tDescription: pulumi.String(\"Template that requires secret and SQL warehouse access\"),\n\t\t\tGitRepo: pulumi.String(\"https://github.com/example/resource-app.git\"),\n\t\t\tPath: pulumi.String(\"resource-template\"),\n\t\t\tGitProvider: pulumi.String(\"github\"),\n\t\t\tManifest: \u0026databricks.AppsSettingsCustomTemplateManifestArgs{\n\t\t\t\tVersion: pulumi.Int(1),\n\t\t\t\tName: pulumi.String(\"resource-consuming-app\"),\n\t\t\t\tDescription: pulumi.String(\"This app requires access to a secret and SQL warehouse.\"),\n\t\t\t\tResourceSpecs: databricks.AppsSettingsCustomTemplateManifestResourceSpecArray{\n\t\t\t\t\t\u0026databricks.AppsSettingsCustomTemplateManifestResourceSpecArgs{\n\t\t\t\t\t\tName: pulumi.String(\"my-secret\"),\n\t\t\t\t\t\tDescription: pulumi.String(\"A secret needed by the app\"),\n\t\t\t\t\t\tSecretSpec: \u0026databricks.AppsSettingsCustomTemplateManifestResourceSpecSecretSpecArgs{\n\t\t\t\t\t\t\tPermission: pulumi.String(\"READ\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t\u0026databricks.AppsSettingsCustomTemplateManifestResourceSpecArgs{\n\t\t\t\t\t\tName: pulumi.String(\"warehouse\"),\n\t\t\t\t\t\tDescription: pulumi.String(\"Warehouse access\"),\n\t\t\t\t\t\tSqlWarehouseSpec: \u0026databricks.AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpecArgs{\n\t\t\t\t\t\t\tPermission: pulumi.String(\"CAN_USE\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_appssettingscustomtemplate\" \"resources_example\" {\n name = \"my-resource-template\"\n description = \"Template that requires secret and SQL warehouse access\"\n git_repo = \"https://github.com/example/resource-app.git\"\n path = \"resource-template\"\n git_provider = \"github\"\n manifest = {\n version = 1\n name = \"resource-consuming-app\"\n description = \"This app requires access to a secret and SQL warehouse.\"\n resource_specs = [{\n \"name\" = \"my-secret\"\n \"description\" = \"A secret needed by the app\"\n \"secretSpec\" = {\n \"permission\" = \"READ\"\n }\n }, {\n \"name\" = \"warehouse\"\n \"description\" = \"Warehouse access\"\n \"sqlWarehouseSpec\" = {\n \"permission\" = \"CAN_USE\"\n }\n }]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.AppsSettingsCustomTemplate;\nimport com.pulumi.databricks.AppsSettingsCustomTemplateArgs;\nimport com.pulumi.databricks.inputs.AppsSettingsCustomTemplateManifestArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var resourcesExample = new AppsSettingsCustomTemplate(\"resourcesExample\", AppsSettingsCustomTemplateArgs.builder()\n .name(\"my-resource-template\")\n .description(\"Template that requires secret and SQL warehouse access\")\n .gitRepo(\"https://github.com/example/resource-app.git\")\n .path(\"resource-template\")\n .gitProvider(\"github\")\n .manifest(AppsSettingsCustomTemplateManifestArgs.builder()\n .version(1)\n .name(\"resource-consuming-app\")\n .description(\"This app requires access to a secret and SQL warehouse.\")\n .resourceSpecs( \n AppsSettingsCustomTemplateManifestResourceSpecArgs.builder()\n .name(\"my-secret\")\n .description(\"A secret needed by the app\")\n .secretSpec(AppsSettingsCustomTemplateManifestResourceSpecSecretSpecArgs.builder()\n .permission(\"READ\")\n .build())\n .build(),\n AppsSettingsCustomTemplateManifestResourceSpecArgs.builder()\n .name(\"warehouse\")\n .description(\"Warehouse access\")\n .sqlWarehouseSpec(AppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpecArgs.builder()\n .permission(\"CAN_USE\")\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n resourcesExample:\n type: databricks:AppsSettingsCustomTemplate\n name: resources_example\n properties:\n name: my-resource-template\n description: Template that requires secret and SQL warehouse access\n gitRepo: https://github.com/example/resource-app.git\n path: resource-template\n gitProvider: github\n manifest:\n version: 1\n name: resource-consuming-app\n description: This app requires access to a secret and SQL warehouse.\n resourceSpecs:\n - name: my-secret\n description: A secret needed by the app\n secretSpec:\n permission: READ\n - name: warehouse\n description: Warehouse access\n sqlWarehouseSpec:\n permission: CAN_USE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "creator": { "type": "string", "description": "(string)\n" }, "description": { "type": "string", "description": "The description of the template\n" }, "gitProvider": { "type": "string", "description": "The Git provider of the template\n" }, "gitRepo": { "type": "string", "description": "The Git repository URL that the template resides in\n" }, "manifest": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifest:AppsSettingsCustomTemplateManifest", "description": "The manifest of the template. It defines fields and default values when installing the template\n" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "path": { "type": "string", "description": "The path to the template within the Git repository\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateProviderConfig:AppsSettingsCustomTemplateProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "required": [ "creator", "gitProvider", "gitRepo", "manifest", "name", "path", "providerConfig" ], "inputProperties": { "description": { "type": "string", "description": "The description of the template\n" }, "gitProvider": { "type": "string", "description": "The Git provider of the template\n" }, "gitRepo": { "type": "string", "description": "The Git repository URL that the template resides in\n" }, "manifest": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifest:AppsSettingsCustomTemplateManifest", "description": "The manifest of the template. It defines fields and default values when installing the template\n" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "path": { "type": "string", "description": "The path to the template within the Git repository\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateProviderConfig:AppsSettingsCustomTemplateProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "requiredInputs": [ "gitProvider", "gitRepo", "manifest", "path" ], "stateInputs": { "description": "Input properties used for looking up and filtering AppsSettingsCustomTemplate resources.\n", "properties": { "creator": { "type": "string", "description": "(string)\n" }, "description": { "type": "string", "description": "The description of the template\n" }, "gitProvider": { "type": "string", "description": "The Git provider of the template\n" }, "gitRepo": { "type": "string", "description": "The Git repository URL that the template resides in\n" }, "manifest": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateManifest:AppsSettingsCustomTemplateManifest", "description": "The manifest of the template. It defines fields and default values when installing the template\n" }, "name": { "type": "string", "description": "The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces.\nIt must be unique within the workspace\n" }, "path": { "type": "string", "description": "The path to the template within the Git repository\n" }, "providerConfig": { "$ref": "#/types/databricks:index/AppsSettingsCustomTemplateProviderConfig:AppsSettingsCustomTemplateProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "type": "object" } }, "databricks:index/artifactAllowlist:ArtifactAllowlist": { "description": "In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the allowlist in UC so that users can leverage these artifacts on compute configured with shared access mode.\n\n\u003e It is required to define all allowlist for an artifact type in a single resource, otherwise Pulumi cannot guarantee config drift prevention.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst initScripts = new databricks.ArtifactAllowlist(\"init_scripts\", {\n artifactType: \"INIT_SCRIPT\",\n artifactMatchers: [{\n artifact: \"/Volumes/inits\",\n matchType: \"PREFIX_MATCH\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ninit_scripts = databricks.ArtifactAllowlist(\"init_scripts\",\n artifact_type=\"INIT_SCRIPT\",\n artifact_matchers=[{\n \"artifact\": \"/Volumes/inits\",\n \"match_type\": \"PREFIX_MATCH\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var initScripts = new Databricks.ArtifactAllowlist(\"init_scripts\", new()\n {\n ArtifactType = \"INIT_SCRIPT\",\n ArtifactMatchers = new[]\n {\n new Databricks.Inputs.ArtifactAllowlistArtifactMatcherArgs\n {\n Artifact = \"/Volumes/inits\",\n MatchType = \"PREFIX_MATCH\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewArtifactAllowlist(ctx, \"init_scripts\", \u0026databricks.ArtifactAllowlistArgs{\n\t\t\tArtifactType: pulumi.String(\"INIT_SCRIPT\"),\n\t\t\tArtifactMatchers: databricks.ArtifactAllowlistArtifactMatcherArray{\n\t\t\t\t\u0026databricks.ArtifactAllowlistArtifactMatcherArgs{\n\t\t\t\t\tArtifact: pulumi.String(\"/Volumes/inits\"),\n\t\t\t\t\tMatchType: pulumi.String(\"PREFIX_MATCH\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_artifactallowlist\" \"init_scripts\" {\n artifact_type = \"INIT_SCRIPT\"\n artifact_matchers {\n artifact = \"/Volumes/inits\"\n match_type = \"PREFIX_MATCH\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ArtifactAllowlist;\nimport com.pulumi.databricks.ArtifactAllowlistArgs;\nimport com.pulumi.databricks.inputs.ArtifactAllowlistArtifactMatcherArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var initScripts = new ArtifactAllowlist(\"initScripts\", ArtifactAllowlistArgs.builder()\n .artifactType(\"INIT_SCRIPT\")\n .artifactMatchers(ArtifactAllowlistArtifactMatcherArgs.builder()\n .artifact(\"/Volumes/inits\")\n .matchType(\"PREFIX_MATCH\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n initScripts:\n type: databricks:ArtifactAllowlist\n name: init_scripts\n properties:\n artifactType: INIT_SCRIPT\n artifactMatchers:\n - artifact: /Volumes/inits\n matchType: PREFIX_MATCH\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Library \" pulumi-lang-dotnet=\" databricks.Library \" pulumi-lang-go=\" Library \" pulumi-lang-python=\" Library \" pulumi-lang-yaml=\" databricks.Library \" pulumi-lang-java=\" databricks.Library \" pulumi-lang-hcl=\" databricks_library \"\u003e databricks.Library \u003c/span\u003eto install a [library](https://docs.databricks.com/libraries/index.html) on databricks_cluster.\n\n", "properties": { "artifactMatchers": { "type": "array", "items": { "$ref": "#/types/databricks:index/ArtifactAllowlistArtifactMatcher:ArtifactAllowlistArtifactMatcher" } }, "artifactType": { "type": "string", "description": "The artifact type of the allowlist. Can be `INIT_SCRIPT`, `LIBRARY_JAR` or `LIBRARY_MAVEN`. Change forces creation of a new resource.\n" }, "createdAt": { "type": "integer", "description": "Time at which this artifact allowlist was set.\n" }, "createdBy": { "type": "string", "description": "Identity that set the artifact allowlist.\n" }, "metastoreId": { "type": "string", "description": "ID of the parent metastore.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ArtifactAllowlistProviderConfig:ArtifactAllowlistProviderConfig" } }, "required": [ "artifactMatchers", "artifactType", "createdAt", "createdBy", "metastoreId", "providerConfig" ], "inputProperties": { "artifactMatchers": { "type": "array", "items": { "$ref": "#/types/databricks:index/ArtifactAllowlistArtifactMatcher:ArtifactAllowlistArtifactMatcher" } }, "artifactType": { "type": "string", "description": "The artifact type of the allowlist. Can be `INIT_SCRIPT`, `LIBRARY_JAR` or `LIBRARY_MAVEN`. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "createdAt": { "type": "integer", "description": "Time at which this artifact allowlist was set.\n" }, "createdBy": { "type": "string", "description": "Identity that set the artifact allowlist.\n" }, "metastoreId": { "type": "string", "description": "ID of the parent metastore.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ArtifactAllowlistProviderConfig:ArtifactAllowlistProviderConfig" } }, "requiredInputs": [ "artifactMatchers", "artifactType" ], "stateInputs": { "description": "Input properties used for looking up and filtering ArtifactAllowlist resources.\n", "properties": { "artifactMatchers": { "type": "array", "items": { "$ref": "#/types/databricks:index/ArtifactAllowlistArtifactMatcher:ArtifactAllowlistArtifactMatcher" } }, "artifactType": { "type": "string", "description": "The artifact type of the allowlist. Can be `INIT_SCRIPT`, `LIBRARY_JAR` or `LIBRARY_MAVEN`. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "createdAt": { "type": "integer", "description": "Time at which this artifact allowlist was set.\n" }, "createdBy": { "type": "string", "description": "Identity that set the artifact allowlist.\n" }, "metastoreId": { "type": "string", "description": "ID of the parent metastore.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ArtifactAllowlistProviderConfig:ArtifactAllowlistProviderConfig" } }, "type": "object" } }, "databricks:index/automaticClusterUpdateWorkspaceSetting:AutomaticClusterUpdateWorkspaceSetting": { "properties": { "automaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingProviderConfig:AutomaticClusterUpdateWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "required": [ "automaticClusterUpdateWorkspace", "etag", "providerConfig", "settingName" ], "inputProperties": { "automaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingProviderConfig:AutomaticClusterUpdateWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "requiredInputs": [ "automaticClusterUpdateWorkspace" ], "stateInputs": { "description": "Input properties used for looking up and filtering AutomaticClusterUpdateWorkspaceSetting resources.\n", "properties": { "automaticClusterUpdateWorkspace": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace:AutomaticClusterUpdateWorkspaceSettingAutomaticClusterUpdateWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/AutomaticClusterUpdateWorkspaceSettingProviderConfig:AutomaticClusterUpdateWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/budget:Budget": { "description": "This resource allows you to manage [Databricks Budgets](https://docs.databricks.com/en/admin/account-settings/budgets.html).\n\n\u003e This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html).\n\n\u003e This resource can only be used with an account-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Budget(\"this\", {\n displayName: \"databricks-workspace-budget\",\n alertConfigurations: [{\n timePeriod: \"MONTH\",\n triggerType: \"CUMULATIVE_SPENDING_EXCEEDED\",\n quantityType: \"LIST_PRICE_DOLLARS_USD\",\n quantityThreshold: \"840\",\n actionConfigurations: [{\n actionType: \"EMAIL_NOTIFICATION\",\n target: \"abc@gmail.com\",\n }],\n }],\n filter: {\n workspaceId: {\n operator: \"IN\",\n values: [1234567890098765],\n },\n tags: [\n {\n key: \"Team\",\n value: {\n operator: \"IN\",\n values: [\"Data Science\"],\n },\n },\n {\n key: \"Environment\",\n value: {\n operator: \"IN\",\n values: [\"Development\"],\n },\n },\n ],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Budget(\"this\",\n display_name=\"databricks-workspace-budget\",\n alert_configurations=[{\n \"time_period\": \"MONTH\",\n \"trigger_type\": \"CUMULATIVE_SPENDING_EXCEEDED\",\n \"quantity_type\": \"LIST_PRICE_DOLLARS_USD\",\n \"quantity_threshold\": \"840\",\n \"action_configurations\": [{\n \"action_type\": \"EMAIL_NOTIFICATION\",\n \"target\": \"abc@gmail.com\",\n }],\n }],\n filter={\n \"workspace_id\": {\n \"operator\": \"IN\",\n \"values\": [int(1234567890098765)],\n },\n \"tags\": [\n {\n \"key\": \"Team\",\n \"value\": {\n \"operator\": \"IN\",\n \"values\": [\"Data Science\"],\n },\n },\n {\n \"key\": \"Environment\",\n \"value\": {\n \"operator\": \"IN\",\n \"values\": [\"Development\"],\n },\n },\n ],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Budget(\"this\", new()\n {\n DisplayName = \"databricks-workspace-budget\",\n AlertConfigurations = new[]\n {\n new Databricks.Inputs.BudgetAlertConfigurationArgs\n {\n TimePeriod = \"MONTH\",\n TriggerType = \"CUMULATIVE_SPENDING_EXCEEDED\",\n QuantityType = \"LIST_PRICE_DOLLARS_USD\",\n QuantityThreshold = \"840\",\n ActionConfigurations = new[]\n {\n new Databricks.Inputs.BudgetAlertConfigurationActionConfigurationArgs\n {\n ActionType = \"EMAIL_NOTIFICATION\",\n Target = \"abc@gmail.com\",\n },\n },\n },\n },\n Filter = new Databricks.Inputs.BudgetFilterArgs\n {\n WorkspaceId = new Databricks.Inputs.BudgetFilterWorkspaceIdArgs\n {\n Operator = \"IN\",\n Values = new[]\n {\n 1234567890098765,\n },\n },\n Tags = new[]\n {\n new Databricks.Inputs.BudgetFilterTagArgs\n {\n Key = \"Team\",\n Value = new Databricks.Inputs.BudgetFilterTagValueArgs\n {\n Operator = \"IN\",\n Values = new[]\n {\n \"Data Science\",\n },\n },\n },\n new Databricks.Inputs.BudgetFilterTagArgs\n {\n Key = \"Environment\",\n Value = new Databricks.Inputs.BudgetFilterTagValueArgs\n {\n Operator = \"IN\",\n Values = new[]\n {\n \"Development\",\n },\n },\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewBudget(ctx, \"this\", \u0026databricks.BudgetArgs{\n\t\t\tDisplayName: pulumi.String(\"databricks-workspace-budget\"),\n\t\t\tAlertConfigurations: databricks.BudgetAlertConfigurationArray{\n\t\t\t\t\u0026databricks.BudgetAlertConfigurationArgs{\n\t\t\t\t\tTimePeriod: pulumi.String(\"MONTH\"),\n\t\t\t\t\tTriggerType: pulumi.String(\"CUMULATIVE_SPENDING_EXCEEDED\"),\n\t\t\t\t\tQuantityType: pulumi.String(\"LIST_PRICE_DOLLARS_USD\"),\n\t\t\t\t\tQuantityThreshold: pulumi.String(\"840\"),\n\t\t\t\t\tActionConfigurations: databricks.BudgetAlertConfigurationActionConfigurationArray{\n\t\t\t\t\t\t\u0026databricks.BudgetAlertConfigurationActionConfigurationArgs{\n\t\t\t\t\t\t\tActionType: pulumi.String(\"EMAIL_NOTIFICATION\"),\n\t\t\t\t\t\t\tTarget: pulumi.String(\"abc@gmail.com\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tFilter: \u0026databricks.BudgetFilterArgs{\n\t\t\t\tWorkspaceId: \u0026databricks.BudgetFilterWorkspaceIdArgs{\n\t\t\t\t\tOperator: pulumi.String(\"IN\"),\n\t\t\t\t\tValues: pulumi.IntArray{\n\t\t\t\t\t\tpulumi.Int(1234567890098765),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tTags: databricks.BudgetFilterTagArray{\n\t\t\t\t\t\u0026databricks.BudgetFilterTagArgs{\n\t\t\t\t\t\tKey: pulumi.String(\"Team\"),\n\t\t\t\t\t\tValue: \u0026databricks.BudgetFilterTagValueArgs{\n\t\t\t\t\t\t\tOperator: pulumi.String(\"IN\"),\n\t\t\t\t\t\t\tValues: pulumi.StringArray{\n\t\t\t\t\t\t\t\tpulumi.String(\"Data Science\"),\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\t\u0026databricks.BudgetFilterTagArgs{\n\t\t\t\t\t\tKey: pulumi.String(\"Environment\"),\n\t\t\t\t\t\tValue: \u0026databricks.BudgetFilterTagValueArgs{\n\t\t\t\t\t\t\tOperator: pulumi.String(\"IN\"),\n\t\t\t\t\t\t\tValues: pulumi.StringArray{\n\t\t\t\t\t\t\t\tpulumi.String(\"Development\"),\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_budget\" \"this\" {\n display_name = \"databricks-workspace-budget\"\n alert_configurations {\n time_period = \"MONTH\"\n trigger_type = \"CUMULATIVE_SPENDING_EXCEEDED\"\n quantity_type = \"LIST_PRICE_DOLLARS_USD\"\n quantity_threshold = \"840\"\n action_configurations {\n action_type = \"EMAIL_NOTIFICATION\"\n target = \"abc@gmail.com\"\n }\n }\n filter = {\n workspace_id = {\n operator = \"IN\"\n values = [1234567890098765]\n }\n tags = [{\n \"key\" = \"Team\"\n \"value\" = {\n \"operator\" = \"IN\"\n \"values\" = [\"Data Science\"]\n }\n }, {\n \"key\" = \"Environment\"\n \"value\" = {\n \"operator\" = \"IN\"\n \"values\" = [\"Development\"]\n }\n }]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Budget;\nimport com.pulumi.databricks.BudgetArgs;\nimport com.pulumi.databricks.inputs.BudgetAlertConfigurationArgs;\nimport com.pulumi.databricks.inputs.BudgetFilterArgs;\nimport com.pulumi.databricks.inputs.BudgetFilterWorkspaceIdArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Budget(\"this\", BudgetArgs.builder()\n .displayName(\"databricks-workspace-budget\")\n .alertConfigurations(BudgetAlertConfigurationArgs.builder()\n .timePeriod(\"MONTH\")\n .triggerType(\"CUMULATIVE_SPENDING_EXCEEDED\")\n .quantityType(\"LIST_PRICE_DOLLARS_USD\")\n .quantityThreshold(\"840\")\n .actionConfigurations(BudgetAlertConfigurationActionConfigurationArgs.builder()\n .actionType(\"EMAIL_NOTIFICATION\")\n .target(\"abc@gmail.com\")\n .build())\n .build())\n .filter(BudgetFilterArgs.builder()\n .workspaceId(BudgetFilterWorkspaceIdArgs.builder()\n .operator(\"IN\")\n .values(1234567890098765)\n .build())\n .tags( \n BudgetFilterTagArgs.builder()\n .key(\"Team\")\n .value(BudgetFilterTagValueArgs.builder()\n .operator(\"IN\")\n .values(\"Data Science\")\n .build())\n .build(),\n BudgetFilterTagArgs.builder()\n .key(\"Environment\")\n .value(BudgetFilterTagValueArgs.builder()\n .operator(\"IN\")\n .values(\"Development\")\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Budget\n properties:\n displayName: databricks-workspace-budget\n alertConfigurations:\n - timePeriod: MONTH\n triggerType: CUMULATIVE_SPENDING_EXCEEDED\n quantityType: LIST_PRICE_DOLLARS_USD\n quantityThreshold: '840'\n actionConfigurations:\n - actionType: EMAIL_NOTIFICATION\n target: abc@gmail.com\n filter:\n workspaceId:\n operator: IN\n values:\n - 1.234567890098765e+15\n tags:\n - key: Team\n value:\n operator: IN\n values:\n - Data Science\n - key: Environment\n value:\n operator: IN\n values:\n - Development\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up Databricks workspaces.\n\n", "properties": { "accountId": { "type": "string", "description": "The ID of the Databricks Account.\n" }, "alertConfigurations": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetAlertConfiguration:BudgetAlertConfiguration" } }, "budgetConfigurationId": { "type": "string", "description": "The ID of the budget configuration.\n" }, "createTime": { "type": "integer" }, "displayName": { "type": "string", "description": "Name of the budget in Databricks Account.\n" }, "filter": { "$ref": "#/types/databricks:index/BudgetFilter:BudgetFilter" }, "updateTime": { "type": "integer" } }, "required": [ "accountId", "budgetConfigurationId", "createTime", "updateTime" ], "inputProperties": { "accountId": { "type": "string", "description": "The ID of the Databricks Account.\n" }, "alertConfigurations": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetAlertConfiguration:BudgetAlertConfiguration" } }, "budgetConfigurationId": { "type": "string", "description": "The ID of the budget configuration.\n" }, "createTime": { "type": "integer" }, "displayName": { "type": "string", "description": "Name of the budget in Databricks Account.\n" }, "filter": { "$ref": "#/types/databricks:index/BudgetFilter:BudgetFilter" }, "updateTime": { "type": "integer" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Budget resources.\n", "properties": { "accountId": { "type": "string", "description": "The ID of the Databricks Account.\n" }, "alertConfigurations": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetAlertConfiguration:BudgetAlertConfiguration" } }, "budgetConfigurationId": { "type": "string", "description": "The ID of the budget configuration.\n" }, "createTime": { "type": "integer" }, "displayName": { "type": "string", "description": "Name of the budget in Databricks Account.\n" }, "filter": { "$ref": "#/types/databricks:index/BudgetFilter:BudgetFilter" }, "updateTime": { "type": "integer" } }, "type": "object" } }, "databricks:index/budgetPolicy:BudgetPolicy": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/account/budgetpolicy)\n\nAdministrators can use budget policies to ensure that the correct tags appear automatically on serverless resources without depending on users to attach tags manually, allowing for customized cost reporting and chargebacks.\n\nBudget policies consist of tags that are applied to any serverless compute activity incurred by a user assigned to the policy.\n\nThe tags are logged in your billing records, allowing you to attribute serverless usage to specific budgets.\n\n\u003e **Note** This resource can only be used with an account-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.BudgetPolicy(\"this\", {\n policyName: \"my-budget-policy\",\n customTags: [{\n key: \"mykey\",\n value: \"myvalue\",\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.BudgetPolicy(\"this\",\n policy_name=\"my-budget-policy\",\n custom_tags=[{\n \"key\": \"mykey\",\n \"value\": \"myvalue\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.BudgetPolicy(\"this\", new()\n {\n PolicyName = \"my-budget-policy\",\n CustomTags = new[]\n {\n new Databricks.Inputs.BudgetPolicyCustomTagArgs\n {\n Key = \"mykey\",\n Value = \"myvalue\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewBudgetPolicy(ctx, \"this\", \u0026databricks.BudgetPolicyArgs{\n\t\t\tPolicyName: pulumi.String(\"my-budget-policy\"),\n\t\t\tCustomTags: databricks.BudgetPolicyCustomTagArray{\n\t\t\t\t\u0026databricks.BudgetPolicyCustomTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"mykey\"),\n\t\t\t\t\tValue: pulumi.String(\"myvalue\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_budgetpolicy\" \"this\" {\n policy_name = \"my-budget-policy\"\n custom_tags {\n key = \"mykey\"\n value = \"myvalue\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.BudgetPolicy;\nimport com.pulumi.databricks.BudgetPolicyArgs;\nimport com.pulumi.databricks.inputs.BudgetPolicyCustomTagArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new BudgetPolicy(\"this\", BudgetPolicyArgs.builder()\n .policyName(\"my-budget-policy\")\n .customTags(BudgetPolicyCustomTagArgs.builder()\n .key(\"mykey\")\n .value(\"myvalue\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:BudgetPolicy\n properties:\n policyName: my-budget-policy\n customTags:\n - key: mykey\n value: myvalue\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "bindingWorkspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetPolicyCustomTag:BudgetPolicyCustomTag" }, "description": "A list of tags defined by the customer. At most 20 entries are allowed per policy\n" }, "policyId": { "type": "string", "description": "(string) - The Id of the policy. This field is generated by Databricks and globally unique\n" }, "policyName": { "type": "string", "description": "The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`\n" } }, "required": [ "policyId" ], "inputProperties": { "bindingWorkspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetPolicyCustomTag:BudgetPolicyCustomTag" }, "description": "A list of tags defined by the customer. At most 20 entries are allowed per policy\n" }, "policyId": { "type": "string", "description": "(string) - The Id of the policy. This field is generated by Databricks and globally unique\n" }, "policyName": { "type": "string", "description": "The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering BudgetPolicy resources.\n", "properties": { "bindingWorkspaceIds": { "type": "array", "items": { "type": "integer" }, "description": "List of workspaces that this budget policy will be exclusively bound to.\nAn empty binding implies that this budget policy is open to any workspace in the account\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/BudgetPolicyCustomTag:BudgetPolicyCustomTag" }, "description": "A list of tags defined by the customer. At most 20 entries are allowed per policy\n" }, "policyId": { "type": "string", "description": "(string) - The Id of the policy. This field is generated by Databricks and globally unique\n" }, "policyName": { "type": "string", "description": "The name of the policy.\n- Must be unique among active policies.\n- Can contain only characters from the ISO 8859-1 (latin1) set.\n- Can't start with reserved keywords such as `databricks:default-policy`\n" } }, "type": "object" } }, "databricks:index/catalog:Catalog": { "description": "Within a metastore, Unity Catalog provides a 3-level namespace for organizing data: Catalogs, Databases (also called Schemas), and Tables / Views.\n\nA \u003cspan pulumi-lang-nodejs=\"`databricks.Catalog`\" pulumi-lang-dotnet=\"`databricks.Catalog`\" pulumi-lang-go=\"`Catalog`\" pulumi-lang-python=\"`Catalog`\" pulumi-lang-yaml=\"`databricks.Catalog`\" pulumi-lang-java=\"`databricks.Catalog`\" pulumi-lang-hcl=\"`databricks_catalog`\"\u003e`databricks.Catalog`\u003c/span\u003e is contained within\u003cspan pulumi-lang-nodejs=\" databricks.Metastore \" pulumi-lang-dotnet=\" databricks.Metastore \" pulumi-lang-go=\" Metastore \" pulumi-lang-python=\" Metastore \" pulumi-lang-yaml=\" databricks.Metastore \" pulumi-lang-java=\" databricks.Metastore \" pulumi-lang-hcl=\" databricks_metastore \"\u003e databricks.Metastore \u003c/span\u003eand can contain databricks_schema. By default, Databricks creates \u003cspan pulumi-lang-nodejs=\"`default`\" pulumi-lang-dotnet=\"`Default`\" pulumi-lang-go=\"`default`\" pulumi-lang-python=\"`default`\" pulumi-lang-yaml=\"`default`\" pulumi-lang-java=\"`default`\" pulumi-lang-hcl=\"`default`\"\u003e`default`\u003c/span\u003e schema for every new catalog, but Pulumi plugin is removing this auto-created schema, so that resource destruction could be done in a clean way.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n name: \"sandbox\",\n comment: \"this catalog is managed by terraform\",\n properties: {\n purpose: \"testing\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n name=\"sandbox\",\n comment=\"this catalog is managed by terraform\",\n properties={\n \"purpose\": \"testing\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n Name = \"sandbox\",\n Comment = \"this catalog is managed by terraform\",\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tComment: pulumi.String(\"this catalog is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n name = \"sandbox\"\n comment = \"this catalog is managed by terraform\"\n properties = {\n \"purpose\" = \"testing\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .name(\"sandbox\")\n .comment(\"this catalog is managed by terraform\")\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n name: sandbox\n comment: this catalog is managed by terraform\n properties:\n purpose: testing\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.getTables \" pulumi-lang-dotnet=\" databricks.getTables \" pulumi-lang-go=\" getTables \" pulumi-lang-python=\" get_tables \" pulumi-lang-yaml=\" databricks.getTables \" pulumi-lang-java=\" databricks.getTables \" pulumi-lang-hcl=\" data.databricks_tables \"\u003e databricks.getTables \u003c/span\u003edata to list tables within Unity Catalog.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getSchemas \" pulumi-lang-dotnet=\" databricks.getSchemas \" pulumi-lang-go=\" getSchemas \" pulumi-lang-python=\" get_schemas \" pulumi-lang-yaml=\" databricks.getSchemas \" pulumi-lang-java=\" databricks.getSchemas \" pulumi-lang-hcl=\" data.databricks_schemas \"\u003e databricks.getSchemas \u003c/span\u003edata to list schemas within Unity Catalog.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getCatalogs \" pulumi-lang-dotnet=\" databricks.getCatalogs \" pulumi-lang-go=\" getCatalogs \" pulumi-lang-python=\" get_catalogs \" pulumi-lang-yaml=\" databricks.getCatalogs \" pulumi-lang-java=\" databricks.getCatalogs \" pulumi-lang-hcl=\" data.databricks_catalogs \"\u003e databricks.getCatalogs \u003c/span\u003edata to list catalogs within Unity Catalog.\n\n", "properties": { "browseOnly": { "type": "boolean" }, "catalogType": { "type": "string", "description": "the type of the catalog.\n" }, "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "connectionName": { "type": "string", "description": "For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.\n" }, "createdAt": { "type": "integer", "description": "time at which this catalog was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "username of catalog creator.\n" }, "effectivePredictiveOptimizationFlag": { "$ref": "#/types/databricks:index/CatalogEffectivePredictiveOptimizationFlag:CatalogEffectivePredictiveOptimizationFlag" }, "enablePredictiveOptimization": { "type": "string", "description": "Whether predictive optimization should be enabled for this object and objects under it. Can be `ENABLE`, `DISABLE` or `INHERIT`\n" }, "forceDestroy": { "type": "boolean", "description": "Delete catalog regardless of its contents.\n" }, "fullName": { "type": "string" }, "isolationMode": { "type": "string", "description": "Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATED` or `OPEN`. Setting the catalog to `ISOLATED` will automatically allow access from the current workspace.\n" }, "managedEncryptionSettings": { "$ref": "#/types/databricks:index/CatalogManagedEncryptionSettings:CatalogManagedEncryptionSettings" }, "metastoreId": { "type": "string", "description": "ID of the parent metastore.\n" }, "name": { "type": "string", "description": "Name of Catalog relative to parent metastore.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the catalog owner.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Extensible Catalog properties.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/CatalogProviderConfig:CatalogProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "providerName": { "type": "string", "description": "For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.\n" }, "provisioningInfo": { "$ref": "#/types/databricks:index/CatalogProvisioningInfo:CatalogProvisioningInfo" }, "securableType": { "type": "string", "description": "the type of Unity Catalog securable.\n" }, "shareName": { "type": "string", "description": "For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.\n" }, "storageLocation": { "type": "string", "description": "effective storage Location URL (full path) for managed tables within catalog.\n" }, "storageRoot": { "type": "string", "description": "Managed location of the catalog. Location in cloud storage where data for managed tables will be stored. If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.). If not specified, the location will default to the metastore root location. Change forces creation of a new resource.\n" }, "updatedAt": { "type": "integer", "description": "time at which this catalog was last modified, in epoch milliseconds..\n" }, "updatedBy": { "type": "string", "description": "username of user who last modified catalog.\n" } }, "required": [ "catalogType", "createdAt", "createdBy", "effectivePredictiveOptimizationFlag", "enablePredictiveOptimization", "fullName", "isolationMode", "metastoreId", "name", "owner", "providerConfig", "provisioningInfo", "securableType", "storageLocation", "updatedAt", "updatedBy" ], "inputProperties": { "browseOnly": { "type": "boolean" }, "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "connectionName": { "type": "string", "description": "For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.\n", "willReplaceOnChanges": true }, "effectivePredictiveOptimizationFlag": { "$ref": "#/types/databricks:index/CatalogEffectivePredictiveOptimizationFlag:CatalogEffectivePredictiveOptimizationFlag" }, "enablePredictiveOptimization": { "type": "string", "description": "Whether predictive optimization should be enabled for this object and objects under it. Can be `ENABLE`, `DISABLE` or `INHERIT`\n" }, "forceDestroy": { "type": "boolean", "description": "Delete catalog regardless of its contents.\n" }, "isolationMode": { "type": "string", "description": "Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATED` or `OPEN`. Setting the catalog to `ISOLATED` will automatically allow access from the current workspace.\n" }, "managedEncryptionSettings": { "$ref": "#/types/databricks:index/CatalogManagedEncryptionSettings:CatalogManagedEncryptionSettings" }, "metastoreId": { "type": "string", "description": "ID of the parent metastore.\n" }, "name": { "type": "string", "description": "Name of Catalog relative to parent metastore.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the catalog owner.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Extensible Catalog properties.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/CatalogProviderConfig:CatalogProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "providerName": { "type": "string", "description": "For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "provisioningInfo": { "$ref": "#/types/databricks:index/CatalogProvisioningInfo:CatalogProvisioningInfo" }, "shareName": { "type": "string", "description": "For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "storageRoot": { "type": "string", "description": "Managed location of the catalog. Location in cloud storage where data for managed tables will be stored. If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.). If not specified, the location will default to the metastore root location. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "stateInputs": { "description": "Input properties used for looking up and filtering Catalog resources.\n", "properties": { "browseOnly": { "type": "boolean" }, "catalogType": { "type": "string", "description": "the type of the catalog.\n" }, "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "connectionName": { "type": "string", "description": "For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.\n", "willReplaceOnChanges": true }, "createdAt": { "type": "integer", "description": "time at which this catalog was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "username of catalog creator.\n" }, "effectivePredictiveOptimizationFlag": { "$ref": "#/types/databricks:index/CatalogEffectivePredictiveOptimizationFlag:CatalogEffectivePredictiveOptimizationFlag" }, "enablePredictiveOptimization": { "type": "string", "description": "Whether predictive optimization should be enabled for this object and objects under it. Can be `ENABLE`, `DISABLE` or `INHERIT`\n" }, "forceDestroy": { "type": "boolean", "description": "Delete catalog regardless of its contents.\n" }, "fullName": { "type": "string" }, "isolationMode": { "type": "string", "description": "Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATED` or `OPEN`. Setting the catalog to `ISOLATED` will automatically allow access from the current workspace.\n" }, "managedEncryptionSettings": { "$ref": "#/types/databricks:index/CatalogManagedEncryptionSettings:CatalogManagedEncryptionSettings" }, "metastoreId": { "type": "string", "description": "ID of the parent metastore.\n" }, "name": { "type": "string", "description": "Name of Catalog relative to parent metastore.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the catalog owner.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Extensible Catalog properties.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/CatalogProviderConfig:CatalogProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "providerName": { "type": "string", "description": "For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "provisioningInfo": { "$ref": "#/types/databricks:index/CatalogProvisioningInfo:CatalogProvisioningInfo" }, "securableType": { "type": "string", "description": "the type of Unity Catalog securable.\n" }, "shareName": { "type": "string", "description": "For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "storageLocation": { "type": "string", "description": "effective storage Location URL (full path) for managed tables within catalog.\n" }, "storageRoot": { "type": "string", "description": "Managed location of the catalog. Location in cloud storage where data for managed tables will be stored. If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.). If not specified, the location will default to the metastore root location. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "updatedAt": { "type": "integer", "description": "time at which this catalog was last modified, in epoch milliseconds..\n" }, "updatedBy": { "type": "string", "description": "username of user who last modified catalog.\n" } }, "type": "object" } }, "databricks:index/catalogWorkspaceBinding:CatalogWorkspaceBinding": { "description": "\u003e This resource has been deprecated and will be removed soon. Please use the\u003cspan pulumi-lang-nodejs=\" databricks.WorkspaceBinding \" pulumi-lang-dotnet=\" databricks.WorkspaceBinding \" pulumi-lang-go=\" WorkspaceBinding \" pulumi-lang-python=\" WorkspaceBinding \" pulumi-lang-yaml=\" databricks.WorkspaceBinding \" pulumi-lang-java=\" databricks.WorkspaceBinding \" pulumi-lang-hcl=\" databricks_workspace_binding \"\u003e databricks.WorkspaceBinding \u003c/span\u003eresource instead.\n\nIf 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\n\nBy default, Databricks assigns the catalog to all workspaces attached to the current metastore. By using \u003cspan pulumi-lang-nodejs=\"`databricks.CatalogWorkspaceBinding`\" pulumi-lang-dotnet=\"`databricks.CatalogWorkspaceBinding`\" pulumi-lang-go=\"`CatalogWorkspaceBinding`\" pulumi-lang-python=\"`CatalogWorkspaceBinding`\" pulumi-lang-yaml=\"`databricks.CatalogWorkspaceBinding`\" pulumi-lang-java=\"`databricks.CatalogWorkspaceBinding`\" pulumi-lang-hcl=\"`databricks_catalog_workspace_binding`\"\u003e`databricks.CatalogWorkspaceBinding`\u003c/span\u003e, the catalog will be unassigned from all workspaces and only assigned explicitly using this resource.\n\n\u003e To use this resource the catalog must have its isolation mode set to `ISOLATED` in the \u003cspan pulumi-lang-nodejs=\"`databricks.Catalog`\" pulumi-lang-dotnet=\"`databricks.Catalog`\" pulumi-lang-go=\"`Catalog`\" pulumi-lang-python=\"`Catalog`\" pulumi-lang-yaml=\"`databricks.Catalog`\" pulumi-lang-java=\"`databricks.Catalog`\" pulumi-lang-hcl=\"`databricks_catalog`\"\u003e`databricks.Catalog`\u003c/span\u003e 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).\n\n\u003e 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.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n name: \"sandbox\",\n isolationMode: \"ISOLATED\",\n});\nconst sandboxCatalogWorkspaceBinding = new databricks.CatalogWorkspaceBinding(\"sandbox\", {\n securableName: sandbox.name,\n workspaceId: other.workspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n name=\"sandbox\",\n isolation_mode=\"ISOLATED\")\nsandbox_catalog_workspace_binding = databricks.CatalogWorkspaceBinding(\"sandbox\",\n securable_name=sandbox.name,\n workspace_id=other[\"workspaceId\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n Name = \"sandbox\",\n IsolationMode = \"ISOLATED\",\n });\n\n var sandboxCatalogWorkspaceBinding = new Databricks.CatalogWorkspaceBinding(\"sandbox\", new()\n {\n SecurableName = sandbox.Name,\n WorkspaceId = other.WorkspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsandbox, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tIsolationMode: pulumi.String(\"ISOLATED\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewCatalogWorkspaceBinding(ctx, \"sandbox\", \u0026databricks.CatalogWorkspaceBindingArgs{\n\t\t\tSecurableName: sandbox.Name,\n\t\t\tWorkspaceId: pulumi.Any(other.WorkspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n name = \"sandbox\"\n isolation_mode = \"ISOLATED\"\n}\nresource \"databricks_catalogworkspacebinding\" \"sandbox\" {\n securable_name = databricks_catalog.sandbox.name\n workspace_id = other.workspaceId\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport com.pulumi.databricks.CatalogWorkspaceBinding;\nimport com.pulumi.databricks.CatalogWorkspaceBindingArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .name(\"sandbox\")\n .isolationMode(\"ISOLATED\")\n .build());\n\n var sandboxCatalogWorkspaceBinding = new CatalogWorkspaceBinding(\"sandboxCatalogWorkspaceBinding\", CatalogWorkspaceBindingArgs.builder()\n .securableName(sandbox.name())\n .workspaceId(other.workspaceId())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n name: sandbox\n isolationMode: ISOLATED\n sandboxCatalogWorkspaceBinding:\n type: databricks:CatalogWorkspaceBinding\n name: sandbox\n properties:\n securableName: ${sandbox.name}\n workspaceId: ${other.workspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "bindingType": { "type": "string", "description": "Binding mode. Default to `BINDING_TYPE_READ_WRITE`. Possible values are `BINDING_TYPE_READ_ONLY`, `BINDING_TYPE_READ_WRITE`\n" }, "catalogName": { "type": "string", "deprecationMessage": "Please use 'securable_name' and 'securable_type instead." }, "providerConfig": { "$ref": "#/types/databricks:index/CatalogWorkspaceBindingProviderConfig:CatalogWorkspaceBindingProviderConfig" }, "securableName": { "type": "string", "description": "Name of securable. Change forces creation of a new resource.\n" }, "securableType": { "type": "string", "description": "Type of securable. Default to \u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e. Change forces creation of a new resource.\n" }, "workspaceId": { "type": "string", "description": "ID of the workspace. Change forces creation of a new resource.\n" } }, "required": [ "providerConfig", "securableName", "workspaceId" ], "inputProperties": { "bindingType": { "type": "string", "description": "Binding mode. Default to `BINDING_TYPE_READ_WRITE`. Possible values are `BINDING_TYPE_READ_ONLY`, `BINDING_TYPE_READ_WRITE`\n", "willReplaceOnChanges": true }, "catalogName": { "type": "string", "deprecationMessage": "Please use 'securable_name' and 'securable_type instead.", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/CatalogWorkspaceBindingProviderConfig:CatalogWorkspaceBindingProviderConfig" }, "securableName": { "type": "string", "description": "Name of securable. Change forces creation of a new resource.\n" }, "securableType": { "type": "string", "description": "Type of securable. Default to \u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "workspaceId": { "type": "string", "description": "ID of the workspace. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "workspaceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering CatalogWorkspaceBinding resources.\n", "properties": { "bindingType": { "type": "string", "description": "Binding mode. Default to `BINDING_TYPE_READ_WRITE`. Possible values are `BINDING_TYPE_READ_ONLY`, `BINDING_TYPE_READ_WRITE`\n", "willReplaceOnChanges": true }, "catalogName": { "type": "string", "deprecationMessage": "Please use 'securable_name' and 'securable_type instead.", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/CatalogWorkspaceBindingProviderConfig:CatalogWorkspaceBindingProviderConfig" }, "securableName": { "type": "string", "description": "Name of securable. Change forces creation of a new resource.\n" }, "securableType": { "type": "string", "description": "Type of securable. Default to \u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "workspaceId": { "type": "string", "description": "ID of the workspace. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/cluster:Cluster": { "description": "This resource allows you to manage [Databricks Clusters](https://docs.databricks.com/clusters/index.html).\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e In case of `Cannot access cluster ####-######-####### that was terminated or unpinned more than 30 days ago` errors, please upgrade to v0.5.5 or later. If for some reason you cannot upgrade the version of provider, then the other viable option to unblock the apply pipeline is `terraform state rm path.to.databricks_cluster.resource` command.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst smallest = databricks.getNodeType({\n localDisk: true,\n});\nconst latestLts = databricks.getSparkVersion({\n longTermSupport: true,\n});\nconst sharedAutoscaling = new databricks.Cluster(\"shared_autoscaling\", {\n clusterName: \"Shared Autoscaling\",\n sparkVersion: latestLts.then(latestLts =\u003e latestLts.id),\n nodeTypeId: smallest.then(smallest =\u003e smallest.id),\n autoterminationMinutes: 20,\n autoscale: {\n minWorkers: 1,\n maxWorkers: 50,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsmallest = databricks.get_node_type(local_disk=True)\nlatest_lts = databricks.get_spark_version(long_term_support=True)\nshared_autoscaling = databricks.Cluster(\"shared_autoscaling\",\n cluster_name=\"Shared Autoscaling\",\n spark_version=latest_lts.id,\n node_type_id=smallest.id,\n autotermination_minutes=20,\n autoscale={\n \"min_workers\": 1,\n \"max_workers\": 50,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var smallest = Databricks.GetNodeType.Invoke(new()\n {\n LocalDisk = true,\n });\n\n var latestLts = Databricks.GetSparkVersion.Invoke(new()\n {\n LongTermSupport = true,\n });\n\n var sharedAutoscaling = new Databricks.Cluster(\"shared_autoscaling\", new()\n {\n ClusterName = \"Shared Autoscaling\",\n SparkVersion = latestLts.Apply(getSparkVersionResult =\u003e getSparkVersionResult.Id),\n NodeTypeId = smallest.Apply(getNodeTypeResult =\u003e getNodeTypeResult.Id),\n AutoterminationMinutes = 20,\n Autoscale = new Databricks.Inputs.ClusterAutoscaleArgs\n {\n MinWorkers = 1,\n MaxWorkers = 50,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsmallest, err := databricks.GetNodeType(ctx, \u0026databricks.GetNodeTypeArgs{\n\t\t\tLocalDisk: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlatestLts, err := databricks.GetSparkVersion(ctx, \u0026databricks.GetSparkVersionArgs{\n\t\t\tLongTermSupport: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewCluster(ctx, \"shared_autoscaling\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Shared Autoscaling\"),\n\t\t\tSparkVersion: pulumi.String(pulumi.String(latestLts.Id)),\n\t\t\tNodeTypeId: pulumi.String(pulumi.String(smallest.Id)),\n\t\t\tAutoterminationMinutes: pulumi.Int(20),\n\t\t\tAutoscale: \u0026databricks.ClusterAutoscaleArgs{\n\t\t\t\tMinWorkers: pulumi.Int(1),\n\t\t\t\tMaxWorkers: pulumi.Int(50),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getnodetype\" \"smallest\" {\n local_disk = true\n}\ndata \"databricks_getsparkversion\" \"latestLts\" {\n long_term_support = true\n}\n\nresource \"databricks_cluster\" \"shared_autoscaling\" {\n cluster_name = \"Shared Autoscaling\"\n spark_version = data.databricks_getsparkversion.latestLts.id\n node_type_id = data.databricks_getnodetype.smallest.id\n autotermination_minutes = 20\n autoscale = {\n min_workers = 1\n max_workers = 50\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetNodeTypeArgs;\nimport com.pulumi.databricks.inputs.GetSparkVersionArgs;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport com.pulumi.databricks.inputs.ClusterAutoscaleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var smallest = DatabricksFunctions.getNodeType(GetNodeTypeArgs.builder()\n .localDisk(true)\n .build());\n\n final var latestLts = DatabricksFunctions.getSparkVersion(GetSparkVersionArgs.builder()\n .longTermSupport(true)\n .build());\n\n var sharedAutoscaling = new Cluster(\"sharedAutoscaling\", ClusterArgs.builder()\n .clusterName(\"Shared Autoscaling\")\n .sparkVersion(latestLts.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(20)\n .autoscale(ClusterAutoscaleArgs.builder()\n .minWorkers(1)\n .maxWorkers(50)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sharedAutoscaling:\n type: databricks:Cluster\n name: shared_autoscaling\n properties:\n clusterName: Shared Autoscaling\n sparkVersion: ${latestLts.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 20\n autoscale:\n minWorkers: 1\n maxWorkers: 50\nvariables:\n smallest:\n fn::invoke:\n function: databricks:getNodeType\n arguments:\n localDisk: true\n latestLts:\n fn::invoke:\n function: databricks:getSparkVersion\n arguments:\n longTermSupport: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003ecan control which groups or individual users can create clusters.\n*\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003ecan control which kinds of clusters users can create.\n* Users, who have access to Cluster Policy, but do not have an \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set would still be able to create clusters, but within the boundary of the policy.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Manage*, *Restart* or *Attach to* individual clusters.\n* \u003cspan pulumi-lang-nodejs=\"`instanceProfileArn`\" pulumi-lang-dotnet=\"`InstanceProfileArn`\" pulumi-lang-go=\"`instanceProfileArn`\" pulumi-lang-python=\"`instance_profile_arn`\" pulumi-lang-yaml=\"`instanceProfileArn`\" pulumi-lang-java=\"`instanceProfileArn`\" pulumi-lang-hcl=\"`instance_profile_arn`\"\u003e`instanceProfileArn`\u003c/span\u003e *(AWS only)* can control which data a given cluster can access through cloud-native controls.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* Dynamic Passthrough Clusters for a Group guide.\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getClusters \" pulumi-lang-dotnet=\" databricks.getClusters \" pulumi-lang-go=\" getClusters \" pulumi-lang-python=\" get_clusters \" pulumi-lang-yaml=\" databricks.getClusters \" pulumi-lang-java=\" databricks.getClusters \" pulumi-lang-hcl=\" data.databricks_clusters \"\u003e databricks.getClusters \u003c/span\u003edata to retrieve a list of\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eids.\n*\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003eto create a\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003epolicy, which limits the ability to create clusters based on a set of rules.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getCurrentUser \" pulumi-lang-dotnet=\" databricks.getCurrentUser \" pulumi-lang-go=\" getCurrentUser \" pulumi-lang-python=\" get_current_user \" pulumi-lang-yaml=\" databricks.getCurrentUser \" pulumi-lang-java=\" databricks.getCurrentUser \" pulumi-lang-hcl=\" data.databricks_current_user \"\u003e databricks.getCurrentUser \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003eor databricks_service_principal, that is calling Databricks REST API.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GlobalInitScript \" pulumi-lang-dotnet=\" databricks.GlobalInitScript \" pulumi-lang-go=\" GlobalInitScript \" pulumi-lang-python=\" GlobalInitScript \" pulumi-lang-yaml=\" databricks.GlobalInitScript \" pulumi-lang-java=\" databricks.GlobalInitScript \" pulumi-lang-hcl=\" databricks_global_init_script \"\u003e databricks.GlobalInitScript \u003c/span\u003eto manage [global init scripts](https://docs.databricks.com/clusters/init-scripts.html#global-init-scripts), which are run on all\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand databricks_job.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstancePool \" pulumi-lang-dotnet=\" databricks.InstancePool \" pulumi-lang-go=\" InstancePool \" pulumi-lang-python=\" InstancePool \" pulumi-lang-yaml=\" databricks.InstancePool \" pulumi-lang-java=\" databricks.InstancePool \" pulumi-lang-hcl=\" databricks_instance_pool \"\u003e databricks.InstancePool \u003c/span\u003eto manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eto manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eto manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a databricks_cluster.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Library \" pulumi-lang-dotnet=\" databricks.Library \" pulumi-lang-go=\" Library \" pulumi-lang-python=\" Library \" pulumi-lang-yaml=\" databricks.Library \" pulumi-lang-java=\" databricks.Library \" pulumi-lang-hcl=\" databricks_library \"\u003e databricks.Library \u003c/span\u003eto install a [library](https://docs.databricks.com/libraries/index.html) on databricks_cluster.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003edata to get the smallest node type for\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003ethat fits search criteria, like amount of RAM or number of cores.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Pipeline \" pulumi-lang-dotnet=\" databricks.Pipeline \" pulumi-lang-go=\" Pipeline \" pulumi-lang-python=\" Pipeline \" pulumi-lang-yaml=\" databricks.Pipeline \" pulumi-lang-java=\" databricks.Pipeline \" pulumi-lang-hcl=\" databricks_pipeline \"\u003e databricks.Pipeline \u003c/span\u003eto deploy [Lakeflow Declarative Pipelines](https://docs.databricks.com/aws/en/dlt).\n*\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003edata to get [Databricks Runtime (DBR)](https://docs.databricks.com/runtime/dbr.html) version that could be used for \u003cspan pulumi-lang-nodejs=\"`sparkVersion`\" pulumi-lang-dotnet=\"`SparkVersion`\" pulumi-lang-go=\"`sparkVersion`\" pulumi-lang-python=\"`spark_version`\" pulumi-lang-yaml=\"`sparkVersion`\" pulumi-lang-java=\"`sparkVersion`\" pulumi-lang-hcl=\"`spark_version`\"\u003e`sparkVersion`\u003c/span\u003e parameter in\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand other resources.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getZones \" pulumi-lang-dotnet=\" databricks.getZones \" pulumi-lang-go=\" getZones \" pulumi-lang-python=\" get_zones \" pulumi-lang-yaml=\" databricks.getZones \" pulumi-lang-java=\" databricks.getZones \" pulumi-lang-hcl=\" data.databricks_zones \"\u003e databricks.getZones \u003c/span\u003edata to fetch all available AWS availability zones on your workspace on AWS.\n\n## Import\n\nThe resource cluster can be imported using cluster id.\n\n```sh\n$ pulumi import databricks:index/cluster:Cluster this \u003ccluster-id\u003e\n```\n\n", "properties": { "applyPolicyDefaultValues": { "type": "boolean", "description": "Whether to use policy default values for missing cluster attributes.\n" }, "autoscale": { "$ref": "#/types/databricks:index/ClusterAutoscale:ClusterAutoscale" }, "autoterminationMinutes": { "type": "integer", "description": "Automatically terminate the cluster after being inactive for this time in minutes. If specified, the threshold must be between 10 and 10000 minutes. You can also set this value to 0 to explicitly disable automatic termination. Defaults to \u003cspan pulumi-lang-nodejs=\"`60`\" pulumi-lang-dotnet=\"`60`\" pulumi-lang-go=\"`60`\" pulumi-lang-python=\"`60`\" pulumi-lang-yaml=\"`60`\" pulumi-lang-java=\"`60`\" pulumi-lang-hcl=\"`60`\"\u003e`60`\u003c/span\u003e. *We highly recommend having this setting present for Interactive/BI clusters.*\n" }, "awsAttributes": { "$ref": "#/types/databricks:index/ClusterAwsAttributes:ClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/ClusterAzureAttributes:ClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/ClusterClusterLogConf:ClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterClusterMountInfo:ClusterClusterMountInfo" } }, "clusterName": { "type": "string", "description": "Cluster name, which doesn't have to be unique. If not specified at creation, the cluster name will be an empty string.\n" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "should have tag `ResourceClass` set to value `Serverless`\n\nFor example:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst clusterWithTableAccessControl = new databricks.Cluster(\"cluster_with_table_access_control\", {\n clusterName: \"Shared High-Concurrency\",\n sparkVersion: latestLts.id,\n nodeTypeId: smallest.id,\n autoterminationMinutes: 20,\n sparkConf: {\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.cluster.profile\": \"serverless\",\n },\n customTags: {\n ResourceClass: \"Serverless\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncluster_with_table_access_control = databricks.Cluster(\"cluster_with_table_access_control\",\n cluster_name=\"Shared High-Concurrency\",\n spark_version=latest_lts[\"id\"],\n node_type_id=smallest[\"id\"],\n autotermination_minutes=20,\n spark_conf={\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.cluster.profile\": \"serverless\",\n },\n custom_tags={\n \"ResourceClass\": \"Serverless\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var clusterWithTableAccessControl = new Databricks.Cluster(\"cluster_with_table_access_control\", new()\n {\n ClusterName = \"Shared High-Concurrency\",\n SparkVersion = latestLts.Id,\n NodeTypeId = smallest.Id,\n AutoterminationMinutes = 20,\n SparkConf = \n {\n { \"spark.databricks.repl.allowedLanguages\", \"python,sql\" },\n { \"spark.databricks.cluster.profile\", \"serverless\" },\n },\n CustomTags = \n {\n { \"ResourceClass\", \"Serverless\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewCluster(ctx, \"cluster_with_table_access_control\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Shared High-Concurrency\"),\n\t\t\tSparkVersion: pulumi.Any(latestLts.Id),\n\t\t\tNodeTypeId: pulumi.Any(smallest.Id),\n\t\t\tAutoterminationMinutes: pulumi.Int(20),\n\t\t\tSparkConf: pulumi.StringMap{\n\t\t\t\t\"spark.databricks.repl.allowedLanguages\": pulumi.String(\"python,sql\"),\n\t\t\t\t\"spark.databricks.cluster.profile\": pulumi.String(\"serverless\"),\n\t\t\t},\n\t\t\tCustomTags: pulumi.StringMap{\n\t\t\t\t\"ResourceClass\": pulumi.String(\"Serverless\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_cluster\" \"cluster_with_table_access_control\" {\n cluster_name = \"Shared High-Concurrency\"\n spark_version = latestLts.id\n node_type_id = smallest.id\n autotermination_minutes = 20\n spark_conf = {\n \"spark.databricks.repl.allowedLanguages\" = \"python,sql\"\n \"spark.databricks.cluster.profile\" = \"serverless\"\n }\n custom_tags = {\n \"ResourceClass\" = \"Serverless\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var clusterWithTableAccessControl = new Cluster(\"clusterWithTableAccessControl\", ClusterArgs.builder()\n .clusterName(\"Shared High-Concurrency\")\n .sparkVersion(latestLts.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(20)\n .sparkConf(Map.ofEntries(\n Map.entry(\"spark.databricks.repl.allowedLanguages\", \"python,sql\"),\n Map.entry(\"spark.databricks.cluster.profile\", \"serverless\")\n ))\n .customTags(Map.of(\"ResourceClass\", \"Serverless\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n clusterWithTableAccessControl:\n type: databricks:Cluster\n name: cluster_with_table_access_control\n properties:\n clusterName: Shared High-Concurrency\n sparkVersion: ${latestLts.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 20\n sparkConf:\n spark.databricks.repl.allowedLanguages: python,sql\n spark.databricks.cluster.profile: serverless\n customTags:\n ResourceClass: Serverless\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "dataSecurityMode": { "type": "string", "description": "Select the security features of the cluster (see [API docs](https://docs.databricks.com/api/workspace/clusters/create#data_security_mode) for full list of values). [Unity Catalog requires](https://docs.databricks.com/data-governance/unity-catalog/compute.html#create-clusters--sql-warehouses-with-unity-catalog-access) `SINGLE_USER` or `USER_ISOLATION` mode. `LEGACY_PASSTHROUGH` for passthrough cluster and `LEGACY_TABLE_ACL` for Table ACL cluster. If omitted, default security features are enabled. To disable security features use `NONE` or legacy mode `NO_ISOLATION`. If \u003cspan pulumi-lang-nodejs=\"`kind`\" pulumi-lang-dotnet=\"`Kind`\" pulumi-lang-go=\"`kind`\" pulumi-lang-python=\"`kind`\" pulumi-lang-yaml=\"`kind`\" pulumi-lang-java=\"`kind`\" pulumi-lang-hcl=\"`kind`\"\u003e`kind`\u003c/span\u003e is specified, then the following options are available:\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n" }, "defaultTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(map) Tags that are added by Databricks by default, regardless of any \u003cspan pulumi-lang-nodejs=\"`customTags`\" pulumi-lang-dotnet=\"`CustomTags`\" pulumi-lang-go=\"`customTags`\" pulumi-lang-python=\"`custom_tags`\" pulumi-lang-yaml=\"`customTags`\" pulumi-lang-java=\"`customTags`\" pulumi-lang-hcl=\"`custom_tags`\"\u003e`customTags`\u003c/span\u003e that may have been added. These include: Vendor: Databricks, Creator: \u003cusername_of_creator\u003e, ClusterName: \u003cname_of_cluster\u003e, ClusterId: \u003cid_of_cluster\u003e, Name: \u003cDatabricks internal use\u003e, and any workspace and pool tags.\n" }, "dockerImage": { "$ref": "#/types/databricks:index/ClusterDockerImage:ClusterDockerImage" }, "driverInstancePoolId": { "type": "string", "description": "similar to \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e, but for driver node. If omitted, and \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e is specified, then the driver will be allocated from that pool.\n" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/ClusterDriverNodeTypeFlexibility:ClusterDriverNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`driverNodeTypeId`\" pulumi-lang-dotnet=\"`DriverNodeTypeId`\" pulumi-lang-go=\"`driverNodeTypeId`\" pulumi-lang-python=\"`driver_node_type_id`\" pulumi-lang-yaml=\"`driverNodeTypeId`\" pulumi-lang-java=\"`driverNodeTypeId`\" pulumi-lang-hcl=\"`driver_node_type_id`\"\u003e`driverNodeTypeId`\u003c/span\u003e isn't available.\n" }, "driverNodeTypeId": { "type": "string", "description": "The node type of the Spark driver. This field is optional; if unset, API will set the driver node type to the same value as \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e defined above.\n" }, "enableElasticDisk": { "type": "boolean", "description": "If you don't want to allocate a fixed number of EBS volumes at cluster creation time, use autoscaling local storage. With autoscaling local storage, Databricks monitors the amount of free disk space available on your cluster's Spark workers. If a worker begins to run too low on disk, Databricks automatically attaches a new EBS volume to the worker before it runs out of disk space. EBS volumes are attached up to a limit of 5 TB of total disk space per instance (including the instance's local storage). To scale down EBS usage, make sure you have \u003cspan pulumi-lang-nodejs=\"`autoterminationMinutes`\" pulumi-lang-dotnet=\"`AutoterminationMinutes`\" pulumi-lang-go=\"`autoterminationMinutes`\" pulumi-lang-python=\"`autotermination_minutes`\" pulumi-lang-yaml=\"`autoterminationMinutes`\" pulumi-lang-java=\"`autoterminationMinutes`\" pulumi-lang-hcl=\"`autotermination_minutes`\"\u003e`autoterminationMinutes`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`autoscale`\" pulumi-lang-dotnet=\"`Autoscale`\" pulumi-lang-go=\"`autoscale`\" pulumi-lang-python=\"`autoscale`\" pulumi-lang-yaml=\"`autoscale`\" pulumi-lang-java=\"`autoscale`\" pulumi-lang-hcl=\"`autoscale`\"\u003e`autoscale`\u003c/span\u003e attributes set. More documentation available at [cluster configuration page](https://docs.databricks.com/clusters/configure.html#autoscaling-local-storage-1).\n" }, "enableLocalDiskEncryption": { "type": "boolean", "description": "Some instance types you use to run clusters may have locally attached disks. Databricks may store shuffle data or temporary data on these locally attached disks. To ensure that all data at rest is encrypted for all storage types, including shuffle data stored temporarily on your cluster's local disks, you can enable local disk encryption. When local disk encryption is enabled, Databricks generates an encryption key locally unique to each cluster node and uses it to encrypt all data stored on local disks. The scope of the key is local to each cluster node and is destroyed along with the cluster node itself. During its lifetime, the key resides in memory for encryption and decryption and is stored encrypted on the disk. *Your workloads may run more slowly because of the performance impact of reading and writing encrypted data to and from local volumes. This feature is not available for all Azure Databricks subscriptions. Contact your Microsoft or Databricks account representative to request access.*\n" }, "gcpAttributes": { "$ref": "#/types/databricks:index/ClusterGcpAttributes:ClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "description": "An optional token to guarantee the idempotency of cluster creation requests. If an active cluster with the provided token already exists, the request will not create a new cluster, but it will return the existing running cluster's ID instead. If you specify the idempotency token, upon failure, you can retry until the request succeeds. Databricks platform guarantees to launch exactly one cluster with that idempotency token. This token should have at most 64 characters.\n" }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterInitScript:ClusterInitScript" } }, "instancePoolId": { "type": "string", "description": "To reduce cluster start time, you can attach a cluster to a predefined pool of idle instances. When attached to a pool, a cluster allocates its driver and worker nodes from the pool. If the pool does not have sufficient idle resources to accommodate the cluster's request, it expands by allocating new instances from the instance provider. When an attached cluster changes its state to `TERMINATED`, the instances it used are returned to the pool and reused by a different cluster.\n" }, "isPinned": { "type": "boolean", "description": "boolean value specifying if the cluster is pinned (not pinned by default). You must be a Databricks administrator to use this. The pinned clusters' maximum number is [limited to 100](https://docs.databricks.com/clusters/clusters-manage.html#pin-a-cluster), so \u003cspan pulumi-lang-nodejs=\"`apply`\" pulumi-lang-dotnet=\"`Apply`\" pulumi-lang-go=\"`apply`\" pulumi-lang-python=\"`apply`\" pulumi-lang-yaml=\"`apply`\" pulumi-lang-java=\"`apply`\" pulumi-lang-hcl=\"`apply`\"\u003e`apply`\u003c/span\u003e may fail if you have more than that (this number may change over time, so check Databricks documentation for actual number).\n" }, "isSingleNode": { "type": "boolean", "description": "When set to true, Databricks will automatically set single node related \u003cspan pulumi-lang-nodejs=\"`customTags`\" pulumi-lang-dotnet=\"`CustomTags`\" pulumi-lang-go=\"`customTags`\" pulumi-lang-python=\"`custom_tags`\" pulumi-lang-yaml=\"`customTags`\" pulumi-lang-java=\"`customTags`\" pulumi-lang-hcl=\"`custom_tags`\"\u003e`customTags`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`sparkConf`\" pulumi-lang-dotnet=\"`SparkConf`\" pulumi-lang-go=\"`sparkConf`\" pulumi-lang-python=\"`spark_conf`\" pulumi-lang-yaml=\"`sparkConf`\" pulumi-lang-java=\"`sparkConf`\" pulumi-lang-hcl=\"`spark_conf`\"\u003e`sparkConf`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e.\n" }, "kind": { "type": "string", "description": "The kind of compute described by this compute specification. Possible values (see [API docs](https://docs.databricks.com/api/workspace/clusters/create#kind) for full list): `CLASSIC_PREVIEW` (if corresponding public preview is enabled).\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterLibrary:ClusterLibrary" } }, "noWait": { "type": "boolean", "description": "If true, the provider will not wait for the cluster to reach `RUNNING` state when creating the cluster, allowing cluster creation and library installation to continue asynchronously. Defaults to false (the provider will wait for cluster creation and library installation to succeed).\n" }, "nodeTypeId": { "type": "string", "description": "Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003eid. If \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e is specified, this field is not needed.\n" }, "numWorkers": { "type": "integer", "description": "Number of worker nodes that this cluster should have. A cluster has one Spark driver and \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e executors for a total of \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e + 1 Spark nodes.\n" }, "policyId": { "type": "string", "description": "Identifier of Cluster Policy to validate cluster and preset certain defaults. *The primary use for cluster policies is to allow users to create policy-scoped clusters via UI rather than sharing configuration for API-created clusters.* For example, when you specify \u003cspan pulumi-lang-nodejs=\"`policyId`\" pulumi-lang-dotnet=\"`PolicyId`\" pulumi-lang-go=\"`policyId`\" pulumi-lang-python=\"`policy_id`\" pulumi-lang-yaml=\"`policyId`\" pulumi-lang-java=\"`policyId`\" pulumi-lang-hcl=\"`policy_id`\"\u003e`policyId`\u003c/span\u003e of [external metastore](https://docs.databricks.com/administration-guide/clusters/policies.html#external-metastore-policy) policy, you still have to fill in relevant keys for \u003cspan pulumi-lang-nodejs=\"`sparkConf`\" pulumi-lang-dotnet=\"`SparkConf`\" pulumi-lang-go=\"`sparkConf`\" pulumi-lang-python=\"`spark_conf`\" pulumi-lang-yaml=\"`sparkConf`\" pulumi-lang-java=\"`sparkConf`\" pulumi-lang-hcl=\"`spark_conf`\"\u003e`sparkConf`\u003c/span\u003e. If relevant fields aren't filled in, then it will cause the configuration drift detected on each plan/apply, and Pulumi will try to apply the detected changes.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterProviderConfig:ClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string", "description": "The type of runtime engine to use. If not specified, the runtime engine type is inferred based on the\u003cspan pulumi-lang-nodejs=\" sparkVersion \" pulumi-lang-dotnet=\" SparkVersion \" pulumi-lang-go=\" sparkVersion \" pulumi-lang-python=\" spark_version \" pulumi-lang-yaml=\" sparkVersion \" pulumi-lang-java=\" sparkVersion \" pulumi-lang-hcl=\" spark_version \"\u003e sparkVersion \u003c/span\u003evalue. Allowed values include: `PHOTON`, `STANDARD`.\n" }, "singleUserName": { "type": "string", "description": "The optional user name of the user (or group name if \u003cspan pulumi-lang-nodejs=\"`kind`\" pulumi-lang-dotnet=\"`Kind`\" pulumi-lang-go=\"`kind`\" pulumi-lang-python=\"`kind`\" pulumi-lang-yaml=\"`kind`\" pulumi-lang-java=\"`kind`\" pulumi-lang-hcl=\"`kind`\"\u003e`kind`\u003c/span\u003e if specified) to assign to an interactive cluster. This field is required when using \u003cspan pulumi-lang-nodejs=\"`dataSecurityMode`\" pulumi-lang-dotnet=\"`DataSecurityMode`\" pulumi-lang-go=\"`dataSecurityMode`\" pulumi-lang-python=\"`data_security_mode`\" pulumi-lang-yaml=\"`dataSecurityMode`\" pulumi-lang-java=\"`dataSecurityMode`\" pulumi-lang-hcl=\"`data_security_mode`\"\u003e`dataSecurityMode`\u003c/span\u003e set to `SINGLE_USER` or AAD Passthrough for Azure Data Lake Storage (ADLS) with a single-user cluster (i.e., not high-concurrency clusters).\n" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" }, "description": "should have following items:\n* `spark.databricks.repl.allowedLanguages` set to a list of supported languages, for example: `python,sql`, or `python,sql,r`. Scala is not supported!\n* `spark.databricks.cluster.profile` set to \u003cspan pulumi-lang-nodejs=\"`serverless`\" pulumi-lang-dotnet=\"`Serverless`\" pulumi-lang-go=\"`serverless`\" pulumi-lang-python=\"`serverless`\" pulumi-lang-yaml=\"`serverless`\" pulumi-lang-java=\"`serverless`\" pulumi-lang-hcl=\"`serverless`\"\u003e`serverless`\u003c/span\u003e\n" }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with environment variable key-value pairs to fine-tune Spark clusters. Key-value pairs of the form (X,Y) are exported (i.e., X='Y') while launching the driver and workers.\n" }, "sparkVersion": { "type": "string", "description": "[Runtime version](https://docs.databricks.com/runtime/index.html) of the cluster. Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003eid. We advise using Cluster Policies to restrict the list of versions for simplicity while maintaining enough control.\n" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public key contents that will be added to each Spark node in this cluster. The corresponding private keys can be used to login with the user name ubuntu on port 2200. You can specify up to 10 keys.\n" }, "state": { "type": "string", "description": "(string) State of the cluster.\n" }, "totalInitialRemoteDiskSize": { "type": "integer" }, "url": { "type": "string" }, "useMlRuntime": { "type": "boolean", "description": "Whenever ML runtime should be selected or not. Actual runtime is determined by \u003cspan pulumi-lang-nodejs=\"`sparkVersion`\" pulumi-lang-dotnet=\"`SparkVersion`\" pulumi-lang-go=\"`sparkVersion`\" pulumi-lang-python=\"`spark_version`\" pulumi-lang-yaml=\"`sparkVersion`\" pulumi-lang-java=\"`sparkVersion`\" pulumi-lang-hcl=\"`spark_version`\"\u003e`sparkVersion`\u003c/span\u003e (DBR release), this field \u003cspan pulumi-lang-nodejs=\"`useMlRuntime`\" pulumi-lang-dotnet=\"`UseMlRuntime`\" pulumi-lang-go=\"`useMlRuntime`\" pulumi-lang-python=\"`use_ml_runtime`\" pulumi-lang-yaml=\"`useMlRuntime`\" pulumi-lang-java=\"`useMlRuntime`\" pulumi-lang-hcl=\"`use_ml_runtime`\"\u003e`useMlRuntime`\u003c/span\u003e, and whether \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e is GPU node or not.\n" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/ClusterWorkerNodeTypeFlexibility:ClusterWorkerNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e isn't available.\n" }, "workloadType": { "$ref": "#/types/databricks:index/ClusterWorkloadType:ClusterWorkloadType" } }, "required": [ "clusterId", "defaultTags", "driverInstancePoolId", "driverNodeTypeId", "enableElasticDisk", "enableLocalDiskEncryption", "nodeTypeId", "providerConfig", "sparkVersion", "state", "url" ], "inputProperties": { "applyPolicyDefaultValues": { "type": "boolean", "description": "Whether to use policy default values for missing cluster attributes.\n" }, "autoscale": { "$ref": "#/types/databricks:index/ClusterAutoscale:ClusterAutoscale" }, "autoterminationMinutes": { "type": "integer", "description": "Automatically terminate the cluster after being inactive for this time in minutes. If specified, the threshold must be between 10 and 10000 minutes. You can also set this value to 0 to explicitly disable automatic termination. Defaults to \u003cspan pulumi-lang-nodejs=\"`60`\" pulumi-lang-dotnet=\"`60`\" pulumi-lang-go=\"`60`\" pulumi-lang-python=\"`60`\" pulumi-lang-yaml=\"`60`\" pulumi-lang-java=\"`60`\" pulumi-lang-hcl=\"`60`\"\u003e`60`\u003c/span\u003e. *We highly recommend having this setting present for Interactive/BI clusters.*\n" }, "awsAttributes": { "$ref": "#/types/databricks:index/ClusterAwsAttributes:ClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/ClusterAzureAttributes:ClusterAzureAttributes" }, "clusterLogConf": { "$ref": "#/types/databricks:index/ClusterClusterLogConf:ClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterClusterMountInfo:ClusterClusterMountInfo" } }, "clusterName": { "type": "string", "description": "Cluster name, which doesn't have to be unique. If not specified at creation, the cluster name will be an empty string.\n" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "should have tag `ResourceClass` set to value `Serverless`\n\nFor example:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst clusterWithTableAccessControl = new databricks.Cluster(\"cluster_with_table_access_control\", {\n clusterName: \"Shared High-Concurrency\",\n sparkVersion: latestLts.id,\n nodeTypeId: smallest.id,\n autoterminationMinutes: 20,\n sparkConf: {\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.cluster.profile\": \"serverless\",\n },\n customTags: {\n ResourceClass: \"Serverless\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncluster_with_table_access_control = databricks.Cluster(\"cluster_with_table_access_control\",\n cluster_name=\"Shared High-Concurrency\",\n spark_version=latest_lts[\"id\"],\n node_type_id=smallest[\"id\"],\n autotermination_minutes=20,\n spark_conf={\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.cluster.profile\": \"serverless\",\n },\n custom_tags={\n \"ResourceClass\": \"Serverless\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var clusterWithTableAccessControl = new Databricks.Cluster(\"cluster_with_table_access_control\", new()\n {\n ClusterName = \"Shared High-Concurrency\",\n SparkVersion = latestLts.Id,\n NodeTypeId = smallest.Id,\n AutoterminationMinutes = 20,\n SparkConf = \n {\n { \"spark.databricks.repl.allowedLanguages\", \"python,sql\" },\n { \"spark.databricks.cluster.profile\", \"serverless\" },\n },\n CustomTags = \n {\n { \"ResourceClass\", \"Serverless\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewCluster(ctx, \"cluster_with_table_access_control\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Shared High-Concurrency\"),\n\t\t\tSparkVersion: pulumi.Any(latestLts.Id),\n\t\t\tNodeTypeId: pulumi.Any(smallest.Id),\n\t\t\tAutoterminationMinutes: pulumi.Int(20),\n\t\t\tSparkConf: pulumi.StringMap{\n\t\t\t\t\"spark.databricks.repl.allowedLanguages\": pulumi.String(\"python,sql\"),\n\t\t\t\t\"spark.databricks.cluster.profile\": pulumi.String(\"serverless\"),\n\t\t\t},\n\t\t\tCustomTags: pulumi.StringMap{\n\t\t\t\t\"ResourceClass\": pulumi.String(\"Serverless\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_cluster\" \"cluster_with_table_access_control\" {\n cluster_name = \"Shared High-Concurrency\"\n spark_version = latestLts.id\n node_type_id = smallest.id\n autotermination_minutes = 20\n spark_conf = {\n \"spark.databricks.repl.allowedLanguages\" = \"python,sql\"\n \"spark.databricks.cluster.profile\" = \"serverless\"\n }\n custom_tags = {\n \"ResourceClass\" = \"Serverless\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var clusterWithTableAccessControl = new Cluster(\"clusterWithTableAccessControl\", ClusterArgs.builder()\n .clusterName(\"Shared High-Concurrency\")\n .sparkVersion(latestLts.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(20)\n .sparkConf(Map.ofEntries(\n Map.entry(\"spark.databricks.repl.allowedLanguages\", \"python,sql\"),\n Map.entry(\"spark.databricks.cluster.profile\", \"serverless\")\n ))\n .customTags(Map.of(\"ResourceClass\", \"Serverless\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n clusterWithTableAccessControl:\n type: databricks:Cluster\n name: cluster_with_table_access_control\n properties:\n clusterName: Shared High-Concurrency\n sparkVersion: ${latestLts.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 20\n sparkConf:\n spark.databricks.repl.allowedLanguages: python,sql\n spark.databricks.cluster.profile: serverless\n customTags:\n ResourceClass: Serverless\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "dataSecurityMode": { "type": "string", "description": "Select the security features of the cluster (see [API docs](https://docs.databricks.com/api/workspace/clusters/create#data_security_mode) for full list of values). [Unity Catalog requires](https://docs.databricks.com/data-governance/unity-catalog/compute.html#create-clusters--sql-warehouses-with-unity-catalog-access) `SINGLE_USER` or `USER_ISOLATION` mode. `LEGACY_PASSTHROUGH` for passthrough cluster and `LEGACY_TABLE_ACL` for Table ACL cluster. If omitted, default security features are enabled. To disable security features use `NONE` or legacy mode `NO_ISOLATION`. If \u003cspan pulumi-lang-nodejs=\"`kind`\" pulumi-lang-dotnet=\"`Kind`\" pulumi-lang-go=\"`kind`\" pulumi-lang-python=\"`kind`\" pulumi-lang-yaml=\"`kind`\" pulumi-lang-java=\"`kind`\" pulumi-lang-hcl=\"`kind`\"\u003e`kind`\u003c/span\u003e is specified, then the following options are available:\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n" }, "dockerImage": { "$ref": "#/types/databricks:index/ClusterDockerImage:ClusterDockerImage" }, "driverInstancePoolId": { "type": "string", "description": "similar to \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e, but for driver node. If omitted, and \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e is specified, then the driver will be allocated from that pool.\n" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/ClusterDriverNodeTypeFlexibility:ClusterDriverNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`driverNodeTypeId`\" pulumi-lang-dotnet=\"`DriverNodeTypeId`\" pulumi-lang-go=\"`driverNodeTypeId`\" pulumi-lang-python=\"`driver_node_type_id`\" pulumi-lang-yaml=\"`driverNodeTypeId`\" pulumi-lang-java=\"`driverNodeTypeId`\" pulumi-lang-hcl=\"`driver_node_type_id`\"\u003e`driverNodeTypeId`\u003c/span\u003e isn't available.\n" }, "driverNodeTypeId": { "type": "string", "description": "The node type of the Spark driver. This field is optional; if unset, API will set the driver node type to the same value as \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e defined above.\n" }, "enableElasticDisk": { "type": "boolean", "description": "If you don't want to allocate a fixed number of EBS volumes at cluster creation time, use autoscaling local storage. With autoscaling local storage, Databricks monitors the amount of free disk space available on your cluster's Spark workers. If a worker begins to run too low on disk, Databricks automatically attaches a new EBS volume to the worker before it runs out of disk space. EBS volumes are attached up to a limit of 5 TB of total disk space per instance (including the instance's local storage). To scale down EBS usage, make sure you have \u003cspan pulumi-lang-nodejs=\"`autoterminationMinutes`\" pulumi-lang-dotnet=\"`AutoterminationMinutes`\" pulumi-lang-go=\"`autoterminationMinutes`\" pulumi-lang-python=\"`autotermination_minutes`\" pulumi-lang-yaml=\"`autoterminationMinutes`\" pulumi-lang-java=\"`autoterminationMinutes`\" pulumi-lang-hcl=\"`autotermination_minutes`\"\u003e`autoterminationMinutes`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`autoscale`\" pulumi-lang-dotnet=\"`Autoscale`\" pulumi-lang-go=\"`autoscale`\" pulumi-lang-python=\"`autoscale`\" pulumi-lang-yaml=\"`autoscale`\" pulumi-lang-java=\"`autoscale`\" pulumi-lang-hcl=\"`autoscale`\"\u003e`autoscale`\u003c/span\u003e attributes set. More documentation available at [cluster configuration page](https://docs.databricks.com/clusters/configure.html#autoscaling-local-storage-1).\n" }, "enableLocalDiskEncryption": { "type": "boolean", "description": "Some instance types you use to run clusters may have locally attached disks. Databricks may store shuffle data or temporary data on these locally attached disks. To ensure that all data at rest is encrypted for all storage types, including shuffle data stored temporarily on your cluster's local disks, you can enable local disk encryption. When local disk encryption is enabled, Databricks generates an encryption key locally unique to each cluster node and uses it to encrypt all data stored on local disks. The scope of the key is local to each cluster node and is destroyed along with the cluster node itself. During its lifetime, the key resides in memory for encryption and decryption and is stored encrypted on the disk. *Your workloads may run more slowly because of the performance impact of reading and writing encrypted data to and from local volumes. This feature is not available for all Azure Databricks subscriptions. Contact your Microsoft or Databricks account representative to request access.*\n" }, "gcpAttributes": { "$ref": "#/types/databricks:index/ClusterGcpAttributes:ClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "description": "An optional token to guarantee the idempotency of cluster creation requests. If an active cluster with the provided token already exists, the request will not create a new cluster, but it will return the existing running cluster's ID instead. If you specify the idempotency token, upon failure, you can retry until the request succeeds. Databricks platform guarantees to launch exactly one cluster with that idempotency token. This token should have at most 64 characters.\n", "willReplaceOnChanges": true }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterInitScript:ClusterInitScript" } }, "instancePoolId": { "type": "string", "description": "To reduce cluster start time, you can attach a cluster to a predefined pool of idle instances. When attached to a pool, a cluster allocates its driver and worker nodes from the pool. If the pool does not have sufficient idle resources to accommodate the cluster's request, it expands by allocating new instances from the instance provider. When an attached cluster changes its state to `TERMINATED`, the instances it used are returned to the pool and reused by a different cluster.\n" }, "isPinned": { "type": "boolean", "description": "boolean value specifying if the cluster is pinned (not pinned by default). You must be a Databricks administrator to use this. The pinned clusters' maximum number is [limited to 100](https://docs.databricks.com/clusters/clusters-manage.html#pin-a-cluster), so \u003cspan pulumi-lang-nodejs=\"`apply`\" pulumi-lang-dotnet=\"`Apply`\" pulumi-lang-go=\"`apply`\" pulumi-lang-python=\"`apply`\" pulumi-lang-yaml=\"`apply`\" pulumi-lang-java=\"`apply`\" pulumi-lang-hcl=\"`apply`\"\u003e`apply`\u003c/span\u003e may fail if you have more than that (this number may change over time, so check Databricks documentation for actual number).\n" }, "isSingleNode": { "type": "boolean", "description": "When set to true, Databricks will automatically set single node related \u003cspan pulumi-lang-nodejs=\"`customTags`\" pulumi-lang-dotnet=\"`CustomTags`\" pulumi-lang-go=\"`customTags`\" pulumi-lang-python=\"`custom_tags`\" pulumi-lang-yaml=\"`customTags`\" pulumi-lang-java=\"`customTags`\" pulumi-lang-hcl=\"`custom_tags`\"\u003e`customTags`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`sparkConf`\" pulumi-lang-dotnet=\"`SparkConf`\" pulumi-lang-go=\"`sparkConf`\" pulumi-lang-python=\"`spark_conf`\" pulumi-lang-yaml=\"`sparkConf`\" pulumi-lang-java=\"`sparkConf`\" pulumi-lang-hcl=\"`spark_conf`\"\u003e`sparkConf`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e.\n" }, "kind": { "type": "string", "description": "The kind of compute described by this compute specification. Possible values (see [API docs](https://docs.databricks.com/api/workspace/clusters/create#kind) for full list): `CLASSIC_PREVIEW` (if corresponding public preview is enabled).\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterLibrary:ClusterLibrary" } }, "noWait": { "type": "boolean", "description": "If true, the provider will not wait for the cluster to reach `RUNNING` state when creating the cluster, allowing cluster creation and library installation to continue asynchronously. Defaults to false (the provider will wait for cluster creation and library installation to succeed).\n" }, "nodeTypeId": { "type": "string", "description": "Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003eid. If \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e is specified, this field is not needed.\n" }, "numWorkers": { "type": "integer", "description": "Number of worker nodes that this cluster should have. A cluster has one Spark driver and \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e executors for a total of \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e + 1 Spark nodes.\n" }, "policyId": { "type": "string", "description": "Identifier of Cluster Policy to validate cluster and preset certain defaults. *The primary use for cluster policies is to allow users to create policy-scoped clusters via UI rather than sharing configuration for API-created clusters.* For example, when you specify \u003cspan pulumi-lang-nodejs=\"`policyId`\" pulumi-lang-dotnet=\"`PolicyId`\" pulumi-lang-go=\"`policyId`\" pulumi-lang-python=\"`policy_id`\" pulumi-lang-yaml=\"`policyId`\" pulumi-lang-java=\"`policyId`\" pulumi-lang-hcl=\"`policy_id`\"\u003e`policyId`\u003c/span\u003e of [external metastore](https://docs.databricks.com/administration-guide/clusters/policies.html#external-metastore-policy) policy, you still have to fill in relevant keys for \u003cspan pulumi-lang-nodejs=\"`sparkConf`\" pulumi-lang-dotnet=\"`SparkConf`\" pulumi-lang-go=\"`sparkConf`\" pulumi-lang-python=\"`spark_conf`\" pulumi-lang-yaml=\"`sparkConf`\" pulumi-lang-java=\"`sparkConf`\" pulumi-lang-hcl=\"`spark_conf`\"\u003e`sparkConf`\u003c/span\u003e. If relevant fields aren't filled in, then it will cause the configuration drift detected on each plan/apply, and Pulumi will try to apply the detected changes.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterProviderConfig:ClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string", "description": "The type of runtime engine to use. If not specified, the runtime engine type is inferred based on the\u003cspan pulumi-lang-nodejs=\" sparkVersion \" pulumi-lang-dotnet=\" SparkVersion \" pulumi-lang-go=\" sparkVersion \" pulumi-lang-python=\" spark_version \" pulumi-lang-yaml=\" sparkVersion \" pulumi-lang-java=\" sparkVersion \" pulumi-lang-hcl=\" spark_version \"\u003e sparkVersion \u003c/span\u003evalue. Allowed values include: `PHOTON`, `STANDARD`.\n" }, "singleUserName": { "type": "string", "description": "The optional user name of the user (or group name if \u003cspan pulumi-lang-nodejs=\"`kind`\" pulumi-lang-dotnet=\"`Kind`\" pulumi-lang-go=\"`kind`\" pulumi-lang-python=\"`kind`\" pulumi-lang-yaml=\"`kind`\" pulumi-lang-java=\"`kind`\" pulumi-lang-hcl=\"`kind`\"\u003e`kind`\u003c/span\u003e if specified) to assign to an interactive cluster. This field is required when using \u003cspan pulumi-lang-nodejs=\"`dataSecurityMode`\" pulumi-lang-dotnet=\"`DataSecurityMode`\" pulumi-lang-go=\"`dataSecurityMode`\" pulumi-lang-python=\"`data_security_mode`\" pulumi-lang-yaml=\"`dataSecurityMode`\" pulumi-lang-java=\"`dataSecurityMode`\" pulumi-lang-hcl=\"`data_security_mode`\"\u003e`dataSecurityMode`\u003c/span\u003e set to `SINGLE_USER` or AAD Passthrough for Azure Data Lake Storage (ADLS) with a single-user cluster (i.e., not high-concurrency clusters).\n" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" }, "description": "should have following items:\n* `spark.databricks.repl.allowedLanguages` set to a list of supported languages, for example: `python,sql`, or `python,sql,r`. Scala is not supported!\n* `spark.databricks.cluster.profile` set to \u003cspan pulumi-lang-nodejs=\"`serverless`\" pulumi-lang-dotnet=\"`Serverless`\" pulumi-lang-go=\"`serverless`\" pulumi-lang-python=\"`serverless`\" pulumi-lang-yaml=\"`serverless`\" pulumi-lang-java=\"`serverless`\" pulumi-lang-hcl=\"`serverless`\"\u003e`serverless`\u003c/span\u003e\n" }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with environment variable key-value pairs to fine-tune Spark clusters. Key-value pairs of the form (X,Y) are exported (i.e., X='Y') while launching the driver and workers.\n" }, "sparkVersion": { "type": "string", "description": "[Runtime version](https://docs.databricks.com/runtime/index.html) of the cluster. Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003eid. We advise using Cluster Policies to restrict the list of versions for simplicity while maintaining enough control.\n" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public key contents that will be added to each Spark node in this cluster. The corresponding private keys can be used to login with the user name ubuntu on port 2200. You can specify up to 10 keys.\n" }, "totalInitialRemoteDiskSize": { "type": "integer" }, "useMlRuntime": { "type": "boolean", "description": "Whenever ML runtime should be selected or not. Actual runtime is determined by \u003cspan pulumi-lang-nodejs=\"`sparkVersion`\" pulumi-lang-dotnet=\"`SparkVersion`\" pulumi-lang-go=\"`sparkVersion`\" pulumi-lang-python=\"`spark_version`\" pulumi-lang-yaml=\"`sparkVersion`\" pulumi-lang-java=\"`sparkVersion`\" pulumi-lang-hcl=\"`spark_version`\"\u003e`sparkVersion`\u003c/span\u003e (DBR release), this field \u003cspan pulumi-lang-nodejs=\"`useMlRuntime`\" pulumi-lang-dotnet=\"`UseMlRuntime`\" pulumi-lang-go=\"`useMlRuntime`\" pulumi-lang-python=\"`use_ml_runtime`\" pulumi-lang-yaml=\"`useMlRuntime`\" pulumi-lang-java=\"`useMlRuntime`\" pulumi-lang-hcl=\"`use_ml_runtime`\"\u003e`useMlRuntime`\u003c/span\u003e, and whether \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e is GPU node or not.\n" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/ClusterWorkerNodeTypeFlexibility:ClusterWorkerNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e isn't available.\n" }, "workloadType": { "$ref": "#/types/databricks:index/ClusterWorkloadType:ClusterWorkloadType" } }, "requiredInputs": [ "sparkVersion" ], "stateInputs": { "description": "Input properties used for looking up and filtering Cluster resources.\n", "properties": { "applyPolicyDefaultValues": { "type": "boolean", "description": "Whether to use policy default values for missing cluster attributes.\n" }, "autoscale": { "$ref": "#/types/databricks:index/ClusterAutoscale:ClusterAutoscale" }, "autoterminationMinutes": { "type": "integer", "description": "Automatically terminate the cluster after being inactive for this time in minutes. If specified, the threshold must be between 10 and 10000 minutes. You can also set this value to 0 to explicitly disable automatic termination. Defaults to \u003cspan pulumi-lang-nodejs=\"`60`\" pulumi-lang-dotnet=\"`60`\" pulumi-lang-go=\"`60`\" pulumi-lang-python=\"`60`\" pulumi-lang-yaml=\"`60`\" pulumi-lang-java=\"`60`\" pulumi-lang-hcl=\"`60`\"\u003e`60`\u003c/span\u003e. *We highly recommend having this setting present for Interactive/BI clusters.*\n" }, "awsAttributes": { "$ref": "#/types/databricks:index/ClusterAwsAttributes:ClusterAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/ClusterAzureAttributes:ClusterAzureAttributes" }, "clusterId": { "type": "string" }, "clusterLogConf": { "$ref": "#/types/databricks:index/ClusterClusterLogConf:ClusterClusterLogConf" }, "clusterMountInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterClusterMountInfo:ClusterClusterMountInfo" } }, "clusterName": { "type": "string", "description": "Cluster name, which doesn't have to be unique. If not specified at creation, the cluster name will be an empty string.\n" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "should have tag `ResourceClass` set to value `Serverless`\n\nFor example:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst clusterWithTableAccessControl = new databricks.Cluster(\"cluster_with_table_access_control\", {\n clusterName: \"Shared High-Concurrency\",\n sparkVersion: latestLts.id,\n nodeTypeId: smallest.id,\n autoterminationMinutes: 20,\n sparkConf: {\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.cluster.profile\": \"serverless\",\n },\n customTags: {\n ResourceClass: \"Serverless\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncluster_with_table_access_control = databricks.Cluster(\"cluster_with_table_access_control\",\n cluster_name=\"Shared High-Concurrency\",\n spark_version=latest_lts[\"id\"],\n node_type_id=smallest[\"id\"],\n autotermination_minutes=20,\n spark_conf={\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.cluster.profile\": \"serverless\",\n },\n custom_tags={\n \"ResourceClass\": \"Serverless\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var clusterWithTableAccessControl = new Databricks.Cluster(\"cluster_with_table_access_control\", new()\n {\n ClusterName = \"Shared High-Concurrency\",\n SparkVersion = latestLts.Id,\n NodeTypeId = smallest.Id,\n AutoterminationMinutes = 20,\n SparkConf = \n {\n { \"spark.databricks.repl.allowedLanguages\", \"python,sql\" },\n { \"spark.databricks.cluster.profile\", \"serverless\" },\n },\n CustomTags = \n {\n { \"ResourceClass\", \"Serverless\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewCluster(ctx, \"cluster_with_table_access_control\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Shared High-Concurrency\"),\n\t\t\tSparkVersion: pulumi.Any(latestLts.Id),\n\t\t\tNodeTypeId: pulumi.Any(smallest.Id),\n\t\t\tAutoterminationMinutes: pulumi.Int(20),\n\t\t\tSparkConf: pulumi.StringMap{\n\t\t\t\t\"spark.databricks.repl.allowedLanguages\": pulumi.String(\"python,sql\"),\n\t\t\t\t\"spark.databricks.cluster.profile\": pulumi.String(\"serverless\"),\n\t\t\t},\n\t\t\tCustomTags: pulumi.StringMap{\n\t\t\t\t\"ResourceClass\": pulumi.String(\"Serverless\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_cluster\" \"cluster_with_table_access_control\" {\n cluster_name = \"Shared High-Concurrency\"\n spark_version = latestLts.id\n node_type_id = smallest.id\n autotermination_minutes = 20\n spark_conf = {\n \"spark.databricks.repl.allowedLanguages\" = \"python,sql\"\n \"spark.databricks.cluster.profile\" = \"serverless\"\n }\n custom_tags = {\n \"ResourceClass\" = \"Serverless\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var clusterWithTableAccessControl = new Cluster(\"clusterWithTableAccessControl\", ClusterArgs.builder()\n .clusterName(\"Shared High-Concurrency\")\n .sparkVersion(latestLts.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(20)\n .sparkConf(Map.ofEntries(\n Map.entry(\"spark.databricks.repl.allowedLanguages\", \"python,sql\"),\n Map.entry(\"spark.databricks.cluster.profile\", \"serverless\")\n ))\n .customTags(Map.of(\"ResourceClass\", \"Serverless\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n clusterWithTableAccessControl:\n type: databricks:Cluster\n name: cluster_with_table_access_control\n properties:\n clusterName: Shared High-Concurrency\n sparkVersion: ${latestLts.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 20\n sparkConf:\n spark.databricks.repl.allowedLanguages: python,sql\n spark.databricks.cluster.profile: serverless\n customTags:\n ResourceClass: Serverless\n```\n\u003c!--End PulumiCodeChooser --\u003e\n" }, "dataSecurityMode": { "type": "string", "description": "Select the security features of the cluster (see [API docs](https://docs.databricks.com/api/workspace/clusters/create#data_security_mode) for full list of values). [Unity Catalog requires](https://docs.databricks.com/data-governance/unity-catalog/compute.html#create-clusters--sql-warehouses-with-unity-catalog-access) `SINGLE_USER` or `USER_ISOLATION` mode. `LEGACY_PASSTHROUGH` for passthrough cluster and `LEGACY_TABLE_ACL` for Table ACL cluster. If omitted, default security features are enabled. To disable security features use `NONE` or legacy mode `NO_ISOLATION`. If \u003cspan pulumi-lang-nodejs=\"`kind`\" pulumi-lang-dotnet=\"`Kind`\" pulumi-lang-go=\"`kind`\" pulumi-lang-python=\"`kind`\" pulumi-lang-yaml=\"`kind`\" pulumi-lang-java=\"`kind`\" pulumi-lang-hcl=\"`kind`\"\u003e`kind`\u003c/span\u003e is specified, then the following options are available:\n* `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode depending on your compute configuration.\n* `DATA_SECURITY_MODE_STANDARD`: Alias for `USER_ISOLATION`.\n* `DATA_SECURITY_MODE_DEDICATED`: Alias for `SINGLE_USER`.\n" }, "defaultTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(map) Tags that are added by Databricks by default, regardless of any \u003cspan pulumi-lang-nodejs=\"`customTags`\" pulumi-lang-dotnet=\"`CustomTags`\" pulumi-lang-go=\"`customTags`\" pulumi-lang-python=\"`custom_tags`\" pulumi-lang-yaml=\"`customTags`\" pulumi-lang-java=\"`customTags`\" pulumi-lang-hcl=\"`custom_tags`\"\u003e`customTags`\u003c/span\u003e that may have been added. These include: Vendor: Databricks, Creator: \u003cusername_of_creator\u003e, ClusterName: \u003cname_of_cluster\u003e, ClusterId: \u003cid_of_cluster\u003e, Name: \u003cDatabricks internal use\u003e, and any workspace and pool tags.\n" }, "dockerImage": { "$ref": "#/types/databricks:index/ClusterDockerImage:ClusterDockerImage" }, "driverInstancePoolId": { "type": "string", "description": "similar to \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e, but for driver node. If omitted, and \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e is specified, then the driver will be allocated from that pool.\n" }, "driverNodeTypeFlexibility": { "$ref": "#/types/databricks:index/ClusterDriverNodeTypeFlexibility:ClusterDriverNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`driverNodeTypeId`\" pulumi-lang-dotnet=\"`DriverNodeTypeId`\" pulumi-lang-go=\"`driverNodeTypeId`\" pulumi-lang-python=\"`driver_node_type_id`\" pulumi-lang-yaml=\"`driverNodeTypeId`\" pulumi-lang-java=\"`driverNodeTypeId`\" pulumi-lang-hcl=\"`driver_node_type_id`\"\u003e`driverNodeTypeId`\u003c/span\u003e isn't available.\n" }, "driverNodeTypeId": { "type": "string", "description": "The node type of the Spark driver. This field is optional; if unset, API will set the driver node type to the same value as \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e defined above.\n" }, "enableElasticDisk": { "type": "boolean", "description": "If you don't want to allocate a fixed number of EBS volumes at cluster creation time, use autoscaling local storage. With autoscaling local storage, Databricks monitors the amount of free disk space available on your cluster's Spark workers. If a worker begins to run too low on disk, Databricks automatically attaches a new EBS volume to the worker before it runs out of disk space. EBS volumes are attached up to a limit of 5 TB of total disk space per instance (including the instance's local storage). To scale down EBS usage, make sure you have \u003cspan pulumi-lang-nodejs=\"`autoterminationMinutes`\" pulumi-lang-dotnet=\"`AutoterminationMinutes`\" pulumi-lang-go=\"`autoterminationMinutes`\" pulumi-lang-python=\"`autotermination_minutes`\" pulumi-lang-yaml=\"`autoterminationMinutes`\" pulumi-lang-java=\"`autoterminationMinutes`\" pulumi-lang-hcl=\"`autotermination_minutes`\"\u003e`autoterminationMinutes`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`autoscale`\" pulumi-lang-dotnet=\"`Autoscale`\" pulumi-lang-go=\"`autoscale`\" pulumi-lang-python=\"`autoscale`\" pulumi-lang-yaml=\"`autoscale`\" pulumi-lang-java=\"`autoscale`\" pulumi-lang-hcl=\"`autoscale`\"\u003e`autoscale`\u003c/span\u003e attributes set. More documentation available at [cluster configuration page](https://docs.databricks.com/clusters/configure.html#autoscaling-local-storage-1).\n" }, "enableLocalDiskEncryption": { "type": "boolean", "description": "Some instance types you use to run clusters may have locally attached disks. Databricks may store shuffle data or temporary data on these locally attached disks. To ensure that all data at rest is encrypted for all storage types, including shuffle data stored temporarily on your cluster's local disks, you can enable local disk encryption. When local disk encryption is enabled, Databricks generates an encryption key locally unique to each cluster node and uses it to encrypt all data stored on local disks. The scope of the key is local to each cluster node and is destroyed along with the cluster node itself. During its lifetime, the key resides in memory for encryption and decryption and is stored encrypted on the disk. *Your workloads may run more slowly because of the performance impact of reading and writing encrypted data to and from local volumes. This feature is not available for all Azure Databricks subscriptions. Contact your Microsoft or Databricks account representative to request access.*\n" }, "gcpAttributes": { "$ref": "#/types/databricks:index/ClusterGcpAttributes:ClusterGcpAttributes" }, "idempotencyToken": { "type": "string", "description": "An optional token to guarantee the idempotency of cluster creation requests. If an active cluster with the provided token already exists, the request will not create a new cluster, but it will return the existing running cluster's ID instead. If you specify the idempotency token, upon failure, you can retry until the request succeeds. Databricks platform guarantees to launch exactly one cluster with that idempotency token. This token should have at most 64 characters.\n", "willReplaceOnChanges": true }, "initScripts": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterInitScript:ClusterInitScript" } }, "instancePoolId": { "type": "string", "description": "To reduce cluster start time, you can attach a cluster to a predefined pool of idle instances. When attached to a pool, a cluster allocates its driver and worker nodes from the pool. If the pool does not have sufficient idle resources to accommodate the cluster's request, it expands by allocating new instances from the instance provider. When an attached cluster changes its state to `TERMINATED`, the instances it used are returned to the pool and reused by a different cluster.\n" }, "isPinned": { "type": "boolean", "description": "boolean value specifying if the cluster is pinned (not pinned by default). You must be a Databricks administrator to use this. The pinned clusters' maximum number is [limited to 100](https://docs.databricks.com/clusters/clusters-manage.html#pin-a-cluster), so \u003cspan pulumi-lang-nodejs=\"`apply`\" pulumi-lang-dotnet=\"`Apply`\" pulumi-lang-go=\"`apply`\" pulumi-lang-python=\"`apply`\" pulumi-lang-yaml=\"`apply`\" pulumi-lang-java=\"`apply`\" pulumi-lang-hcl=\"`apply`\"\u003e`apply`\u003c/span\u003e may fail if you have more than that (this number may change over time, so check Databricks documentation for actual number).\n" }, "isSingleNode": { "type": "boolean", "description": "When set to true, Databricks will automatically set single node related \u003cspan pulumi-lang-nodejs=\"`customTags`\" pulumi-lang-dotnet=\"`CustomTags`\" pulumi-lang-go=\"`customTags`\" pulumi-lang-python=\"`custom_tags`\" pulumi-lang-yaml=\"`customTags`\" pulumi-lang-java=\"`customTags`\" pulumi-lang-hcl=\"`custom_tags`\"\u003e`customTags`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`sparkConf`\" pulumi-lang-dotnet=\"`SparkConf`\" pulumi-lang-go=\"`sparkConf`\" pulumi-lang-python=\"`spark_conf`\" pulumi-lang-yaml=\"`sparkConf`\" pulumi-lang-java=\"`sparkConf`\" pulumi-lang-hcl=\"`spark_conf`\"\u003e`sparkConf`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e.\n" }, "kind": { "type": "string", "description": "The kind of compute described by this compute specification. Possible values (see [API docs](https://docs.databricks.com/api/workspace/clusters/create#kind) for full list): `CLASSIC_PREVIEW` (if corresponding public preview is enabled).\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterLibrary:ClusterLibrary" } }, "noWait": { "type": "boolean", "description": "If true, the provider will not wait for the cluster to reach `RUNNING` state when creating the cluster, allowing cluster creation and library installation to continue asynchronously. Defaults to false (the provider will wait for cluster creation and library installation to succeed).\n" }, "nodeTypeId": { "type": "string", "description": "Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003eid. If \u003cspan pulumi-lang-nodejs=\"`instancePoolId`\" pulumi-lang-dotnet=\"`InstancePoolId`\" pulumi-lang-go=\"`instancePoolId`\" pulumi-lang-python=\"`instance_pool_id`\" pulumi-lang-yaml=\"`instancePoolId`\" pulumi-lang-java=\"`instancePoolId`\" pulumi-lang-hcl=\"`instance_pool_id`\"\u003e`instancePoolId`\u003c/span\u003e is specified, this field is not needed.\n" }, "numWorkers": { "type": "integer", "description": "Number of worker nodes that this cluster should have. A cluster has one Spark driver and \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e executors for a total of \u003cspan pulumi-lang-nodejs=\"`numWorkers`\" pulumi-lang-dotnet=\"`NumWorkers`\" pulumi-lang-go=\"`numWorkers`\" pulumi-lang-python=\"`num_workers`\" pulumi-lang-yaml=\"`numWorkers`\" pulumi-lang-java=\"`numWorkers`\" pulumi-lang-hcl=\"`num_workers`\"\u003e`numWorkers`\u003c/span\u003e + 1 Spark nodes.\n" }, "policyId": { "type": "string", "description": "Identifier of Cluster Policy to validate cluster and preset certain defaults. *The primary use for cluster policies is to allow users to create policy-scoped clusters via UI rather than sharing configuration for API-created clusters.* For example, when you specify \u003cspan pulumi-lang-nodejs=\"`policyId`\" pulumi-lang-dotnet=\"`PolicyId`\" pulumi-lang-go=\"`policyId`\" pulumi-lang-python=\"`policy_id`\" pulumi-lang-yaml=\"`policyId`\" pulumi-lang-java=\"`policyId`\" pulumi-lang-hcl=\"`policy_id`\"\u003e`policyId`\u003c/span\u003e of [external metastore](https://docs.databricks.com/administration-guide/clusters/policies.html#external-metastore-policy) policy, you still have to fill in relevant keys for \u003cspan pulumi-lang-nodejs=\"`sparkConf`\" pulumi-lang-dotnet=\"`SparkConf`\" pulumi-lang-go=\"`sparkConf`\" pulumi-lang-python=\"`spark_conf`\" pulumi-lang-yaml=\"`sparkConf`\" pulumi-lang-java=\"`sparkConf`\" pulumi-lang-hcl=\"`spark_conf`\"\u003e`sparkConf`\u003c/span\u003e. If relevant fields aren't filled in, then it will cause the configuration drift detected on each plan/apply, and Pulumi will try to apply the detected changes.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterProviderConfig:ClusterProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteDiskThroughput": { "type": "integer" }, "runtimeEngine": { "type": "string", "description": "The type of runtime engine to use. If not specified, the runtime engine type is inferred based on the\u003cspan pulumi-lang-nodejs=\" sparkVersion \" pulumi-lang-dotnet=\" SparkVersion \" pulumi-lang-go=\" sparkVersion \" pulumi-lang-python=\" spark_version \" pulumi-lang-yaml=\" sparkVersion \" pulumi-lang-java=\" sparkVersion \" pulumi-lang-hcl=\" spark_version \"\u003e sparkVersion \u003c/span\u003evalue. Allowed values include: `PHOTON`, `STANDARD`.\n" }, "singleUserName": { "type": "string", "description": "The optional user name of the user (or group name if \u003cspan pulumi-lang-nodejs=\"`kind`\" pulumi-lang-dotnet=\"`Kind`\" pulumi-lang-go=\"`kind`\" pulumi-lang-python=\"`kind`\" pulumi-lang-yaml=\"`kind`\" pulumi-lang-java=\"`kind`\" pulumi-lang-hcl=\"`kind`\"\u003e`kind`\u003c/span\u003e if specified) to assign to an interactive cluster. This field is required when using \u003cspan pulumi-lang-nodejs=\"`dataSecurityMode`\" pulumi-lang-dotnet=\"`DataSecurityMode`\" pulumi-lang-go=\"`dataSecurityMode`\" pulumi-lang-python=\"`data_security_mode`\" pulumi-lang-yaml=\"`dataSecurityMode`\" pulumi-lang-java=\"`dataSecurityMode`\" pulumi-lang-hcl=\"`data_security_mode`\"\u003e`dataSecurityMode`\u003c/span\u003e set to `SINGLE_USER` or AAD Passthrough for Azure Data Lake Storage (ADLS) with a single-user cluster (i.e., not high-concurrency clusters).\n" }, "sparkConf": { "type": "object", "additionalProperties": { "type": "string" }, "description": "should have following items:\n* `spark.databricks.repl.allowedLanguages` set to a list of supported languages, for example: `python,sql`, or `python,sql,r`. Scala is not supported!\n* `spark.databricks.cluster.profile` set to \u003cspan pulumi-lang-nodejs=\"`serverless`\" pulumi-lang-dotnet=\"`Serverless`\" pulumi-lang-go=\"`serverless`\" pulumi-lang-python=\"`serverless`\" pulumi-lang-yaml=\"`serverless`\" pulumi-lang-java=\"`serverless`\" pulumi-lang-hcl=\"`serverless`\"\u003e`serverless`\u003c/span\u003e\n" }, "sparkEnvVars": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map with environment variable key-value pairs to fine-tune Spark clusters. Key-value pairs of the form (X,Y) are exported (i.e., X='Y') while launching the driver and workers.\n" }, "sparkVersion": { "type": "string", "description": "[Runtime version](https://docs.databricks.com/runtime/index.html) of the cluster. Any supported\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003eid. We advise using Cluster Policies to restrict the list of versions for simplicity while maintaining enough control.\n" }, "sshPublicKeys": { "type": "array", "items": { "type": "string" }, "description": "SSH public key contents that will be added to each Spark node in this cluster. The corresponding private keys can be used to login with the user name ubuntu on port 2200. You can specify up to 10 keys.\n" }, "state": { "type": "string", "description": "(string) State of the cluster.\n" }, "totalInitialRemoteDiskSize": { "type": "integer" }, "url": { "type": "string" }, "useMlRuntime": { "type": "boolean", "description": "Whenever ML runtime should be selected or not. Actual runtime is determined by \u003cspan pulumi-lang-nodejs=\"`sparkVersion`\" pulumi-lang-dotnet=\"`SparkVersion`\" pulumi-lang-go=\"`sparkVersion`\" pulumi-lang-python=\"`spark_version`\" pulumi-lang-yaml=\"`sparkVersion`\" pulumi-lang-java=\"`sparkVersion`\" pulumi-lang-hcl=\"`spark_version`\"\u003e`sparkVersion`\u003c/span\u003e (DBR release), this field \u003cspan pulumi-lang-nodejs=\"`useMlRuntime`\" pulumi-lang-dotnet=\"`UseMlRuntime`\" pulumi-lang-go=\"`useMlRuntime`\" pulumi-lang-python=\"`use_ml_runtime`\" pulumi-lang-yaml=\"`useMlRuntime`\" pulumi-lang-java=\"`useMlRuntime`\" pulumi-lang-hcl=\"`use_ml_runtime`\"\u003e`useMlRuntime`\u003c/span\u003e, and whether \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e is GPU node or not.\n" }, "workerNodeTypeFlexibility": { "$ref": "#/types/databricks:index/ClusterWorkerNodeTypeFlexibility:ClusterWorkerNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e isn't available.\n" }, "workloadType": { "$ref": "#/types/databricks:index/ClusterWorkloadType:ClusterWorkloadType" } }, "type": "object" } }, "databricks:index/clusterPolicy:ClusterPolicy": { "description": "This resource creates a cluster policy, which limits the ability to create clusters based on a set of rules. The policy rules limit the attributes or attribute values available for cluster creation. cluster policies have ACLs that limit their use to specific users and groups. Only admin users can create, edit, and delete policies. Admin users also have access to all policies.\n\n\u003e This resource can only be used with a workspace-level provider!\n\nCluster policies let you:\n\n* Limit users to create clusters with prescribed settings.\n* Simplify the user interface and enable more users to create their own clusters (by fixing and hiding some values).\n* Control cost by limiting per cluster maximum cost (by setting limits on attributes whose values contribute to hourly price).\n\nCluster policy permissions limit which policies a user can select in the Policy drop-down when the user creates a cluster:\n\n* If no policies have been created in the workspace, the Policy drop-down does not display.\n* A user who has cluster create permission can select the `Free form` policy and create fully-configurable clusters.\n* A user who has both cluster create permission and access to cluster policies can select the Free form policy and policies they have access to.\n* A user that has access to only cluster policies, can select the policies they have access to.\n\n## Example Usage\n\nLet us take a look at an example of how you can manage two teams: Marketing and Data Engineering. In the following scenario we want the marketing team to have a really good query experience, so we enabled delta cache for them. On the other hand we want the data engineering team to be able to utilize bigger clusters so we increased the dbus per hour that they can spend. This strategy allows your marketing users and data engineering users to use Databricks in a self service manner but have a different experience in regards to security and performance. And down the line if you need to add more global settings you can propagate them through the \"base cluster policy\".\n\n`modules/base-cluster-policy/main.tf` could look like:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\n\nconst config = new pulumi.Config();\n// Team that performs the work\nconst team = config.requireObject\u003cany\u003e(\"team\");\n// Cluster policy overrides\nconst policyOverrides = config.requireObject\u003cany\u003e(\"policyOverrides\");\nconst defaultPolicy = {\n dbus_per_hour: {\n type: \"range\",\n maxValue: 10,\n },\n autotermination_minutes: {\n type: \"fixed\",\n value: 20,\n hidden: true,\n },\n \"custom_tags.Team\": {\n type: \"fixed\",\n value: team,\n },\n};\nconst fairUse = new databricks.ClusterPolicy(\"fair_use\", {\n name: `${team} cluster policy`,\n definition: JSON.stringify(std.merge({\n input: [\n defaultPolicy,\n policyOverrides,\n ],\n }).then(invoke =\u003e invoke.result)),\n libraries: [\n {\n pypi: {\n \"package\": \"databricks-sdk==0.12.0\",\n },\n },\n {\n maven: {\n coordinates: \"com.oracle.database.jdbc:ojdbc8:XXXX\",\n },\n },\n ],\n});\nconst canUseClusterPolicyinstanceProfile = new databricks.Permissions(\"can_use_cluster_policyinstance_profile\", {\n clusterPolicyId: fairUse.id,\n accessControls: [{\n groupName: team,\n permissionLevel: \"CAN_USE\",\n }],\n});\n```\n```python\nimport pulumi\nimport json\nimport pulumi_databricks as databricks\nimport pulumi_std as std\n\nconfig = pulumi.Config()\n# Team that performs the work\nteam = config.require_object(\"team\")\n# Cluster policy overrides\npolicy_overrides = config.require_object(\"policyOverrides\")\ndefault_policy = {\n \"dbus_per_hour\": {\n \"type\": \"range\",\n \"maxValue\": 10,\n },\n \"autotermination_minutes\": {\n \"type\": \"fixed\",\n \"value\": 20,\n \"hidden\": True,\n },\n \"custom_tags.Team\": {\n \"type\": \"fixed\",\n \"value\": team,\n },\n}\nfair_use = databricks.ClusterPolicy(\"fair_use\",\n name=f\"{team} cluster policy\",\n definition=json.dumps(std.merge(input=[\n default_policy,\n policy_overrides,\n ]).result),\n libraries=[\n {\n \"pypi\": {\n \"package\": \"databricks-sdk==0.12.0\",\n },\n },\n {\n \"maven\": {\n \"coordinates\": \"com.oracle.database.jdbc:ojdbc8:XXXX\",\n },\n },\n ])\ncan_use_cluster_policyinstance_profile = databricks.Permissions(\"can_use_cluster_policyinstance_profile\",\n cluster_policy_id=fair_use.id,\n access_controls=[{\n \"group_name\": team,\n \"permission_level\": \"CAN_USE\",\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text.Json;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Team that performs the work\n var team = config.RequireObject\u003cdynamic\u003e(\"team\");\n // Cluster policy overrides\n var policyOverrides = config.RequireObject\u003cdynamic\u003e(\"policyOverrides\");\n var defaultPolicy = \n {\n { \"dbus_per_hour\", \n {\n { \"type\", \"range\" },\n { \"maxValue\", 10 },\n } },\n { \"autotermination_minutes\", \n {\n { \"type\", \"fixed\" },\n { \"value\", 20 },\n { \"hidden\", true },\n } },\n { \"custom_tags.Team\", \n {\n { \"type\", \"fixed\" },\n { \"value\", team },\n } },\n };\n\n var fairUse = new Databricks.ClusterPolicy(\"fair_use\", new()\n {\n Name = $\"{team} cluster policy\",\n Definition = JsonSerializer.Serialize(Std.Merge.Invoke(new()\n {\n Input = new[]\n {\n defaultPolicy,\n policyOverrides,\n },\n }).Apply(invoke =\u003e invoke.Result)),\n Libraries = new[]\n {\n new Databricks.Inputs.ClusterPolicyLibraryArgs\n {\n Pypi = new Databricks.Inputs.ClusterPolicyLibraryPypiArgs\n {\n Package = \"databricks-sdk==0.12.0\",\n },\n },\n new Databricks.Inputs.ClusterPolicyLibraryArgs\n {\n Maven = new Databricks.Inputs.ClusterPolicyLibraryMavenArgs\n {\n Coordinates = \"com.oracle.database.jdbc:ojdbc8:XXXX\",\n },\n },\n },\n });\n\n var canUseClusterPolicyinstanceProfile = new Databricks.Permissions(\"can_use_cluster_policyinstance_profile\", new()\n {\n ClusterPolicyId = fairUse.Id,\n AccessControls = new[]\n {\n new Databricks.Inputs.PermissionsAccessControlArgs\n {\n GroupName = team,\n PermissionLevel = \"CAN_USE\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"encoding/json\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Team that performs the work\n\t\tvar team interface{}\n\t\tcfg.RequireObject(\"team\", \u0026team)\n\t\t// Cluster policy overrides\n\t\tvar policyOverrides interface{}\n\t\tcfg.RequireObject(\"policyOverrides\", \u0026policyOverrides)\n\t\tdefaultPolicy := map[string]interface{}{\n\t\t\t\"dbus_per_hour\": map[string]interface{}{\n\t\t\t\t\"type\": \"range\",\n\t\t\t\t\"maxValue\": 10,\n\t\t\t},\n\t\t\t\"autotermination_minutes\": map[string]interface{}{\n\t\t\t\t\"type\": \"fixed\",\n\t\t\t\t\"value\": 20,\n\t\t\t\t\"hidden\": true,\n\t\t\t},\n\t\t\t\"custom_tags.Team\": map[string]interface{}{\n\t\t\t\t\"type\": \"fixed\",\n\t\t\t\t\"value\": team,\n\t\t\t},\n\t\t}\n\t\ttmpJSON0, err := json.Marshal(std.Merge(ctx, \u0026std.MergeArgs{\n\t\t\tInput: []interface{}{\n\t\t\t\tdefaultPolicy,\n\t\t\t\tpolicyOverrides,\n\t\t\t},\n\t\t}, nil).Result)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjson0 := string(tmpJSON0)\n\t\tfairUse, err := databricks.NewClusterPolicy(ctx, \"fair_use\", \u0026databricks.ClusterPolicyArgs{\n\t\t\tName: pulumi.Sprintf(\"%v cluster policy\", team),\n\t\t\tDefinition: json0,\n\t\t\tLibraries: databricks.ClusterPolicyLibraryArray{\n\t\t\t\t\u0026databricks.ClusterPolicyLibraryArgs{\n\t\t\t\t\tPypi: \u0026databricks.ClusterPolicyLibraryPypiArgs{\n\t\t\t\t\t\tPackage: pulumi.String(\"databricks-sdk==0.12.0\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.ClusterPolicyLibraryArgs{\n\t\t\t\t\tMaven: \u0026databricks.ClusterPolicyLibraryMavenArgs{\n\t\t\t\t\t\tCoordinates: pulumi.String(\"com.oracle.database.jdbc:ojdbc8:XXXX\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewPermissions(ctx, \"can_use_cluster_policyinstance_profile\", \u0026databricks.PermissionsArgs{\n\t\t\tClusterPolicyId: fairUse.ID(),\n\t\t\tAccessControls: databricks.PermissionsAccessControlArray{\n\t\t\t\t\u0026databricks.PermissionsAccessControlArgs{\n\t\t\t\t\tGroupName: pulumi.Any(team),\n\t\t\t\t\tPermissionLevel: pulumi.String(\"CAN_USE\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n }\n}\n\ndata \"std_merge\" \"invoke_0\" {\n input = [local.defaultPolicy, var.policyOverrides]\n}\n\nresource \"databricks_clusterpolicy\" \"fair_use\" {\n name =\"${var.team} cluster policy\"\n definition = jsonencode(data.std_merge.invoke_0.result)\n libraries {\n pypi = {\n package = \"databricks-sdk==0.12.0\"\n }\n }\n libraries {\n maven = {\n coordinates = \"com.oracle.database.jdbc:ojdbc8:XXXX\"\n }\n }\n}\nresource \"databricks_permissions\" \"can_use_cluster_policyinstance_profile\" {\n cluster_policy_id = databricks_clusterpolicy.fair_use.id\n access_controls {\n group_name = var.team\n permission_level = \"CAN_USE\"\n }\n}\nvariable \"team\" {\n description = \"Team that performs the work\"\n}\nvariable \"policyOverrides\" {\n description = \"Cluster policy overrides\"\n}\nlocals {\n defaultPolicy = {\n \"dbus_per_hour\" = {\n \"type\" = \"range\"\n \"maxValue\" = 10\n }\n \"autotermination_minutes\" = {\n \"type\" = \"fixed\"\n \"value\" = 20\n \"hidden\" = true\n }\n \"custom_tags.Team\" = {\n \"type\" = \"fixed\"\n \"value\" = var.team\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ClusterPolicy;\nimport com.pulumi.databricks.ClusterPolicyArgs;\nimport com.pulumi.databricks.inputs.ClusterPolicyLibraryArgs;\nimport com.pulumi.databricks.inputs.ClusterPolicyLibraryPypiArgs;\nimport com.pulumi.databricks.inputs.ClusterPolicyLibraryMavenArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.MergeArgs;\nimport com.pulumi.databricks.Permissions;\nimport com.pulumi.databricks.PermissionsArgs;\nimport com.pulumi.databricks.inputs.PermissionsAccessControlArgs;\nimport static com.pulumi.codegen.internal.Serialization.*;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var team = config.require(\"team\");\n final var policyOverrides = config.require(\"policyOverrides\");\n final var defaultPolicy = Map.ofEntries(\n Map.entry(\"dbus_per_hour\", Map.ofEntries(\n Map.entry(\"type\", \"range\"),\n Map.entry(\"maxValue\", 10)\n )),\n Map.entry(\"autotermination_minutes\", Map.ofEntries(\n Map.entry(\"type\", \"fixed\"),\n Map.entry(\"value\", 20),\n Map.entry(\"hidden\", true)\n )),\n Map.entry(\"custom_tags.Team\", Map.ofEntries(\n Map.entry(\"type\", \"fixed\"),\n Map.entry(\"value\", team)\n ))\n );\n\n var fairUse = new ClusterPolicy(\"fairUse\", ClusterPolicyArgs.builder()\n .name(String.format(\"%s cluster policy\", team))\n .definition(serializeJson(\n StdFunctions.merge(MergeArgs.builder()\n .input( \n defaultPolicy,\n policyOverrides)\n .build()).result()))\n .libraries( \n ClusterPolicyLibraryArgs.builder()\n .pypi(ClusterPolicyLibraryPypiArgs.builder()\n .package_(\"databricks-sdk==0.12.0\")\n .build())\n .build(),\n ClusterPolicyLibraryArgs.builder()\n .maven(ClusterPolicyLibraryMavenArgs.builder()\n .coordinates(\"com.oracle.database.jdbc:ojdbc8:XXXX\")\n .build())\n .build())\n .build());\n\n var canUseClusterPolicyinstanceProfile = new Permissions(\"canUseClusterPolicyinstanceProfile\", PermissionsArgs.builder()\n .clusterPolicyId(fairUse.id())\n .accessControls(PermissionsAccessControlArgs.builder()\n .groupName(team)\n .permissionLevel(\"CAN_USE\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n team:\n type: object\n policyOverrides:\n type: object\nresources:\n fairUse:\n type: databricks:ClusterPolicy\n name: fair_use\n properties:\n name: ${team} cluster policy\n definition:\n fn::toJSON:\n fn::invoke:\n function: std:merge\n arguments:\n input:\n - ${defaultPolicy}\n - ${policyOverrides}\n return: result\n libraries:\n - pypi:\n package: databricks-sdk==0.12.0\n - maven:\n coordinates: com.oracle.database.jdbc:ojdbc8:XXXX\n canUseClusterPolicyinstanceProfile:\n type: databricks:Permissions\n name: can_use_cluster_policyinstance_profile\n properties:\n clusterPolicyId: ${fairUse.id}\n accessControls:\n - groupName: ${team}\n permissionLevel: CAN_USE\nvariables:\n defaultPolicy:\n dbus_per_hour:\n type: range\n maxValue: 10\n autotermination_minutes:\n type: fixed\n value: 20\n hidden: true\n custom_tags.Team:\n type: fixed\n value: ${team}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nAnd custom instances of that base policy module for our marketing and data engineering teams would look like:\n\n### Overriding the built-in cluster policies\n\nYou can override built-in cluster policies by creating a \u003cspan pulumi-lang-nodejs=\"`databricks.ClusterPolicy`\" pulumi-lang-dotnet=\"`databricks.ClusterPolicy`\" pulumi-lang-go=\"`ClusterPolicy`\" pulumi-lang-python=\"`ClusterPolicy`\" pulumi-lang-yaml=\"`databricks.ClusterPolicy`\" pulumi-lang-java=\"`databricks.ClusterPolicy`\" pulumi-lang-hcl=\"`databricks_cluster_policy`\"\u003e`databricks.ClusterPolicy`\u003c/span\u003e resource with following attributes:\n\n* \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e - the name of the built-in cluster policy.\n* \u003cspan pulumi-lang-nodejs=\"`policyFamilyId`\" pulumi-lang-dotnet=\"`PolicyFamilyId`\" pulumi-lang-go=\"`policyFamilyId`\" pulumi-lang-python=\"`policy_family_id`\" pulumi-lang-yaml=\"`policyFamilyId`\" pulumi-lang-java=\"`policyFamilyId`\" pulumi-lang-hcl=\"`policy_family_id`\"\u003e`policyFamilyId`\u003c/span\u003e - the ID of the cluster policy family used for built-in cluster policy.\n* \u003cspan pulumi-lang-nodejs=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-dotnet=\"`PolicyFamilyDefinitionOverrides`\" pulumi-lang-go=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-python=\"`policy_family_definition_overrides`\" pulumi-lang-yaml=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-java=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-hcl=\"`policy_family_definition_overrides`\"\u003e`policyFamilyDefinitionOverrides`\u003c/span\u003e - settings to override in the built-in cluster policy.\n\nYou can obtain the list of defined cluster policies families using the `databricks policy-families list` command of the new [Databricks CLI](https://docs.databricks.com/en/dev-tools/cli/index.html), or via [list policy families](https://docs.databricks.com/api/workspace/policyfamilies/list) REST API.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst personalVmOverride = {\n autotermination_minutes: {\n type: \"fixed\",\n value: 220,\n hidden: true,\n },\n \"custom_tags.Team\": {\n type: \"fixed\",\n value: team,\n },\n};\nconst personalVm = new databricks.ClusterPolicy(\"personal_vm\", {\n policyFamilyId: \"personal-vm\",\n policyFamilyDefinitionOverrides: JSON.stringify(personalVmOverride),\n name: \"Personal Compute\",\n});\n```\n```python\nimport pulumi\nimport json\nimport pulumi_databricks as databricks\n\npersonal_vm_override = {\n \"autotermination_minutes\": {\n \"type\": \"fixed\",\n \"value\": 220,\n \"hidden\": True,\n },\n \"custom_tags.Team\": {\n \"type\": \"fixed\",\n \"value\": team,\n },\n}\npersonal_vm = databricks.ClusterPolicy(\"personal_vm\",\n policy_family_id=\"personal-vm\",\n policy_family_definition_overrides=json.dumps(personal_vm_override),\n name=\"Personal Compute\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text.Json;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var personalVmOverride = \n {\n { \"autotermination_minutes\", \n {\n { \"type\", \"fixed\" },\n { \"value\", 220 },\n { \"hidden\", true },\n } },\n { \"custom_tags.Team\", \n {\n { \"type\", \"fixed\" },\n { \"value\", team },\n } },\n };\n\n var personalVm = new Databricks.ClusterPolicy(\"personal_vm\", new()\n {\n PolicyFamilyId = \"personal-vm\",\n PolicyFamilyDefinitionOverrides = JsonSerializer.Serialize(personalVmOverride),\n Name = \"Personal Compute\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"encoding/json\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tpersonalVmOverride := map[string]interface{}{\n\t\t\t\"autotermination_minutes\": map[string]interface{}{\n\t\t\t\t\"type\": \"fixed\",\n\t\t\t\t\"value\": 220,\n\t\t\t\t\"hidden\": true,\n\t\t\t},\n\t\t\t\"custom_tags.Team\": map[string]interface{}{\n\t\t\t\t\"type\": \"fixed\",\n\t\t\t\t\"value\": team,\n\t\t\t},\n\t\t}\n\t\ttmpJSON0, err := json.Marshal(personalVmOverride)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjson0 := string(tmpJSON0)\n\t\t_, err = databricks.NewClusterPolicy(ctx, \"personal_vm\", \u0026databricks.ClusterPolicyArgs{\n\t\t\tPolicyFamilyId: pulumi.String(\"personal-vm\"),\n\t\t\tPolicyFamilyDefinitionOverrides: pulumi.String(pulumi.String(json0)),\n\t\t\tName: pulumi.String(\"Personal Compute\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_clusterpolicy\" \"personal_vm\" {\n policy_family_id = \"personal-vm\"\n policy_family_definition_overrides = jsonencode(local.personalVmOverride)\n name = \"Personal Compute\"\n}\nlocals {\n personalVmOverride = {\n \"autotermination_minutes\" = {\n \"type\" = \"fixed\"\n \"value\" = 220\n \"hidden\" = true\n }\n \"custom_tags.Team\" = {\n \"type\" = \"fixed\"\n \"value\" = team\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ClusterPolicy;\nimport com.pulumi.databricks.ClusterPolicyArgs;\nimport static com.pulumi.codegen.internal.Serialization.*;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var personalVmOverride = Map.ofEntries(\n Map.entry(\"autotermination_minutes\", Map.ofEntries(\n Map.entry(\"type\", \"fixed\"),\n Map.entry(\"value\", 220),\n Map.entry(\"hidden\", true)\n )),\n Map.entry(\"custom_tags.Team\", Map.ofEntries(\n Map.entry(\"type\", \"fixed\"),\n Map.entry(\"value\", team)\n ))\n );\n\n var personalVm = new ClusterPolicy(\"personalVm\", ClusterPolicyArgs.builder()\n .policyFamilyId(\"personal-vm\")\n .policyFamilyDefinitionOverrides(serializeJson(\n personalVmOverride))\n .name(\"Personal Compute\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n personalVm:\n type: databricks:ClusterPolicy\n name: personal_vm\n properties:\n policyFamilyId: personal-vm\n policyFamilyDefinitionOverrides:\n fn::toJSON: ${personalVmOverride}\n name: Personal Compute\nvariables:\n personalVmOverride:\n autotermination_minutes:\n type: fixed\n value: 220\n hidden: true\n custom_tags.Team:\n type: fixed\n value: ${team}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* Dynamic Passthrough Clusters for a Group guide.\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getClusters \" pulumi-lang-dotnet=\" databricks.getClusters \" pulumi-lang-go=\" getClusters \" pulumi-lang-python=\" get_clusters \" pulumi-lang-yaml=\" databricks.getClusters \" pulumi-lang-java=\" databricks.getClusters \" pulumi-lang-hcl=\" data.databricks_clusters \"\u003e databricks.getClusters \u003c/span\u003edata to retrieve a list of\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eids.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.getCurrentUser \" pulumi-lang-dotnet=\" databricks.getCurrentUser \" pulumi-lang-go=\" getCurrentUser \" pulumi-lang-python=\" get_current_user \" pulumi-lang-yaml=\" databricks.getCurrentUser \" pulumi-lang-java=\" databricks.getCurrentUser \" pulumi-lang-hcl=\" data.databricks_current_user \"\u003e databricks.getCurrentUser \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003eor databricks_service_principal, that is calling Databricks REST API.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GlobalInitScript \" pulumi-lang-dotnet=\" databricks.GlobalInitScript \" pulumi-lang-go=\" GlobalInitScript \" pulumi-lang-python=\" GlobalInitScript \" pulumi-lang-yaml=\" databricks.GlobalInitScript \" pulumi-lang-java=\" databricks.GlobalInitScript \" pulumi-lang-hcl=\" databricks_global_init_script \"\u003e databricks.GlobalInitScript \u003c/span\u003eto manage [global init scripts](https://docs.databricks.com/clusters/init-scripts.html#global-init-scripts), which are run on all\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand databricks_job.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstancePool \" pulumi-lang-dotnet=\" databricks.InstancePool \" pulumi-lang-go=\" InstancePool \" pulumi-lang-python=\" InstancePool \" pulumi-lang-yaml=\" databricks.InstancePool \" pulumi-lang-java=\" databricks.InstancePool \" pulumi-lang-hcl=\" databricks_instance_pool \"\u003e databricks.InstancePool \u003c/span\u003eto manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eto manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount.\n*\u003cspan pulumi-lang-nodejs=\" databricks.IpAccessList \" pulumi-lang-dotnet=\" databricks.IpAccessList \" pulumi-lang-go=\" IpAccessList \" pulumi-lang-python=\" IpAccessList \" pulumi-lang-yaml=\" databricks.IpAccessList \" pulumi-lang-java=\" databricks.IpAccessList \" pulumi-lang-hcl=\" databricks_ip_access_list \"\u003e databricks.IpAccessList \u003c/span\u003eto allow access from [predefined IP ranges](https://docs.databricks.com/security/network/ip-access-list.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Library \" pulumi-lang-dotnet=\" databricks.Library \" pulumi-lang-go=\" Library \" pulumi-lang-python=\" Library \" pulumi-lang-yaml=\" databricks.Library \" pulumi-lang-java=\" databricks.Library \" pulumi-lang-hcl=\" databricks_library \"\u003e databricks.Library \u003c/span\u003eto install a [library](https://docs.databricks.com/libraries/index.html) on databricks_cluster.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getNodeType \" pulumi-lang-dotnet=\" databricks.getNodeType \" pulumi-lang-go=\" getNodeType \" pulumi-lang-python=\" get_node_type \" pulumi-lang-yaml=\" databricks.getNodeType \" pulumi-lang-java=\" databricks.getNodeType \" pulumi-lang-hcl=\" data.databricks_node_type \"\u003e databricks.getNodeType \u003c/span\u003edata to get the smallest node type for\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003ethat fits search criteria, like amount of RAM or number of cores.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eto manage [access control](https://docs.databricks.com/security/access-control/index.html) in Databricks workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003edata to get [Databricks Runtime (DBR)](https://docs.databricks.com/runtime/dbr.html) version that could be used for \u003cspan pulumi-lang-nodejs=\"`sparkVersion`\" pulumi-lang-dotnet=\"`SparkVersion`\" pulumi-lang-go=\"`sparkVersion`\" pulumi-lang-python=\"`spark_version`\" pulumi-lang-yaml=\"`sparkVersion`\" pulumi-lang-java=\"`sparkVersion`\" pulumi-lang-hcl=\"`spark_version`\"\u003e`sparkVersion`\u003c/span\u003e parameter in\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand other resources.\n*\u003cspan pulumi-lang-nodejs=\" databricks.UserInstanceProfile \" pulumi-lang-dotnet=\" databricks.UserInstanceProfile \" pulumi-lang-go=\" UserInstanceProfile \" pulumi-lang-python=\" UserInstanceProfile \" pulumi-lang-yaml=\" databricks.UserInstanceProfile \" pulumi-lang-java=\" databricks.UserInstanceProfile \" pulumi-lang-hcl=\" databricks_user_instance_profile \"\u003e databricks.UserInstanceProfile \u003c/span\u003eto attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_user.\n*\u003cspan pulumi-lang-nodejs=\" databricks.WorkspaceConf \" pulumi-lang-dotnet=\" databricks.WorkspaceConf \" pulumi-lang-go=\" WorkspaceConf \" pulumi-lang-python=\" WorkspaceConf \" pulumi-lang-yaml=\" databricks.WorkspaceConf \" pulumi-lang-java=\" databricks.WorkspaceConf \" pulumi-lang-hcl=\" databricks_workspace_conf \"\u003e databricks.WorkspaceConf \u003c/span\u003eto manage workspace configuration for expert usage.\n\n", "properties": { "definition": { "type": "string", "description": "Policy definition: JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policies.html#cluster-policy-definition). Cannot be used with \u003cspan pulumi-lang-nodejs=\"`policyFamilyId`\" pulumi-lang-dotnet=\"`PolicyFamilyId`\" pulumi-lang-go=\"`policyFamilyId`\" pulumi-lang-python=\"`policy_family_id`\" pulumi-lang-yaml=\"`policyFamilyId`\" pulumi-lang-java=\"`policyFamilyId`\" pulumi-lang-hcl=\"`policy_family_id`\"\u003e`policyFamilyId`\u003c/span\u003e\n" }, "description": { "type": "string", "description": "Additional human-readable description of the cluster policy.\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterPolicyLibrary:ClusterPolicyLibrary" } }, "maxClustersPerUser": { "type": "integer", "description": "Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.\n" }, "name": { "type": "string", "description": "Cluster policy name. This must be unique. Length must be between 1 and 100 characters.\n" }, "policyFamilyDefinitionOverrides": { "type": "string", "description": "Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.\n" }, "policyFamilyId": { "type": "string", "description": "ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with \u003cspan pulumi-lang-nodejs=\"`definition`\" pulumi-lang-dotnet=\"`Definition`\" pulumi-lang-go=\"`definition`\" pulumi-lang-python=\"`definition`\" pulumi-lang-yaml=\"`definition`\" pulumi-lang-java=\"`definition`\" pulumi-lang-hcl=\"`definition`\"\u003e`definition`\u003c/span\u003e. Use \u003cspan pulumi-lang-nodejs=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-dotnet=\"`PolicyFamilyDefinitionOverrides`\" pulumi-lang-go=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-python=\"`policy_family_definition_overrides`\" pulumi-lang-yaml=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-java=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-hcl=\"`policy_family_definition_overrides`\"\u003e`policyFamilyDefinitionOverrides`\u003c/span\u003e instead to customize the policy definition.\n" }, "policyId": { "type": "string", "description": "Canonical unique identifier for the cluster policy.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterPolicyProviderConfig:ClusterPolicyProviderConfig" } }, "required": [ "definition", "name", "policyId", "providerConfig" ], "inputProperties": { "definition": { "type": "string", "description": "Policy definition: JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policies.html#cluster-policy-definition). Cannot be used with \u003cspan pulumi-lang-nodejs=\"`policyFamilyId`\" pulumi-lang-dotnet=\"`PolicyFamilyId`\" pulumi-lang-go=\"`policyFamilyId`\" pulumi-lang-python=\"`policy_family_id`\" pulumi-lang-yaml=\"`policyFamilyId`\" pulumi-lang-java=\"`policyFamilyId`\" pulumi-lang-hcl=\"`policy_family_id`\"\u003e`policyFamilyId`\u003c/span\u003e\n" }, "description": { "type": "string", "description": "Additional human-readable description of the cluster policy.\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterPolicyLibrary:ClusterPolicyLibrary" } }, "maxClustersPerUser": { "type": "integer", "description": "Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.\n" }, "name": { "type": "string", "description": "Cluster policy name. This must be unique. Length must be between 1 and 100 characters.\n" }, "policyFamilyDefinitionOverrides": { "type": "string", "description": "Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.\n" }, "policyFamilyId": { "type": "string", "description": "ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with \u003cspan pulumi-lang-nodejs=\"`definition`\" pulumi-lang-dotnet=\"`Definition`\" pulumi-lang-go=\"`definition`\" pulumi-lang-python=\"`definition`\" pulumi-lang-yaml=\"`definition`\" pulumi-lang-java=\"`definition`\" pulumi-lang-hcl=\"`definition`\"\u003e`definition`\u003c/span\u003e. Use \u003cspan pulumi-lang-nodejs=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-dotnet=\"`PolicyFamilyDefinitionOverrides`\" pulumi-lang-go=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-python=\"`policy_family_definition_overrides`\" pulumi-lang-yaml=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-java=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-hcl=\"`policy_family_definition_overrides`\"\u003e`policyFamilyDefinitionOverrides`\u003c/span\u003e instead to customize the policy definition.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterPolicyProviderConfig:ClusterPolicyProviderConfig" } }, "stateInputs": { "description": "Input properties used for looking up and filtering ClusterPolicy resources.\n", "properties": { "definition": { "type": "string", "description": "Policy definition: JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policies.html#cluster-policy-definition). Cannot be used with \u003cspan pulumi-lang-nodejs=\"`policyFamilyId`\" pulumi-lang-dotnet=\"`PolicyFamilyId`\" pulumi-lang-go=\"`policyFamilyId`\" pulumi-lang-python=\"`policy_family_id`\" pulumi-lang-yaml=\"`policyFamilyId`\" pulumi-lang-java=\"`policyFamilyId`\" pulumi-lang-hcl=\"`policy_family_id`\"\u003e`policyFamilyId`\u003c/span\u003e\n" }, "description": { "type": "string", "description": "Additional human-readable description of the cluster policy.\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/ClusterPolicyLibrary:ClusterPolicyLibrary" } }, "maxClustersPerUser": { "type": "integer", "description": "Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.\n" }, "name": { "type": "string", "description": "Cluster policy name. This must be unique. Length must be between 1 and 100 characters.\n" }, "policyFamilyDefinitionOverrides": { "type": "string", "description": "Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.\n" }, "policyFamilyId": { "type": "string", "description": "ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with \u003cspan pulumi-lang-nodejs=\"`definition`\" pulumi-lang-dotnet=\"`Definition`\" pulumi-lang-go=\"`definition`\" pulumi-lang-python=\"`definition`\" pulumi-lang-yaml=\"`definition`\" pulumi-lang-java=\"`definition`\" pulumi-lang-hcl=\"`definition`\"\u003e`definition`\u003c/span\u003e. Use \u003cspan pulumi-lang-nodejs=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-dotnet=\"`PolicyFamilyDefinitionOverrides`\" pulumi-lang-go=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-python=\"`policy_family_definition_overrides`\" pulumi-lang-yaml=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-java=\"`policyFamilyDefinitionOverrides`\" pulumi-lang-hcl=\"`policy_family_definition_overrides`\"\u003e`policyFamilyDefinitionOverrides`\u003c/span\u003e instead to customize the policy definition.\n" }, "policyId": { "type": "string", "description": "Canonical unique identifier for the cluster policy.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ClusterPolicyProviderConfig:ClusterPolicyProviderConfig" } }, "type": "object" } }, "databricks:index/complianceSecurityProfileWorkspaceSetting:ComplianceSecurityProfileWorkspaceSetting": { "properties": { "complianceSecurityProfileWorkspace": { "$ref": "#/types/databricks:index/ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace:ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/ComplianceSecurityProfileWorkspaceSettingProviderConfig:ComplianceSecurityProfileWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "required": [ "complianceSecurityProfileWorkspace", "etag", "providerConfig", "settingName" ], "inputProperties": { "complianceSecurityProfileWorkspace": { "$ref": "#/types/databricks:index/ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace:ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/ComplianceSecurityProfileWorkspaceSettingProviderConfig:ComplianceSecurityProfileWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "requiredInputs": [ "complianceSecurityProfileWorkspace" ], "stateInputs": { "description": "Input properties used for looking up and filtering ComplianceSecurityProfileWorkspaceSetting resources.\n", "properties": { "complianceSecurityProfileWorkspace": { "$ref": "#/types/databricks:index/ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace:ComplianceSecurityProfileWorkspaceSettingComplianceSecurityProfileWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/ComplianceSecurityProfileWorkspaceSettingProviderConfig:ComplianceSecurityProfileWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/connection:Connection": { "description": "\u003e This resource can only be used with a workspace-level provider!\n\nLakehouse Federation is the query federation platform for Databricks. Databricks uses Unity Catalog to manage query federation. To make a dataset available for read-only querying using Lakehouse Federation, you create the following:\n\n- A connection, a securable object in Unity Catalog that specifies a path and credentials for accessing an external database system.\n- A foreign catalog\n\nThis resource manages connections in Unity Catalog. Please note that OAuth U2M is not supported as it requires user interaction for authentication.\n\n## Example Usage\n\nCreate a connection to a MySQL database\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst mysql = new databricks.Connection(\"mysql\", {\n name: \"mysql_connection\",\n connectionType: \"MYSQL\",\n comment: \"this is a connection to mysql db\",\n options: {\n host: \"test.mysql.database.azure.com\",\n port: \"3306\",\n user: \"user\",\n password: \"password\",\n },\n properties: {\n purpose: \"testing\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nmysql = databricks.Connection(\"mysql\",\n name=\"mysql_connection\",\n connection_type=\"MYSQL\",\n comment=\"this is a connection to mysql db\",\n options={\n \"host\": \"test.mysql.database.azure.com\",\n \"port\": \"3306\",\n \"user\": \"user\",\n \"password\": \"password\",\n },\n properties={\n \"purpose\": \"testing\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var mysql = new Databricks.Connection(\"mysql\", new()\n {\n Name = \"mysql_connection\",\n ConnectionType = \"MYSQL\",\n Comment = \"this is a connection to mysql db\",\n Options = \n {\n { \"host\", \"test.mysql.database.azure.com\" },\n { \"port\", \"3306\" },\n { \"user\", \"user\" },\n { \"password\", \"password\" },\n },\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewConnection(ctx, \"mysql\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"mysql_connection\"),\n\t\t\tConnectionType: pulumi.String(\"MYSQL\"),\n\t\t\tComment: pulumi.String(\"this is a connection to mysql db\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"host\": pulumi.String(\"test.mysql.database.azure.com\"),\n\t\t\t\t\"port\": pulumi.String(\"3306\"),\n\t\t\t\t\"user\": pulumi.String(\"user\"),\n\t\t\t\t\"password\": pulumi.String(\"password\"),\n\t\t\t},\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"mysql\" {\n name = \"mysql_connection\"\n connection_type = \"MYSQL\"\n comment = \"this is a connection to mysql db\"\n options = {\n \"host\" = \"test.mysql.database.azure.com\"\n \"port\" = \"3306\"\n \"user\" = \"user\"\n \"password\" = \"password\"\n }\n properties = {\n \"purpose\" = \"testing\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var mysql = new Connection(\"mysql\", ConnectionArgs.builder()\n .name(\"mysql_connection\")\n .connectionType(\"MYSQL\")\n .comment(\"this is a connection to mysql db\")\n .options(Map.ofEntries(\n Map.entry(\"host\", \"test.mysql.database.azure.com\"),\n Map.entry(\"port\", \"3306\"),\n Map.entry(\"user\", \"user\"),\n Map.entry(\"password\", \"password\")\n ))\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n mysql:\n type: databricks:Connection\n properties:\n name: mysql_connection\n connectionType: MYSQL\n comment: this is a connection to mysql db\n options:\n host: test.mysql.database.azure.com\n port: '3306'\n user: user\n password: password\n properties:\n purpose: testing\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreate a connection to a BigQuery database\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst bigquery = new databricks.Connection(\"bigquery\", {\n name: \"bq_connection\",\n connectionType: \"BIGQUERY\",\n comment: \"this is a connection to BQ\",\n options: {\n GoogleServiceAccountKeyJson: JSON.stringify({\n type: \"service_account\",\n project_id: \"PROJECT_ID\",\n private_key_id: \"KEY_ID\",\n private_key: `-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n`,\n client_email: \"SERVICE_ACCOUNT_EMAIL\",\n client_id: \"CLIENT_ID\",\n auth_uri: \"https://accounts.google.com/o/oauth2/auth\",\n token_uri: \"https://accounts.google.com/o/oauth2/token\",\n auth_provider_x509_cert_url: \"https://www.googleapis.com/oauth2/v1/certs\",\n client_x509_cert_url: \"https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\",\n universe_domain: \"googleapis.com\",\n }),\n },\n properties: {\n purpose: \"testing\",\n },\n});\n```\n```python\nimport pulumi\nimport json\nimport pulumi_databricks as databricks\n\nbigquery = databricks.Connection(\"bigquery\",\n name=\"bq_connection\",\n connection_type=\"BIGQUERY\",\n comment=\"this is a connection to BQ\",\n options={\n \"GoogleServiceAccountKeyJson\": json.dumps({\n \"type\": \"service_account\",\n \"project_id\": \"PROJECT_ID\",\n \"private_key_id\": \"KEY_ID\",\n \"private_key\": \"\"\"-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n\"\"\",\n \"client_email\": \"SERVICE_ACCOUNT_EMAIL\",\n \"client_id\": \"CLIENT_ID\",\n \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n \"token_uri\": \"https://accounts.google.com/o/oauth2/token\",\n \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n \"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\",\n \"universe_domain\": \"googleapis.com\",\n }),\n },\n properties={\n \"purpose\": \"testing\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text.Json;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var bigquery = new Databricks.Connection(\"bigquery\", new()\n {\n Name = \"bq_connection\",\n ConnectionType = \"BIGQUERY\",\n Comment = \"this is a connection to BQ\",\n Options = \n {\n { \"GoogleServiceAccountKeyJson\", JsonSerializer.Serialize(new Dictionary\u003cstring, object?\u003e\n {\n [\"type\"] = \"service_account\",\n [\"project_id\"] = \"PROJECT_ID\",\n [\"private_key_id\"] = \"KEY_ID\",\n [\"private_key\"] = @\"-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n\",\n [\"client_email\"] = \"SERVICE_ACCOUNT_EMAIL\",\n [\"client_id\"] = \"CLIENT_ID\",\n [\"auth_uri\"] = \"https://accounts.google.com/o/oauth2/auth\",\n [\"token_uri\"] = \"https://accounts.google.com/o/oauth2/token\",\n [\"auth_provider_x509_cert_url\"] = \"https://www.googleapis.com/oauth2/v1/certs\",\n [\"client_x509_cert_url\"] = \"https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\",\n [\"universe_domain\"] = \"googleapis.com\",\n }) },\n },\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"encoding/json\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\ttmpJSON0, err := json.Marshal(map[string]interface{}{\n\t\t\t\"type\": \"service_account\",\n\t\t\t\"project_id\": \"PROJECT_ID\",\n\t\t\t\"private_key_id\": \"KEY_ID\",\n\t\t\t\"private_key\": \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY\\n-----END PRIVATE KEY-----\\n\",\n\t\t\t\"client_email\": \"SERVICE_ACCOUNT_EMAIL\",\n\t\t\t\"client_id\": \"CLIENT_ID\",\n\t\t\t\"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n\t\t\t\"token_uri\": \"https://accounts.google.com/o/oauth2/token\",\n\t\t\t\"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n\t\t\t\"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\",\n\t\t\t\"universe_domain\": \"googleapis.com\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjson0 := string(tmpJSON0)\n\t\t_, err = databricks.NewConnection(ctx, \"bigquery\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"bq_connection\"),\n\t\t\tConnectionType: pulumi.String(\"BIGQUERY\"),\n\t\t\tComment: pulumi.String(\"this is a connection to BQ\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"GoogleServiceAccountKeyJson\": pulumi.String(pulumi.String(json0)),\n\t\t\t},\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"bigquery\" {\n name = \"bq_connection\"\n connection_type = \"BIGQUERY\"\n comment = \"this is a connection to BQ\"\n options = {\n \"GoogleServiceAccountKeyJson\" = jsonencode({\n \"type\" = \"service_account\"\n \"project_id\" = \"PROJECT_ID\"\n \"private_key_id\" = \"KEY_ID\"\n \"private_key\" = \"-----BEGIN PRIVATE KEY-----\\nPRIVATE_KEY\\n-----END PRIVATE KEY-----\\n\"\n \"client_email\" = \"SERVICE_ACCOUNT_EMAIL\"\n \"client_id\" = \"CLIENT_ID\"\n \"auth_uri\" = \"https://accounts.google.com/o/oauth2/auth\"\n \"token_uri\" = \"https://accounts.google.com/o/oauth2/token\"\n \"auth_provider_x509_cert_url\" = \"https://www.googleapis.com/oauth2/v1/certs\"\n \"client_x509_cert_url\" = \"https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\"\n \"universe_domain\" = \"googleapis.com\"\n })\n }\n properties = {\n \"purpose\" = \"testing\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport static com.pulumi.codegen.internal.Serialization.*;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var bigquery = new Connection(\"bigquery\", ConnectionArgs.builder()\n .name(\"bq_connection\")\n .connectionType(\"BIGQUERY\")\n .comment(\"this is a connection to BQ\")\n .options(Map.of(\"GoogleServiceAccountKeyJson\", serializeJson(\n jsonObject(\n jsonProperty(\"type\", \"service_account\"),\n jsonProperty(\"project_id\", \"PROJECT_ID\"),\n jsonProperty(\"private_key_id\", \"KEY_ID\"),\n jsonProperty(\"private_key\", \"\"\"\n-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY\n-----END PRIVATE KEY-----\n \"\"\"),\n jsonProperty(\"client_email\", \"SERVICE_ACCOUNT_EMAIL\"),\n jsonProperty(\"client_id\", \"CLIENT_ID\"),\n jsonProperty(\"auth_uri\", \"https://accounts.google.com/o/oauth2/auth\"),\n jsonProperty(\"token_uri\", \"https://accounts.google.com/o/oauth2/token\"),\n jsonProperty(\"auth_provider_x509_cert_url\", \"https://www.googleapis.com/oauth2/v1/certs\"),\n jsonProperty(\"client_x509_cert_url\", \"https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\"),\n jsonProperty(\"universe_domain\", \"googleapis.com\")\n ))))\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n bigquery:\n type: databricks:Connection\n properties:\n name: bq_connection\n connectionType: BIGQUERY\n comment: this is a connection to BQ\n options:\n GoogleServiceAccountKeyJson:\n fn::toJSON:\n type: service_account\n project_id: PROJECT_ID\n private_key_id: KEY_ID\n private_key: |\n -----BEGIN PRIVATE KEY-----\n PRIVATE_KEY\n -----END PRIVATE KEY-----\n client_email: SERVICE_ACCOUNT_EMAIL\n client_id: CLIENT_ID\n auth_uri: https://accounts.google.com/o/oauth2/auth\n token_uri: https://accounts.google.com/o/oauth2/token\n auth_provider_x509_cert_url: https://www.googleapis.com/oauth2/v1/certs\n client_x509_cert_url: https://www.googleapis.com/robot/v1/metadata/x509/SERVICE_ACCOUNT_EMAIL\n universe_domain: googleapis.com\n properties:\n purpose: testing\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreate a connection to builtin Hive Metastore\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst hms = new databricks.Connection(\"hms\", {\n name: \"hms-builtin\",\n connectionType: \"HIVE_METASTORE\",\n comment: \"This is a connection to builtin HMS\",\n options: {\n builtin: \"true\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nhms = databricks.Connection(\"hms\",\n name=\"hms-builtin\",\n connection_type=\"HIVE_METASTORE\",\n comment=\"This is a connection to builtin HMS\",\n options={\n \"builtin\": \"true\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var hms = new Databricks.Connection(\"hms\", new()\n {\n Name = \"hms-builtin\",\n ConnectionType = \"HIVE_METASTORE\",\n Comment = \"This is a connection to builtin HMS\",\n Options = \n {\n { \"builtin\", \"true\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewConnection(ctx, \"hms\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"hms-builtin\"),\n\t\t\tConnectionType: pulumi.String(\"HIVE_METASTORE\"),\n\t\t\tComment: pulumi.String(\"This is a connection to builtin HMS\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"builtin\": pulumi.String(\"true\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"hms\" {\n name = \"hms-builtin\"\n connection_type = \"HIVE_METASTORE\"\n comment = \"This is a connection to builtin HMS\"\n options = {\n \"builtin\" = \"true\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var hms = new Connection(\"hms\", ConnectionArgs.builder()\n .name(\"hms-builtin\")\n .connectionType(\"HIVE_METASTORE\")\n .comment(\"This is a connection to builtin HMS\")\n .options(Map.of(\"builtin\", \"true\"))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n hms:\n type: databricks:Connection\n properties:\n name: hms-builtin\n connectionType: HIVE_METASTORE\n comment: This is a connection to builtin HMS\n options:\n builtin: 'true'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreate a HTTP connection with bearer token\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst httpBearer = new databricks.Connection(\"http_bearer\", {\n name: \"http_bearer\",\n connectionType: \"HTTP\",\n comment: \"This is a connection to a HTTP service\",\n options: {\n host: \"https://example.com\",\n port: \"8433\",\n base_path: \"/api/\",\n bearer_token: \"bearer_token\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nhttp_bearer = databricks.Connection(\"http_bearer\",\n name=\"http_bearer\",\n connection_type=\"HTTP\",\n comment=\"This is a connection to a HTTP service\",\n options={\n \"host\": \"https://example.com\",\n \"port\": \"8433\",\n \"base_path\": \"/api/\",\n \"bearer_token\": \"bearer_token\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var httpBearer = new Databricks.Connection(\"http_bearer\", new()\n {\n Name = \"http_bearer\",\n ConnectionType = \"HTTP\",\n Comment = \"This is a connection to a HTTP service\",\n Options = \n {\n { \"host\", \"https://example.com\" },\n { \"port\", \"8433\" },\n { \"base_path\", \"/api/\" },\n { \"bearer_token\", \"bearer_token\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewConnection(ctx, \"http_bearer\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"http_bearer\"),\n\t\t\tConnectionType: pulumi.String(\"HTTP\"),\n\t\t\tComment: pulumi.String(\"This is a connection to a HTTP service\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"host\": pulumi.String(\"https://example.com\"),\n\t\t\t\t\"port\": pulumi.String(\"8433\"),\n\t\t\t\t\"base_path\": pulumi.String(\"/api/\"),\n\t\t\t\t\"bearer_token\": pulumi.String(\"bearer_token\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"http_bearer\" {\n name = \"http_bearer\"\n connection_type = \"HTTP\"\n comment = \"This is a connection to a HTTP service\"\n options = {\n \"host\" = \"https://example.com\"\n \"port\" = \"8433\"\n \"base_path\" = \"/api/\"\n \"bearer_token\" = \"bearer_token\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var httpBearer = new Connection(\"httpBearer\", ConnectionArgs.builder()\n .name(\"http_bearer\")\n .connectionType(\"HTTP\")\n .comment(\"This is a connection to a HTTP service\")\n .options(Map.ofEntries(\n Map.entry(\"host\", \"https://example.com\"),\n Map.entry(\"port\", \"8433\"),\n Map.entry(\"base_path\", \"/api/\"),\n Map.entry(\"bearer_token\", \"bearer_token\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n httpBearer:\n type: databricks:Connection\n name: http_bearer\n properties:\n name: http_bearer\n connectionType: HTTP\n comment: This is a connection to a HTTP service\n options:\n host: https://example.com\n port: '8433'\n base_path: /api/\n bearer_token: bearer_token\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreate a HTTP connection with OAuth M2M\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst httpOauth = new databricks.Connection(\"http_oauth\", {\n name: \"http_oauth\",\n connectionType: \"HTTP\",\n comment: \"This is a connection to a HTTP service\",\n options: {\n host: \"https://example.com\",\n port: \"8433\",\n base_path: \"/api/\",\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n oauth_scope: \"channels:read channels:history chat:write\",\n token_endpoint: \"https://authorization-server.com/oauth/token\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nhttp_oauth = databricks.Connection(\"http_oauth\",\n name=\"http_oauth\",\n connection_type=\"HTTP\",\n comment=\"This is a connection to a HTTP service\",\n options={\n \"host\": \"https://example.com\",\n \"port\": \"8433\",\n \"base_path\": \"/api/\",\n \"client_id\": \"client_id\",\n \"client_secret\": \"client_secret\",\n \"oauth_scope\": \"channels:read channels:history chat:write\",\n \"token_endpoint\": \"https://authorization-server.com/oauth/token\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var httpOauth = new Databricks.Connection(\"http_oauth\", new()\n {\n Name = \"http_oauth\",\n ConnectionType = \"HTTP\",\n Comment = \"This is a connection to a HTTP service\",\n Options = \n {\n { \"host\", \"https://example.com\" },\n { \"port\", \"8433\" },\n { \"base_path\", \"/api/\" },\n { \"client_id\", \"client_id\" },\n { \"client_secret\", \"client_secret\" },\n { \"oauth_scope\", \"channels:read channels:history chat:write\" },\n { \"token_endpoint\", \"https://authorization-server.com/oauth/token\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewConnection(ctx, \"http_oauth\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"http_oauth\"),\n\t\t\tConnectionType: pulumi.String(\"HTTP\"),\n\t\t\tComment: pulumi.String(\"This is a connection to a HTTP service\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"host\": pulumi.String(\"https://example.com\"),\n\t\t\t\t\"port\": pulumi.String(\"8433\"),\n\t\t\t\t\"base_path\": pulumi.String(\"/api/\"),\n\t\t\t\t\"client_id\": pulumi.String(\"client_id\"),\n\t\t\t\t\"client_secret\": pulumi.String(\"client_secret\"),\n\t\t\t\t\"oauth_scope\": pulumi.String(\"channels:read channels:history chat:write\"),\n\t\t\t\t\"token_endpoint\": pulumi.String(\"https://authorization-server.com/oauth/token\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"http_oauth\" {\n name = \"http_oauth\"\n connection_type = \"HTTP\"\n comment = \"This is a connection to a HTTP service\"\n options = {\n \"host\" = \"https://example.com\"\n \"port\" = \"8433\"\n \"base_path\" = \"/api/\"\n \"client_id\" = \"client_id\"\n \"client_secret\" = \"client_secret\"\n \"oauth_scope\" = \"channels:read channels:history chat:write\"\n \"token_endpoint\" = \"https://authorization-server.com/oauth/token\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var httpOauth = new Connection(\"httpOauth\", ConnectionArgs.builder()\n .name(\"http_oauth\")\n .connectionType(\"HTTP\")\n .comment(\"This is a connection to a HTTP service\")\n .options(Map.ofEntries(\n Map.entry(\"host\", \"https://example.com\"),\n Map.entry(\"port\", \"8433\"),\n Map.entry(\"base_path\", \"/api/\"),\n Map.entry(\"client_id\", \"client_id\"),\n Map.entry(\"client_secret\", \"client_secret\"),\n Map.entry(\"oauth_scope\", \"channels:read channels:history chat:write\"),\n Map.entry(\"token_endpoint\", \"https://authorization-server.com/oauth/token\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n httpOauth:\n type: databricks:Connection\n name: http_oauth\n properties:\n name: http_oauth\n connectionType: HTTP\n comment: This is a connection to a HTTP service\n options:\n host: https://example.com\n port: '8433'\n base_path: /api/\n client_id: client_id\n client_secret: client_secret\n oauth_scope: channels:read channels:history chat:write\n token_endpoint: https://authorization-server.com/oauth/token\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreate a PowerBI connection with OAuth M2M\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst pbi = new databricks.Connection(\"pbi\", {\n name: \"test-pbi\",\n connectionType: \"POWER_BI\",\n options: {\n authorization_endpoint: \"https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\",\n client_id: \"client_id\",\n client_secret: \"client_secret\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\npbi = databricks.Connection(\"pbi\",\n name=\"test-pbi\",\n connection_type=\"POWER_BI\",\n options={\n \"authorization_endpoint\": \"https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\",\n \"client_id\": \"client_id\",\n \"client_secret\": \"client_secret\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var pbi = new Databricks.Connection(\"pbi\", new()\n {\n Name = \"test-pbi\",\n ConnectionType = \"POWER_BI\",\n Options = \n {\n { \"authorization_endpoint\", \"https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\" },\n { \"client_id\", \"client_id\" },\n { \"client_secret\", \"client_secret\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewConnection(ctx, \"pbi\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"test-pbi\"),\n\t\t\tConnectionType: pulumi.String(\"POWER_BI\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"authorization_endpoint\": pulumi.String(\"https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\"),\n\t\t\t\t\"client_id\": pulumi.String(\"client_id\"),\n\t\t\t\t\"client_secret\": pulumi.String(\"client_secret\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"pbi\" {\n name = \"test-pbi\"\n connection_type = \"POWER_BI\"\n options = {\n \"authorization_endpoint\" = \"https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\"\n \"client_id\" = \"client_id\"\n \"client_secret\" = \"client_secret\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var pbi = new Connection(\"pbi\", ConnectionArgs.builder()\n .name(\"test-pbi\")\n .connectionType(\"POWER_BI\")\n .options(Map.ofEntries(\n Map.entry(\"authorization_endpoint\", \"https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\"),\n Map.entry(\"client_id\", \"client_id\"),\n Map.entry(\"client_secret\", \"client_secret\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n pbi:\n type: databricks:Connection\n properties:\n name: test-pbi\n connectionType: POWER_BI\n options:\n authorization_endpoint: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize\n client_id: client_id\n client_secret: client_secret\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "comment": { "type": "string", "description": "Free-form text. Change forces creation of a new resource.\n" }, "connectionId": { "type": "string", "description": "Unique ID of the connection.\n" }, "connectionType": { "type": "string", "description": "Connection type. `MYSQL`, `POSTGRESQL`, `SNOWFLAKE`, `REDSHIFT` `SQLDW`, `SQLSERVER`, `DATABRICKS`, `SALESFORCE`, `BIGQUERY`, `WORKDAY_RAAS`, `HIVE_METASTORE`, `GA4_RAW_DATA`, `SERVICENOW`, `SALESFORCE_DATA_CLOUD`, `GLUE`, `ORACLE`, `TERADATA`, `HTTP` or `POWER_BI` are supported. Up-to-date list of connection type supported is in the [documentation](https://docs.databricks.com/query-federation/index.html#supported-data-sources). Change forces creation of a new resource.\n" }, "createdAt": { "type": "integer", "description": "Time at which this connection was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of connection creator.\n" }, "credentialType": { "type": "string", "description": "The type of credential for this connection.\n" }, "fullName": { "type": "string", "description": "Full name of connection.\n" }, "metastoreId": { "type": "string", "description": "Unique ID of the UC metastore for this connection.\n" }, "name": { "type": "string", "description": "Name of the Connection.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The key value of options required by the connection, e.g. \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`port`\" pulumi-lang-dotnet=\"`Port`\" pulumi-lang-go=\"`port`\" pulumi-lang-python=\"`port`\" pulumi-lang-yaml=\"`port`\" pulumi-lang-java=\"`port`\" pulumi-lang-hcl=\"`port`\"\u003e`port`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`user`\" pulumi-lang-dotnet=\"`User`\" pulumi-lang-go=\"`user`\" pulumi-lang-python=\"`user`\" pulumi-lang-yaml=\"`user`\" pulumi-lang-java=\"`user`\" pulumi-lang-hcl=\"`user`\"\u003e`user`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`password`\" pulumi-lang-dotnet=\"`Password`\" pulumi-lang-go=\"`password`\" pulumi-lang-python=\"`password`\" pulumi-lang-yaml=\"`password`\" pulumi-lang-java=\"`password`\" pulumi-lang-hcl=\"`password`\"\u003e`password`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`authorizationEndpoint`\" pulumi-lang-dotnet=\"`AuthorizationEndpoint`\" pulumi-lang-go=\"`authorizationEndpoint`\" pulumi-lang-python=\"`authorization_endpoint`\" pulumi-lang-yaml=\"`authorizationEndpoint`\" pulumi-lang-java=\"`authorizationEndpoint`\" pulumi-lang-hcl=\"`authorization_endpoint`\"\u003e`authorizationEndpoint`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`clientId`\" pulumi-lang-dotnet=\"`ClientId`\" pulumi-lang-go=\"`clientId`\" pulumi-lang-python=\"`client_id`\" pulumi-lang-yaml=\"`clientId`\" pulumi-lang-java=\"`clientId`\" pulumi-lang-hcl=\"`client_id`\"\u003e`clientId`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`clientSecret`\" pulumi-lang-dotnet=\"`ClientSecret`\" pulumi-lang-go=\"`clientSecret`\" pulumi-lang-python=\"`client_secret`\" pulumi-lang-yaml=\"`clientSecret`\" pulumi-lang-java=\"`clientSecret`\" pulumi-lang-hcl=\"`client_secret`\"\u003e`clientSecret`\u003c/span\u003e or `GoogleServiceAccountKeyJson`. Please consult the [documentation](https://docs.databricks.com/query-federation/index.html#supported-data-sources) for the required option.\n", "secret": true }, "owner": { "type": "string", "description": "Name of the connection owner.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form connection properties. Change forces creation of a new resource.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ConnectionProviderConfig:ConnectionProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "provisioningInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/ConnectionProvisioningInfo:ConnectionProvisioningInfo" }, "description": "Object with the status of an asynchronously provisioned resource.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the connection is read-only. Change forces creation of a new resource.\n" }, "securableType": { "type": "string" }, "updatedAt": { "type": "integer", "description": "Time at which connection this was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the connection.\n" }, "url": { "type": "string", "description": "URL of the remote data source, extracted from options.\n" } }, "required": [ "connectionId", "createdAt", "createdBy", "credentialType", "fullName", "metastoreId", "name", "owner", "providerConfig", "provisioningInfos", "readOnly", "securableType", "updatedAt", "updatedBy", "url" ], "inputProperties": { "comment": { "type": "string", "description": "Free-form text. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "connectionType": { "type": "string", "description": "Connection type. `MYSQL`, `POSTGRESQL`, `SNOWFLAKE`, `REDSHIFT` `SQLDW`, `SQLSERVER`, `DATABRICKS`, `SALESFORCE`, `BIGQUERY`, `WORKDAY_RAAS`, `HIVE_METASTORE`, `GA4_RAW_DATA`, `SERVICENOW`, `SALESFORCE_DATA_CLOUD`, `GLUE`, `ORACLE`, `TERADATA`, `HTTP` or `POWER_BI` are supported. Up-to-date list of connection type supported is in the [documentation](https://docs.databricks.com/query-federation/index.html#supported-data-sources). Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Name of the Connection.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The key value of options required by the connection, e.g. \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`port`\" pulumi-lang-dotnet=\"`Port`\" pulumi-lang-go=\"`port`\" pulumi-lang-python=\"`port`\" pulumi-lang-yaml=\"`port`\" pulumi-lang-java=\"`port`\" pulumi-lang-hcl=\"`port`\"\u003e`port`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`user`\" pulumi-lang-dotnet=\"`User`\" pulumi-lang-go=\"`user`\" pulumi-lang-python=\"`user`\" pulumi-lang-yaml=\"`user`\" pulumi-lang-java=\"`user`\" pulumi-lang-hcl=\"`user`\"\u003e`user`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`password`\" pulumi-lang-dotnet=\"`Password`\" pulumi-lang-go=\"`password`\" pulumi-lang-python=\"`password`\" pulumi-lang-yaml=\"`password`\" pulumi-lang-java=\"`password`\" pulumi-lang-hcl=\"`password`\"\u003e`password`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`authorizationEndpoint`\" pulumi-lang-dotnet=\"`AuthorizationEndpoint`\" pulumi-lang-go=\"`authorizationEndpoint`\" pulumi-lang-python=\"`authorization_endpoint`\" pulumi-lang-yaml=\"`authorizationEndpoint`\" pulumi-lang-java=\"`authorizationEndpoint`\" pulumi-lang-hcl=\"`authorization_endpoint`\"\u003e`authorizationEndpoint`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`clientId`\" pulumi-lang-dotnet=\"`ClientId`\" pulumi-lang-go=\"`clientId`\" pulumi-lang-python=\"`client_id`\" pulumi-lang-yaml=\"`clientId`\" pulumi-lang-java=\"`clientId`\" pulumi-lang-hcl=\"`client_id`\"\u003e`clientId`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`clientSecret`\" pulumi-lang-dotnet=\"`ClientSecret`\" pulumi-lang-go=\"`clientSecret`\" pulumi-lang-python=\"`client_secret`\" pulumi-lang-yaml=\"`clientSecret`\" pulumi-lang-java=\"`clientSecret`\" pulumi-lang-hcl=\"`client_secret`\"\u003e`clientSecret`\u003c/span\u003e or `GoogleServiceAccountKeyJson`. Please consult the [documentation](https://docs.databricks.com/query-federation/index.html#supported-data-sources) for the required option.\n", "secret": true }, "owner": { "type": "string", "description": "Name of the connection owner.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form connection properties. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/ConnectionProviderConfig:ConnectionProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the connection is read-only. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "stateInputs": { "description": "Input properties used for looking up and filtering Connection resources.\n", "properties": { "comment": { "type": "string", "description": "Free-form text. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "connectionId": { "type": "string", "description": "Unique ID of the connection.\n" }, "connectionType": { "type": "string", "description": "Connection type. `MYSQL`, `POSTGRESQL`, `SNOWFLAKE`, `REDSHIFT` `SQLDW`, `SQLSERVER`, `DATABRICKS`, `SALESFORCE`, `BIGQUERY`, `WORKDAY_RAAS`, `HIVE_METASTORE`, `GA4_RAW_DATA`, `SERVICENOW`, `SALESFORCE_DATA_CLOUD`, `GLUE`, `ORACLE`, `TERADATA`, `HTTP` or `POWER_BI` are supported. Up-to-date list of connection type supported is in the [documentation](https://docs.databricks.com/query-federation/index.html#supported-data-sources). Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "createdAt": { "type": "integer", "description": "Time at which this connection was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of connection creator.\n" }, "credentialType": { "type": "string", "description": "The type of credential for this connection.\n" }, "fullName": { "type": "string", "description": "Full name of connection.\n" }, "metastoreId": { "type": "string", "description": "Unique ID of the UC metastore for this connection.\n" }, "name": { "type": "string", "description": "Name of the Connection.\n" }, "options": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The key value of options required by the connection, e.g. \u003cspan pulumi-lang-nodejs=\"`host`\" pulumi-lang-dotnet=\"`Host`\" pulumi-lang-go=\"`host`\" pulumi-lang-python=\"`host`\" pulumi-lang-yaml=\"`host`\" pulumi-lang-java=\"`host`\" pulumi-lang-hcl=\"`host`\"\u003e`host`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`port`\" pulumi-lang-dotnet=\"`Port`\" pulumi-lang-go=\"`port`\" pulumi-lang-python=\"`port`\" pulumi-lang-yaml=\"`port`\" pulumi-lang-java=\"`port`\" pulumi-lang-hcl=\"`port`\"\u003e`port`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`user`\" pulumi-lang-dotnet=\"`User`\" pulumi-lang-go=\"`user`\" pulumi-lang-python=\"`user`\" pulumi-lang-yaml=\"`user`\" pulumi-lang-java=\"`user`\" pulumi-lang-hcl=\"`user`\"\u003e`user`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`password`\" pulumi-lang-dotnet=\"`Password`\" pulumi-lang-go=\"`password`\" pulumi-lang-python=\"`password`\" pulumi-lang-yaml=\"`password`\" pulumi-lang-java=\"`password`\" pulumi-lang-hcl=\"`password`\"\u003e`password`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`authorizationEndpoint`\" pulumi-lang-dotnet=\"`AuthorizationEndpoint`\" pulumi-lang-go=\"`authorizationEndpoint`\" pulumi-lang-python=\"`authorization_endpoint`\" pulumi-lang-yaml=\"`authorizationEndpoint`\" pulumi-lang-java=\"`authorizationEndpoint`\" pulumi-lang-hcl=\"`authorization_endpoint`\"\u003e`authorizationEndpoint`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`clientId`\" pulumi-lang-dotnet=\"`ClientId`\" pulumi-lang-go=\"`clientId`\" pulumi-lang-python=\"`client_id`\" pulumi-lang-yaml=\"`clientId`\" pulumi-lang-java=\"`clientId`\" pulumi-lang-hcl=\"`client_id`\"\u003e`clientId`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`clientSecret`\" pulumi-lang-dotnet=\"`ClientSecret`\" pulumi-lang-go=\"`clientSecret`\" pulumi-lang-python=\"`client_secret`\" pulumi-lang-yaml=\"`clientSecret`\" pulumi-lang-java=\"`clientSecret`\" pulumi-lang-hcl=\"`client_secret`\"\u003e`clientSecret`\u003c/span\u003e or `GoogleServiceAccountKeyJson`. Please consult the [documentation](https://docs.databricks.com/query-federation/index.html#supported-data-sources) for the required option.\n", "secret": true }, "owner": { "type": "string", "description": "Name of the connection owner.\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form connection properties. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/ConnectionProviderConfig:ConnectionProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "provisioningInfos": { "type": "array", "items": { "$ref": "#/types/databricks:index/ConnectionProvisioningInfo:ConnectionProvisioningInfo" }, "description": "Object with the status of an asynchronously provisioned resource.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the connection is read-only. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "securableType": { "type": "string" }, "updatedAt": { "type": "integer", "description": "Time at which connection this was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the connection.\n" }, "url": { "type": "string", "description": "URL of the remote data source, extracted from options.\n" } }, "type": "object" } }, "databricks:index/credential:Credential": { "description": "A credential represents an authentication and authorization mechanism for accessing services on your cloud tenant. Each credential is subject to Unity Catalog access-control policies that control which users and groups can access the credential.\n\n\u003e This resource can only be used with a workspace-level provider!\n\nThe type of credential to be created is determined by the \u003cspan pulumi-lang-nodejs=\"`purpose`\" pulumi-lang-dotnet=\"`Purpose`\" pulumi-lang-go=\"`purpose`\" pulumi-lang-python=\"`purpose`\" pulumi-lang-yaml=\"`purpose`\" pulumi-lang-java=\"`purpose`\" pulumi-lang-hcl=\"`purpose`\"\u003e`purpose`\u003c/span\u003e field, which should be either `SERVICE` or `STORAGE`.\nThe caller must be a metastore admin or have the metastore privilege `CREATE_STORAGE_CREDENTIAL` for storage credentials, or `CREATE_SERVICE_CREDENTIAL` for service credentials. The user who creates the credential can delegate ownership to another user or group to manage permissions on it\n\nOn AWS, the IAM role for a credential requires a trust policy. See [documentation](https://docs.databricks.com/en/connect/unity-catalog/cloud-services/service-credentials.html#step-1-create-an-iam-role) for more details. The data source\u003cspan pulumi-lang-nodejs=\" databricks.getAwsUnityCatalogAssumeRolePolicy \" pulumi-lang-dotnet=\" databricks.getAwsUnityCatalogAssumeRolePolicy \" pulumi-lang-go=\" getAwsUnityCatalogAssumeRolePolicy \" pulumi-lang-python=\" get_aws_unity_catalog_assume_role_policy \" pulumi-lang-yaml=\" databricks.getAwsUnityCatalogAssumeRolePolicy \" pulumi-lang-java=\" databricks.getAwsUnityCatalogAssumeRolePolicy \" pulumi-lang-hcl=\" data.databricks_aws_unity_catalog_assume_role_policy \"\u003e databricks.getAwsUnityCatalogAssumeRolePolicy \u003c/span\u003ecan be used to create the necessary AWS Unity Catalog assume role policy.\n\n## Example Usage\n\nFor AWS\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst external = new databricks.Credential(\"external\", {\n name: externalDataAccess.name,\n awsIamRole: {\n roleArn: externalDataAccess.arn,\n },\n purpose: \"SERVICE\",\n comment: \"Managed by TF\",\n});\nconst externalCreds = new databricks.Grants(\"external_creds\", {\n credential: external.databricksCredentialId,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\"ACCESS\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal = databricks.Credential(\"external\",\n name=external_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": external_data_access[\"arn\"],\n },\n purpose=\"SERVICE\",\n comment=\"Managed by TF\")\nexternal_creds = databricks.Grants(\"external_creds\",\n credential=external.databricks_credential_id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"ACCESS\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.Credential(\"external\", new()\n {\n Name = externalDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.CredentialAwsIamRoleArgs\n {\n RoleArn = externalDataAccess.Arn,\n },\n Purpose = \"SERVICE\",\n Comment = \"Managed by TF\",\n });\n\n var externalCreds = new Databricks.Grants(\"external_creds\", new()\n {\n Credential = external.DatabricksCredentialId,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"ACCESS\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewCredential(ctx, \"external\", \u0026databricks.CredentialArgs{\n\t\t\tName: pulumi.Any(externalDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.CredentialAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(externalDataAccess.Arn),\n\t\t\t},\n\t\t\tPurpose: pulumi.String(\"SERVICE\"),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"external_creds\", \u0026databricks.GrantsArgs{\n\t\t\tCredential: external.DatabricksCredentialId,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"ACCESS\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_credential\" \"external\" {\n name = externalDataAccess.name\n aws_iam_role = {\n role_arn = externalDataAccess.arn\n }\n purpose = \"SERVICE\"\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"external_creds\" {\n credential = databricks_credential.external.databricks_credential_id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"ACCESS\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Credential;\nimport com.pulumi.databricks.CredentialArgs;\nimport com.pulumi.databricks.inputs.CredentialAwsIamRoleArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new Credential(\"external\", CredentialArgs.builder()\n .name(externalDataAccess.name())\n .awsIamRole(CredentialAwsIamRoleArgs.builder()\n .roleArn(externalDataAccess.arn())\n .build())\n .purpose(\"SERVICE\")\n .comment(\"Managed by TF\")\n .build());\n\n var externalCreds = new Grants(\"externalCreds\", GrantsArgs.builder()\n .credential(external.databricksCredentialId())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"ACCESS\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:Credential\n properties:\n name: ${externalDataAccess.name}\n awsIamRole:\n roleArn: ${externalDataAccess.arn}\n purpose: SERVICE\n comment: Managed by TF\n externalCreds:\n type: databricks:Grants\n name: external_creds\n properties:\n credential: ${external.databricksCredentialId}\n grants:\n - principal: Data Engineers\n privileges:\n - ACCESS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor Azure\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst externalMi = new databricks.Credential(\"external_mi\", {\n name: \"mi_credential\",\n azureManagedIdentity: {\n accessConnectorId: example.id,\n },\n purpose: \"SERVICE\",\n comment: \"Managed identity credential managed by TF\",\n});\nconst externalCreds = new databricks.Grants(\"external_creds\", {\n credential: externalMi.databricksCredentialId,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\"ACCESS\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal_mi = databricks.Credential(\"external_mi\",\n name=\"mi_credential\",\n azure_managed_identity={\n \"access_connector_id\": example[\"id\"],\n },\n purpose=\"SERVICE\",\n comment=\"Managed identity credential managed by TF\")\nexternal_creds = databricks.Grants(\"external_creds\",\n credential=external_mi.databricks_credential_id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"ACCESS\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var externalMi = new Databricks.Credential(\"external_mi\", new()\n {\n Name = \"mi_credential\",\n AzureManagedIdentity = new Databricks.Inputs.CredentialAzureManagedIdentityArgs\n {\n AccessConnectorId = example.Id,\n },\n Purpose = \"SERVICE\",\n Comment = \"Managed identity credential managed by TF\",\n });\n\n var externalCreds = new Databricks.Grants(\"external_creds\", new()\n {\n Credential = externalMi.DatabricksCredentialId,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"ACCESS\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternalMi, err := databricks.NewCredential(ctx, \"external_mi\", \u0026databricks.CredentialArgs{\n\t\t\tName: pulumi.String(\"mi_credential\"),\n\t\t\tAzureManagedIdentity: \u0026databricks.CredentialAzureManagedIdentityArgs{\n\t\t\t\tAccessConnectorId: pulumi.Any(example.Id),\n\t\t\t},\n\t\t\tPurpose: pulumi.String(\"SERVICE\"),\n\t\t\tComment: pulumi.String(\"Managed identity credential managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"external_creds\", \u0026databricks.GrantsArgs{\n\t\t\tCredential: externalMi.DatabricksCredentialId,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"ACCESS\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_credential\" \"external_mi\" {\n name = \"mi_credential\"\n azure_managed_identity = {\n access_connector_id = example.id\n }\n purpose = \"SERVICE\"\n comment = \"Managed identity credential managed by TF\"\n}\nresource \"databricks_grants\" \"external_creds\" {\n credential = databricks_credential.external_mi.databricks_credential_id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"ACCESS\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Credential;\nimport com.pulumi.databricks.CredentialArgs;\nimport com.pulumi.databricks.inputs.CredentialAzureManagedIdentityArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var externalMi = new Credential(\"externalMi\", CredentialArgs.builder()\n .name(\"mi_credential\")\n .azureManagedIdentity(CredentialAzureManagedIdentityArgs.builder()\n .accessConnectorId(example.id())\n .build())\n .purpose(\"SERVICE\")\n .comment(\"Managed identity credential managed by TF\")\n .build());\n\n var externalCreds = new Grants(\"externalCreds\", GrantsArgs.builder()\n .credential(externalMi.databricksCredentialId())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"ACCESS\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n externalMi:\n type: databricks:Credential\n name: external_mi\n properties:\n name: mi_credential\n azureManagedIdentity:\n accessConnectorId: ${example.id}\n purpose: SERVICE\n comment: Managed identity credential managed by TF\n externalCreds:\n type: databricks:Grants\n name: external_creds\n properties:\n credential: ${externalMi.databricksCredentialId}\n grants:\n - principal: Data Engineers\n privileges:\n - ACCESS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor GCP \n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst externalGcpSa = new databricks.Credential(\"external_gcp_sa\", {\n name: \"gcp_sa_credential\",\n databricksGcpServiceAccount: {},\n purpose: \"SERVICE\",\n comment: \"GCP SA credential managed by TF\",\n});\nconst externalCreds = new databricks.Grants(\"external_creds\", {\n credential: externalGcpSa.databricksCredentialId,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\"ACCESS\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal_gcp_sa = databricks.Credential(\"external_gcp_sa\",\n name=\"gcp_sa_credential\",\n databricks_gcp_service_account={},\n purpose=\"SERVICE\",\n comment=\"GCP SA credential managed by TF\")\nexternal_creds = databricks.Grants(\"external_creds\",\n credential=external_gcp_sa.databricks_credential_id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"ACCESS\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var externalGcpSa = new Databricks.Credential(\"external_gcp_sa\", new()\n {\n Name = \"gcp_sa_credential\",\n DatabricksGcpServiceAccount = null,\n Purpose = \"SERVICE\",\n Comment = \"GCP SA credential managed by TF\",\n });\n\n var externalCreds = new Databricks.Grants(\"external_creds\", new()\n {\n Credential = externalGcpSa.DatabricksCredentialId,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"ACCESS\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternalGcpSa, err := databricks.NewCredential(ctx, \"external_gcp_sa\", \u0026databricks.CredentialArgs{\n\t\t\tName: pulumi.String(\"gcp_sa_credential\"),\n\t\t\tDatabricksGcpServiceAccount: \u0026databricks.CredentialDatabricksGcpServiceAccountArgs{},\n\t\t\tPurpose: pulumi.String(\"SERVICE\"),\n\t\t\tComment: pulumi.String(\"GCP SA credential managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"external_creds\", \u0026databricks.GrantsArgs{\n\t\t\tCredential: externalGcpSa.DatabricksCredentialId,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"ACCESS\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_credential\" \"external_gcp_sa\" {\n name = \"gcp_sa_credential\"\n databricks_gcp_service_account = {}\n purpose = \"SERVICE\"\n comment = \"GCP SA credential managed by TF\"\n}\nresource \"databricks_grants\" \"external_creds\" {\n credential = databricks_credential.external_gcp_sa.databricks_credential_id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"ACCESS\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Credential;\nimport com.pulumi.databricks.CredentialArgs;\nimport com.pulumi.databricks.inputs.CredentialDatabricksGcpServiceAccountArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var externalGcpSa = new Credential(\"externalGcpSa\", CredentialArgs.builder()\n .name(\"gcp_sa_credential\")\n .databricksGcpServiceAccount(CredentialDatabricksGcpServiceAccountArgs.builder()\n .build())\n .purpose(\"SERVICE\")\n .comment(\"GCP SA credential managed by TF\")\n .build());\n\n var externalCreds = new Grants(\"externalCreds\", GrantsArgs.builder()\n .credential(externalGcpSa.databricksCredentialId())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"ACCESS\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n externalGcpSa:\n type: databricks:Credential\n name: external_gcp_sa\n properties:\n name: gcp_sa_credential\n databricksGcpServiceAccount: {}\n purpose: SERVICE\n comment: GCP SA credential managed by TF\n externalCreds:\n type: databricks:Grants\n name: external_creds\n properties:\n credential: ${externalGcpSa.databricksCredentialId}\n grants:\n - principal: Data Engineers\n privileges:\n - ACCESS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "awsIamRole": { "$ref": "#/types/databricks:index/CredentialAwsIamRole:CredentialAwsIamRole" }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/CredentialAzureManagedIdentity:CredentialAzureManagedIdentity" }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/CredentialAzureServicePrincipal:CredentialAzureServicePrincipal" }, "comment": { "type": "string" }, "createdAt": { "type": "integer" }, "createdBy": { "type": "string" }, "credentialId": { "type": "string", "description": "Unique ID of the credential.\n" }, "databricksCredentialId": { "type": "string", "description": "ID of this credential - same as the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e.\n" }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/CredentialDatabricksGcpServiceAccount:CredentialDatabricksGcpServiceAccount" }, "forceDestroy": { "type": "boolean", "description": "Delete credential regardless of its dependencies.\n" }, "forceUpdate": { "type": "boolean", "description": "Update credential regardless of its dependents.\n" }, "fullName": { "type": "string" }, "isolationMode": { "type": "string", "description": "Whether the credential is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the credential to `ISOLATION_MODE_ISOLATED` will automatically restrict access to only from the current workspace.\n\n\u003cspan pulumi-lang-nodejs=\"`awsIamRole`\" pulumi-lang-dotnet=\"`AwsIamRole`\" pulumi-lang-go=\"`awsIamRole`\" pulumi-lang-python=\"`aws_iam_role`\" pulumi-lang-yaml=\"`awsIamRole`\" pulumi-lang-java=\"`awsIamRole`\" pulumi-lang-hcl=\"`aws_iam_role`\"\u003e`awsIamRole`\u003c/span\u003e optional configuration block for credential details for AWS:\n" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Name of Credentials, which must be unique within the databricks_metastore. Change of the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e forces creation of a new resource.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the credential owner.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/CredentialProviderConfig:CredentialProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "purpose": { "type": "string", "description": "Indicates the purpose of the credential. Can be `SERVICE` or `STORAGE`.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the credential is only usable for read operations. Only applicable when purpose is `STORAGE`.\n" }, "skipValidation": { "type": "boolean", "description": "Suppress validation errors if any \u0026 force save the credential.\n" }, "updatedAt": { "type": "integer" }, "updatedBy": { "type": "string" }, "usedForManagedStorage": { "type": "boolean" } }, "required": [ "createdAt", "createdBy", "credentialId", "databricksGcpServiceAccount", "fullName", "databricksCredentialId", "isolationMode", "metastoreId", "name", "owner", "providerConfig", "purpose", "updatedAt", "updatedBy", "usedForManagedStorage" ], "inputProperties": { "awsIamRole": { "$ref": "#/types/databricks:index/CredentialAwsIamRole:CredentialAwsIamRole" }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/CredentialAzureManagedIdentity:CredentialAzureManagedIdentity" }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/CredentialAzureServicePrincipal:CredentialAzureServicePrincipal" }, "comment": { "type": "string" }, "createdAt": { "type": "integer" }, "createdBy": { "type": "string" }, "databricksCredentialId": { "type": "string", "description": "ID of this credential - same as the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e.\n" }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/CredentialDatabricksGcpServiceAccount:CredentialDatabricksGcpServiceAccount" }, "forceDestroy": { "type": "boolean", "description": "Delete credential regardless of its dependencies.\n" }, "forceUpdate": { "type": "boolean", "description": "Update credential regardless of its dependents.\n" }, "fullName": { "type": "string" }, "isolationMode": { "type": "string", "description": "Whether the credential is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the credential to `ISOLATION_MODE_ISOLATED` will automatically restrict access to only from the current workspace.\n\n\u003cspan pulumi-lang-nodejs=\"`awsIamRole`\" pulumi-lang-dotnet=\"`AwsIamRole`\" pulumi-lang-go=\"`awsIamRole`\" pulumi-lang-python=\"`aws_iam_role`\" pulumi-lang-yaml=\"`awsIamRole`\" pulumi-lang-java=\"`awsIamRole`\" pulumi-lang-hcl=\"`aws_iam_role`\"\u003e`awsIamRole`\u003c/span\u003e optional configuration block for credential details for AWS:\n" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Name of Credentials, which must be unique within the databricks_metastore. Change of the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e forces creation of a new resource.\n", "willReplaceOnChanges": true }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the credential owner.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/CredentialProviderConfig:CredentialProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "purpose": { "type": "string", "description": "Indicates the purpose of the credential. Can be `SERVICE` or `STORAGE`.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the credential is only usable for read operations. Only applicable when purpose is `STORAGE`.\n" }, "skipValidation": { "type": "boolean", "description": "Suppress validation errors if any \u0026 force save the credential.\n" }, "updatedAt": { "type": "integer" }, "updatedBy": { "type": "string" }, "usedForManagedStorage": { "type": "boolean" } }, "requiredInputs": [ "purpose" ], "stateInputs": { "description": "Input properties used for looking up and filtering Credential resources.\n", "properties": { "awsIamRole": { "$ref": "#/types/databricks:index/CredentialAwsIamRole:CredentialAwsIamRole" }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/CredentialAzureManagedIdentity:CredentialAzureManagedIdentity" }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/CredentialAzureServicePrincipal:CredentialAzureServicePrincipal" }, "comment": { "type": "string" }, "createdAt": { "type": "integer" }, "createdBy": { "type": "string" }, "credentialId": { "type": "string", "description": "Unique ID of the credential.\n" }, "databricksCredentialId": { "type": "string", "description": "ID of this credential - same as the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e.\n" }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/CredentialDatabricksGcpServiceAccount:CredentialDatabricksGcpServiceAccount" }, "forceDestroy": { "type": "boolean", "description": "Delete credential regardless of its dependencies.\n" }, "forceUpdate": { "type": "boolean", "description": "Update credential regardless of its dependents.\n" }, "fullName": { "type": "string" }, "isolationMode": { "type": "string", "description": "Whether the credential is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the credential to `ISOLATION_MODE_ISOLATED` will automatically restrict access to only from the current workspace.\n\n\u003cspan pulumi-lang-nodejs=\"`awsIamRole`\" pulumi-lang-dotnet=\"`AwsIamRole`\" pulumi-lang-go=\"`awsIamRole`\" pulumi-lang-python=\"`aws_iam_role`\" pulumi-lang-yaml=\"`awsIamRole`\" pulumi-lang-java=\"`awsIamRole`\" pulumi-lang-hcl=\"`aws_iam_role`\"\u003e`awsIamRole`\u003c/span\u003e optional configuration block for credential details for AWS:\n" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Name of Credentials, which must be unique within the databricks_metastore. Change of the \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e forces creation of a new resource.\n", "willReplaceOnChanges": true }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the credential owner.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/CredentialProviderConfig:CredentialProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "purpose": { "type": "string", "description": "Indicates the purpose of the credential. Can be `SERVICE` or `STORAGE`.\n" }, "readOnly": { "type": "boolean", "description": "Indicates whether the credential is only usable for read operations. Only applicable when purpose is `STORAGE`.\n" }, "skipValidation": { "type": "boolean", "description": "Suppress validation errors if any \u0026 force save the credential.\n" }, "updatedAt": { "type": "integer" }, "updatedBy": { "type": "string" }, "usedForManagedStorage": { "type": "boolean" } }, "type": "object" } }, "databricks:index/customAppIntegration:CustomAppIntegration": { "description": "This resource allows you to enable [custom OAuth applications](https://docs.databricks.com/en/integrations/enable-disable-oauth.html#enable-custom-oauth-applications-using-the-databricks-ui).\n\n\u003e This resource can only be used with an account-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.CustomAppIntegration(\"this\", {\n name: \"custom_integration_name\",\n redirectUrls: [\"https://example.com\"],\n scopes: [\"all-apis\"],\n tokenAccessPolicy: {\n accessTokenTtlInMinutes: 15,\n refreshTokenTtlInMinutes: 30,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.CustomAppIntegration(\"this\",\n name=\"custom_integration_name\",\n redirect_urls=[\"https://example.com\"],\n scopes=[\"all-apis\"],\n token_access_policy={\n \"access_token_ttl_in_minutes\": 15,\n \"refresh_token_ttl_in_minutes\": 30,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.CustomAppIntegration(\"this\", new()\n {\n Name = \"custom_integration_name\",\n RedirectUrls = new[]\n {\n \"https://example.com\",\n },\n Scopes = new[]\n {\n \"all-apis\",\n },\n TokenAccessPolicy = new Databricks.Inputs.CustomAppIntegrationTokenAccessPolicyArgs\n {\n AccessTokenTtlInMinutes = 15,\n RefreshTokenTtlInMinutes = 30,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewCustomAppIntegration(ctx, \"this\", \u0026databricks.CustomAppIntegrationArgs{\n\t\t\tName: pulumi.String(\"custom_integration_name\"),\n\t\t\tRedirectUrls: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"https://example.com\"),\n\t\t\t},\n\t\t\tScopes: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"all-apis\"),\n\t\t\t},\n\t\t\tTokenAccessPolicy: \u0026databricks.CustomAppIntegrationTokenAccessPolicyArgs{\n\t\t\t\tAccessTokenTtlInMinutes: pulumi.Int(15),\n\t\t\t\tRefreshTokenTtlInMinutes: pulumi.Int(30),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_customappintegration\" \"this\" {\n name = \"custom_integration_name\"\n redirect_urls = [\"https://example.com\"]\n scopes = [\"all-apis\"]\n token_access_policy = {\n access_token_ttl_in_minutes = 15\n refresh_token_ttl_in_minutes = 30\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.CustomAppIntegration;\nimport com.pulumi.databricks.CustomAppIntegrationArgs;\nimport com.pulumi.databricks.inputs.CustomAppIntegrationTokenAccessPolicyArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new CustomAppIntegration(\"this\", CustomAppIntegrationArgs.builder()\n .name(\"custom_integration_name\")\n .redirectUrls(\"https://example.com\")\n .scopes(\"all-apis\")\n .tokenAccessPolicy(CustomAppIntegrationTokenAccessPolicyArgs.builder()\n .accessTokenTtlInMinutes(15)\n .refreshTokenTtlInMinutes(30)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:CustomAppIntegration\n properties:\n name: custom_integration_name\n redirectUrls:\n - https://example.com\n scopes:\n - all-apis\n tokenAccessPolicy:\n accessTokenTtlInMinutes: 15\n refreshTokenTtlInMinutes: 30\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up Databricks workspaces.\n\n", "properties": { "clientId": { "type": "string", "description": "OAuth client-id generated by Databricks\n" }, "clientSecret": { "type": "string", "description": "OAuth client-secret generated by the Databricks if this is a confidential OAuth app.\n", "secret": true }, "confidential": { "type": "boolean", "description": "Indicates whether an OAuth client secret is required to authenticate this client. Default to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e. Change requires a new resource.\n" }, "createTime": { "type": "string" }, "createdBy": { "type": "integer" }, "creatorUsername": { "type": "string" }, "integrationId": { "type": "string", "description": "Unique integration id for the custom OAuth app.\n" }, "name": { "type": "string", "description": "Name of the custom OAuth app. Change requires a new resource.\n" }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "description": "List of OAuth redirect urls.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "OAuth scopes granted to the application. Supported scopes: `all-apis`, \u003cspan pulumi-lang-nodejs=\"`sql`\" pulumi-lang-dotnet=\"`Sql`\" pulumi-lang-go=\"`sql`\" pulumi-lang-python=\"`sql`\" pulumi-lang-yaml=\"`sql`\" pulumi-lang-java=\"`sql`\" pulumi-lang-hcl=\"`sql`\"\u003e`sql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`offlineAccess`\" pulumi-lang-dotnet=\"`OfflineAccess`\" pulumi-lang-go=\"`offlineAccess`\" pulumi-lang-python=\"`offline_access`\" pulumi-lang-yaml=\"`offlineAccess`\" pulumi-lang-java=\"`offlineAccess`\" pulumi-lang-hcl=\"`offline_access`\"\u003e`offlineAccess`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`openid`\" pulumi-lang-dotnet=\"`Openid`\" pulumi-lang-go=\"`openid`\" pulumi-lang-python=\"`openid`\" pulumi-lang-yaml=\"`openid`\" pulumi-lang-java=\"`openid`\" pulumi-lang-hcl=\"`openid`\"\u003e`openid`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`profile`\" pulumi-lang-dotnet=\"`Profile`\" pulumi-lang-go=\"`profile`\" pulumi-lang-python=\"`profile`\" pulumi-lang-yaml=\"`profile`\" pulumi-lang-java=\"`profile`\" pulumi-lang-hcl=\"`profile`\"\u003e`profile`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`email`\" pulumi-lang-dotnet=\"`Email`\" pulumi-lang-go=\"`email`\" pulumi-lang-python=\"`email`\" pulumi-lang-yaml=\"`email`\" pulumi-lang-java=\"`email`\" pulumi-lang-hcl=\"`email`\"\u003e`email`\u003c/span\u003e.\n" }, "tokenAccessPolicy": { "$ref": "#/types/databricks:index/CustomAppIntegrationTokenAccessPolicy:CustomAppIntegrationTokenAccessPolicy" }, "userAuthorizedScopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "clientId", "clientSecret", "createTime", "createdBy", "creatorUsername", "integrationId", "name" ], "inputProperties": { "clientId": { "type": "string", "description": "OAuth client-id generated by Databricks\n" }, "clientSecret": { "type": "string", "description": "OAuth client-secret generated by the Databricks if this is a confidential OAuth app.\n", "secret": true }, "confidential": { "type": "boolean", "description": "Indicates whether an OAuth client secret is required to authenticate this client. Default to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e. Change requires a new resource.\n", "willReplaceOnChanges": true }, "createTime": { "type": "string" }, "createdBy": { "type": "integer" }, "creatorUsername": { "type": "string" }, "integrationId": { "type": "string", "description": "Unique integration id for the custom OAuth app.\n" }, "name": { "type": "string", "description": "Name of the custom OAuth app. Change requires a new resource.\n", "willReplaceOnChanges": true }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "description": "List of OAuth redirect urls.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "OAuth scopes granted to the application. Supported scopes: `all-apis`, \u003cspan pulumi-lang-nodejs=\"`sql`\" pulumi-lang-dotnet=\"`Sql`\" pulumi-lang-go=\"`sql`\" pulumi-lang-python=\"`sql`\" pulumi-lang-yaml=\"`sql`\" pulumi-lang-java=\"`sql`\" pulumi-lang-hcl=\"`sql`\"\u003e`sql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`offlineAccess`\" pulumi-lang-dotnet=\"`OfflineAccess`\" pulumi-lang-go=\"`offlineAccess`\" pulumi-lang-python=\"`offline_access`\" pulumi-lang-yaml=\"`offlineAccess`\" pulumi-lang-java=\"`offlineAccess`\" pulumi-lang-hcl=\"`offline_access`\"\u003e`offlineAccess`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`openid`\" pulumi-lang-dotnet=\"`Openid`\" pulumi-lang-go=\"`openid`\" pulumi-lang-python=\"`openid`\" pulumi-lang-yaml=\"`openid`\" pulumi-lang-java=\"`openid`\" pulumi-lang-hcl=\"`openid`\"\u003e`openid`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`profile`\" pulumi-lang-dotnet=\"`Profile`\" pulumi-lang-go=\"`profile`\" pulumi-lang-python=\"`profile`\" pulumi-lang-yaml=\"`profile`\" pulumi-lang-java=\"`profile`\" pulumi-lang-hcl=\"`profile`\"\u003e`profile`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`email`\" pulumi-lang-dotnet=\"`Email`\" pulumi-lang-go=\"`email`\" pulumi-lang-python=\"`email`\" pulumi-lang-yaml=\"`email`\" pulumi-lang-java=\"`email`\" pulumi-lang-hcl=\"`email`\"\u003e`email`\u003c/span\u003e.\n" }, "tokenAccessPolicy": { "$ref": "#/types/databricks:index/CustomAppIntegrationTokenAccessPolicy:CustomAppIntegrationTokenAccessPolicy" }, "userAuthorizedScopes": { "type": "array", "items": { "type": "string" } } }, "stateInputs": { "description": "Input properties used for looking up and filtering CustomAppIntegration resources.\n", "properties": { "clientId": { "type": "string", "description": "OAuth client-id generated by Databricks\n" }, "clientSecret": { "type": "string", "description": "OAuth client-secret generated by the Databricks if this is a confidential OAuth app.\n", "secret": true }, "confidential": { "type": "boolean", "description": "Indicates whether an OAuth client secret is required to authenticate this client. Default to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e. Change requires a new resource.\n", "willReplaceOnChanges": true }, "createTime": { "type": "string" }, "createdBy": { "type": "integer" }, "creatorUsername": { "type": "string" }, "integrationId": { "type": "string", "description": "Unique integration id for the custom OAuth app.\n" }, "name": { "type": "string", "description": "Name of the custom OAuth app. Change requires a new resource.\n", "willReplaceOnChanges": true }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "description": "List of OAuth redirect urls.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "OAuth scopes granted to the application. Supported scopes: `all-apis`, \u003cspan pulumi-lang-nodejs=\"`sql`\" pulumi-lang-dotnet=\"`Sql`\" pulumi-lang-go=\"`sql`\" pulumi-lang-python=\"`sql`\" pulumi-lang-yaml=\"`sql`\" pulumi-lang-java=\"`sql`\" pulumi-lang-hcl=\"`sql`\"\u003e`sql`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`offlineAccess`\" pulumi-lang-dotnet=\"`OfflineAccess`\" pulumi-lang-go=\"`offlineAccess`\" pulumi-lang-python=\"`offline_access`\" pulumi-lang-yaml=\"`offlineAccess`\" pulumi-lang-java=\"`offlineAccess`\" pulumi-lang-hcl=\"`offline_access`\"\u003e`offlineAccess`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`openid`\" pulumi-lang-dotnet=\"`Openid`\" pulumi-lang-go=\"`openid`\" pulumi-lang-python=\"`openid`\" pulumi-lang-yaml=\"`openid`\" pulumi-lang-java=\"`openid`\" pulumi-lang-hcl=\"`openid`\"\u003e`openid`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`profile`\" pulumi-lang-dotnet=\"`Profile`\" pulumi-lang-go=\"`profile`\" pulumi-lang-python=\"`profile`\" pulumi-lang-yaml=\"`profile`\" pulumi-lang-java=\"`profile`\" pulumi-lang-hcl=\"`profile`\"\u003e`profile`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`email`\" pulumi-lang-dotnet=\"`Email`\" pulumi-lang-go=\"`email`\" pulumi-lang-python=\"`email`\" pulumi-lang-yaml=\"`email`\" pulumi-lang-java=\"`email`\" pulumi-lang-hcl=\"`email`\"\u003e`email`\u003c/span\u003e.\n" }, "tokenAccessPolicy": { "$ref": "#/types/databricks:index/CustomAppIntegrationTokenAccessPolicy:CustomAppIntegrationTokenAccessPolicy" }, "userAuthorizedScopes": { "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "databricks:index/dashboard:Dashboard": { "description": "This resource allows you to manage Databricks [Dashboards](https://docs.databricks.com/en/dashboards/index.html). To manage [Dashboards](https://docs.databricks.com/en/dashboards/index.html) you must have a warehouse access on your databricks workspace.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\nDashboard using \u003cspan pulumi-lang-nodejs=\"`serializedDashboard`\" pulumi-lang-dotnet=\"`SerializedDashboard`\" pulumi-lang-go=\"`serializedDashboard`\" pulumi-lang-python=\"`serialized_dashboard`\" pulumi-lang-yaml=\"`serializedDashboard`\" pulumi-lang-java=\"`serializedDashboard`\" pulumi-lang-hcl=\"`serialized_dashboard`\"\u003e`serializedDashboard`\u003c/span\u003e attribute:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst starter = databricks.getSqlWarehouse({\n name: \"Starter Warehouse\",\n});\nconst dashboard = new databricks.Dashboard(\"dashboard\", {\n displayName: \"New Dashboard\",\n warehouseId: starter.then(starter =\u003e starter.id),\n serializedDashboard: \"{\\\"pages\\\":[{\\\"name\\\":\\\"new_name\\\",\\\"displayName\\\":\\\"New Page\\\"}]}\",\n embedCredentials: false,\n parentPath: \"/Shared/provider-test\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nstarter = databricks.get_sql_warehouse(name=\"Starter Warehouse\")\ndashboard = databricks.Dashboard(\"dashboard\",\n display_name=\"New Dashboard\",\n warehouse_id=starter.id,\n serialized_dashboard=\"{\\\"pages\\\":[{\\\"name\\\":\\\"new_name\\\",\\\"displayName\\\":\\\"New Page\\\"}]}\",\n embed_credentials=False,\n parent_path=\"/Shared/provider-test\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var starter = Databricks.GetSqlWarehouse.Invoke(new()\n {\n Name = \"Starter Warehouse\",\n });\n\n var dashboard = new Databricks.Dashboard(\"dashboard\", new()\n {\n DisplayName = \"New Dashboard\",\n WarehouseId = starter.Apply(getSqlWarehouseResult =\u003e getSqlWarehouseResult.Id),\n SerializedDashboard = \"{\\\"pages\\\":[{\\\"name\\\":\\\"new_name\\\",\\\"displayName\\\":\\\"New Page\\\"}]}\",\n EmbedCredentials = false,\n ParentPath = \"/Shared/provider-test\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tstarter, err := databricks.GetSqlWarehouse(ctx, \u0026databricks.GetSqlWarehouseArgs{\n\t\t\tName: pulumi.StringRef(\"Starter Warehouse\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewDashboard(ctx, \"dashboard\", \u0026databricks.DashboardArgs{\n\t\t\tDisplayName: pulumi.String(\"New Dashboard\"),\n\t\t\tWarehouseId: pulumi.String(pulumi.String(starter.Id)),\n\t\t\tSerializedDashboard: pulumi.String(\"{\\\"pages\\\":[{\\\"name\\\":\\\"new_name\\\",\\\"displayName\\\":\\\"New Page\\\"}]}\"),\n\t\t\tEmbedCredentials: pulumi.Bool(false),\n\t\t\tParentPath: pulumi.String(\"/Shared/provider-test\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getsqlwarehouse\" \"starter\" {\n name = \"Starter Warehouse\"\n}\n\nresource \"databricks_dashboard\" \"dashboard\" {\n display_name = \"New Dashboard\"\n warehouse_id = data.databricks_getsqlwarehouse.starter.id\n serialized_dashboard = \"{\\\"pages\\\":[{\\\"name\\\":\\\"new_name\\\",\\\"displayName\\\":\\\"New Page\\\"}]}\"\n embed_credentials = false // Optional\n parent_path = \"/Shared/provider-test\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetSqlWarehouseArgs;\nimport com.pulumi.databricks.Dashboard;\nimport com.pulumi.databricks.DashboardArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var starter = DatabricksFunctions.getSqlWarehouse(GetSqlWarehouseArgs.builder()\n .name(\"Starter Warehouse\")\n .build());\n\n var dashboard = new Dashboard(\"dashboard\", DashboardArgs.builder()\n .displayName(\"New Dashboard\")\n .warehouseId(starter.id())\n .serializedDashboard(\"{\\\"pages\\\":[{\\\"name\\\":\\\"new_name\\\",\\\"displayName\\\":\\\"New Page\\\"}]}\")\n .embedCredentials(false)\n .parentPath(\"/Shared/provider-test\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n dashboard:\n type: databricks:Dashboard\n properties:\n displayName: New Dashboard\n warehouseId: ${starter.id}\n serializedDashboard: '{\"pages\":[{\"name\":\"new_name\",\"displayName\":\"New Page\"}]}'\n embedCredentials: false # Optional\n parentPath: /Shared/provider-test\nvariables:\n starter:\n fn::invoke:\n function: databricks:getSqlWarehouse\n arguments:\n name: Starter Warehouse\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nDashboard using \u003cspan pulumi-lang-nodejs=\"`filePath`\" pulumi-lang-dotnet=\"`FilePath`\" pulumi-lang-go=\"`filePath`\" pulumi-lang-python=\"`file_path`\" pulumi-lang-yaml=\"`filePath`\" pulumi-lang-java=\"`filePath`\" pulumi-lang-hcl=\"`file_path`\"\u003e`filePath`\u003c/span\u003e attribute:\n\n", "properties": { "createTime": { "type": "string" }, "dashboardChangeDetected": { "type": "boolean" }, "dashboardId": { "type": "string" }, "datasetCatalog": { "type": "string", "description": "Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\n" }, "datasetSchema": { "type": "string", "description": "Sets the default schema for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\n" }, "displayName": { "type": "string", "description": "The display name of the dashboard.\n" }, "embedCredentials": { "type": "boolean", "description": "Whether to embed credentials in the dashboard. Default is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e.\n" }, "etag": { "type": "string" }, "filePath": { "type": "string", "description": "The path to the dashboard JSON file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`serializedDashboard`\" pulumi-lang-dotnet=\"`SerializedDashboard`\" pulumi-lang-go=\"`serializedDashboard`\" pulumi-lang-python=\"`serialized_dashboard`\" pulumi-lang-yaml=\"`serializedDashboard`\" pulumi-lang-java=\"`serializedDashboard`\" pulumi-lang-hcl=\"`serialized_dashboard`\"\u003e`serializedDashboard`\u003c/span\u003e.\n" }, "lifecycleState": { "type": "string" }, "md5": { "type": "string" }, "parentPath": { "type": "string", "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. If folder doesn't exist, it will be created.\n" }, "path": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DashboardProviderConfig:DashboardProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "serializedDashboard": { "type": "string", "description": "The contents of the dashboard in serialized string form. Conflicts with \u003cspan pulumi-lang-nodejs=\"`filePath`\" pulumi-lang-dotnet=\"`FilePath`\" pulumi-lang-go=\"`filePath`\" pulumi-lang-python=\"`file_path`\" pulumi-lang-yaml=\"`filePath`\" pulumi-lang-java=\"`filePath`\" pulumi-lang-hcl=\"`file_path`\"\u003e`filePath`\u003c/span\u003e.\n" }, "updateTime": { "type": "string" }, "warehouseId": { "type": "string", "description": "The warehouse ID used to run the dashboard.\n" } }, "required": [ "createTime", "dashboardId", "displayName", "lifecycleState", "md5", "parentPath", "path", "providerConfig", "updateTime", "warehouseId" ], "inputProperties": { "createTime": { "type": "string" }, "dashboardChangeDetected": { "type": "boolean" }, "dashboardId": { "type": "string" }, "datasetCatalog": { "type": "string", "description": "Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\n" }, "datasetSchema": { "type": "string", "description": "Sets the default schema for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\n" }, "displayName": { "type": "string", "description": "The display name of the dashboard.\n" }, "embedCredentials": { "type": "boolean", "description": "Whether to embed credentials in the dashboard. Default is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e.\n" }, "etag": { "type": "string" }, "filePath": { "type": "string", "description": "The path to the dashboard JSON file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`serializedDashboard`\" pulumi-lang-dotnet=\"`SerializedDashboard`\" pulumi-lang-go=\"`serializedDashboard`\" pulumi-lang-python=\"`serialized_dashboard`\" pulumi-lang-yaml=\"`serializedDashboard`\" pulumi-lang-java=\"`serializedDashboard`\" pulumi-lang-hcl=\"`serialized_dashboard`\"\u003e`serializedDashboard`\u003c/span\u003e.\n" }, "lifecycleState": { "type": "string" }, "md5": { "type": "string" }, "parentPath": { "type": "string", "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. If folder doesn't exist, it will be created.\n", "willReplaceOnChanges": true }, "path": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DashboardProviderConfig:DashboardProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "serializedDashboard": { "type": "string", "description": "The contents of the dashboard in serialized string form. Conflicts with \u003cspan pulumi-lang-nodejs=\"`filePath`\" pulumi-lang-dotnet=\"`FilePath`\" pulumi-lang-go=\"`filePath`\" pulumi-lang-python=\"`file_path`\" pulumi-lang-yaml=\"`filePath`\" pulumi-lang-java=\"`filePath`\" pulumi-lang-hcl=\"`file_path`\"\u003e`filePath`\u003c/span\u003e.\n" }, "updateTime": { "type": "string" }, "warehouseId": { "type": "string", "description": "The warehouse ID used to run the dashboard.\n" } }, "requiredInputs": [ "displayName", "parentPath", "warehouseId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Dashboard resources.\n", "properties": { "createTime": { "type": "string" }, "dashboardChangeDetected": { "type": "boolean" }, "dashboardId": { "type": "string" }, "datasetCatalog": { "type": "string", "description": "Sets the default catalog for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\n" }, "datasetSchema": { "type": "string", "description": "Sets the default schema for all datasets in this dashboard. Does not impact table references that use fully qualified catalog names (ex: samples.nyctaxi.trips).\n" }, "displayName": { "type": "string", "description": "The display name of the dashboard.\n" }, "embedCredentials": { "type": "boolean", "description": "Whether to embed credentials in the dashboard. Default is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e.\n" }, "etag": { "type": "string" }, "filePath": { "type": "string", "description": "The path to the dashboard JSON file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`serializedDashboard`\" pulumi-lang-dotnet=\"`SerializedDashboard`\" pulumi-lang-go=\"`serializedDashboard`\" pulumi-lang-python=\"`serialized_dashboard`\" pulumi-lang-yaml=\"`serializedDashboard`\" pulumi-lang-java=\"`serializedDashboard`\" pulumi-lang-hcl=\"`serialized_dashboard`\"\u003e`serializedDashboard`\u003c/span\u003e.\n" }, "lifecycleState": { "type": "string" }, "md5": { "type": "string" }, "parentPath": { "type": "string", "description": "The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. If folder doesn't exist, it will be created.\n", "willReplaceOnChanges": true }, "path": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DashboardProviderConfig:DashboardProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "serializedDashboard": { "type": "string", "description": "The contents of the dashboard in serialized string form. Conflicts with \u003cspan pulumi-lang-nodejs=\"`filePath`\" pulumi-lang-dotnet=\"`FilePath`\" pulumi-lang-go=\"`filePath`\" pulumi-lang-python=\"`file_path`\" pulumi-lang-yaml=\"`filePath`\" pulumi-lang-java=\"`filePath`\" pulumi-lang-hcl=\"`file_path`\"\u003e`filePath`\u003c/span\u003e.\n" }, "updateTime": { "type": "string" }, "warehouseId": { "type": "string", "description": "The warehouse ID used to run the dashboard.\n" } }, "type": "object" } }, "databricks:index/dataClassificationCatalogConfig:DataClassificationCatalogConfig": { "description": "[![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/dataclassification)\n\nThis resource allows you to manage the Data Classification configuration for Unity Catalog catalogs.\n\nData Classification automatically identifies and tags sensitive data (personally identifiable information, or PII) in Unity Catalog tables. Creating this resource enables Data Classification for the specified catalog, while deleting it disables Data Classification.\n\nTo manage Data Classification configuration, you must either:\n1. be an owner of the catalog, OR\n2. have **USE_CATALOG** and **MANAGE** permissions on the catalog\n\n\u003e **Note** This resource can only be used with a workspace-level provider.\n\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\n// Enable Data Classification for a set of schemas in a catalog\nconst example = new databricks.DataClassificationCatalogConfig(\"example\", {\n name: \"catalogs/prod_catalog/config\",\n includedSchemas: {\n names: [\n \"sales\",\n \"marketing\",\n \"customer_data\",\n ],\n },\n autoTagConfigs: [\n {\n classificationTag: \"class.credit_card\",\n autoTaggingMode: \"AUTO_TAGGING_ENABLED\",\n },\n {\n classificationTag: \"class.email\",\n autoTaggingMode: \"AUTO_TAGGING_ENABLED\",\n },\n ],\n});\n// Enable Data Classification for the entire catalog (all current and future schemas)\nconst allSchemas = new databricks.DataClassificationCatalogConfig(\"all_schemas\", {name: \"catalogs/staging_catalog/config\"});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\n# Enable Data Classification for a set of schemas in a catalog\nexample = databricks.DataClassificationCatalogConfig(\"example\",\n name=\"catalogs/prod_catalog/config\",\n included_schemas={\n \"names\": [\n \"sales\",\n \"marketing\",\n \"customer_data\",\n ],\n },\n auto_tag_configs=[\n {\n \"classification_tag\": \"class.credit_card\",\n \"auto_tagging_mode\": \"AUTO_TAGGING_ENABLED\",\n },\n {\n \"classification_tag\": \"class.email\",\n \"auto_tagging_mode\": \"AUTO_TAGGING_ENABLED\",\n },\n ])\n# Enable Data Classification for the entire catalog (all current and future schemas)\nall_schemas = databricks.DataClassificationCatalogConfig(\"all_schemas\", name=\"catalogs/staging_catalog/config\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n // Enable Data Classification for a set of schemas in a catalog\n var example = new Databricks.DataClassificationCatalogConfig(\"example\", new()\n {\n Name = \"catalogs/prod_catalog/config\",\n IncludedSchemas = new Databricks.Inputs.DataClassificationCatalogConfigIncludedSchemasArgs\n {\n Names = new[]\n {\n \"sales\",\n \"marketing\",\n \"customer_data\",\n },\n },\n AutoTagConfigs = new[]\n {\n new Databricks.Inputs.DataClassificationCatalogConfigAutoTagConfigArgs\n {\n ClassificationTag = \"class.credit_card\",\n AutoTaggingMode = \"AUTO_TAGGING_ENABLED\",\n },\n new Databricks.Inputs.DataClassificationCatalogConfigAutoTagConfigArgs\n {\n ClassificationTag = \"class.email\",\n AutoTaggingMode = \"AUTO_TAGGING_ENABLED\",\n },\n },\n });\n\n // Enable Data Classification for the entire catalog (all current and future schemas)\n var allSchemas = new Databricks.DataClassificationCatalogConfig(\"all_schemas\", new()\n {\n Name = \"catalogs/staging_catalog/config\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t// Enable Data Classification for a set of schemas in a catalog\n\t\t_, err := databricks.NewDataClassificationCatalogConfig(ctx, \"example\", \u0026databricks.DataClassificationCatalogConfigArgs{\n\t\t\tName: \"catalogs/prod_catalog/config\",\n\t\t\tIncludedSchemas: \u0026databricks.DataClassificationCatalogConfigIncludedSchemasArgs{\n\t\t\t\tNames: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"sales\"),\n\t\t\t\t\tpulumi.String(\"marketing\"),\n\t\t\t\t\tpulumi.String(\"customer_data\"),\n\t\t\t\t},\n\t\t\t},\n\t\t\tAutoTagConfigs: databricks.DataClassificationCatalogConfigAutoTagConfigArray{\n\t\t\t\t\u0026databricks.DataClassificationCatalogConfigAutoTagConfigArgs{\n\t\t\t\t\tClassificationTag: pulumi.String(\"class.credit_card\"),\n\t\t\t\t\tAutoTaggingMode: pulumi.String(\"AUTO_TAGGING_ENABLED\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.DataClassificationCatalogConfigAutoTagConfigArgs{\n\t\t\t\t\tClassificationTag: pulumi.String(\"class.email\"),\n\t\t\t\t\tAutoTaggingMode: pulumi.String(\"AUTO_TAGGING_ENABLED\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// Enable Data Classification for the entire catalog (all current and future schemas)\n\t\t_, err = databricks.NewDataClassificationCatalogConfig(ctx, \"all_schemas\", \u0026databricks.DataClassificationCatalogConfigArgs{\n\t\t\tName: \"catalogs/staging_catalog/config\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n# Enable Data Classification for a set of schemas in a catalog\nresource \"databricks_dataclassificationcatalogconfig\" \"example\" {\n name = \"catalogs/prod_catalog/config\"\n included_schemas = {\n names = [\"sales\", \"marketing\", \"customer_data\"]\n }\n auto_tag_configs {\n classification_tag = \"class.credit_card\"\n auto_tagging_mode = \"AUTO_TAGGING_ENABLED\"\n }\n auto_tag_configs {\n classification_tag = \"class.email\"\n auto_tagging_mode = \"AUTO_TAGGING_ENABLED\"\n }\n}\n# Enable Data Classification for the entire catalog (all current and future schemas)\nresource \"databricks_dataclassificationcatalogconfig\" \"all_schemas\" {\n name = \"catalogs/staging_catalog/config\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DataClassificationCatalogConfig;\nimport com.pulumi.databricks.DataClassificationCatalogConfigArgs;\nimport com.pulumi.databricks.inputs.DataClassificationCatalogConfigIncludedSchemasArgs;\nimport com.pulumi.databricks.inputs.DataClassificationCatalogConfigAutoTagConfigArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n // Enable Data Classification for a set of schemas in a catalog\n var example = new DataClassificationCatalogConfig(\"example\", DataClassificationCatalogConfigArgs.builder()\n .name(\"catalogs/prod_catalog/config\")\n .includedSchemas(DataClassificationCatalogConfigIncludedSchemasArgs.builder()\n .names( \n \"sales\",\n \"marketing\",\n \"customer_data\")\n .build())\n .autoTagConfigs( \n DataClassificationCatalogConfigAutoTagConfigArgs.builder()\n .classificationTag(\"class.credit_card\")\n .autoTaggingMode(\"AUTO_TAGGING_ENABLED\")\n .build(),\n DataClassificationCatalogConfigAutoTagConfigArgs.builder()\n .classificationTag(\"class.email\")\n .autoTaggingMode(\"AUTO_TAGGING_ENABLED\")\n .build())\n .build());\n\n // Enable Data Classification for the entire catalog (all current and future schemas)\n var allSchemas = new DataClassificationCatalogConfig(\"allSchemas\", DataClassificationCatalogConfigArgs.builder()\n .name(\"catalogs/staging_catalog/config\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n # Enable Data Classification for a set of schemas in a catalog\n example:\n type: databricks:DataClassificationCatalogConfig\n properties:\n name: catalogs/prod_catalog/config\n includedSchemas:\n names:\n - sales\n - marketing\n - customer_data\n autoTagConfigs:\n - classificationTag: class.credit_card\n autoTaggingMode: AUTO_TAGGING_ENABLED\n - classificationTag: class.email\n autoTaggingMode: AUTO_TAGGING_ENABLED\n # Enable Data Classification for the entire catalog (all current and future schemas)\n allSchemas:\n type: databricks:DataClassificationCatalogConfig\n name: all_schemas\n properties:\n name: catalogs/staging_catalog/config\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "autoTagConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigAutoTagConfig:DataClassificationCatalogConfigAutoTagConfig" }, "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled\n" }, "includedSchemas": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigIncludedSchemas:DataClassificationCatalogConfigIncludedSchemas", "description": "Schemas to include in the scan. Empty list is not supported as it results in a no-op\nscan. If \u003cspan pulumi-lang-nodejs=\"`includedSchemas`\" pulumi-lang-dotnet=\"`IncludedSchemas`\" pulumi-lang-go=\"`includedSchemas`\" pulumi-lang-python=\"`included_schemas`\" pulumi-lang-yaml=\"`includedSchemas`\" pulumi-lang-java=\"`includedSchemas`\" pulumi-lang-hcl=\"`included_schemas`\"\u003e`includedSchemas`\u003c/span\u003e is not set, all schemas are scanned\n" }, "name": { "type": "string", "description": "(string) - Resource name in the format: catalogs/{catalog_name}/config\n" }, "parent": { "type": "string", "description": "Parent resource in the format: catalogs/{catalog_name}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigProviderConfig:DataClassificationCatalogConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "required": [ "name", "parent", "providerConfig" ], "inputProperties": { "autoTagConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigAutoTagConfig:DataClassificationCatalogConfigAutoTagConfig" }, "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled\n" }, "includedSchemas": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigIncludedSchemas:DataClassificationCatalogConfigIncludedSchemas", "description": "Schemas to include in the scan. Empty list is not supported as it results in a no-op\nscan. If \u003cspan pulumi-lang-nodejs=\"`includedSchemas`\" pulumi-lang-dotnet=\"`IncludedSchemas`\" pulumi-lang-go=\"`includedSchemas`\" pulumi-lang-python=\"`included_schemas`\" pulumi-lang-yaml=\"`includedSchemas`\" pulumi-lang-java=\"`includedSchemas`\" pulumi-lang-hcl=\"`included_schemas`\"\u003e`includedSchemas`\u003c/span\u003e is not set, all schemas are scanned\n" }, "parent": { "type": "string", "description": "Parent resource in the format: catalogs/{catalog_name}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigProviderConfig:DataClassificationCatalogConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "requiredInputs": [ "parent" ], "stateInputs": { "description": "Input properties used for looking up and filtering DataClassificationCatalogConfig resources.\n", "properties": { "autoTagConfigs": { "type": "array", "items": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigAutoTagConfig:DataClassificationCatalogConfigAutoTagConfig" }, "description": "List of auto-tagging configurations for this catalog.\nEmpty list means no auto-tagging is enabled\n" }, "includedSchemas": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigIncludedSchemas:DataClassificationCatalogConfigIncludedSchemas", "description": "Schemas to include in the scan. Empty list is not supported as it results in a no-op\nscan. If \u003cspan pulumi-lang-nodejs=\"`includedSchemas`\" pulumi-lang-dotnet=\"`IncludedSchemas`\" pulumi-lang-go=\"`includedSchemas`\" pulumi-lang-python=\"`included_schemas`\" pulumi-lang-yaml=\"`includedSchemas`\" pulumi-lang-java=\"`includedSchemas`\" pulumi-lang-hcl=\"`included_schemas`\"\u003e`includedSchemas`\u003c/span\u003e is not set, all schemas are scanned\n" }, "name": { "type": "string", "description": "(string) - Resource name in the format: catalogs/{catalog_name}/config\n" }, "parent": { "type": "string", "description": "Parent resource in the format: catalogs/{catalog_name}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataClassificationCatalogConfigProviderConfig:DataClassificationCatalogConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "type": "object" } }, "databricks:index/dataQualityMonitor:DataQualityMonitor": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/dataquality)\n\nThis resource allows you to set up data quality monitoring checks for Unity Catalog objects, currently schema and table. \n\nFor the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003cspan pulumi-lang-nodejs=\"`objectType`\" pulumi-lang-dotnet=\"`ObjectType`\" pulumi-lang-go=\"`objectType`\" pulumi-lang-python=\"`object_type`\" pulumi-lang-yaml=\"`objectType`\" pulumi-lang-java=\"`objectType`\" pulumi-lang-hcl=\"`object_type`\"\u003e`objectType`\u003c/span\u003e, you must either:\n1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the table's parent schema, and have **SELECT** access on the table\n2. have **USE_CATALOG** on the table's parent catalog, be an owner of the table's parent schema, and have **SELECT** access on the table.\n3. have the following permissions:\n - **USE_CATALOG** on the table's parent catalog\n - **USE_SCHEMA** on the table's parent schema\n - be an owner of the table.\n\n\u003e **Note** This resource can only be used with a workspace-level provider!\n\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Schema(\"this\", {\n catalogName: \"my_catalog\",\n name: \"my_schema\",\n});\nconst thisDataQualityMonitor = new databricks.DataQualityMonitor(\"this\", {\n objectType: \"schema\",\n objectId: _this.schemaId,\n anomalyDetectionConfig: {},\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Schema(\"this\",\n catalog_name=\"my_catalog\",\n name=\"my_schema\")\nthis_data_quality_monitor = databricks.DataQualityMonitor(\"this\",\n object_type=\"schema\",\n object_id=this.schema_id,\n anomaly_detection_config={})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Schema(\"this\", new()\n {\n CatalogName = \"my_catalog\",\n Name = \"my_schema\",\n });\n\n var thisDataQualityMonitor = new Databricks.DataQualityMonitor(\"this\", new()\n {\n ObjectType = \"schema\",\n ObjectId = @this.SchemaId,\n AnomalyDetectionConfig = null,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewSchema(ctx, \"this\", \u0026databricks.SchemaArgs{\n\t\t\tCatalogName: pulumi.String(\"my_catalog\"),\n\t\t\tName: pulumi.String(\"my_schema\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewDataQualityMonitor(ctx, \"this\", \u0026databricks.DataQualityMonitorArgs{\n\t\t\tObjectType: pulumi.String(\"schema\"),\n\t\t\tObjectId: this.SchemaId,\n\t\t\tAnomalyDetectionConfig: \u0026databricks.DataQualityMonitorAnomalyDetectionConfigArgs{},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_schema\" \"this\" {\n catalog_name = \"my_catalog\"\n name = \"my_schema\"\n}\nresource \"databricks_dataqualitymonitor\" \"this\" {\n object_type = \"schema\"\n object_id = databricks_schema.this.schema_id\n anomaly_detection_config = {}\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Schema;\nimport com.pulumi.databricks.SchemaArgs;\nimport com.pulumi.databricks.DataQualityMonitor;\nimport com.pulumi.databricks.DataQualityMonitorArgs;\nimport com.pulumi.databricks.inputs.DataQualityMonitorAnomalyDetectionConfigArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Schema(\"this\", SchemaArgs.builder()\n .catalogName(\"my_catalog\")\n .name(\"my_schema\")\n .build());\n\n var thisDataQualityMonitor = new DataQualityMonitor(\"thisDataQualityMonitor\", DataQualityMonitorArgs.builder()\n .objectType(\"schema\")\n .objectId(this_.schemaId())\n .anomalyDetectionConfig(DataQualityMonitorAnomalyDetectionConfigArgs.builder()\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Schema\n properties:\n catalogName: my_catalog\n name: my_schema\n thisDataQualityMonitor:\n type: databricks:DataQualityMonitor\n name: this\n properties:\n objectType: schema\n objectId: ${this.schemaId}\n anomalyDetectionConfig: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "anomalyDetectionConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorAnomalyDetectionConfig:DataQualityMonitorAnomalyDetectionConfig", "description": "Anomaly Detection Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e object types\n" }, "dataProfilingConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfig:DataQualityMonitorDataProfilingConfig", "description": "Data Profiling Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e object types. Exactly one `Analysis Configuration`\nmust be present\n" }, "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorProviderConfig:DataQualityMonitorProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "required": [ "objectId", "objectType", "providerConfig" ], "inputProperties": { "anomalyDetectionConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorAnomalyDetectionConfig:DataQualityMonitorAnomalyDetectionConfig", "description": "Anomaly Detection Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e object types\n" }, "dataProfilingConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfig:DataQualityMonitorDataProfilingConfig", "description": "Data Profiling Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e object types. Exactly one `Analysis Configuration`\nmust be present\n" }, "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorProviderConfig:DataQualityMonitorProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "requiredInputs": [ "objectId", "objectType" ], "stateInputs": { "description": "Input properties used for looking up and filtering DataQualityMonitor resources.\n", "properties": { "anomalyDetectionConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorAnomalyDetectionConfig:DataQualityMonitorAnomalyDetectionConfig", "description": "Anomaly Detection Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e object types\n" }, "dataProfilingConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorDataProfilingConfig:DataQualityMonitorDataProfilingConfig", "description": "Data Profiling Configuration, applicable to \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e object types. Exactly one `Analysis Configuration`\nmust be present\n" }, "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataQualityMonitorProviderConfig:DataQualityMonitorProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "type": "object" } }, "databricks:index/dataQualityRefresh:DataQualityRefresh": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/dataquality)\n\nThis resource allows you to refresh the data quality monitoring checks on Unity Catalog tables.\n\nYou must either:\n1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the table's parent schema, and have **SELECT** access on the table\n2. have **USE_CATALOG** on the table's parent catalog, be an owner of the table's parent schema, and have **SELECT** access on the table.\n3. have the following permissions:\n - **USE_CATALOG** on the table's parent catalog\n - **USE_SCHEMA** on the table's parent schema\n - be an owner of the table.\n\n\u003e **Note** This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n name: \"sandbox\",\n comment: \"this catalog is managed by terraform\",\n properties: {\n purpose: \"testing\",\n },\n});\nconst myTestSchema = new databricks.Schema(\"myTestSchema\", {\n catalogName: sandbox.id,\n name: \"myTestSchema\",\n comment: \"this database is managed by terraform\",\n properties: {\n kind: \"various\",\n },\n});\nconst myTestTable = new databricks.SqlTable(\"myTestTable\", {\n catalogName: \"main\",\n schemaName: myTestSchema.name,\n name: \"bar\",\n tableType: \"MANAGED\",\n dataSourceFormat: \"DELTA\",\n columns: [{\n name: \"timestamp\",\n type: \"int\",\n }],\n});\nconst _this = new databricks.DataQualityMonitor(\"this\", {\n objectType: \"table\",\n objectId: myTestTable.id,\n dataProfilingConfig: {\n outputSchema: myTestSchema.schemaId,\n },\n});\nconst thisDataQualityRefresh = new databricks.DataQualityRefresh(\"this\", {\n objectType: \"table\",\n objectId: myTestTable.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n name=\"sandbox\",\n comment=\"this catalog is managed by terraform\",\n properties={\n \"purpose\": \"testing\",\n })\nmy_test_schema = databricks.Schema(\"myTestSchema\",\n catalog_name=sandbox.id,\n name=\"myTestSchema\",\n comment=\"this database is managed by terraform\",\n properties={\n \"kind\": \"various\",\n })\nmy_test_table = databricks.SqlTable(\"myTestTable\",\n catalog_name=\"main\",\n schema_name=my_test_schema.name,\n name=\"bar\",\n table_type=\"MANAGED\",\n data_source_format=\"DELTA\",\n columns=[{\n \"name\": \"timestamp\",\n \"type\": \"int\",\n }])\nthis = databricks.DataQualityMonitor(\"this\",\n object_type=\"table\",\n object_id=my_test_table.id,\n data_profiling_config={\n \"output_schema\": my_test_schema.schema_id,\n })\nthis_data_quality_refresh = databricks.DataQualityRefresh(\"this\",\n object_type=\"table\",\n object_id=my_test_table.id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n Name = \"sandbox\",\n Comment = \"this catalog is managed by terraform\",\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var myTestSchema = new Databricks.Schema(\"myTestSchema\", new()\n {\n CatalogName = sandbox.Id,\n Name = \"myTestSchema\",\n Comment = \"this database is managed by terraform\",\n Properties = \n {\n { \"kind\", \"various\" },\n },\n });\n\n var myTestTable = new Databricks.SqlTable(\"myTestTable\", new()\n {\n CatalogName = \"main\",\n SchemaName = myTestSchema.Name,\n Name = \"bar\",\n TableType = \"MANAGED\",\n DataSourceFormat = \"DELTA\",\n Columns = new[]\n {\n new Databricks.Inputs.SqlTableColumnArgs\n {\n Name = \"timestamp\",\n Type = \"int\",\n },\n },\n });\n\n var @this = new Databricks.DataQualityMonitor(\"this\", new()\n {\n ObjectType = \"table\",\n ObjectId = myTestTable.Id,\n DataProfilingConfig = new Databricks.Inputs.DataQualityMonitorDataProfilingConfigArgs\n {\n OutputSchema = myTestSchema.SchemaId,\n },\n });\n\n var thisDataQualityRefresh = new Databricks.DataQualityRefresh(\"this\", new()\n {\n ObjectType = \"table\",\n ObjectId = myTestTable.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsandbox, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tComment: pulumi.String(\"this catalog is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyTestSchema, err := databricks.NewSchema(ctx, \"myTestSchema\", \u0026databricks.SchemaArgs{\n\t\t\tCatalogName: sandbox.ID(),\n\t\t\tName: pulumi.String(\"myTestSchema\"),\n\t\t\tComment: pulumi.String(\"this database is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"kind\": pulumi.String(\"various\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyTestTable, err := databricks.NewSqlTable(ctx, \"myTestTable\", \u0026databricks.SqlTableArgs{\n\t\t\tCatalogName: pulumi.String(\"main\"),\n\t\t\tSchemaName: myTestSchema.Name,\n\t\t\tName: pulumi.String(\"bar\"),\n\t\t\tTableType: pulumi.String(\"MANAGED\"),\n\t\t\tDataSourceFormat: pulumi.String(\"DELTA\"),\n\t\t\tColumns: databricks.SqlTableColumnArray{\n\t\t\t\t\u0026databricks.SqlTableColumnArgs{\n\t\t\t\t\tName: pulumi.String(\"timestamp\"),\n\t\t\t\t\tType: pulumi.String(\"int\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewDataQualityMonitor(ctx, \"this\", \u0026databricks.DataQualityMonitorArgs{\n\t\t\tObjectType: pulumi.String(\"table\"),\n\t\t\tObjectId: myTestTable.ID(),\n\t\t\tDataProfilingConfig: \u0026databricks.DataQualityMonitorDataProfilingConfigArgs{\n\t\t\t\tOutputSchema: myTestSchema.SchemaId,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewDataQualityRefresh(ctx, \"this\", \u0026databricks.DataQualityRefreshArgs{\n\t\t\tObjectType: pulumi.String(\"table\"),\n\t\t\tObjectId: myTestTable.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n name = \"sandbox\"\n comment = \"this catalog is managed by terraform\"\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_schema\" \"myTestSchema\" {\n catalog_name = databricks_catalog.sandbox.id\n name = \"myTestSchema\"\n comment = \"this database is managed by terraform\"\n properties = {\n \"kind\" = \"various\"\n }\n}\nresource \"databricks_sqltable\" \"myTestTable\" {\n catalog_name = \"main\"\n schema_name = databricks_schema.myTestSchema.name\n name = \"bar\"\n table_type = \"MANAGED\"\n data_source_format = \"DELTA\"\n columns {\n name = \"timestamp\"\n type = \"int\"\n }\n}\nresource \"databricks_dataqualitymonitor\" \"this\" {\n object_type = \"table\"\n object_id = databricks_sqltable.myTestTable.id\n data_profiling_config = {\n output_schema = databricks_schema.myTestSchema.schema_id\n }\n}\nresource \"databricks_dataqualityrefresh\" \"this\" {\n object_type = \"table\"\n object_id = databricks_sqltable.myTestTable.id\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport com.pulumi.databricks.Schema;\nimport com.pulumi.databricks.SchemaArgs;\nimport com.pulumi.databricks.SqlTable;\nimport com.pulumi.databricks.SqlTableArgs;\nimport com.pulumi.databricks.inputs.SqlTableColumnArgs;\nimport com.pulumi.databricks.DataQualityMonitor;\nimport com.pulumi.databricks.DataQualityMonitorArgs;\nimport com.pulumi.databricks.inputs.DataQualityMonitorDataProfilingConfigArgs;\nimport com.pulumi.databricks.DataQualityRefresh;\nimport com.pulumi.databricks.DataQualityRefreshArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .name(\"sandbox\")\n .comment(\"this catalog is managed by terraform\")\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var myTestSchema = new Schema(\"myTestSchema\", SchemaArgs.builder()\n .catalogName(sandbox.id())\n .name(\"myTestSchema\")\n .comment(\"this database is managed by terraform\")\n .properties(Map.of(\"kind\", \"various\"))\n .build());\n\n var myTestTable = new SqlTable(\"myTestTable\", SqlTableArgs.builder()\n .catalogName(\"main\")\n .schemaName(myTestSchema.name())\n .name(\"bar\")\n .tableType(\"MANAGED\")\n .dataSourceFormat(\"DELTA\")\n .columns(SqlTableColumnArgs.builder()\n .name(\"timestamp\")\n .type(\"int\")\n .build())\n .build());\n\n var this_ = new DataQualityMonitor(\"this\", DataQualityMonitorArgs.builder()\n .objectType(\"table\")\n .objectId(myTestTable.id())\n .dataProfilingConfig(DataQualityMonitorDataProfilingConfigArgs.builder()\n .outputSchema(myTestSchema.schemaId())\n .build())\n .build());\n\n var thisDataQualityRefresh = new DataQualityRefresh(\"thisDataQualityRefresh\", DataQualityRefreshArgs.builder()\n .objectType(\"table\")\n .objectId(myTestTable.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n name: sandbox\n comment: this catalog is managed by terraform\n properties:\n purpose: testing\n myTestSchema:\n type: databricks:Schema\n properties:\n catalogName: ${sandbox.id}\n name: myTestSchema\n comment: this database is managed by terraform\n properties:\n kind: various\n myTestTable:\n type: databricks:SqlTable\n properties:\n catalogName: main\n schemaName: ${myTestSchema.name}\n name: bar\n tableType: MANAGED\n dataSourceFormat: DELTA\n columns:\n - name: timestamp\n type: int\n this:\n type: databricks:DataQualityMonitor\n properties:\n objectType: table\n objectId: ${myTestTable.id}\n dataProfilingConfig:\n outputSchema: ${myTestSchema.schemaId}\n thisDataQualityRefresh:\n type: databricks:DataQualityRefresh\n name: this\n properties:\n objectType: table\n objectId: ${myTestTable.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "endTimeMs": { "type": "integer", "description": "(integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)\n" }, "message": { "type": "string", "description": "(string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)\n" }, "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003eor \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataQualityRefreshProviderConfig:DataQualityRefreshProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "refreshId": { "type": "integer", "description": "(integer) - Unique id of the refresh operation\n" }, "startTimeMs": { "type": "integer", "description": "(integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)\n" }, "state": { "type": "string", "description": "(string) - The current state of the refresh. Possible values are: `MONITOR_REFRESH_STATE_CANCELED`, `MONITOR_REFRESH_STATE_FAILED`, `MONITOR_REFRESH_STATE_PENDING`, `MONITOR_REFRESH_STATE_RUNNING`, `MONITOR_REFRESH_STATE_SUCCESS`, `MONITOR_REFRESH_STATE_UNKNOWN`\n" }, "trigger": { "type": "string", "description": "(string) - What triggered the refresh. Possible values are: `MONITOR_REFRESH_TRIGGER_DATA_CHANGE`, `MONITOR_REFRESH_TRIGGER_MANUAL`, `MONITOR_REFRESH_TRIGGER_SCHEDULE`, `MONITOR_REFRESH_TRIGGER_UNKNOWN`\n" } }, "required": [ "endTimeMs", "message", "objectId", "objectType", "providerConfig", "refreshId", "startTimeMs", "state", "trigger" ], "inputProperties": { "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003eor \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataQualityRefreshProviderConfig:DataQualityRefreshProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "requiredInputs": [ "objectId", "objectType" ], "stateInputs": { "description": "Input properties used for looking up and filtering DataQualityRefresh resources.\n", "properties": { "endTimeMs": { "type": "integer", "description": "(integer) - Time when the refresh ended (milliseconds since 1/1/1970 UTC)\n" }, "message": { "type": "string", "description": "(string) - An optional message to give insight into the current state of the refresh (e.g. FAILURE messages)\n" }, "objectId": { "type": "string", "description": "The UUID of the request object. It is \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e for \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`schemaId`\" pulumi-lang-dotnet=\"`SchemaId`\" pulumi-lang-go=\"`schemaId`\" pulumi-lang-python=\"`schema_id`\" pulumi-lang-yaml=\"`schemaId`\" pulumi-lang-java=\"`schemaId`\" pulumi-lang-hcl=\"`schema_id`\"\u003e`schemaId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[schemaId]\" pulumi-lang-dotnet=\"[SchemaId]\" pulumi-lang-go=\"[schemaId]\" pulumi-lang-python=\"[schema_id]\" pulumi-lang-yaml=\"[schemaId]\" pulumi-lang-java=\"[schemaId]\" pulumi-lang-hcl=\"[schema_id]\"\u003e[schemaId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/schemas/get#schema_id) of the `Schemas` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Schema ID` field.\n\nFind the \u003cspan pulumi-lang-nodejs=\"`tableId`\" pulumi-lang-dotnet=\"`TableId`\" pulumi-lang-go=\"`tableId`\" pulumi-lang-python=\"`table_id`\" pulumi-lang-yaml=\"`tableId`\" pulumi-lang-java=\"`tableId`\" pulumi-lang-hcl=\"`table_id`\"\u003e`tableId`\u003c/span\u003e from either:\n1. The \u003cspan pulumi-lang-nodejs=\"[tableId]\" pulumi-lang-dotnet=\"[TableId]\" pulumi-lang-go=\"[tableId]\" pulumi-lang-python=\"[table_id]\" pulumi-lang-yaml=\"[tableId]\" pulumi-lang-java=\"[tableId]\" pulumi-lang-hcl=\"[table_id]\"\u003e[tableId]\u003c/span\u003e(https://docs.databricks.com/api/workspace/tables/get#table_id) of the `Tables` resource.\n2. In [Catalog Explorer](https://docs.databricks.com/aws/en/catalog-explorer/) \u003e select the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e \u003e go to the `Details` tab \u003e the `Table ID` field\n" }, "objectType": { "type": "string", "description": "The type of the monitored object. Can be one of the following: \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003eor \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DataQualityRefreshProviderConfig:DataQualityRefreshProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "refreshId": { "type": "integer", "description": "(integer) - Unique id of the refresh operation\n" }, "startTimeMs": { "type": "integer", "description": "(integer) - Time when the refresh started (milliseconds since 1/1/1970 UTC)\n" }, "state": { "type": "string", "description": "(string) - The current state of the refresh. Possible values are: `MONITOR_REFRESH_STATE_CANCELED`, `MONITOR_REFRESH_STATE_FAILED`, `MONITOR_REFRESH_STATE_PENDING`, `MONITOR_REFRESH_STATE_RUNNING`, `MONITOR_REFRESH_STATE_SUCCESS`, `MONITOR_REFRESH_STATE_UNKNOWN`\n" }, "trigger": { "type": "string", "description": "(string) - What triggered the refresh. Possible values are: `MONITOR_REFRESH_TRIGGER_DATA_CHANGE`, `MONITOR_REFRESH_TRIGGER_MANUAL`, `MONITOR_REFRESH_TRIGGER_SCHEDULE`, `MONITOR_REFRESH_TRIGGER_UNKNOWN`\n" } }, "type": "object" } }, "databricks:index/databaseDatabaseCatalog:DatabaseDatabaseCatalog": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/database)\n\nDatabase Catalogs are databases inside a Lakebase Database Instance which are synced into a Postgres Catalog inside Unity Catalog.\n\n## Example Usage\n\n### Example\n\nThis example creates a Database Catalog based on an existing database in the Database Instance\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseDatabaseCatalog(\"this\", {\n name: \"my_registered_catalog\",\n databaseInstanceName: \"my-database-instance\",\n databaseName: \"databricks_postgres\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseDatabaseCatalog(\"this\",\n name=\"my_registered_catalog\",\n database_instance_name=\"my-database-instance\",\n database_name=\"databricks_postgres\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseDatabaseCatalog(\"this\", new()\n {\n Name = \"my_registered_catalog\",\n DatabaseInstanceName = \"my-database-instance\",\n DatabaseName = \"databricks_postgres\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseDatabaseCatalog(ctx, \"this\", \u0026databricks.DatabaseDatabaseCatalogArgs{\n\t\t\tName: pulumi.String(\"my_registered_catalog\"),\n\t\t\tDatabaseInstanceName: pulumi.String(\"my-database-instance\"),\n\t\t\tDatabaseName: pulumi.String(\"databricks_postgres\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databasedatabasecatalog\" \"this\" {\n name = \"my_registered_catalog\"\n database_instance_name = \"my-database-instance\"\n database_name = \"databricks_postgres\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseDatabaseCatalog;\nimport com.pulumi.databricks.DatabaseDatabaseCatalogArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseDatabaseCatalog(\"this\", DatabaseDatabaseCatalogArgs.builder()\n .name(\"my_registered_catalog\")\n .databaseInstanceName(\"my-database-instance\")\n .databaseName(\"databricks_postgres\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseDatabaseCatalog\n properties:\n name: my_registered_catalog\n databaseInstanceName: my-database-instance\n databaseName: databricks_postgres\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nThis example creates a Database Catalog along with a new database inside an existing Database Instance\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseDatabaseCatalog(\"this\", {\n name: \"my_registered_catalog\",\n databaseInstanceName: \"my-database-instance\",\n databaseName: \"new_registered_catalog_database\",\n createDatabaseIfNotExists: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseDatabaseCatalog(\"this\",\n name=\"my_registered_catalog\",\n database_instance_name=\"my-database-instance\",\n database_name=\"new_registered_catalog_database\",\n create_database_if_not_exists=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseDatabaseCatalog(\"this\", new()\n {\n Name = \"my_registered_catalog\",\n DatabaseInstanceName = \"my-database-instance\",\n DatabaseName = \"new_registered_catalog_database\",\n CreateDatabaseIfNotExists = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseDatabaseCatalog(ctx, \"this\", \u0026databricks.DatabaseDatabaseCatalogArgs{\n\t\t\tName: pulumi.String(\"my_registered_catalog\"),\n\t\t\tDatabaseInstanceName: pulumi.String(\"my-database-instance\"),\n\t\t\tDatabaseName: pulumi.String(\"new_registered_catalog_database\"),\n\t\t\tCreateDatabaseIfNotExists: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databasedatabasecatalog\" \"this\" {\n name = \"my_registered_catalog\"\n database_instance_name = \"my-database-instance\"\n database_name = \"new_registered_catalog_database\"\n create_database_if_not_exists = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseDatabaseCatalog;\nimport com.pulumi.databricks.DatabaseDatabaseCatalogArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseDatabaseCatalog(\"this\", DatabaseDatabaseCatalogArgs.builder()\n .name(\"my_registered_catalog\")\n .databaseInstanceName(\"my-database-instance\")\n .databaseName(\"new_registered_catalog_database\")\n .createDatabaseIfNotExists(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseDatabaseCatalog\n properties:\n name: my_registered_catalog\n databaseInstanceName: my-database-instance\n databaseName: new_registered_catalog_database\n createDatabaseIfNotExists: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nThis example creates a DatabaseInstance and then a Database Catalog inside it\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst instance = new databricks.DatabaseInstance(\"instance\", {\n name: \"my-database-instance\",\n capacity: \"CU_1\",\n});\nconst catalog = new databricks.DatabaseDatabaseCatalog(\"catalog\", {\n name: \"my_registered_catalog\",\n databaseInstanceName: instance.name,\n databaseName: \"new_registered_catalog_database\",\n createDatabaseIfNotExists: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ninstance = databricks.DatabaseInstance(\"instance\",\n name=\"my-database-instance\",\n capacity=\"CU_1\")\ncatalog = databricks.DatabaseDatabaseCatalog(\"catalog\",\n name=\"my_registered_catalog\",\n database_instance_name=instance.name,\n database_name=\"new_registered_catalog_database\",\n create_database_if_not_exists=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var instance = new Databricks.DatabaseInstance(\"instance\", new()\n {\n Name = \"my-database-instance\",\n Capacity = \"CU_1\",\n });\n\n var catalog = new Databricks.DatabaseDatabaseCatalog(\"catalog\", new()\n {\n Name = \"my_registered_catalog\",\n DatabaseInstanceName = instance.Name,\n DatabaseName = \"new_registered_catalog_database\",\n CreateDatabaseIfNotExists = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinstance, err := databricks.NewDatabaseInstance(ctx, \"instance\", \u0026databricks.DatabaseInstanceArgs{\n\t\t\tName: pulumi.String(\"my-database-instance\"),\n\t\t\tCapacity: pulumi.String(\"CU_1\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewDatabaseDatabaseCatalog(ctx, \"catalog\", \u0026databricks.DatabaseDatabaseCatalogArgs{\n\t\t\tName: pulumi.String(\"my_registered_catalog\"),\n\t\t\tDatabaseInstanceName: instance.Name,\n\t\t\tDatabaseName: pulumi.String(\"new_registered_catalog_database\"),\n\t\t\tCreateDatabaseIfNotExists: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databaseinstance\" \"instance\" {\n name = \"my-database-instance\"\n capacity = \"CU_1\"\n}\nresource \"databricks_databasedatabasecatalog\" \"catalog\" {\n name = \"my_registered_catalog\"\n database_instance_name = databricks_databaseinstance.instance.name\n database_name = \"new_registered_catalog_database\"\n create_database_if_not_exists = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseInstance;\nimport com.pulumi.databricks.DatabaseInstanceArgs;\nimport com.pulumi.databricks.DatabaseDatabaseCatalog;\nimport com.pulumi.databricks.DatabaseDatabaseCatalogArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var instance = new DatabaseInstance(\"instance\", DatabaseInstanceArgs.builder()\n .name(\"my-database-instance\")\n .capacity(\"CU_1\")\n .build());\n\n var catalog = new DatabaseDatabaseCatalog(\"catalog\", DatabaseDatabaseCatalogArgs.builder()\n .name(\"my_registered_catalog\")\n .databaseInstanceName(instance.name())\n .databaseName(\"new_registered_catalog_database\")\n .createDatabaseIfNotExists(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instance:\n type: databricks:DatabaseInstance\n properties:\n name: my-database-instance\n capacity: CU_1\n catalog:\n type: databricks:DatabaseDatabaseCatalog\n properties:\n name: my_registered_catalog\n databaseInstanceName: ${instance.name}\n databaseName: new_registered_catalog_database\n createDatabaseIfNotExists: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "createDatabaseIfNotExists": { "type": "boolean" }, "databaseInstanceName": { "type": "string", "description": "The name of the DatabaseInstance housing the database\n" }, "databaseName": { "type": "string", "description": "The name of the database (in a instance) associated with the catalog\n" }, "name": { "type": "string", "description": "The name of the catalog in UC\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseDatabaseCatalogProviderConfig:DatabaseDatabaseCatalogProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "uid": { "type": "string", "description": "(string)\n" } }, "required": [ "createDatabaseIfNotExists", "databaseInstanceName", "databaseName", "name", "providerConfig", "uid" ], "inputProperties": { "createDatabaseIfNotExists": { "type": "boolean" }, "databaseInstanceName": { "type": "string", "description": "The name of the DatabaseInstance housing the database\n" }, "databaseName": { "type": "string", "description": "The name of the database (in a instance) associated with the catalog\n" }, "name": { "type": "string", "description": "The name of the catalog in UC\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseDatabaseCatalogProviderConfig:DatabaseDatabaseCatalogProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "requiredInputs": [ "databaseInstanceName", "databaseName" ], "stateInputs": { "description": "Input properties used for looking up and filtering DatabaseDatabaseCatalog resources.\n", "properties": { "createDatabaseIfNotExists": { "type": "boolean" }, "databaseInstanceName": { "type": "string", "description": "The name of the DatabaseInstance housing the database\n" }, "databaseName": { "type": "string", "description": "The name of the database (in a instance) associated with the catalog\n" }, "name": { "type": "string", "description": "The name of the catalog in UC\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseDatabaseCatalogProviderConfig:DatabaseDatabaseCatalogProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "uid": { "type": "string", "description": "(string)\n" } }, "type": "object" } }, "databricks:index/databaseInstance:DatabaseInstance": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/database)\n\nLakebase Database Instances are managed Postgres instances, composed of a primary Postgres compute instance and 0 or more read replica instances.\n\n## Example Usage\n\n### Basic Example\n\nThis example creates a simple Database Instance with the specified name and capacity.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseInstance(\"this\", {\n name: \"my-database-instance\",\n capacity: \"CU_2\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseInstance(\"this\",\n name=\"my-database-instance\",\n capacity=\"CU_2\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseInstance(\"this\", new()\n {\n Name = \"my-database-instance\",\n Capacity = \"CU_2\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseInstance(ctx, \"this\", \u0026databricks.DatabaseInstanceArgs{\n\t\t\tName: pulumi.String(\"my-database-instance\"),\n\t\t\tCapacity: pulumi.String(\"CU_2\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databaseinstance\" \"this\" {\n name = \"my-database-instance\"\n capacity = \"CU_2\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseInstance;\nimport com.pulumi.databricks.DatabaseInstanceArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseInstance(\"this\", DatabaseInstanceArgs.builder()\n .name(\"my-database-instance\")\n .capacity(\"CU_2\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseInstance\n properties:\n name: my-database-instance\n capacity: CU_2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example with Readable Secondaries\n\nThis example creates a Database Instance with readable secondaries (and HA) enabled.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseInstance(\"this\", {\n name: \"my-database-instance\",\n capacity: \"CU_2\",\n nodeCount: 2,\n enableReadableSecondaries: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseInstance(\"this\",\n name=\"my-database-instance\",\n capacity=\"CU_2\",\n node_count=2,\n enable_readable_secondaries=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseInstance(\"this\", new()\n {\n Name = \"my-database-instance\",\n Capacity = \"CU_2\",\n NodeCount = 2,\n EnableReadableSecondaries = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseInstance(ctx, \"this\", \u0026databricks.DatabaseInstanceArgs{\n\t\t\tName: pulumi.String(\"my-database-instance\"),\n\t\t\tCapacity: pulumi.String(\"CU_2\"),\n\t\t\tNodeCount: pulumi.Int(2),\n\t\t\tEnableReadableSecondaries: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databaseinstance\" \"this\" {\n name = \"my-database-instance\"\n capacity = \"CU_2\"\n node_count = 2\n enable_readable_secondaries = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseInstance;\nimport com.pulumi.databricks.DatabaseInstanceArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseInstance(\"this\", DatabaseInstanceArgs.builder()\n .name(\"my-database-instance\")\n .capacity(\"CU_2\")\n .nodeCount(2)\n .enableReadableSecondaries(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseInstance\n properties:\n name: my-database-instance\n capacity: CU_2\n nodeCount: 2\n enableReadableSecondaries: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example Child Instance Created From Parent\n\nThis example creates a child Database Instance from a specified parent Database Instance at the current point in time.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst child = new databricks.DatabaseInstance(\"child\", {\n name: \"my-database-instance\",\n capacity: \"CU_2\",\n parentInstanceRef: {\n name: \"my-parent-instance\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nchild = databricks.DatabaseInstance(\"child\",\n name=\"my-database-instance\",\n capacity=\"CU_2\",\n parent_instance_ref={\n \"name\": \"my-parent-instance\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var child = new Databricks.DatabaseInstance(\"child\", new()\n {\n Name = \"my-database-instance\",\n Capacity = \"CU_2\",\n ParentInstanceRef = new Databricks.Inputs.DatabaseInstanceParentInstanceRefArgs\n {\n Name = \"my-parent-instance\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseInstance(ctx, \"child\", \u0026databricks.DatabaseInstanceArgs{\n\t\t\tName: pulumi.String(\"my-database-instance\"),\n\t\t\tCapacity: pulumi.String(\"CU_2\"),\n\t\t\tParentInstanceRef: \u0026databricks.DatabaseInstanceParentInstanceRefArgs{\n\t\t\t\tName: pulumi.String(\"my-parent-instance\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databaseinstance\" \"child\" {\n name = \"my-database-instance\"\n capacity = \"CU_2\"\n parent_instance_ref = {\n name = \"my-parent-instance\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseInstance;\nimport com.pulumi.databricks.DatabaseInstanceArgs;\nimport com.pulumi.databricks.inputs.DatabaseInstanceParentInstanceRefArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var child = new DatabaseInstance(\"child\", DatabaseInstanceArgs.builder()\n .name(\"my-database-instance\")\n .capacity(\"CU_2\")\n .parentInstanceRef(DatabaseInstanceParentInstanceRefArgs.builder()\n .name(\"my-parent-instance\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n child:\n type: databricks:DatabaseInstance\n properties:\n name: my-database-instance\n capacity: CU_2\n parentInstanceRef:\n name: my-parent-instance\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example with a usage policy and custom tags\n\nThis example creates a Database Instance with an associated usage policy and custom tags.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseInstance(\"this\", {\n name: \"my-database-instance\",\n capacity: \"CU_8\",\n usagePolicyId: \"948192fa-a98b-498f-a09b-ecee79d8b983\",\n customTags: [\n {\n key: \"custom_tag_key1\",\n value: \"custom_tag_value1\",\n },\n {\n key: \"custom_tag_key2\",\n value: \"custom_tag_value2\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseInstance(\"this\",\n name=\"my-database-instance\",\n capacity=\"CU_8\",\n usage_policy_id=\"948192fa-a98b-498f-a09b-ecee79d8b983\",\n custom_tags=[\n {\n \"key\": \"custom_tag_key1\",\n \"value\": \"custom_tag_value1\",\n },\n {\n \"key\": \"custom_tag_key2\",\n \"value\": \"custom_tag_value2\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseInstance(\"this\", new()\n {\n Name = \"my-database-instance\",\n Capacity = \"CU_8\",\n UsagePolicyId = \"948192fa-a98b-498f-a09b-ecee79d8b983\",\n CustomTags = new[]\n {\n new Databricks.Inputs.DatabaseInstanceCustomTagArgs\n {\n Key = \"custom_tag_key1\",\n Value = \"custom_tag_value1\",\n },\n new Databricks.Inputs.DatabaseInstanceCustomTagArgs\n {\n Key = \"custom_tag_key2\",\n Value = \"custom_tag_value2\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseInstance(ctx, \"this\", \u0026databricks.DatabaseInstanceArgs{\n\t\t\tName: pulumi.String(\"my-database-instance\"),\n\t\t\tCapacity: pulumi.String(\"CU_8\"),\n\t\t\tUsagePolicyId: pulumi.String(\"948192fa-a98b-498f-a09b-ecee79d8b983\"),\n\t\t\tCustomTags: databricks.DatabaseInstanceCustomTagArray{\n\t\t\t\t\u0026databricks.DatabaseInstanceCustomTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"custom_tag_key1\"),\n\t\t\t\t\tValue: pulumi.String(\"custom_tag_value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.DatabaseInstanceCustomTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"custom_tag_key2\"),\n\t\t\t\t\tValue: pulumi.String(\"custom_tag_value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databaseinstance\" \"this\" {\n name = \"my-database-instance\"\n capacity = \"CU_8\"\n usage_policy_id = \"948192fa-a98b-498f-a09b-ecee79d8b983\"\n custom_tags {\n key = \"custom_tag_key1\"\n value = \"custom_tag_value1\"\n }\n custom_tags {\n key = \"custom_tag_key2\"\n value = \"custom_tag_value2\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseInstance;\nimport com.pulumi.databricks.DatabaseInstanceArgs;\nimport com.pulumi.databricks.inputs.DatabaseInstanceCustomTagArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseInstance(\"this\", DatabaseInstanceArgs.builder()\n .name(\"my-database-instance\")\n .capacity(\"CU_8\")\n .usagePolicyId(\"948192fa-a98b-498f-a09b-ecee79d8b983\")\n .customTags( \n DatabaseInstanceCustomTagArgs.builder()\n .key(\"custom_tag_key1\")\n .value(\"custom_tag_value1\")\n .build(),\n DatabaseInstanceCustomTagArgs.builder()\n .key(\"custom_tag_key2\")\n .value(\"custom_tag_value2\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseInstance\n properties:\n name: my-database-instance\n capacity: CU_8\n usagePolicyId: 948192fa-a98b-498f-a09b-ecee79d8b983\n customTags:\n - key: custom_tag_key1\n value: custom_tag_value1\n - key: custom_tag_key2\n value: custom_tag_value2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "capacity": { "type": "string", "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\"\n" }, "childInstanceRefs": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceChildInstanceRef:DatabaseInstanceChildInstanceRef" }, "description": "(list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is\nparent instance\n" }, "creationTime": { "type": "string", "description": "(string) - The timestamp when the instance was created\n" }, "creator": { "type": "string", "description": "(string) - The email of the creator of the instance\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceCustomTag:DatabaseInstanceCustomTag" }, "description": "Custom tags associated with the instance. This field is only included on create and update responses\n" }, "effectiveCapacity": { "type": "string", "description": "(string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveCustomTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceEffectiveCustomTag:DatabaseInstanceEffectiveCustomTag" }, "description": "(list of CustomTag) - The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveEnablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether the instance has PG native password login enabled.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveEnableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveNodeCount": { "type": "integer", "description": "(integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveRetentionWindowInDays": { "type": "integer", "description": "(integer) - The retention window for the instance. This is the time window in days\nfor which the historical data is retained.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveStopped": { "type": "boolean", "description": "(boolean) - Whether the instance is stopped.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "(string) - The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "Whether to enable PG native password login on the instance. Defaults to false\n" }, "enableReadableSecondaries": { "type": "boolean", "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "nodeCount": { "type": "integer", "description": "The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see\u003cspan pulumi-lang-nodejs=\" effectiveNodeCount \" pulumi-lang-dotnet=\" EffectiveNodeCount \" pulumi-lang-go=\" effectiveNodeCount \" pulumi-lang-python=\" effective_node_count \" pulumi-lang-yaml=\" effectiveNodeCount \" pulumi-lang-java=\" effectiveNodeCount \" pulumi-lang-hcl=\" effective_node_count \"\u003e effectiveNodeCount \u003c/span\u003efor the output\n" }, "parentInstanceRef": { "$ref": "#/types/databricks:index/DatabaseInstanceParentInstanceRef:DatabaseInstanceParentInstanceRef", "description": "The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "pgVersion": { "type": "string", "description": "(string) - The version of Postgres running on the instance\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseInstanceProviderConfig:DatabaseInstanceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeOnDelete": { "type": "boolean", "description": "Deprecated. Omitting the field or setting it to true will result in the field being hard deleted. Setting a value\nof false will throw a bad request\n" }, "readOnlyDns": { "type": "string", "description": "(string) - The DNS endpoint to connect to the instance for read only access. This is only available if\u003cspan pulumi-lang-nodejs=\"\nenableReadableSecondaries \" pulumi-lang-dotnet=\"\nEnableReadableSecondaries \" pulumi-lang-go=\"\nenableReadableSecondaries \" pulumi-lang-python=\"\nenable_readable_secondaries \" pulumi-lang-yaml=\"\nenableReadableSecondaries \" pulumi-lang-java=\"\nenableReadableSecondaries \" pulumi-lang-hcl=\"\nenable_readable_secondaries \"\u003e\nenableReadableSecondaries \u003c/span\u003eis true\n" }, "readWriteDns": { "type": "string", "description": "(string) - The DNS endpoint to connect to the instance for read+write access\n" }, "retentionWindowInDays": { "type": "integer", "description": "The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days\n" }, "state": { "type": "string", "description": "(string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`\n" }, "stopped": { "type": "boolean", "description": "Whether to stop the instance. An input only param, see\u003cspan pulumi-lang-nodejs=\" effectiveStopped \" pulumi-lang-dotnet=\" EffectiveStopped \" pulumi-lang-go=\" effectiveStopped \" pulumi-lang-python=\" effective_stopped \" pulumi-lang-yaml=\" effectiveStopped \" pulumi-lang-java=\" effectiveStopped \" pulumi-lang-hcl=\" effective_stopped \"\u003e effectiveStopped \u003c/span\u003efor the output\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" }, "usagePolicyId": { "type": "string", "description": "The desired usage policy to associate with the instance\n" } }, "required": [ "childInstanceRefs", "creationTime", "creator", "customTags", "effectiveCapacity", "effectiveCustomTags", "effectiveEnablePgNativeLogin", "effectiveEnableReadableSecondaries", "effectiveNodeCount", "effectiveRetentionWindowInDays", "effectiveStopped", "effectiveUsagePolicyId", "enablePgNativeLogin", "enableReadableSecondaries", "name", "nodeCount", "pgVersion", "providerConfig", "readOnlyDns", "readWriteDns", "retentionWindowInDays", "state", "stopped", "uid", "usagePolicyId" ], "inputProperties": { "capacity": { "type": "string", "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\"\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceCustomTag:DatabaseInstanceCustomTag" }, "description": "Custom tags associated with the instance. This field is only included on create and update responses\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "Whether to enable PG native password login on the instance. Defaults to false\n" }, "enableReadableSecondaries": { "type": "boolean", "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "nodeCount": { "type": "integer", "description": "The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see\u003cspan pulumi-lang-nodejs=\" effectiveNodeCount \" pulumi-lang-dotnet=\" EffectiveNodeCount \" pulumi-lang-go=\" effectiveNodeCount \" pulumi-lang-python=\" effective_node_count \" pulumi-lang-yaml=\" effectiveNodeCount \" pulumi-lang-java=\" effectiveNodeCount \" pulumi-lang-hcl=\" effective_node_count \"\u003e effectiveNodeCount \u003c/span\u003efor the output\n" }, "parentInstanceRef": { "$ref": "#/types/databricks:index/DatabaseInstanceParentInstanceRef:DatabaseInstanceParentInstanceRef", "description": "The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseInstanceProviderConfig:DatabaseInstanceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeOnDelete": { "type": "boolean", "description": "Deprecated. Omitting the field or setting it to true will result in the field being hard deleted. Setting a value\nof false will throw a bad request\n" }, "retentionWindowInDays": { "type": "integer", "description": "The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days\n" }, "stopped": { "type": "boolean", "description": "Whether to stop the instance. An input only param, see\u003cspan pulumi-lang-nodejs=\" effectiveStopped \" pulumi-lang-dotnet=\" EffectiveStopped \" pulumi-lang-go=\" effectiveStopped \" pulumi-lang-python=\" effective_stopped \" pulumi-lang-yaml=\" effectiveStopped \" pulumi-lang-java=\" effectiveStopped \" pulumi-lang-hcl=\" effective_stopped \"\u003e effectiveStopped \u003c/span\u003efor the output\n" }, "usagePolicyId": { "type": "string", "description": "The desired usage policy to associate with the instance\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering DatabaseInstance resources.\n", "properties": { "capacity": { "type": "string", "description": "The sku of the instance. Valid values are \"CU_1\", \"CU_2\", \"CU_4\", \"CU_8\"\n" }, "childInstanceRefs": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceChildInstanceRef:DatabaseInstanceChildInstanceRef" }, "description": "(list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is\nparent instance\n" }, "creationTime": { "type": "string", "description": "(string) - The timestamp when the instance was created\n" }, "creator": { "type": "string", "description": "(string) - The email of the creator of the instance\n" }, "customTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceCustomTag:DatabaseInstanceCustomTag" }, "description": "Custom tags associated with the instance. This field is only included on create and update responses\n" }, "effectiveCapacity": { "type": "string", "description": "(string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveCustomTags": { "type": "array", "items": { "$ref": "#/types/databricks:index/DatabaseInstanceEffectiveCustomTag:DatabaseInstanceEffectiveCustomTag" }, "description": "(list of CustomTag) - The recorded custom tags associated with the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveEnablePgNativeLogin": { "type": "boolean", "description": "(boolean) - Whether the instance has PG native password login enabled.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveEnableReadableSecondaries": { "type": "boolean", "description": "(boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveNodeCount": { "type": "integer", "description": "(integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveRetentionWindowInDays": { "type": "integer", "description": "(integer) - The retention window for the instance. This is the time window in days\nfor which the historical data is retained.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveStopped": { "type": "boolean", "description": "(boolean) - Whether the instance is stopped.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveUsagePolicyId": { "type": "string", "description": "(string) - The policy that is applied to the instance.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "enablePgNativeLogin": { "type": "boolean", "description": "Whether to enable PG native password login on the instance. Defaults to false\n" }, "enableReadableSecondaries": { "type": "boolean", "description": "Whether to enable secondaries to serve read-only traffic. Defaults to false\n" }, "name": { "type": "string", "description": "The name of the instance. This is the unique identifier for the instance\n" }, "nodeCount": { "type": "integer", "description": "The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to\n1 primary and 0 secondaries. This field is input only, see\u003cspan pulumi-lang-nodejs=\" effectiveNodeCount \" pulumi-lang-dotnet=\" EffectiveNodeCount \" pulumi-lang-go=\" effectiveNodeCount \" pulumi-lang-python=\" effective_node_count \" pulumi-lang-yaml=\" effectiveNodeCount \" pulumi-lang-java=\" effectiveNodeCount \" pulumi-lang-hcl=\" effective_node_count \"\u003e effectiveNodeCount \u003c/span\u003efor the output\n" }, "parentInstanceRef": { "$ref": "#/types/databricks:index/DatabaseInstanceParentInstanceRef:DatabaseInstanceParentInstanceRef", "description": "The ref of the parent instance. This is only available if the instance is\nchild instance.\nInput: For specifying the parent instance to create a child instance. Optional.\nOutput: Only populated if provided as input to create a child instance\n" }, "pgVersion": { "type": "string", "description": "(string) - The version of Postgres running on the instance\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseInstanceProviderConfig:DatabaseInstanceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "purgeOnDelete": { "type": "boolean", "description": "Deprecated. Omitting the field or setting it to true will result in the field being hard deleted. Setting a value\nof false will throw a bad request\n" }, "readOnlyDns": { "type": "string", "description": "(string) - The DNS endpoint to connect to the instance for read only access. This is only available if\u003cspan pulumi-lang-nodejs=\"\nenableReadableSecondaries \" pulumi-lang-dotnet=\"\nEnableReadableSecondaries \" pulumi-lang-go=\"\nenableReadableSecondaries \" pulumi-lang-python=\"\nenable_readable_secondaries \" pulumi-lang-yaml=\"\nenableReadableSecondaries \" pulumi-lang-java=\"\nenableReadableSecondaries \" pulumi-lang-hcl=\"\nenable_readable_secondaries \"\u003e\nenableReadableSecondaries \u003c/span\u003eis true\n" }, "readWriteDns": { "type": "string", "description": "(string) - The DNS endpoint to connect to the instance for read+write access\n" }, "retentionWindowInDays": { "type": "integer", "description": "The retention window for the instance. This is the time window in days\nfor which the historical data is retained. The default value is 7 days.\nValid values are 2 to 35 days\n" }, "state": { "type": "string", "description": "(string) - The current state of the instance. Possible values are: `AVAILABLE`, `DELETING`, `FAILING_OVER`, `STARTING`, `STOPPED`, `UPDATING`\n" }, "stopped": { "type": "boolean", "description": "Whether to stop the instance. An input only param, see\u003cspan pulumi-lang-nodejs=\" effectiveStopped \" pulumi-lang-dotnet=\" EffectiveStopped \" pulumi-lang-go=\" effectiveStopped \" pulumi-lang-python=\" effective_stopped \" pulumi-lang-yaml=\" effectiveStopped \" pulumi-lang-java=\" effectiveStopped \" pulumi-lang-hcl=\" effective_stopped \"\u003e effectiveStopped \u003c/span\u003efor the output\n" }, "uid": { "type": "string", "description": "(string) - Id of the ref database instance\n" }, "usagePolicyId": { "type": "string", "description": "The desired usage policy to associate with the instance\n" } }, "type": "object" } }, "databricks:index/databaseSyncedDatabaseTable:DatabaseSyncedDatabaseTable": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/database)\n\nLakebase Synced Database Tables are Postgres tables automatically synced from a source table inside Unity Catalog.\nThey can be used to serve realtime queries without the operational overhead of managing ETL pipelines. \n\nSynced Database Tables can be configured inside either Database Catalogs or Standard Catalogs. Multiple\nSynced Database Tables can be bin packed inside a single pipeline to optimize costs.\n\n## Example Usage\n\n### Creating a Synced Database Table inside a Database Catalog\n\nThis example creates a Synced Database Table inside a Database Catalog.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseSyncedDatabaseTable(\"this\", {\n name: \"my_database_catalog.public.synced_table\",\n logicalDatabaseName: \"databricks_postgres\",\n spec: {\n schedulingPolicy: \"SNAPSHOT\",\n sourceTableFullName: \"source_delta.tpch.customer\",\n primaryKeyColumns: [\"c_custkey\"],\n createDatabaseObjectsIfMissing: true,\n newPipelineSpec: {\n storageCatalog: \"source_delta\",\n storageSchema: \"tpch\",\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseSyncedDatabaseTable(\"this\",\n name=\"my_database_catalog.public.synced_table\",\n logical_database_name=\"databricks_postgres\",\n spec={\n \"scheduling_policy\": \"SNAPSHOT\",\n \"source_table_full_name\": \"source_delta.tpch.customer\",\n \"primary_key_columns\": [\"c_custkey\"],\n \"create_database_objects_if_missing\": True,\n \"new_pipeline_spec\": {\n \"storage_catalog\": \"source_delta\",\n \"storage_schema\": \"tpch\",\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseSyncedDatabaseTable(\"this\", new()\n {\n Name = \"my_database_catalog.public.synced_table\",\n LogicalDatabaseName = \"databricks_postgres\",\n Spec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecArgs\n {\n SchedulingPolicy = \"SNAPSHOT\",\n SourceTableFullName = \"source_delta.tpch.customer\",\n PrimaryKeyColumns = new[]\n {\n \"c_custkey\",\n },\n CreateDatabaseObjectsIfMissing = true,\n NewPipelineSpec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs\n {\n StorageCatalog = \"source_delta\",\n StorageSchema = \"tpch\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseSyncedDatabaseTable(ctx, \"this\", \u0026databricks.DatabaseSyncedDatabaseTableArgs{\n\t\t\tName: pulumi.String(\"my_database_catalog.public.synced_table\"),\n\t\t\tLogicalDatabaseName: pulumi.String(\"databricks_postgres\"),\n\t\t\tSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecArgs{\n\t\t\t\tSchedulingPolicy: pulumi.String(\"SNAPSHOT\"),\n\t\t\t\tSourceTableFullName: pulumi.String(\"source_delta.tpch.customer\"),\n\t\t\t\tPrimaryKeyColumns: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"c_custkey\"),\n\t\t\t\t},\n\t\t\t\tCreateDatabaseObjectsIfMissing: pulumi.Bool(true),\n\t\t\t\tNewPipelineSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs{\n\t\t\t\t\tStorageCatalog: pulumi.String(\"source_delta\"),\n\t\t\t\t\tStorageSchema: pulumi.String(\"tpch\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databasesynceddatabasetable\" \"this\" {\n name = \"my_database_catalog.public.synced_table\"\n logical_database_name = \"databricks_postgres\"\n spec = {\n scheduling_policy = \"SNAPSHOT\"\n source_table_full_name = \"source_delta.tpch.customer\"\n primary_key_columns = [\"c_custkey\"]\n create_database_objects_if_missing = true\n new_pipeline_spec = {\n storage_catalog = \"source_delta\"\n storage_schema = \"tpch\"\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTable;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTableArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseSyncedDatabaseTable(\"this\", DatabaseSyncedDatabaseTableArgs.builder()\n .name(\"my_database_catalog.public.synced_table\")\n .logicalDatabaseName(\"databricks_postgres\")\n .spec(DatabaseSyncedDatabaseTableSpecArgs.builder()\n .schedulingPolicy(\"SNAPSHOT\")\n .sourceTableFullName(\"source_delta.tpch.customer\")\n .primaryKeyColumns(\"c_custkey\")\n .createDatabaseObjectsIfMissing(true)\n .newPipelineSpec(DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs.builder()\n .storageCatalog(\"source_delta\")\n .storageSchema(\"tpch\")\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseSyncedDatabaseTable\n properties:\n name: my_database_catalog.public.synced_table\n logicalDatabaseName: databricks_postgres\n spec:\n schedulingPolicy: SNAPSHOT\n sourceTableFullName: source_delta.tpch.customer\n primaryKeyColumns:\n - c_custkey\n createDatabaseObjectsIfMissing: true\n newPipelineSpec:\n storageCatalog: source_delta\n storageSchema: tpch\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Creating a Synced Database Table inside a Standard Catalog\n\nThis example creates a Synced Database Table inside a Standard Catalog.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DatabaseSyncedDatabaseTable(\"this\", {\n name: \"my_standard_catalog.public.synced_table\",\n logicalDatabaseName: \"databricks_postgres\",\n databaseInstanceName: \"my-database-instance\",\n spec: {\n schedulingPolicy: \"SNAPSHOT\",\n sourceTableFullName: \"source_delta.tpch.customer\",\n primaryKeyColumns: [\"c_custkey\"],\n createDatabaseObjectsIfMissing: true,\n newPipelineSpec: {\n storageCatalog: \"source_delta\",\n storageSchema: \"tpch\",\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DatabaseSyncedDatabaseTable(\"this\",\n name=\"my_standard_catalog.public.synced_table\",\n logical_database_name=\"databricks_postgres\",\n database_instance_name=\"my-database-instance\",\n spec={\n \"scheduling_policy\": \"SNAPSHOT\",\n \"source_table_full_name\": \"source_delta.tpch.customer\",\n \"primary_key_columns\": [\"c_custkey\"],\n \"create_database_objects_if_missing\": True,\n \"new_pipeline_spec\": {\n \"storage_catalog\": \"source_delta\",\n \"storage_schema\": \"tpch\",\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DatabaseSyncedDatabaseTable(\"this\", new()\n {\n Name = \"my_standard_catalog.public.synced_table\",\n LogicalDatabaseName = \"databricks_postgres\",\n DatabaseInstanceName = \"my-database-instance\",\n Spec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecArgs\n {\n SchedulingPolicy = \"SNAPSHOT\",\n SourceTableFullName = \"source_delta.tpch.customer\",\n PrimaryKeyColumns = new[]\n {\n \"c_custkey\",\n },\n CreateDatabaseObjectsIfMissing = true,\n NewPipelineSpec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs\n {\n StorageCatalog = \"source_delta\",\n StorageSchema = \"tpch\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDatabaseSyncedDatabaseTable(ctx, \"this\", \u0026databricks.DatabaseSyncedDatabaseTableArgs{\n\t\t\tName: pulumi.String(\"my_standard_catalog.public.synced_table\"),\n\t\t\tLogicalDatabaseName: pulumi.String(\"databricks_postgres\"),\n\t\t\tDatabaseInstanceName: pulumi.String(\"my-database-instance\"),\n\t\t\tSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecArgs{\n\t\t\t\tSchedulingPolicy: pulumi.String(\"SNAPSHOT\"),\n\t\t\t\tSourceTableFullName: pulumi.String(\"source_delta.tpch.customer\"),\n\t\t\t\tPrimaryKeyColumns: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"c_custkey\"),\n\t\t\t\t},\n\t\t\t\tCreateDatabaseObjectsIfMissing: pulumi.Bool(true),\n\t\t\t\tNewPipelineSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs{\n\t\t\t\t\tStorageCatalog: pulumi.String(\"source_delta\"),\n\t\t\t\t\tStorageSchema: pulumi.String(\"tpch\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databasesynceddatabasetable\" \"this\" {\n name = \"my_standard_catalog.public.synced_table\"\n logical_database_name = \"databricks_postgres\"\n database_instance_name = \"my-database-instance\"\n spec = {\n scheduling_policy = \"SNAPSHOT\"\n source_table_full_name = \"source_delta.tpch.customer\"\n primary_key_columns = [\"c_custkey\"]\n create_database_objects_if_missing = true\n new_pipeline_spec = {\n storage_catalog = \"source_delta\"\n storage_schema = \"tpch\"\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTable;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTableArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DatabaseSyncedDatabaseTable(\"this\", DatabaseSyncedDatabaseTableArgs.builder()\n .name(\"my_standard_catalog.public.synced_table\")\n .logicalDatabaseName(\"databricks_postgres\")\n .databaseInstanceName(\"my-database-instance\")\n .spec(DatabaseSyncedDatabaseTableSpecArgs.builder()\n .schedulingPolicy(\"SNAPSHOT\")\n .sourceTableFullName(\"source_delta.tpch.customer\")\n .primaryKeyColumns(\"c_custkey\")\n .createDatabaseObjectsIfMissing(true)\n .newPipelineSpec(DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs.builder()\n .storageCatalog(\"source_delta\")\n .storageSchema(\"tpch\")\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DatabaseSyncedDatabaseTable\n properties:\n name: my_standard_catalog.public.synced_table\n logicalDatabaseName: databricks_postgres\n databaseInstanceName: my-database-instance\n spec:\n schedulingPolicy: SNAPSHOT\n sourceTableFullName: source_delta.tpch.customer\n primaryKeyColumns:\n - c_custkey\n createDatabaseObjectsIfMissing: true\n newPipelineSpec:\n storageCatalog: source_delta\n storageSchema: tpch\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Creating multiple Synced Database Tables and bin packing them into a single pipeline\n\nThis example creates two Synced Database Tables. The first one specifies a new pipeline spec,\nwhich generates a new pipeline. The second one utilizes the pipeline ID of the first table.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst instance = new databricks.DatabaseInstance(\"instance\", {\n name: \"my-database-instance\",\n capacity: \"CU_1\",\n});\nconst syncedTable1 = new databricks.DatabaseSyncedDatabaseTable(\"synced_table_1\", {\n name: \"my_standard_catalog.public.synced_table1\",\n logicalDatabaseName: \"databricks_postgres\",\n databaseInstanceName: instance.name,\n spec: {\n schedulingPolicy: \"SNAPSHOT\",\n sourceTableFullName: \"source_delta.tpch.customer\",\n primaryKeyColumns: [\"c_custkey\"],\n createDatabaseObjectsIfMissing: true,\n newPipelineSpec: {\n storageCatalog: \"source_delta\",\n storageSchema: \"tpch\",\n },\n },\n});\nconst syncedTable2 = new databricks.DatabaseSyncedDatabaseTable(\"synced_table_2\", {\n name: \"my_standard_catalog.public.synced_table2\",\n logicalDatabaseName: \"databricks_postgres\",\n databaseInstanceName: instance.name,\n spec: {\n schedulingPolicy: \"SNAPSHOT\",\n sourceTableFullName: \"source_delta.tpch.customer\",\n primaryKeyColumns: [\"c_custkey\"],\n createDatabaseObjectsIfMissing: true,\n existingPipelineId: syncedTable1.dataSynchronizationStatus.apply(dataSynchronizationStatus =\u003e dataSynchronizationStatus.pipelineId),\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ninstance = databricks.DatabaseInstance(\"instance\",\n name=\"my-database-instance\",\n capacity=\"CU_1\")\nsynced_table1 = databricks.DatabaseSyncedDatabaseTable(\"synced_table_1\",\n name=\"my_standard_catalog.public.synced_table1\",\n logical_database_name=\"databricks_postgres\",\n database_instance_name=instance.name,\n spec={\n \"scheduling_policy\": \"SNAPSHOT\",\n \"source_table_full_name\": \"source_delta.tpch.customer\",\n \"primary_key_columns\": [\"c_custkey\"],\n \"create_database_objects_if_missing\": True,\n \"new_pipeline_spec\": {\n \"storage_catalog\": \"source_delta\",\n \"storage_schema\": \"tpch\",\n },\n })\nsynced_table2 = databricks.DatabaseSyncedDatabaseTable(\"synced_table_2\",\n name=\"my_standard_catalog.public.synced_table2\",\n logical_database_name=\"databricks_postgres\",\n database_instance_name=instance.name,\n spec={\n \"scheduling_policy\": \"SNAPSHOT\",\n \"source_table_full_name\": \"source_delta.tpch.customer\",\n \"primary_key_columns\": [\"c_custkey\"],\n \"create_database_objects_if_missing\": True,\n \"existing_pipeline_id\": synced_table1.data_synchronization_status.pipeline_id,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var instance = new Databricks.DatabaseInstance(\"instance\", new()\n {\n Name = \"my-database-instance\",\n Capacity = \"CU_1\",\n });\n\n var syncedTable1 = new Databricks.DatabaseSyncedDatabaseTable(\"synced_table_1\", new()\n {\n Name = \"my_standard_catalog.public.synced_table1\",\n LogicalDatabaseName = \"databricks_postgres\",\n DatabaseInstanceName = instance.Name,\n Spec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecArgs\n {\n SchedulingPolicy = \"SNAPSHOT\",\n SourceTableFullName = \"source_delta.tpch.customer\",\n PrimaryKeyColumns = new[]\n {\n \"c_custkey\",\n },\n CreateDatabaseObjectsIfMissing = true,\n NewPipelineSpec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs\n {\n StorageCatalog = \"source_delta\",\n StorageSchema = \"tpch\",\n },\n },\n });\n\n var syncedTable2 = new Databricks.DatabaseSyncedDatabaseTable(\"synced_table_2\", new()\n {\n Name = \"my_standard_catalog.public.synced_table2\",\n LogicalDatabaseName = \"databricks_postgres\",\n DatabaseInstanceName = instance.Name,\n Spec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecArgs\n {\n SchedulingPolicy = \"SNAPSHOT\",\n SourceTableFullName = \"source_delta.tpch.customer\",\n PrimaryKeyColumns = new[]\n {\n \"c_custkey\",\n },\n CreateDatabaseObjectsIfMissing = true,\n ExistingPipelineId = syncedTable1.DataSynchronizationStatus.Apply(dataSynchronizationStatus =\u003e dataSynchronizationStatus.PipelineId),\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinstance, err := databricks.NewDatabaseInstance(ctx, \"instance\", \u0026databricks.DatabaseInstanceArgs{\n\t\t\tName: pulumi.String(\"my-database-instance\"),\n\t\t\tCapacity: pulumi.String(\"CU_1\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsyncedTable1, err := databricks.NewDatabaseSyncedDatabaseTable(ctx, \"synced_table_1\", \u0026databricks.DatabaseSyncedDatabaseTableArgs{\n\t\t\tName: pulumi.String(\"my_standard_catalog.public.synced_table1\"),\n\t\t\tLogicalDatabaseName: pulumi.String(\"databricks_postgres\"),\n\t\t\tDatabaseInstanceName: instance.Name,\n\t\t\tSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecArgs{\n\t\t\t\tSchedulingPolicy: pulumi.String(\"SNAPSHOT\"),\n\t\t\t\tSourceTableFullName: pulumi.String(\"source_delta.tpch.customer\"),\n\t\t\t\tPrimaryKeyColumns: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"c_custkey\"),\n\t\t\t\t},\n\t\t\t\tCreateDatabaseObjectsIfMissing: pulumi.Bool(true),\n\t\t\t\tNewPipelineSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs{\n\t\t\t\t\tStorageCatalog: pulumi.String(\"source_delta\"),\n\t\t\t\t\tStorageSchema: pulumi.String(\"tpch\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewDatabaseSyncedDatabaseTable(ctx, \"synced_table_2\", \u0026databricks.DatabaseSyncedDatabaseTableArgs{\n\t\t\tName: pulumi.String(\"my_standard_catalog.public.synced_table2\"),\n\t\t\tLogicalDatabaseName: pulumi.String(\"databricks_postgres\"),\n\t\t\tDatabaseInstanceName: instance.Name,\n\t\t\tSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecArgs{\n\t\t\t\tSchedulingPolicy: pulumi.String(\"SNAPSHOT\"),\n\t\t\t\tSourceTableFullName: pulumi.String(\"source_delta.tpch.customer\"),\n\t\t\t\tPrimaryKeyColumns: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"c_custkey\"),\n\t\t\t\t},\n\t\t\t\tCreateDatabaseObjectsIfMissing: pulumi.Bool(true),\n\t\t\t\tExistingPipelineId: syncedTable1.DataSynchronizationStatus.ApplyT(func(dataSynchronizationStatus databricks.DatabaseSyncedDatabaseTableDataSynchronizationStatus) (*string, error) {\n\t\t\t\t\treturn \u0026dataSynchronizationStatus.PipelineId, nil\n\t\t\t\t}).(pulumi.StringPtrOutput),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databaseinstance\" \"instance\" {\n name = \"my-database-instance\"\n capacity = \"CU_1\"\n}\nresource \"databricks_databasesynceddatabasetable\" \"synced_table_1\" {\n name = \"my_standard_catalog.public.synced_table1\"\n logical_database_name = \"databricks_postgres\"\n database_instance_name = databricks_databaseinstance.instance.name\n spec = {\n scheduling_policy = \"SNAPSHOT\"\n source_table_full_name = \"source_delta.tpch.customer\"\n primary_key_columns = [\"c_custkey\"]\n create_database_objects_if_missing = true\n new_pipeline_spec = {\n storage_catalog = \"source_delta\"\n storage_schema = \"tpch\"\n }\n }\n}\nresource \"databricks_databasesynceddatabasetable\" \"synced_table_2\" {\n name = \"my_standard_catalog.public.synced_table2\"\n logical_database_name = \"databricks_postgres\"\n database_instance_name = databricks_databaseinstance.instance.name\n spec = {\n scheduling_policy = \"SNAPSHOT\"\n source_table_full_name = \"source_delta.tpch.customer\"\n primary_key_columns = [\"c_custkey\"]\n create_database_objects_if_missing = true\n existing_pipeline_id = databricks_databasesynceddatabasetable.synced_table_1.data_synchronization_status.pipeline_id\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseInstance;\nimport com.pulumi.databricks.DatabaseInstanceArgs;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTable;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTableArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var instance = new DatabaseInstance(\"instance\", DatabaseInstanceArgs.builder()\n .name(\"my-database-instance\")\n .capacity(\"CU_1\")\n .build());\n\n var syncedTable1 = new DatabaseSyncedDatabaseTable(\"syncedTable1\", DatabaseSyncedDatabaseTableArgs.builder()\n .name(\"my_standard_catalog.public.synced_table1\")\n .logicalDatabaseName(\"databricks_postgres\")\n .databaseInstanceName(instance.name())\n .spec(DatabaseSyncedDatabaseTableSpecArgs.builder()\n .schedulingPolicy(\"SNAPSHOT\")\n .sourceTableFullName(\"source_delta.tpch.customer\")\n .primaryKeyColumns(\"c_custkey\")\n .createDatabaseObjectsIfMissing(true)\n .newPipelineSpec(DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs.builder()\n .storageCatalog(\"source_delta\")\n .storageSchema(\"tpch\")\n .build())\n .build())\n .build());\n\n var syncedTable2 = new DatabaseSyncedDatabaseTable(\"syncedTable2\", DatabaseSyncedDatabaseTableArgs.builder()\n .name(\"my_standard_catalog.public.synced_table2\")\n .logicalDatabaseName(\"databricks_postgres\")\n .databaseInstanceName(instance.name())\n .spec(DatabaseSyncedDatabaseTableSpecArgs.builder()\n .schedulingPolicy(\"SNAPSHOT\")\n .sourceTableFullName(\"source_delta.tpch.customer\")\n .primaryKeyColumns(\"c_custkey\")\n .createDatabaseObjectsIfMissing(true)\n .existingPipelineId(syncedTable1.dataSynchronizationStatus().applyValue(_dataSynchronizationStatus -\u003e _dataSynchronizationStatus.pipelineId()))\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instance:\n type: databricks:DatabaseInstance\n properties:\n name: my-database-instance\n capacity: CU_1\n syncedTable1:\n type: databricks:DatabaseSyncedDatabaseTable\n name: synced_table_1\n properties:\n name: my_standard_catalog.public.synced_table1\n logicalDatabaseName: databricks_postgres\n databaseInstanceName: ${instance.name}\n spec:\n schedulingPolicy: SNAPSHOT\n sourceTableFullName: source_delta.tpch.customer\n primaryKeyColumns:\n - c_custkey\n createDatabaseObjectsIfMissing: true\n newPipelineSpec:\n storageCatalog: source_delta\n storageSchema: tpch\n syncedTable2:\n type: databricks:DatabaseSyncedDatabaseTable\n name: synced_table_2\n properties:\n name: my_standard_catalog.public.synced_table2\n logicalDatabaseName: databricks_postgres\n databaseInstanceName: ${instance.name}\n spec:\n schedulingPolicy: SNAPSHOT\n sourceTableFullName: source_delta.tpch.customer\n primaryKeyColumns:\n - c_custkey\n createDatabaseObjectsIfMissing: true\n existingPipelineId: ${syncedTable1.dataSynchronizationStatus.pipelineId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Creating a Synced Database Table with a custom Jobs schedule\n\nThis example creates a Synced Database Table and customizes the pipeline schedule. It assumes you already have \n\n- A database instance named `\"my-database-instance\"`\n- A standard catalog named `\u003cspan pulumi-lang-nodejs=\"\"myStandardCatalog\"\" pulumi-lang-dotnet=\"\"MyStandardCatalog\"\" pulumi-lang-go=\"\"myStandardCatalog\"\" pulumi-lang-python=\"\"my_standard_catalog\"\" pulumi-lang-yaml=\"\"myStandardCatalog\"\" pulumi-lang-java=\"\"myStandardCatalog\"\" pulumi-lang-hcl=\"\"my_standard_catalog\"\"\u003e\"myStandardCatalog\"\u003c/span\u003e`\n- A schema in the standard catalog named `\"default\"`\n- A source delta table named `\"source_delta.schema.customer\"` with the primary key `\u003cspan pulumi-lang-nodejs=\"\"cCustkey\"\" pulumi-lang-dotnet=\"\"CCustkey\"\" pulumi-lang-go=\"\"cCustkey\"\" pulumi-lang-python=\"\"c_custkey\"\" pulumi-lang-yaml=\"\"cCustkey\"\" pulumi-lang-java=\"\"cCustkey\"\" pulumi-lang-hcl=\"\"c_custkey\"\"\u003e\"cCustkey\"\u003c/span\u003e`\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst syncedTable = new databricks.DatabaseSyncedDatabaseTable(\"synced_table\", {\n name: \"my_standard_catalog.default.my_synced_table\",\n logicalDatabaseName: \"terraform_test_db\",\n databaseInstanceName: \"my-database-instance\",\n spec: {\n schedulingPolicy: \"SNAPSHOT\",\n sourceTableFullName: \"source_delta.schema.customer\",\n primaryKeyColumns: [\"c_custkey\"],\n createDatabaseObjectsIfMissing: true,\n newPipelineSpec: {\n storageCatalog: \"source_delta\",\n storageSchema: \"schema\",\n },\n },\n});\nconst syncPipelineScheduleJob = new databricks.Job(\"sync_pipeline_schedule_job\", {\n name: \"Synced Pipeline Refresh\",\n description: \"Job to schedule synced database table pipeline. \",\n tasks: [{\n taskKey: \"synced-table-pipeline\",\n pipelineTask: {\n pipelineId: syncedTable.dataSynchronizationStatus.apply(dataSynchronizationStatus =\u003e dataSynchronizationStatus.pipelineId),\n },\n }],\n schedule: {\n quartzCronExpression: \"0 0 0 * * ?\",\n timezoneId: \"Europe/Helsinki\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsynced_table = databricks.DatabaseSyncedDatabaseTable(\"synced_table\",\n name=\"my_standard_catalog.default.my_synced_table\",\n logical_database_name=\"terraform_test_db\",\n database_instance_name=\"my-database-instance\",\n spec={\n \"scheduling_policy\": \"SNAPSHOT\",\n \"source_table_full_name\": \"source_delta.schema.customer\",\n \"primary_key_columns\": [\"c_custkey\"],\n \"create_database_objects_if_missing\": True,\n \"new_pipeline_spec\": {\n \"storage_catalog\": \"source_delta\",\n \"storage_schema\": \"schema\",\n },\n })\nsync_pipeline_schedule_job = databricks.Job(\"sync_pipeline_schedule_job\",\n name=\"Synced Pipeline Refresh\",\n description=\"Job to schedule synced database table pipeline. \",\n tasks=[{\n \"task_key\": \"synced-table-pipeline\",\n \"pipeline_task\": {\n \"pipeline_id\": synced_table.data_synchronization_status.pipeline_id,\n },\n }],\n schedule={\n \"quartz_cron_expression\": \"0 0 0 * * ?\",\n \"timezone_id\": \"Europe/Helsinki\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var syncedTable = new Databricks.DatabaseSyncedDatabaseTable(\"synced_table\", new()\n {\n Name = \"my_standard_catalog.default.my_synced_table\",\n LogicalDatabaseName = \"terraform_test_db\",\n DatabaseInstanceName = \"my-database-instance\",\n Spec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecArgs\n {\n SchedulingPolicy = \"SNAPSHOT\",\n SourceTableFullName = \"source_delta.schema.customer\",\n PrimaryKeyColumns = new[]\n {\n \"c_custkey\",\n },\n CreateDatabaseObjectsIfMissing = true,\n NewPipelineSpec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs\n {\n StorageCatalog = \"source_delta\",\n StorageSchema = \"schema\",\n },\n },\n });\n\n var syncPipelineScheduleJob = new Databricks.Job(\"sync_pipeline_schedule_job\", new()\n {\n Name = \"Synced Pipeline Refresh\",\n Description = \"Job to schedule synced database table pipeline. \",\n Tasks = new[]\n {\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"synced-table-pipeline\",\n PipelineTask = new Databricks.Inputs.JobTaskPipelineTaskArgs\n {\n PipelineId = syncedTable.DataSynchronizationStatus.Apply(dataSynchronizationStatus =\u003e dataSynchronizationStatus.PipelineId),\n },\n },\n },\n Schedule = new Databricks.Inputs.JobScheduleArgs\n {\n QuartzCronExpression = \"0 0 0 * * ?\",\n TimezoneId = \"Europe/Helsinki\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsyncedTable, err := databricks.NewDatabaseSyncedDatabaseTable(ctx, \"synced_table\", \u0026databricks.DatabaseSyncedDatabaseTableArgs{\n\t\t\tName: pulumi.String(\"my_standard_catalog.default.my_synced_table\"),\n\t\t\tLogicalDatabaseName: pulumi.String(\"terraform_test_db\"),\n\t\t\tDatabaseInstanceName: pulumi.String(\"my-database-instance\"),\n\t\t\tSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecArgs{\n\t\t\t\tSchedulingPolicy: pulumi.String(\"SNAPSHOT\"),\n\t\t\t\tSourceTableFullName: pulumi.String(\"source_delta.schema.customer\"),\n\t\t\t\tPrimaryKeyColumns: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"c_custkey\"),\n\t\t\t\t},\n\t\t\t\tCreateDatabaseObjectsIfMissing: pulumi.Bool(true),\n\t\t\t\tNewPipelineSpec: \u0026databricks.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs{\n\t\t\t\t\tStorageCatalog: pulumi.String(\"source_delta\"),\n\t\t\t\t\tStorageSchema: pulumi.String(\"schema\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewJob(ctx, \"sync_pipeline_schedule_job\", \u0026databricks.JobArgs{\n\t\t\tName: pulumi.String(\"Synced Pipeline Refresh\"),\n\t\t\tDescription: pulumi.String(\"Job to schedule synced database table pipeline. \"),\n\t\t\tTasks: databricks.JobTaskArray{\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"synced-table-pipeline\"),\n\t\t\t\t\tPipelineTask: \u0026databricks.JobTaskPipelineTaskArgs{\n\t\t\t\t\t\tPipelineId: syncedTable.DataSynchronizationStatus.ApplyT(func(dataSynchronizationStatus databricks.DatabaseSyncedDatabaseTableDataSynchronizationStatus) (*string, error) {\n\t\t\t\t\t\t\treturn \u0026dataSynchronizationStatus.PipelineId, nil\n\t\t\t\t\t\t}).(pulumi.StringPtrOutput),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tSchedule: \u0026databricks.JobScheduleArgs{\n\t\t\t\tQuartzCronExpression: pulumi.String(\"0 0 0 * * ?\"),\n\t\t\t\tTimezoneId: pulumi.String(\"Europe/Helsinki\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_databasesynceddatabasetable\" \"synced_table\" {\n name = \"my_standard_catalog.default.my_synced_table\"\n logical_database_name = \"terraform_test_db\"\n database_instance_name = \"my-database-instance\"\n spec = {\n scheduling_policy = \"SNAPSHOT\"\n source_table_full_name = \"source_delta.schema.customer\"\n primary_key_columns = [\"c_custkey\"]\n create_database_objects_if_missing = true\n new_pipeline_spec = {\n storage_catalog = \"source_delta\"\n storage_schema = \"schema\"\n }\n }\n}\nresource \"databricks_job\" \"sync_pipeline_schedule_job\" {\n name = \"Synced Pipeline Refresh\"\n description = \"Job to schedule synced database table pipeline. \"\n tasks {\n task_key = \"synced-table-pipeline\"\n pipeline_task = {\n pipeline_id = databricks_databasesynceddatabasetable.synced_table.data_synchronization_status.pipeline_id\n }\n }\n schedule = {\n quartz_cron_expression = \"0 0 0 * * ?\"\n timezone_id = \"Europe/Helsinki\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTable;\nimport com.pulumi.databricks.DatabaseSyncedDatabaseTableArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecArgs;\nimport com.pulumi.databricks.inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs;\nimport com.pulumi.databricks.Job;\nimport com.pulumi.databricks.JobArgs;\nimport com.pulumi.databricks.inputs.JobTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskPipelineTaskArgs;\nimport com.pulumi.databricks.inputs.JobScheduleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var syncedTable = new DatabaseSyncedDatabaseTable(\"syncedTable\", DatabaseSyncedDatabaseTableArgs.builder()\n .name(\"my_standard_catalog.default.my_synced_table\")\n .logicalDatabaseName(\"terraform_test_db\")\n .databaseInstanceName(\"my-database-instance\")\n .spec(DatabaseSyncedDatabaseTableSpecArgs.builder()\n .schedulingPolicy(\"SNAPSHOT\")\n .sourceTableFullName(\"source_delta.schema.customer\")\n .primaryKeyColumns(\"c_custkey\")\n .createDatabaseObjectsIfMissing(true)\n .newPipelineSpec(DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs.builder()\n .storageCatalog(\"source_delta\")\n .storageSchema(\"schema\")\n .build())\n .build())\n .build());\n\n var syncPipelineScheduleJob = new Job(\"syncPipelineScheduleJob\", JobArgs.builder()\n .name(\"Synced Pipeline Refresh\")\n .description(\"Job to schedule synced database table pipeline. \")\n .tasks(JobTaskArgs.builder()\n .taskKey(\"synced-table-pipeline\")\n .pipelineTask(JobTaskPipelineTaskArgs.builder()\n .pipelineId(syncedTable.dataSynchronizationStatus().applyValue(_dataSynchronizationStatus -\u003e _dataSynchronizationStatus.pipelineId()))\n .build())\n .build())\n .schedule(JobScheduleArgs.builder()\n .quartzCronExpression(\"0 0 0 * * ?\")\n .timezoneId(\"Europe/Helsinki\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n syncedTable:\n type: databricks:DatabaseSyncedDatabaseTable\n name: synced_table\n properties:\n name: my_standard_catalog.default.my_synced_table\n logicalDatabaseName: terraform_test_db\n databaseInstanceName: my-database-instance\n spec:\n schedulingPolicy: SNAPSHOT\n sourceTableFullName: source_delta.schema.customer\n primaryKeyColumns:\n - c_custkey\n createDatabaseObjectsIfMissing: true\n newPipelineSpec:\n storageCatalog: source_delta\n storageSchema: schema\n syncPipelineScheduleJob:\n type: databricks:Job\n name: sync_pipeline_schedule_job\n properties:\n name: Synced Pipeline Refresh\n description: 'Job to schedule synced database table pipeline. '\n tasks:\n - taskKey: synced-table-pipeline\n pipelineTask:\n pipelineId: ${syncedTable.dataSynchronizationStatus.pipelineId}\n schedule:\n quartzCronExpression: 0 0 0 * * ?\n timezoneId: Europe/Helsinki\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "dataSynchronizationStatus": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatus", "description": "(SyncedTableStatus) - Synced Table data synchronization status\n" }, "databaseInstanceName": { "type": "string", "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected)\n" }, "effectiveDatabaseInstanceName": { "type": "string", "description": "(string) - The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveLogicalDatabaseName": { "type": "string", "description": "(string) - The name of the logical database that this table is registered to.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "logicalDatabaseName": { "type": "string", "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the \u003cspan pulumi-lang-nodejs=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-dotnet=\"`CreateDatabaseObjectsIsMissing`\" pulumi-lang-go=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-python=\"`create_database_objects_is_missing`\" pulumi-lang-yaml=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-java=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-hcl=\"`create_database_objects_is_missing`\"\u003e`createDatabaseObjectsIsMissing`\u003c/span\u003e field in \u003cspan pulumi-lang-nodejs=\"`spec`\" pulumi-lang-dotnet=\"`Spec`\" pulumi-lang-go=\"`spec`\" pulumi-lang-python=\"`spec`\" pulumi-lang-yaml=\"`spec`\" pulumi-lang-java=\"`spec`\" pulumi-lang-hcl=\"`spec`\"\u003e`spec`\u003c/span\u003e\n" }, "name": { "type": "string", "description": "Full three-part (catalog, schema, table) name of the table\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableProviderConfig:DatabaseSyncedDatabaseTableProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableSpec:DatabaseSyncedDatabaseTableSpec" }, "unityCatalogProvisioningState": { "type": "string", "description": "(string) - The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously). Possible values are: `ACTIVE`, `DEGRADED`, `DELETING`, `FAILED`, `PROVISIONING`, `UPDATING`\n" } }, "required": [ "dataSynchronizationStatus", "databaseInstanceName", "effectiveDatabaseInstanceName", "effectiveLogicalDatabaseName", "logicalDatabaseName", "name", "providerConfig", "unityCatalogProvisioningState" ], "inputProperties": { "databaseInstanceName": { "type": "string", "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected)\n" }, "logicalDatabaseName": { "type": "string", "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the \u003cspan pulumi-lang-nodejs=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-dotnet=\"`CreateDatabaseObjectsIsMissing`\" pulumi-lang-go=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-python=\"`create_database_objects_is_missing`\" pulumi-lang-yaml=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-java=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-hcl=\"`create_database_objects_is_missing`\"\u003e`createDatabaseObjectsIsMissing`\u003c/span\u003e field in \u003cspan pulumi-lang-nodejs=\"`spec`\" pulumi-lang-dotnet=\"`Spec`\" pulumi-lang-go=\"`spec`\" pulumi-lang-python=\"`spec`\" pulumi-lang-yaml=\"`spec`\" pulumi-lang-java=\"`spec`\" pulumi-lang-hcl=\"`spec`\"\u003e`spec`\u003c/span\u003e\n" }, "name": { "type": "string", "description": "Full three-part (catalog, schema, table) name of the table\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableProviderConfig:DatabaseSyncedDatabaseTableProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableSpec:DatabaseSyncedDatabaseTableSpec" } }, "stateInputs": { "description": "Input properties used for looking up and filtering DatabaseSyncedDatabaseTable resources.\n", "properties": { "dataSynchronizationStatus": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableDataSynchronizationStatus:DatabaseSyncedDatabaseTableDataSynchronizationStatus", "description": "(SyncedTableStatus) - Synced Table data synchronization status\n" }, "databaseInstanceName": { "type": "string", "description": "Name of the target database instance. This is required when creating synced database tables in standard catalogs.\nThis is optional when creating synced database tables in registered catalogs. If this field is specified\nwhen creating synced database tables in registered catalogs, the database instance name MUST\nmatch that of the registered catalog (or the request will be rejected)\n" }, "effectiveDatabaseInstanceName": { "type": "string", "description": "(string) - The name of the database instance that this table is registered to. This field is always returned, and for\ntables inside database catalogs is inferred database instance associated with the catalog.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "effectiveLogicalDatabaseName": { "type": "string", "description": "(string) - The name of the logical database that this table is registered to.\nThis is an output only field that contains the value computed from the input field combined with\nserver side defaults. Use the field without the effective_ prefix to set the value\n" }, "logicalDatabaseName": { "type": "string", "description": "Target Postgres database object (logical database) name for this table.\n\nWhen creating a synced table in a registered Postgres catalog, the\ntarget Postgres database name is inferred to be that of the registered catalog.\nIf this field is specified in this scenario, the Postgres database name MUST\nmatch that of the registered catalog (or the request will be rejected).\n\nWhen creating a synced table in a standard catalog, this field is required.\nIn this scenario, specifying this field will allow targeting an arbitrary postgres database.\nNote that this has implications for the \u003cspan pulumi-lang-nodejs=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-dotnet=\"`CreateDatabaseObjectsIsMissing`\" pulumi-lang-go=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-python=\"`create_database_objects_is_missing`\" pulumi-lang-yaml=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-java=\"`createDatabaseObjectsIsMissing`\" pulumi-lang-hcl=\"`create_database_objects_is_missing`\"\u003e`createDatabaseObjectsIsMissing`\u003c/span\u003e field in \u003cspan pulumi-lang-nodejs=\"`spec`\" pulumi-lang-dotnet=\"`Spec`\" pulumi-lang-go=\"`spec`\" pulumi-lang-python=\"`spec`\" pulumi-lang-yaml=\"`spec`\" pulumi-lang-java=\"`spec`\" pulumi-lang-hcl=\"`spec`\"\u003e`spec`\u003c/span\u003e\n" }, "name": { "type": "string", "description": "Full three-part (catalog, schema, table) name of the table\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableProviderConfig:DatabaseSyncedDatabaseTableProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "spec": { "$ref": "#/types/databricks:index/DatabaseSyncedDatabaseTableSpec:DatabaseSyncedDatabaseTableSpec" }, "unityCatalogProvisioningState": { "type": "string", "description": "(string) - The provisioning state of the synced table entity in Unity Catalog. This is distinct from the\nstate of the data synchronization pipeline (i.e. the table may be in \"ACTIVE\" but the pipeline\nmay be in \"PROVISIONING\" as it runs asynchronously). Possible values are: `ACTIVE`, `DEGRADED`, `DELETING`, `FAILED`, `PROVISIONING`, `UPDATING`\n" } }, "type": "object" } }, "databricks:index/dbfsFile:DbfsFile": { "description": "\u003e Please switch to\u003cspan pulumi-lang-nodejs=\" databricks.File \" pulumi-lang-dotnet=\" databricks.File \" pulumi-lang-go=\" File \" pulumi-lang-python=\" File \" pulumi-lang-yaml=\" databricks.File \" pulumi-lang-java=\" databricks.File \" pulumi-lang-hcl=\" databricks_file \"\u003e databricks.File \u003c/span\u003eor\u003cspan pulumi-lang-nodejs=\" databricks.WorkspaceFile \" pulumi-lang-dotnet=\" databricks.WorkspaceFile \" pulumi-lang-go=\" WorkspaceFile \" pulumi-lang-python=\" WorkspaceFile \" pulumi-lang-yaml=\" databricks.WorkspaceFile \" pulumi-lang-java=\" databricks.WorkspaceFile \" pulumi-lang-hcl=\" databricks_workspace_file \"\u003e databricks.WorkspaceFile \u003c/span\u003eto manage files. Databricks recommends against storing any production data or sensitive information in the DBFS root.\n\nThis is a resource that lets you manage relatively small files on [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html). The best use cases are libraries for\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eor databricks_job. You can also use\u003cspan pulumi-lang-nodejs=\" databricks.DbfsFile \" pulumi-lang-dotnet=\" databricks.DbfsFile \" pulumi-lang-go=\" DbfsFile \" pulumi-lang-python=\" DbfsFile \" pulumi-lang-yaml=\" databricks.DbfsFile \" pulumi-lang-java=\" databricks.DbfsFile \" pulumi-lang-hcl=\" databricks_dbfs_file \"\u003e databricks.DbfsFile \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" databricks.getDbfsFilePaths \" pulumi-lang-dotnet=\" databricks.getDbfsFilePaths \" pulumi-lang-go=\" getDbfsFilePaths \" pulumi-lang-python=\" get_dbfs_file_paths \" pulumi-lang-yaml=\" databricks.getDbfsFilePaths \" pulumi-lang-java=\" databricks.getDbfsFilePaths \" pulumi-lang-hcl=\" data.databricks_dbfs_file_paths \"\u003e databricks.getDbfsFilePaths \u003c/span\u003edata sources.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n", "properties": { "contentBase64": { "type": "string", "description": "Encoded file contents. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e. Use of \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances, like creating a data pipeline configuration file.\n" }, "dbfsPath": { "type": "string", "description": "Path, but with `dbfs:` prefix.\n" }, "fileSize": { "type": "integer", "description": "The file size of the file that is being tracked by this resource in bytes.\n" }, "md5": { "type": "string" }, "path": { "type": "string", "description": "The path of the file in which you wish to save.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DbfsFileProviderConfig:DbfsFileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "source": { "type": "string", "description": "The full absolute path to the file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e.\n" } }, "required": [ "dbfsPath", "fileSize", "path", "providerConfig" ], "inputProperties": { "contentBase64": { "type": "string", "description": "Encoded file contents. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e. Use of \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances, like creating a data pipeline configuration file.\n", "willReplaceOnChanges": true }, "md5": { "type": "string", "willReplaceOnChanges": true }, "path": { "type": "string", "description": "The path of the file in which you wish to save.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/DbfsFileProviderConfig:DbfsFileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "source": { "type": "string", "description": "The full absolute path to the file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e.\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "path" ], "stateInputs": { "description": "Input properties used for looking up and filtering DbfsFile resources.\n", "properties": { "contentBase64": { "type": "string", "description": "Encoded file contents. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e. Use of \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances, like creating a data pipeline configuration file.\n", "willReplaceOnChanges": true }, "dbfsPath": { "type": "string", "description": "Path, but with `dbfs:` prefix.\n" }, "fileSize": { "type": "integer", "description": "The file size of the file that is being tracked by this resource in bytes.\n" }, "md5": { "type": "string", "willReplaceOnChanges": true }, "path": { "type": "string", "description": "The path of the file in which you wish to save.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/DbfsFileProviderConfig:DbfsFileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "source": { "type": "string", "description": "The full absolute path to the file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e.\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/defaultNamespaceSetting:DefaultNamespaceSetting": { "description": "The \u003cspan pulumi-lang-nodejs=\"`databricks.DefaultNamespaceSetting`\" pulumi-lang-dotnet=\"`databricks.DefaultNamespaceSetting`\" pulumi-lang-go=\"`DefaultNamespaceSetting`\" pulumi-lang-python=\"`DefaultNamespaceSetting`\" pulumi-lang-yaml=\"`databricks.DefaultNamespaceSetting`\" pulumi-lang-java=\"`databricks.DefaultNamespaceSetting`\" pulumi-lang-hcl=\"`databricks_default_namespace_setting`\"\u003e`databricks.DefaultNamespaceSetting`\u003c/span\u003e resource allows you to operate the setting configuration for the default namespace in the Databricks workspace.\n\n\u003e This resource can only be used with a workspace-level provider!\n\nSetting the default catalog for the workspace determines the catalog that is used when queries do not reference\na fully qualified 3 level name. For example, if the default catalog is set to 'retail_prod' then a query\n'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable'\n(the schema 'default' is always assumed).\nThis setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DefaultNamespaceSetting(\"this\", {namespace: {\n value: \"namespace_value\",\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DefaultNamespaceSetting(\"this\", namespace={\n \"value\": \"namespace_value\",\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DefaultNamespaceSetting(\"this\", new()\n {\n Namespace = new Databricks.Inputs.DefaultNamespaceSettingNamespaceArgs\n {\n Value = \"namespace_value\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDefaultNamespaceSetting(ctx, \"this\", \u0026databricks.DefaultNamespaceSettingArgs{\n\t\t\tNamespace: \u0026databricks.DefaultNamespaceSettingNamespaceArgs{\n\t\t\t\tValue: pulumi.String(\"namespace_value\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_defaultnamespacesetting\" \"this\" {\n namespace = {\n value = \"namespace_value\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DefaultNamespaceSetting;\nimport com.pulumi.databricks.DefaultNamespaceSettingArgs;\nimport com.pulumi.databricks.inputs.DefaultNamespaceSettingNamespaceArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DefaultNamespaceSetting(\"this\", DefaultNamespaceSettingArgs.builder()\n .namespace(DefaultNamespaceSettingNamespaceArgs.builder()\n .value(\"namespace_value\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DefaultNamespaceSetting\n properties:\n namespace:\n value: namespace_value\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "etag": { "type": "string" }, "namespace": { "$ref": "#/types/databricks:index/DefaultNamespaceSettingNamespace:DefaultNamespaceSettingNamespace", "description": "The configuration details.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DefaultNamespaceSettingProviderConfig:DefaultNamespaceSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "required": [ "etag", "namespace", "providerConfig", "settingName" ], "inputProperties": { "etag": { "type": "string" }, "namespace": { "$ref": "#/types/databricks:index/DefaultNamespaceSettingNamespace:DefaultNamespaceSettingNamespace", "description": "The configuration details.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DefaultNamespaceSettingProviderConfig:DefaultNamespaceSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "requiredInputs": [ "namespace" ], "stateInputs": { "description": "Input properties used for looking up and filtering DefaultNamespaceSetting resources.\n", "properties": { "etag": { "type": "string" }, "namespace": { "$ref": "#/types/databricks:index/DefaultNamespaceSettingNamespace:DefaultNamespaceSettingNamespace", "description": "The configuration details.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DefaultNamespaceSettingProviderConfig:DefaultNamespaceSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/directory:Directory": { "description": "This resource allows you to manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\nYou can declare a Pulumi-managed directory by specifying the \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e attribute of the corresponding directory.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst myCustomDirectory = new databricks.Directory(\"my_custom_directory\", {path: \"/my_custom_directory\"});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nmy_custom_directory = databricks.Directory(\"my_custom_directory\", path=\"/my_custom_directory\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myCustomDirectory = new Databricks.Directory(\"my_custom_directory\", new()\n {\n Path = \"/my_custom_directory\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDirectory(ctx, \"my_custom_directory\", \u0026databricks.DirectoryArgs{\n\t\t\tPath: pulumi.String(\"/my_custom_directory\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_directory\" \"my_custom_directory\" {\n path = \"/my_custom_directory\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Directory;\nimport com.pulumi.databricks.DirectoryArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var myCustomDirectory = new Directory(\"myCustomDirectory\", DirectoryArgs.builder()\n .path(\"/my_custom_directory\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myCustomDirectory:\n type: databricks:Directory\n name: my_custom_directory\n properties:\n path: /my_custom_directory\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n-\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can access folders.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n- End to end workspace management guide.\n-\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).\n-\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003edata to export a notebook from Databricks Workspace.\n-\u003cspan pulumi-lang-nodejs=\" databricks.getNotebookPaths \" pulumi-lang-dotnet=\" databricks.getNotebookPaths \" pulumi-lang-go=\" getNotebookPaths \" pulumi-lang-python=\" get_notebook_paths \" pulumi-lang-yaml=\" databricks.getNotebookPaths \" pulumi-lang-java=\" databricks.getNotebookPaths \" pulumi-lang-hcl=\" data.databricks_notebook_paths \"\u003e databricks.getNotebookPaths \u003c/span\u003edata to list notebooks in Databricks Workspace.\n-\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n-\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003edata to get [Databricks Runtime (DBR)](https://docs.databricks.com/runtime/dbr.html) version that could be used for \u003cspan pulumi-lang-nodejs=\"`sparkVersion`\" pulumi-lang-dotnet=\"`SparkVersion`\" pulumi-lang-go=\"`sparkVersion`\" pulumi-lang-python=\"`spark_version`\" pulumi-lang-yaml=\"`sparkVersion`\" pulumi-lang-java=\"`sparkVersion`\" pulumi-lang-hcl=\"`spark_version`\"\u003e`sparkVersion`\u003c/span\u003e parameter in\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand other resources.\n-\u003cspan pulumi-lang-nodejs=\" databricks.WorkspaceConf \" pulumi-lang-dotnet=\" databricks.WorkspaceConf \" pulumi-lang-go=\" WorkspaceConf \" pulumi-lang-python=\" WorkspaceConf \" pulumi-lang-yaml=\" databricks.WorkspaceConf \" pulumi-lang-java=\" databricks.WorkspaceConf \" pulumi-lang-hcl=\" databricks_workspace_conf \"\u003e databricks.WorkspaceConf \u003c/span\u003eto manage workspace configuration for expert usage.\n\n", "properties": { "deleteRecursive": { "type": "boolean", "description": "Whether or not to trigger a recursive delete of this directory and its resources when deleting this on Pulumi. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n" }, "objectId": { "type": "integer", "description": "Unique identifier for a DIRECTORY\n" }, "path": { "type": "string", "description": "The absolute path of the directory, beginning with \"/\", e.g. \"/Demo\".\n" }, "providerConfig": { "$ref": "#/types/databricks:index/DirectoryProviderConfig:DirectoryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "workspacePath": { "type": "string", "description": "path on Workspace File System (WSFS) in form of `/Workspace` + \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e\n" } }, "required": [ "objectId", "path", "providerConfig", "workspacePath" ], "inputProperties": { "deleteRecursive": { "type": "boolean", "description": "Whether or not to trigger a recursive delete of this directory and its resources when deleting this on Pulumi. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n" }, "objectId": { "type": "integer", "description": "Unique identifier for a DIRECTORY\n" }, "path": { "type": "string", "description": "The absolute path of the directory, beginning with \"/\", e.g. \"/Demo\".\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/DirectoryProviderConfig:DirectoryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "requiredInputs": [ "path" ], "stateInputs": { "description": "Input properties used for looking up and filtering Directory resources.\n", "properties": { "deleteRecursive": { "type": "boolean", "description": "Whether or not to trigger a recursive delete of this directory and its resources when deleting this on Pulumi. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n" }, "objectId": { "type": "integer", "description": "Unique identifier for a DIRECTORY\n" }, "path": { "type": "string", "description": "The absolute path of the directory, beginning with \"/\", e.g. \"/Demo\".\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/DirectoryProviderConfig:DirectoryProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "workspacePath": { "type": "string", "description": "path on Workspace File System (WSFS) in form of `/Workspace` + \u003cspan pulumi-lang-nodejs=\"`path`\" pulumi-lang-dotnet=\"`Path`\" pulumi-lang-go=\"`path`\" pulumi-lang-python=\"`path`\" pulumi-lang-yaml=\"`path`\" pulumi-lang-java=\"`path`\" pulumi-lang-hcl=\"`path`\"\u003e`path`\u003c/span\u003e\n" } }, "type": "object" } }, "databricks:index/disableLegacyAccessSetting:DisableLegacyAccessSetting": { "description": "The \u003cspan pulumi-lang-nodejs=\"`databricks.DisableLegacyAccessSetting`\" pulumi-lang-dotnet=\"`databricks.DisableLegacyAccessSetting`\" pulumi-lang-go=\"`DisableLegacyAccessSetting`\" pulumi-lang-python=\"`DisableLegacyAccessSetting`\" pulumi-lang-yaml=\"`databricks.DisableLegacyAccessSetting`\" pulumi-lang-java=\"`databricks.DisableLegacyAccessSetting`\" pulumi-lang-hcl=\"`databricks_disable_legacy_access_setting`\"\u003e`databricks.DisableLegacyAccessSetting`\u003c/span\u003e resource allows you to disable legacy access. It has the following impact:\n\n1. Disables direct access to Hive Metastores from the workspace. However, you can still access a Hive Metastore through Hive Metastore federation.\n2. Disables Fallback Mode on any External Location access from the workspace.\n3. Disables Databricks Runtime versions prior to 13.3LTS.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e It may take 5 minutes to take effect and requires a restart of clusters and SQL warehouses.\n\n\u003e Please also set the default namespace using\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003eto any value other than \u003cspan pulumi-lang-nodejs=\"`hiveMetastore`\" pulumi-lang-dotnet=\"`HiveMetastore`\" pulumi-lang-go=\"`hiveMetastore`\" pulumi-lang-python=\"`hive_metastore`\" pulumi-lang-yaml=\"`hiveMetastore`\" pulumi-lang-java=\"`hiveMetastore`\" pulumi-lang-hcl=\"`hive_metastore`\"\u003e`hiveMetastore`\u003c/span\u003e to avoid potential issues.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DisableLegacyAccessSetting(\"this\", {disableLegacyAccess: {\n value: true,\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DisableLegacyAccessSetting(\"this\", disable_legacy_access={\n \"value\": True,\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DisableLegacyAccessSetting(\"this\", new()\n {\n DisableLegacyAccess = new Databricks.Inputs.DisableLegacyAccessSettingDisableLegacyAccessArgs\n {\n Value = true,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDisableLegacyAccessSetting(ctx, \"this\", \u0026databricks.DisableLegacyAccessSettingArgs{\n\t\t\tDisableLegacyAccess: \u0026databricks.DisableLegacyAccessSettingDisableLegacyAccessArgs{\n\t\t\t\tValue: pulumi.Bool(true),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_disablelegacyaccesssetting\" \"this\" {\n disable_legacy_access = {\n value = true\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DisableLegacyAccessSetting;\nimport com.pulumi.databricks.DisableLegacyAccessSettingArgs;\nimport com.pulumi.databricks.inputs.DisableLegacyAccessSettingDisableLegacyAccessArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DisableLegacyAccessSetting(\"this\", DisableLegacyAccessSettingArgs.builder()\n .disableLegacyAccess(DisableLegacyAccessSettingDisableLegacyAccessArgs.builder()\n .value(true)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DisableLegacyAccessSetting\n properties:\n disableLegacyAccess:\n value: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Import\n\nThis resource can be imported by predefined name \u003cspan pulumi-lang-nodejs=\"`global`\" pulumi-lang-dotnet=\"`Global`\" pulumi-lang-go=\"`global`\" pulumi-lang-python=\"`global`\" pulumi-lang-yaml=\"`global`\" pulumi-lang-java=\"`global`\" pulumi-lang-hcl=\"`global`\"\u003e`global`\u003c/span\u003e:\n\n```sh\n$ pulumi import databricks:index/disableLegacyAccessSetting:DisableLegacyAccessSetting this global\n```\n\n", "properties": { "disableLegacyAccess": { "$ref": "#/types/databricks:index/DisableLegacyAccessSettingDisableLegacyAccess:DisableLegacyAccessSettingDisableLegacyAccess", "description": "The configuration details.\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyAccessSettingProviderConfig:DisableLegacyAccessSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "required": [ "disableLegacyAccess", "etag", "providerConfig", "settingName" ], "inputProperties": { "disableLegacyAccess": { "$ref": "#/types/databricks:index/DisableLegacyAccessSettingDisableLegacyAccess:DisableLegacyAccessSettingDisableLegacyAccess", "description": "The configuration details.\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyAccessSettingProviderConfig:DisableLegacyAccessSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "requiredInputs": [ "disableLegacyAccess" ], "stateInputs": { "description": "Input properties used for looking up and filtering DisableLegacyAccessSetting resources.\n", "properties": { "disableLegacyAccess": { "$ref": "#/types/databricks:index/DisableLegacyAccessSettingDisableLegacyAccess:DisableLegacyAccessSettingDisableLegacyAccess", "description": "The configuration details.\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyAccessSettingProviderConfig:DisableLegacyAccessSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/disableLegacyDbfsSetting:DisableLegacyDbfsSetting": { "description": "The \u003cspan pulumi-lang-nodejs=\"`databricks.DisableLegacyDbfsSetting`\" pulumi-lang-dotnet=\"`databricks.DisableLegacyDbfsSetting`\" pulumi-lang-go=\"`DisableLegacyDbfsSetting`\" pulumi-lang-python=\"`DisableLegacyDbfsSetting`\" pulumi-lang-yaml=\"`databricks.DisableLegacyDbfsSetting`\" pulumi-lang-java=\"`databricks.DisableLegacyDbfsSetting`\" pulumi-lang-hcl=\"`databricks_disable_legacy_dbfs_setting`\"\u003e`databricks.DisableLegacyDbfsSetting`\u003c/span\u003e resource allows you to disable legacy DBFS.\n\n\u003e This resource can only be used with a workspace-level provider!\n\nDisabling legacy DBFS has the following implications:\n\n1. Access to DBFS root and DBFS mounts is disallowed (as well as the creation of new mounts). \n2. Disables Databricks Runtime versions prior to 13.3LTS.\n\nWhen the setting is off, all DBFS functionality is enabled and no restrictions are imposed on Databricks Runtime versions. This setting can take up to 20 minutes to take effect and requires a manual restart of all-purpose compute clusters and SQL warehouses.\n\nRefer to official docs for more details:\n\n- [Azure](https://learn.microsoft.com/azure/databricks/dbfs/disable-dbfs-root-mounts)\n- [AWS](https://docs.databricks.com/aws/dbfs/disable-dbfs-root-mounts)\n- [GCP](https://docs.gcp.databricks.com/dbfs/disable-dbfs-root-mounts)\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.DisableLegacyDbfsSetting(\"this\", {disableLegacyDbfs: {\n value: true,\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.DisableLegacyDbfsSetting(\"this\", disable_legacy_dbfs={\n \"value\": True,\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.DisableLegacyDbfsSetting(\"this\", new()\n {\n DisableLegacyDbfs = new Databricks.Inputs.DisableLegacyDbfsSettingDisableLegacyDbfsArgs\n {\n Value = true,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewDisableLegacyDbfsSetting(ctx, \"this\", \u0026databricks.DisableLegacyDbfsSettingArgs{\n\t\t\tDisableLegacyDbfs: \u0026databricks.DisableLegacyDbfsSettingDisableLegacyDbfsArgs{\n\t\t\t\tValue: pulumi.Bool(true),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_disablelegacydbfssetting\" \"this\" {\n disable_legacy_dbfs = {\n value = true\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DisableLegacyDbfsSetting;\nimport com.pulumi.databricks.DisableLegacyDbfsSettingArgs;\nimport com.pulumi.databricks.inputs.DisableLegacyDbfsSettingDisableLegacyDbfsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new DisableLegacyDbfsSetting(\"this\", DisableLegacyDbfsSettingArgs.builder()\n .disableLegacyDbfs(DisableLegacyDbfsSettingDisableLegacyDbfsArgs.builder()\n .value(true)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:DisableLegacyDbfsSetting\n properties:\n disableLegacyDbfs:\n value: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "disableLegacyDbfs": { "$ref": "#/types/databricks:index/DisableLegacyDbfsSettingDisableLegacyDbfs:DisableLegacyDbfsSettingDisableLegacyDbfs", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyDbfsSettingProviderConfig:DisableLegacyDbfsSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "required": [ "disableLegacyDbfs", "etag", "providerConfig", "settingName" ], "inputProperties": { "disableLegacyDbfs": { "$ref": "#/types/databricks:index/DisableLegacyDbfsSettingDisableLegacyDbfs:DisableLegacyDbfsSettingDisableLegacyDbfs", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyDbfsSettingProviderConfig:DisableLegacyDbfsSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "requiredInputs": [ "disableLegacyDbfs" ], "stateInputs": { "description": "Input properties used for looking up and filtering DisableLegacyDbfsSetting resources.\n", "properties": { "disableLegacyDbfs": { "$ref": "#/types/databricks:index/DisableLegacyDbfsSettingDisableLegacyDbfs:DisableLegacyDbfsSettingDisableLegacyDbfs", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyDbfsSettingProviderConfig:DisableLegacyDbfsSettingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/disableLegacyFeaturesSetting:DisableLegacyFeaturesSetting": { "description": "\u003e This resource can only be used with an account-level provider!\n\nThe \u003cspan pulumi-lang-nodejs=\"`databricks.DisableLegacyFeaturesSetting`\" pulumi-lang-dotnet=\"`databricks.DisableLegacyFeaturesSetting`\" pulumi-lang-go=\"`DisableLegacyFeaturesSetting`\" pulumi-lang-python=\"`DisableLegacyFeaturesSetting`\" pulumi-lang-yaml=\"`databricks.DisableLegacyFeaturesSetting`\" pulumi-lang-java=\"`databricks.DisableLegacyFeaturesSetting`\" pulumi-lang-hcl=\"`databricks_disable_legacy_features_setting`\"\u003e`databricks.DisableLegacyFeaturesSetting`\u003c/span\u003e resource allows you to disable legacy features on newly created workspaces.\n\n\u003e Before disabling legacy features, make sure that default catalog for the workspace is set to value different than \u003cspan pulumi-lang-nodejs=\"`hiveMetastore`\" pulumi-lang-dotnet=\"`HiveMetastore`\" pulumi-lang-go=\"`hiveMetastore`\" pulumi-lang-python=\"`hive_metastore`\" pulumi-lang-yaml=\"`hiveMetastore`\" pulumi-lang-java=\"`hiveMetastore`\" pulumi-lang-hcl=\"`hive_metastore`\"\u003e`hiveMetastore`\u003c/span\u003e! You can set it using the\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003eresource.\n\nWhen this setting is on, the following applies to new workspaces:\n\n- Disables the use of DBFS root and mounts.\n- Hive Metastore will not be provisioned.\n- Disables the use of 'No-isolation clusters'.\n- Disables Databricks Runtime versions prior to 13.3LTS\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\n// Change default catalog to anything than `hive_metastore`\nconst _this = new databricks.DefaultNamespaceSetting(\"this\", {namespace: {\n value: \"default_catalog\",\n}});\n// Disable legacy features\nconst thisDisableLegacyFeaturesSetting = new databricks.DisableLegacyFeaturesSetting(\"this\", {disableLegacyFeatures: {\n value: true,\n}});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\n# Change default catalog to anything than `hive_metastore`\nthis = databricks.DefaultNamespaceSetting(\"this\", namespace={\n \"value\": \"default_catalog\",\n})\n# Disable legacy features\nthis_disable_legacy_features_setting = databricks.DisableLegacyFeaturesSetting(\"this\", disable_legacy_features={\n \"value\": True,\n})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n // Change default catalog to anything than `hive_metastore`\n var @this = new Databricks.DefaultNamespaceSetting(\"this\", new()\n {\n Namespace = new Databricks.Inputs.DefaultNamespaceSettingNamespaceArgs\n {\n Value = \"default_catalog\",\n },\n });\n\n // Disable legacy features\n var thisDisableLegacyFeaturesSetting = new Databricks.DisableLegacyFeaturesSetting(\"this\", new()\n {\n DisableLegacyFeatures = new Databricks.Inputs.DisableLegacyFeaturesSettingDisableLegacyFeaturesArgs\n {\n Value = true,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t// Change default catalog to anything than `hive_metastore`\n\t\t_, err := databricks.NewDefaultNamespaceSetting(ctx, \"this\", \u0026databricks.DefaultNamespaceSettingArgs{\n\t\t\tNamespace: \u0026databricks.DefaultNamespaceSettingNamespaceArgs{\n\t\t\t\tValue: pulumi.String(\"default_catalog\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// Disable legacy features\n\t\t_, err = databricks.NewDisableLegacyFeaturesSetting(ctx, \"this\", \u0026databricks.DisableLegacyFeaturesSettingArgs{\n\t\t\tDisableLegacyFeatures: \u0026databricks.DisableLegacyFeaturesSettingDisableLegacyFeaturesArgs{\n\t\t\t\tValue: pulumi.Bool(true),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n# Change default catalog to anything than `hive_metastore`\nresource \"databricks_defaultnamespacesetting\" \"this\" {\n namespace = {\n value = \"default_catalog\"\n }\n}\n# Disable legacy features\nresource \"databricks_disablelegacyfeaturessetting\" \"this\" {\n disable_legacy_features = {\n value = true\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DefaultNamespaceSetting;\nimport com.pulumi.databricks.DefaultNamespaceSettingArgs;\nimport com.pulumi.databricks.inputs.DefaultNamespaceSettingNamespaceArgs;\nimport com.pulumi.databricks.DisableLegacyFeaturesSetting;\nimport com.pulumi.databricks.DisableLegacyFeaturesSettingArgs;\nimport com.pulumi.databricks.inputs.DisableLegacyFeaturesSettingDisableLegacyFeaturesArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n // Change default catalog to anything than `hive_metastore`\n var this_ = new DefaultNamespaceSetting(\"this\", DefaultNamespaceSettingArgs.builder()\n .namespace(DefaultNamespaceSettingNamespaceArgs.builder()\n .value(\"default_catalog\")\n .build())\n .build());\n\n // Disable legacy features\n var thisDisableLegacyFeaturesSetting = new DisableLegacyFeaturesSetting(\"thisDisableLegacyFeaturesSetting\", DisableLegacyFeaturesSettingArgs.builder()\n .disableLegacyFeatures(DisableLegacyFeaturesSettingDisableLegacyFeaturesArgs.builder()\n .value(true)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n # Change default catalog to anything than `hive_metastore`\n this:\n type: databricks:DefaultNamespaceSetting\n properties:\n namespace:\n value: default_catalog\n # Disable legacy features\n thisDisableLegacyFeaturesSetting:\n type: databricks:DisableLegacyFeaturesSetting\n name: this\n properties:\n disableLegacyFeatures:\n value: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.DisableLegacyAccessSetting \" pulumi-lang-dotnet=\" databricks.DisableLegacyAccessSetting \" pulumi-lang-go=\" DisableLegacyAccessSetting \" pulumi-lang-python=\" DisableLegacyAccessSetting \" pulumi-lang-yaml=\" databricks.DisableLegacyAccessSetting \" pulumi-lang-java=\" databricks.DisableLegacyAccessSetting \" pulumi-lang-hcl=\" databricks_disable_legacy_access_setting \"\u003e databricks.DisableLegacyAccessSetting \u003c/span\u003eto disable legacy access, enabled by default when creating new workspaces with the \u003cspan pulumi-lang-nodejs=\"`disableLegacyFeatures`\" pulumi-lang-dotnet=\"`DisableLegacyFeatures`\" pulumi-lang-go=\"`disableLegacyFeatures`\" pulumi-lang-python=\"`disable_legacy_features`\" pulumi-lang-yaml=\"`disableLegacyFeatures`\" pulumi-lang-java=\"`disableLegacyFeatures`\" pulumi-lang-hcl=\"`disable_legacy_features`\"\u003e`disableLegacyFeatures`\u003c/span\u003e account level setting turned on.\n*\u003cspan pulumi-lang-nodejs=\" databricks.DisableLegacyDbfsSetting \" pulumi-lang-dotnet=\" databricks.DisableLegacyDbfsSetting \" pulumi-lang-go=\" DisableLegacyDbfsSetting \" pulumi-lang-python=\" DisableLegacyDbfsSetting \" pulumi-lang-yaml=\" databricks.DisableLegacyDbfsSetting \" pulumi-lang-java=\" databricks.DisableLegacyDbfsSetting \" pulumi-lang-hcl=\" databricks_disable_legacy_dbfs_setting \"\u003e databricks.DisableLegacyDbfsSetting \u003c/span\u003eto disable legacy DBFS, enabled by default when creating new workspaces with the \u003cspan pulumi-lang-nodejs=\"`disableLegacyFeatures`\" pulumi-lang-dotnet=\"`DisableLegacyFeatures`\" pulumi-lang-go=\"`disableLegacyFeatures`\" pulumi-lang-python=\"`disable_legacy_features`\" pulumi-lang-yaml=\"`disableLegacyFeatures`\" pulumi-lang-java=\"`disableLegacyFeatures`\" pulumi-lang-hcl=\"`disable_legacy_features`\"\u003e`disableLegacyFeatures`\u003c/span\u003e account level setting turned on.\n\n", "properties": { "disableLegacyFeatures": { "$ref": "#/types/databricks:index/DisableLegacyFeaturesSettingDisableLegacyFeatures:DisableLegacyFeaturesSettingDisableLegacyFeatures", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyFeaturesSettingProviderConfig:DisableLegacyFeaturesSettingProviderConfig", "deprecationMessage": "provider_config has no effect on this account-only resource and will be removed in a future major release." }, "settingName": { "type": "string" } }, "required": [ "disableLegacyFeatures", "etag", "providerConfig", "settingName" ], "inputProperties": { "disableLegacyFeatures": { "$ref": "#/types/databricks:index/DisableLegacyFeaturesSettingDisableLegacyFeatures:DisableLegacyFeaturesSettingDisableLegacyFeatures", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyFeaturesSettingProviderConfig:DisableLegacyFeaturesSettingProviderConfig", "deprecationMessage": "provider_config has no effect on this account-only resource and will be removed in a future major release." }, "settingName": { "type": "string" } }, "requiredInputs": [ "disableLegacyFeatures" ], "stateInputs": { "description": "Input properties used for looking up and filtering DisableLegacyFeaturesSetting resources.\n", "properties": { "disableLegacyFeatures": { "$ref": "#/types/databricks:index/DisableLegacyFeaturesSettingDisableLegacyFeatures:DisableLegacyFeaturesSettingDisableLegacyFeatures", "description": "block with following attributes:\n" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/DisableLegacyFeaturesSettingProviderConfig:DisableLegacyFeaturesSettingProviderConfig", "deprecationMessage": "provider_config has no effect on this account-only resource and will be removed in a future major release." }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/disasterRecoveryFailoverGroup:DisasterRecoveryFailoverGroup": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n", "properties": { "createTime": { "type": "string", "description": "(string) - Time at which this failover group was created\n" }, "effectivePrimaryRegion": { "type": "string", "description": "(string) - Current effective primary region. Replication flows FROM workspaces in this region.\nChanges after a successful failover\n" }, "etag": { "type": "string", "description": "Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications\n" }, "failoverGroupId": { "type": "string", "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}\n" }, "initialPrimaryRegion": { "type": "string", "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses\n" }, "name": { "type": "string", "description": "(string) - Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" }, "parent": { "type": "string", "description": "The parent resource. Format: accounts/{account_id}\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of all regions participating in this failover group\n" }, "replicationPoint": { "type": "string", "description": "(string) - The latest point in time to which data has been replicated\n" }, "state": { "type": "string", "description": "(string) - Aggregate state of the failover group. Possible values are: `ACTIVE`, `CREATING`, `CREATION_FAILED`, `DELETING`, `DELETION_FAILED`, `FAILING_OVER`, `FAILOVER_FAILED`, `INITIAL_REPLICATION`\n" }, "unityCatalogAssets": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssets:DisasterRecoveryFailoverGroupUnityCatalogAssets", "description": "Unity Catalog replication configuration\n" }, "updateTime": { "type": "string", "description": "(string) - Time at which this failover group was last modified\n" }, "workspaceSets": { "type": "array", "items": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupWorkspaceSet:DisasterRecoveryFailoverGroupWorkspaceSet" }, "description": "Workspace sets, each containing workspaces that replicate to each other\n" } }, "required": [ "createTime", "effectivePrimaryRegion", "failoverGroupId", "initialPrimaryRegion", "name", "parent", "regions", "replicationPoint", "state", "updateTime", "workspaceSets" ], "inputProperties": { "etag": { "type": "string", "description": "Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications\n" }, "failoverGroupId": { "type": "string", "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}\n" }, "initialPrimaryRegion": { "type": "string", "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses\n" }, "parent": { "type": "string", "description": "The parent resource. Format: accounts/{account_id}\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of all regions participating in this failover group\n" }, "unityCatalogAssets": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssets:DisasterRecoveryFailoverGroupUnityCatalogAssets", "description": "Unity Catalog replication configuration\n" }, "workspaceSets": { "type": "array", "items": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupWorkspaceSet:DisasterRecoveryFailoverGroupWorkspaceSet" }, "description": "Workspace sets, each containing workspaces that replicate to each other\n" } }, "requiredInputs": [ "failoverGroupId", "initialPrimaryRegion", "parent", "regions", "workspaceSets" ], "stateInputs": { "description": "Input properties used for looking up and filtering DisasterRecoveryFailoverGroup resources.\n", "properties": { "createTime": { "type": "string", "description": "(string) - Time at which this failover group was created\n" }, "effectivePrimaryRegion": { "type": "string", "description": "(string) - Current effective primary region. Replication flows FROM workspaces in this region.\nChanges after a successful failover\n" }, "etag": { "type": "string", "description": "Opaque version string for optimistic locking. Server-generated, returned in responses.\nMust be provided on Update requests to prevent concurrent modifications\n" }, "failoverGroupId": { "type": "string", "description": "Client-provided identifier for the failover group. Used to construct the\nresource name as {parent}/failover-groups/{failover_group_id}\n" }, "initialPrimaryRegion": { "type": "string", "description": "Initial primary region. Used only in Create requests to set the starting\nprimary region. Not returned in responses\n" }, "name": { "type": "string", "description": "(string) - Fully qualified resource name in the format\naccounts/{account_id}/failover-groups/{failover_group_id}\n" }, "parent": { "type": "string", "description": "The parent resource. Format: accounts/{account_id}\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of all regions participating in this failover group\n" }, "replicationPoint": { "type": "string", "description": "(string) - The latest point in time to which data has been replicated\n" }, "state": { "type": "string", "description": "(string) - Aggregate state of the failover group. Possible values are: `ACTIVE`, `CREATING`, `CREATION_FAILED`, `DELETING`, `DELETION_FAILED`, `FAILING_OVER`, `FAILOVER_FAILED`, `INITIAL_REPLICATION`\n" }, "unityCatalogAssets": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupUnityCatalogAssets:DisasterRecoveryFailoverGroupUnityCatalogAssets", "description": "Unity Catalog replication configuration\n" }, "updateTime": { "type": "string", "description": "(string) - Time at which this failover group was last modified\n" }, "workspaceSets": { "type": "array", "items": { "$ref": "#/types/databricks:index/DisasterRecoveryFailoverGroupWorkspaceSet:DisasterRecoveryFailoverGroupWorkspaceSet" }, "description": "Workspace sets, each containing workspaces that replicate to each other\n" } }, "type": "object" } }, "databricks:index/disasterRecoveryStableUrl:DisasterRecoveryStableUrl": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n", "properties": { "failoverGroupName": { "type": "string", "description": "(string) - Fully qualified resource name of the FailoverGroup this stable URL is\ncurrently linked to, in the format\n`accounts/{account_id}/failover-groups/{failover_group_id}`. Empty when\nthe stable URL is not attached to any failover group. Server-controlled:\nwritten by CreateFailoverGroup / UpdateFailoverGroup on link, cleared by\nDeleteFailoverGroup / UpdateFailoverGroup on unlink\n" }, "initialWorkspaceId": { "type": "string", "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics\n" }, "name": { "type": "string", "description": "(string) - Fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}\n" }, "parent": { "type": "string", "description": "The parent resource. Format: accounts/{account_id}\n" }, "stableUrlId": { "type": "string", "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}\n" }, "url": { "type": "string", "description": "(string) - The stable URL endpoint. Generated by the backend on creation and\nimmutable thereafter. For non-Private-Link workspaces this is\n`https://\u003cspog_host\u003e/?c=\u003cconnection_id\u003e`. For Private-Link workspaces\nthis is the per-connection hostname\n" } }, "required": [ "failoverGroupName", "initialWorkspaceId", "name", "parent", "stableUrlId", "url" ], "inputProperties": { "initialWorkspaceId": { "type": "string", "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics\n" }, "parent": { "type": "string", "description": "The parent resource. Format: accounts/{account_id}\n" }, "stableUrlId": { "type": "string", "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}\n" } }, "requiredInputs": [ "initialWorkspaceId", "parent", "stableUrlId" ], "stateInputs": { "description": "Input properties used for looking up and filtering DisasterRecoveryStableUrl resources.\n", "properties": { "failoverGroupName": { "type": "string", "description": "(string) - Fully qualified resource name of the FailoverGroup this stable URL is\ncurrently linked to, in the format\n`accounts/{account_id}/failover-groups/{failover_group_id}`. Empty when\nthe stable URL is not attached to any failover group. Server-controlled:\nwritten by CreateFailoverGroup / UpdateFailoverGroup on link, cleared by\nDeleteFailoverGroup / UpdateFailoverGroup on unlink\n" }, "initialWorkspaceId": { "type": "string", "description": "The workspace this stable URL is initially bound to. Used only in Create\nrequests to associate the stable URL with a workspace. Not returned in\nresponses. Mirrors FailoverGroup.initial_primary_region semantics\n" }, "name": { "type": "string", "description": "(string) - Fully qualified resource name.\nFormat: accounts/{account_id}/stable-urls/{stable_url_id}\n" }, "parent": { "type": "string", "description": "The parent resource. Format: accounts/{account_id}\n" }, "stableUrlId": { "type": "string", "description": "Client-provided identifier for the stable URL. Used to construct the\nresource name as {parent}/stable-urls/{stable_url_id}\n" }, "url": { "type": "string", "description": "(string) - The stable URL endpoint. Generated by the backend on creation and\nimmutable thereafter. For non-Private-Link workspaces this is\n`https://\u003cspog_host\u003e/?c=\u003cconnection_id\u003e`. For Private-Link workspaces\nthis is the per-connection hostname\n" } }, "type": "object" } }, "databricks:index/endpoint:Endpoint": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/account/endpoints)\n\nEndpoint resource manages network connectivity endpoints for private access to Databricks workspaces.\n\n\u003e **Note** This resource can only be used with an account-level provider!\n\n## Example Usage\n\n### Example for Azure cloud\nThis is an example for creating an endpoint in Azure cloud:\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Endpoint(\"this\", {\n parent: \"accounts/123e4567-e89b-12d3-a456-426614174000\",\n displayName: \"my-private-endpoint\",\n region: \"westus\",\n azurePrivateEndpointInfo: {\n privateEndpointName: \"my-pe\",\n privateEndpointResourceGuid: \"12345678-1234-1234-1234-123456789abc\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Endpoint(\"this\",\n parent=\"accounts/123e4567-e89b-12d3-a456-426614174000\",\n display_name=\"my-private-endpoint\",\n region=\"westus\",\n azure_private_endpoint_info={\n \"private_endpoint_name\": \"my-pe\",\n \"private_endpoint_resource_guid\": \"12345678-1234-1234-1234-123456789abc\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Endpoint(\"this\", new()\n {\n Parent = \"accounts/123e4567-e89b-12d3-a456-426614174000\",\n DisplayName = \"my-private-endpoint\",\n Region = \"westus\",\n AzurePrivateEndpointInfo = new Databricks.Inputs.EndpointAzurePrivateEndpointInfoArgs\n {\n PrivateEndpointName = \"my-pe\",\n PrivateEndpointResourceGuid = \"12345678-1234-1234-1234-123456789abc\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewEndpoint(ctx, \"this\", \u0026databricks.EndpointArgs{\n\t\t\tParent: pulumi.String(\"accounts/123e4567-e89b-12d3-a456-426614174000\"),\n\t\t\tDisplayName: pulumi.String(\"my-private-endpoint\"),\n\t\t\tRegion: pulumi.String(\"westus\"),\n\t\t\tAzurePrivateEndpointInfo: \u0026databricks.EndpointAzurePrivateEndpointInfoArgs{\n\t\t\t\tPrivateEndpointName: pulumi.String(\"my-pe\"),\n\t\t\t\tPrivateEndpointResourceGuid: pulumi.String(\"12345678-1234-1234-1234-123456789abc\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_endpoint\" \"this\" {\n parent = \"accounts/123e4567-e89b-12d3-a456-426614174000\"\n display_name = \"my-private-endpoint\"\n region = \"westus\"\n azure_private_endpoint_info = {\n private_endpoint_name = \"my-pe\"\n private_endpoint_resource_guid = \"12345678-1234-1234-1234-123456789abc\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Endpoint;\nimport com.pulumi.databricks.EndpointArgs;\nimport com.pulumi.databricks.inputs.EndpointAzurePrivateEndpointInfoArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Endpoint(\"this\", EndpointArgs.builder()\n .parent(\"accounts/123e4567-e89b-12d3-a456-426614174000\")\n .displayName(\"my-private-endpoint\")\n .region(\"westus\")\n .azurePrivateEndpointInfo(EndpointAzurePrivateEndpointInfoArgs.builder()\n .privateEndpointName(\"my-pe\")\n .privateEndpointResourceGuid(\"12345678-1234-1234-1234-123456789abc\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Endpoint\n properties:\n parent: accounts/123e4567-e89b-12d3-a456-426614174000\n displayName: my-private-endpoint\n region: westus\n azurePrivateEndpointInfo:\n privateEndpointName: my-pe\n privateEndpointResourceGuid: 12345678-1234-1234-1234-123456789abc\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "accountId": { "type": "string", "description": "(string) - The Databricks Account in which the endpoint object exists\n" }, "azurePrivateEndpointInfo": { "$ref": "#/types/databricks:index/EndpointAzurePrivateEndpointInfo:EndpointAzurePrivateEndpointInfo", "description": "Info for an Azure private endpoint\n" }, "createTime": { "type": "string", "description": "(string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone\n" }, "displayName": { "type": "string", "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum\n" }, "endpointId": { "type": "string", "description": "(string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks\n" }, "name": { "type": "string", "description": "(string) - The resource name of the endpoint, which uniquely identifies the endpoint\n" }, "parent": { "type": "string", "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`\n" }, "region": { "type": "string", "description": "The cloud provider region where this endpoint is located\n" }, "state": { "type": "string", "description": "(string) - The state of the endpoint. The endpoint can only be used if the state is `APPROVED`. Possible values are: `APPROVED`, `DISCONNECTED`, `FAILED`, `PENDING`\n" }, "useCase": { "type": "string", "description": "(string) - The use case that determines the type of network connectivity this endpoint provides.\nThis field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are: `SERVICE_DIRECT`\n" } }, "required": [ "accountId", "createTime", "displayName", "endpointId", "name", "parent", "region", "state", "useCase" ], "inputProperties": { "azurePrivateEndpointInfo": { "$ref": "#/types/databricks:index/EndpointAzurePrivateEndpointInfo:EndpointAzurePrivateEndpointInfo", "description": "Info for an Azure private endpoint\n" }, "displayName": { "type": "string", "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum\n" }, "parent": { "type": "string", "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`\n" }, "region": { "type": "string", "description": "The cloud provider region where this endpoint is located\n" } }, "requiredInputs": [ "displayName", "parent", "region" ], "stateInputs": { "description": "Input properties used for looking up and filtering Endpoint resources.\n", "properties": { "accountId": { "type": "string", "description": "(string) - The Databricks Account in which the endpoint object exists\n" }, "azurePrivateEndpointInfo": { "$ref": "#/types/databricks:index/EndpointAzurePrivateEndpointInfo:EndpointAzurePrivateEndpointInfo", "description": "Info for an Azure private endpoint\n" }, "createTime": { "type": "string", "description": "(string) - The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone\n" }, "displayName": { "type": "string", "description": "The human-readable display name of this endpoint.\nThe input should conform to RFC-1034, which restricts to letters, numbers, and hyphens,\nwith the first character a letter, the last a letter or a number, and a 63 character maximum\n" }, "endpointId": { "type": "string", "description": "(string) - The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks\n" }, "name": { "type": "string", "description": "(string) - The resource name of the endpoint, which uniquely identifies the endpoint\n" }, "parent": { "type": "string", "description": "The parent resource name of the account under which the endpoint is created.\nFormat: `accounts/{account_id}`\n" }, "region": { "type": "string", "description": "The cloud provider region where this endpoint is located\n" }, "state": { "type": "string", "description": "(string) - The state of the endpoint. The endpoint can only be used if the state is `APPROVED`. Possible values are: `APPROVED`, `DISCONNECTED`, `FAILED`, `PENDING`\n" }, "useCase": { "type": "string", "description": "(string) - The use case that determines the type of network connectivity this endpoint provides.\nThis field is automatically determined based on the endpoint configuration and cloud-specific settings. Possible values are: `SERVICE_DIRECT`\n" } }, "type": "object" } }, "databricks:index/enhancedSecurityMonitoringWorkspaceSetting:EnhancedSecurityMonitoringWorkspaceSetting": { "properties": { "enhancedSecurityMonitoringWorkspace": { "$ref": "#/types/databricks:index/EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace:EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/EnhancedSecurityMonitoringWorkspaceSettingProviderConfig:EnhancedSecurityMonitoringWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "required": [ "enhancedSecurityMonitoringWorkspace", "etag", "providerConfig", "settingName" ], "inputProperties": { "enhancedSecurityMonitoringWorkspace": { "$ref": "#/types/databricks:index/EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace:EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/EnhancedSecurityMonitoringWorkspaceSettingProviderConfig:EnhancedSecurityMonitoringWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "requiredInputs": [ "enhancedSecurityMonitoringWorkspace" ], "stateInputs": { "description": "Input properties used for looking up and filtering EnhancedSecurityMonitoringWorkspaceSetting resources.\n", "properties": { "enhancedSecurityMonitoringWorkspace": { "$ref": "#/types/databricks:index/EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace:EnhancedSecurityMonitoringWorkspaceSettingEnhancedSecurityMonitoringWorkspace" }, "etag": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/EnhancedSecurityMonitoringWorkspaceSettingProviderConfig:EnhancedSecurityMonitoringWorkspaceSettingProviderConfig" }, "settingName": { "type": "string" } }, "type": "object" } }, "databricks:index/entitlements:Entitlements": { "description": "This resource allows you to set entitlements to existing databricks_users,\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eor databricks_service_principal.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e You must define entitlements of a principal using either \u003cspan pulumi-lang-nodejs=\"`databricks.Entitlements`\" pulumi-lang-dotnet=\"`databricks.Entitlements`\" pulumi-lang-go=\"`Entitlements`\" pulumi-lang-python=\"`Entitlements`\" pulumi-lang-yaml=\"`databricks.Entitlements`\" pulumi-lang-java=\"`databricks.Entitlements`\" pulumi-lang-hcl=\"`databricks_entitlements`\"\u003e`databricks.Entitlements`\u003c/span\u003e or directly within one of databricks_users,\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eor databricks_service_principal. Having entitlements defined in both resources will result in non-deterministic behaviour.\n\n## Example Usage\n\nSetting entitlements for a regular user:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst me = databricks.getUser({\n userName: \"me@example.com\",\n});\nconst meEntitlements = new databricks.Entitlements(\"me\", {\n userId: me.then(me =\u003e me.id),\n allowClusterCreate: true,\n allowInstancePoolCreate: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nme = databricks.get_user(user_name=\"me@example.com\")\nme_entitlements = databricks.Entitlements(\"me\",\n user_id=me.id,\n allow_cluster_create=True,\n allow_instance_pool_create=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var me = Databricks.GetUser.Invoke(new()\n {\n UserName = \"me@example.com\",\n });\n\n var meEntitlements = new Databricks.Entitlements(\"me\", new()\n {\n UserId = me.Apply(getUserResult =\u003e getUserResult.Id),\n AllowClusterCreate = true,\n AllowInstancePoolCreate = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tme, err := databricks.GetUser(ctx, \u0026databricks.LookupUserArgs{\n\t\t\tUserName: pulumi.StringRef(\"me@example.com\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntitlements(ctx, \"me\", \u0026databricks.EntitlementsArgs{\n\t\t\tUserId: pulumi.String(pulumi.String(me.Id)),\n\t\t\tAllowClusterCreate: pulumi.Bool(true),\n\t\t\tAllowInstancePoolCreate: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getuser\" \"me\" {\n user_name = \"me@example.com\"\n}\n\nresource \"databricks_entitlements\" \"me\" {\n user_id = data.databricks_getuser.me.id\n allow_cluster_create = true\n allow_instance_pool_create = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetUserArgs;\nimport com.pulumi.databricks.Entitlements;\nimport com.pulumi.databricks.EntitlementsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var me = DatabricksFunctions.getUser(GetUserArgs.builder()\n .userName(\"me@example.com\")\n .build());\n\n var meEntitlements = new Entitlements(\"meEntitlements\", EntitlementsArgs.builder()\n .userId(me.id())\n .allowClusterCreate(true)\n .allowInstancePoolCreate(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n meEntitlements:\n type: databricks:Entitlements\n name: me\n properties:\n userId: ${me.id}\n allowClusterCreate: true\n allowInstancePoolCreate: true\nvariables:\n me:\n fn::invoke:\n function: databricks:getUser\n arguments:\n userName: me@example.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nSetting entitlements for a service principal:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = databricks.getServicePrincipal({\n applicationId: \"11111111-2222-3333-4444-555666777888\",\n});\nconst thisEntitlements = new databricks.Entitlements(\"this\", {\n servicePrincipalId: _this.then(_this =\u003e _this.spId),\n allowClusterCreate: true,\n allowInstancePoolCreate: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.get_service_principal(application_id=\"11111111-2222-3333-4444-555666777888\")\nthis_entitlements = databricks.Entitlements(\"this\",\n service_principal_id=this.sp_id,\n allow_cluster_create=True,\n allow_instance_pool_create=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = Databricks.GetServicePrincipal.Invoke(new()\n {\n ApplicationId = \"11111111-2222-3333-4444-555666777888\",\n });\n\n var thisEntitlements = new Databricks.Entitlements(\"this\", new()\n {\n ServicePrincipalId = @this.Apply(@this =\u003e @this.Apply(getServicePrincipalResult =\u003e getServicePrincipalResult.SpId)),\n AllowClusterCreate = true,\n AllowInstancePoolCreate = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.GetServicePrincipal(ctx, \u0026databricks.LookupServicePrincipalArgs{\n\t\t\tApplicationId: pulumi.StringRef(\"11111111-2222-3333-4444-555666777888\"),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntitlements(ctx, \"this\", \u0026databricks.EntitlementsArgs{\n\t\t\tServicePrincipalId: pulumi.String(pulumi.String(this.SpId)),\n\t\t\tAllowClusterCreate: pulumi.Bool(true),\n\t\t\tAllowInstancePoolCreate: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getserviceprincipal\" \"this\" {\n application_id = \"11111111-2222-3333-4444-555666777888\"\n}\n\nresource \"databricks_entitlements\" \"this\" {\n service_principal_id = data.databricks_getserviceprincipal.this.sp_id\n allow_cluster_create = true\n allow_instance_pool_create = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetServicePrincipalArgs;\nimport com.pulumi.databricks.Entitlements;\nimport com.pulumi.databricks.EntitlementsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var this = DatabricksFunctions.getServicePrincipal(GetServicePrincipalArgs.builder()\n .applicationId(\"11111111-2222-3333-4444-555666777888\")\n .build());\n\n var thisEntitlements = new Entitlements(\"thisEntitlements\", EntitlementsArgs.builder()\n .servicePrincipalId(this_.spId())\n .allowClusterCreate(true)\n .allowInstancePoolCreate(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n thisEntitlements:\n type: databricks:Entitlements\n name: this\n properties:\n servicePrincipalId: ${this.spId}\n allowClusterCreate: true\n allowInstancePoolCreate: true\nvariables:\n this:\n fn::invoke:\n function: databricks:getServicePrincipal\n arguments:\n applicationId: 11111111-2222-3333-4444-555666777888\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nSetting entitlements to all users in a workspace - referencing special \u003cspan pulumi-lang-nodejs=\"`users`\" pulumi-lang-dotnet=\"`Users`\" pulumi-lang-go=\"`users`\" pulumi-lang-python=\"`users`\" pulumi-lang-yaml=\"`users`\" pulumi-lang-java=\"`users`\" pulumi-lang-hcl=\"`users`\"\u003e`users`\u003c/span\u003e\u003cspan pulumi-lang-nodejs=\" databricks.Group\n\" pulumi-lang-dotnet=\" databricks.Group\n\" pulumi-lang-go=\" Group\n\" pulumi-lang-python=\" Group\n\" pulumi-lang-yaml=\" databricks.Group\n\" pulumi-lang-java=\" databricks.Group\n\" pulumi-lang-hcl=\" databricks_group\n\"\u003e databricks.Group\n\u003c/span\u003e\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst users = databricks.getGroup({\n displayName: \"users\",\n});\nconst workspace_users = new databricks.Entitlements(\"workspace-users\", {\n groupId: users.then(users =\u003e users.id),\n allowClusterCreate: true,\n allowInstancePoolCreate: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nusers = databricks.get_group(display_name=\"users\")\nworkspace_users = databricks.Entitlements(\"workspace-users\",\n group_id=users.id,\n allow_cluster_create=True,\n allow_instance_pool_create=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var users = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"users\",\n });\n\n var workspace_users = new Databricks.Entitlements(\"workspace-users\", new()\n {\n GroupId = users.Apply(getGroupResult =\u003e getGroupResult.Id),\n AllowClusterCreate = true,\n AllowInstancePoolCreate = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tusers, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"users\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntitlements(ctx, \"workspace-users\", \u0026databricks.EntitlementsArgs{\n\t\t\tGroupId: pulumi.String(pulumi.String(users.Id)),\n\t\t\tAllowClusterCreate: pulumi.Bool(true),\n\t\t\tAllowInstancePoolCreate: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"users\" {\n display_name = \"users\"\n}\n\nresource \"databricks_entitlements\" \"workspace-users\" {\n group_id = data.databricks_getgroup.users.id\n allow_cluster_create = true\n allow_instance_pool_create = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.Entitlements;\nimport com.pulumi.databricks.EntitlementsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var users = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"users\")\n .build());\n\n var workspace_users = new Entitlements(\"workspace-users\", EntitlementsArgs.builder()\n .groupId(users.id())\n .allowClusterCreate(true)\n .allowInstancePoolCreate(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n workspace-users:\n type: databricks:Entitlements\n properties:\n groupId: ${users.id}\n allowClusterCreate: true\n allowInstancePoolCreate: true\nvariables:\n users:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: users\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eto manage [Account-level](https://docs.databricks.com/aws/en/admin/users-groups/groups) or [Workspace-level](https://docs.databricks.com/aws/en/admin/users-groups/workspace-local-groups) groups.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003emembers, entitlements and instance profiles.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GroupInstanceProfile \" pulumi-lang-dotnet=\" databricks.GroupInstanceProfile \" pulumi-lang-go=\" GroupInstanceProfile \" pulumi-lang-python=\" GroupInstanceProfile \" pulumi-lang-yaml=\" databricks.GroupInstanceProfile \" pulumi-lang-java=\" databricks.GroupInstanceProfile \" pulumi-lang-hcl=\" databricks_group_instance_profile \"\u003e databricks.GroupInstanceProfile \u003c/span\u003eto attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_group.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GroupMember \" pulumi-lang-dotnet=\" databricks.GroupMember \" pulumi-lang-go=\" GroupMember \" pulumi-lang-python=\" GroupMember \" pulumi-lang-yaml=\" databricks.GroupMember \" pulumi-lang-java=\" databricks.GroupMember \" pulumi-lang-hcl=\" databricks_group_member \"\u003e databricks.GroupMember \u003c/span\u003eto attach users and groups as group members.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eto manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount.\n*\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003edata to retrieve information about databricks_user.\n\n", "properties": { "allowClusterCreate": { "type": "boolean", "description": "Allow the principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e argument. Everyone without \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.\n" }, "allowInstancePoolCreate": { "type": "boolean", "description": "Allow the principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" instancePoolId \" pulumi-lang-dotnet=\" InstancePoolId \" pulumi-lang-go=\" instancePoolId \" pulumi-lang-python=\" instance_pool_id \" pulumi-lang-yaml=\" instancePoolId \" pulumi-lang-java=\" instancePoolId \" pulumi-lang-hcl=\" instance_pool_id \"\u003e instancePoolId \u003c/span\u003eargument.\n" }, "databricksSqlAccess": { "type": "boolean", "description": "This is a field to allow the principal to have access to [Databricks SQL](https://databricks.com/product/databricks-sql) UI, [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one) and through databricks_sql_endpoint.\n" }, "groupId": { "type": "string", "description": "Canonical unique identifier for the group.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EntitlementsProviderConfig:EntitlementsProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "servicePrincipalId": { "type": "string", "description": "Canonical unique identifier for the service principal.\n\nThe following entitlements are available.\n" }, "userId": { "type": "string", "description": "Canonical unique identifier for the user.\n" }, "workspaceAccess": { "type": "boolean", "description": "This is a field to allow the principal to have access to a Databricks Workspace UI and [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one).\n" }, "workspaceConsume": { "type": "boolean", "description": "This is a field to allow the principal to have access only to [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one). Couldn't be used with \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e.\n" } }, "required": [ "providerConfig" ], "inputProperties": { "allowClusterCreate": { "type": "boolean", "description": "Allow the principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e argument. Everyone without \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.\n" }, "allowInstancePoolCreate": { "type": "boolean", "description": "Allow the principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" instancePoolId \" pulumi-lang-dotnet=\" InstancePoolId \" pulumi-lang-go=\" instancePoolId \" pulumi-lang-python=\" instance_pool_id \" pulumi-lang-yaml=\" instancePoolId \" pulumi-lang-java=\" instancePoolId \" pulumi-lang-hcl=\" instance_pool_id \"\u003e instancePoolId \u003c/span\u003eargument.\n" }, "databricksSqlAccess": { "type": "boolean", "description": "This is a field to allow the principal to have access to [Databricks SQL](https://databricks.com/product/databricks-sql) UI, [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one) and through databricks_sql_endpoint.\n" }, "groupId": { "type": "string", "description": "Canonical unique identifier for the group.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/EntitlementsProviderConfig:EntitlementsProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "servicePrincipalId": { "type": "string", "description": "Canonical unique identifier for the service principal.\n\nThe following entitlements are available.\n", "willReplaceOnChanges": true }, "userId": { "type": "string", "description": "Canonical unique identifier for the user.\n", "willReplaceOnChanges": true }, "workspaceAccess": { "type": "boolean", "description": "This is a field to allow the principal to have access to a Databricks Workspace UI and [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one).\n" }, "workspaceConsume": { "type": "boolean", "description": "This is a field to allow the principal to have access only to [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one). Couldn't be used with \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Entitlements resources.\n", "properties": { "allowClusterCreate": { "type": "boolean", "description": "Allow the principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e argument. Everyone without \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.\n" }, "allowInstancePoolCreate": { "type": "boolean", "description": "Allow the principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" instancePoolId \" pulumi-lang-dotnet=\" InstancePoolId \" pulumi-lang-go=\" instancePoolId \" pulumi-lang-python=\" instance_pool_id \" pulumi-lang-yaml=\" instancePoolId \" pulumi-lang-java=\" instancePoolId \" pulumi-lang-hcl=\" instance_pool_id \"\u003e instancePoolId \u003c/span\u003eargument.\n" }, "databricksSqlAccess": { "type": "boolean", "description": "This is a field to allow the principal to have access to [Databricks SQL](https://databricks.com/product/databricks-sql) UI, [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one) and through databricks_sql_endpoint.\n" }, "groupId": { "type": "string", "description": "Canonical unique identifier for the group.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/EntitlementsProviderConfig:EntitlementsProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "servicePrincipalId": { "type": "string", "description": "Canonical unique identifier for the service principal.\n\nThe following entitlements are available.\n", "willReplaceOnChanges": true }, "userId": { "type": "string", "description": "Canonical unique identifier for the user.\n", "willReplaceOnChanges": true }, "workspaceAccess": { "type": "boolean", "description": "This is a field to allow the principal to have access to a Databricks Workspace UI and [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one).\n" }, "workspaceConsume": { "type": "boolean", "description": "This is a field to allow the principal to have access only to [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one). Couldn't be used with \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e.\n" } }, "type": "object" } }, "databricks:index/entityTagAssignment:EntityTagAssignment": { "description": "[![GA](https://img.shields.io/badge/Release_Stage-GA-green)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/entitytagassignments)\n\nThis resource allows you to create, update, list, and delete tag assignments on Unity Catalog entities.\n\n## Example Usage\n\n### Basic tag assignment to a catalog\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst catalogTag = new databricks.EntityTagAssignment(\"catalog_tag\", {\n entityType: \"catalogs\",\n entityName: \"production_catalog\",\n tagKey: \"environment\",\n tagValue: \"production\",\n});\nconst schemaTag = new databricks.EntityTagAssignment(\"schema_tag\", {\n entityType: \"schemas\",\n entityName: \"production_catalog.sales_data\",\n tagKey: \"owner\",\n tagValue: \"sales-team\",\n});\nconst tableTag = new databricks.EntityTagAssignment(\"table_tag\", {\n entityType: \"tables\",\n entityName: \"production_catalog.sales_data.customer_orders\",\n tagKey: \"data_classification\",\n tagValue: \"confidential\",\n});\nconst columnTag = new databricks.EntityTagAssignment(\"column_tag\", {\n entityType: \"columns\",\n entityName: \"production_catalog.sales_data.customers.email_address\",\n tagKey: \"pii\",\n tagValue: \"email\",\n});\nconst volumeTag = new databricks.EntityTagAssignment(\"volume_tag\", {\n entityType: \"volumes\",\n entityName: \"production_catalog.raw_data.landing_zone\",\n tagKey: \"purpose\",\n tagValue: \"data_ingestion\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncatalog_tag = databricks.EntityTagAssignment(\"catalog_tag\",\n entity_type=\"catalogs\",\n entity_name=\"production_catalog\",\n tag_key=\"environment\",\n tag_value=\"production\")\nschema_tag = databricks.EntityTagAssignment(\"schema_tag\",\n entity_type=\"schemas\",\n entity_name=\"production_catalog.sales_data\",\n tag_key=\"owner\",\n tag_value=\"sales-team\")\ntable_tag = databricks.EntityTagAssignment(\"table_tag\",\n entity_type=\"tables\",\n entity_name=\"production_catalog.sales_data.customer_orders\",\n tag_key=\"data_classification\",\n tag_value=\"confidential\")\ncolumn_tag = databricks.EntityTagAssignment(\"column_tag\",\n entity_type=\"columns\",\n entity_name=\"production_catalog.sales_data.customers.email_address\",\n tag_key=\"pii\",\n tag_value=\"email\")\nvolume_tag = databricks.EntityTagAssignment(\"volume_tag\",\n entity_type=\"volumes\",\n entity_name=\"production_catalog.raw_data.landing_zone\",\n tag_key=\"purpose\",\n tag_value=\"data_ingestion\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var catalogTag = new Databricks.EntityTagAssignment(\"catalog_tag\", new()\n {\n EntityType = \"catalogs\",\n EntityName = \"production_catalog\",\n TagKey = \"environment\",\n TagValue = \"production\",\n });\n\n var schemaTag = new Databricks.EntityTagAssignment(\"schema_tag\", new()\n {\n EntityType = \"schemas\",\n EntityName = \"production_catalog.sales_data\",\n TagKey = \"owner\",\n TagValue = \"sales-team\",\n });\n\n var tableTag = new Databricks.EntityTagAssignment(\"table_tag\", new()\n {\n EntityType = \"tables\",\n EntityName = \"production_catalog.sales_data.customer_orders\",\n TagKey = \"data_classification\",\n TagValue = \"confidential\",\n });\n\n var columnTag = new Databricks.EntityTagAssignment(\"column_tag\", new()\n {\n EntityType = \"columns\",\n EntityName = \"production_catalog.sales_data.customers.email_address\",\n TagKey = \"pii\",\n TagValue = \"email\",\n });\n\n var volumeTag = new Databricks.EntityTagAssignment(\"volume_tag\", new()\n {\n EntityType = \"volumes\",\n EntityName = \"production_catalog.raw_data.landing_zone\",\n TagKey = \"purpose\",\n TagValue = \"data_ingestion\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewEntityTagAssignment(ctx, \"catalog_tag\", \u0026databricks.EntityTagAssignmentArgs{\n\t\t\tEntityType: pulumi.String(\"catalogs\"),\n\t\t\tEntityName: pulumi.String(\"production_catalog\"),\n\t\t\tTagKey: pulumi.String(\"environment\"),\n\t\t\tTagValue: pulumi.String(\"production\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntityTagAssignment(ctx, \"schema_tag\", \u0026databricks.EntityTagAssignmentArgs{\n\t\t\tEntityType: pulumi.String(\"schemas\"),\n\t\t\tEntityName: pulumi.String(\"production_catalog.sales_data\"),\n\t\t\tTagKey: pulumi.String(\"owner\"),\n\t\t\tTagValue: pulumi.String(\"sales-team\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntityTagAssignment(ctx, \"table_tag\", \u0026databricks.EntityTagAssignmentArgs{\n\t\t\tEntityType: pulumi.String(\"tables\"),\n\t\t\tEntityName: pulumi.String(\"production_catalog.sales_data.customer_orders\"),\n\t\t\tTagKey: pulumi.String(\"data_classification\"),\n\t\t\tTagValue: pulumi.String(\"confidential\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntityTagAssignment(ctx, \"column_tag\", \u0026databricks.EntityTagAssignmentArgs{\n\t\t\tEntityType: pulumi.String(\"columns\"),\n\t\t\tEntityName: pulumi.String(\"production_catalog.sales_data.customers.email_address\"),\n\t\t\tTagKey: pulumi.String(\"pii\"),\n\t\t\tTagValue: pulumi.String(\"email\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEntityTagAssignment(ctx, \"volume_tag\", \u0026databricks.EntityTagAssignmentArgs{\n\t\t\tEntityType: pulumi.String(\"volumes\"),\n\t\t\tEntityName: pulumi.String(\"production_catalog.raw_data.landing_zone\"),\n\t\t\tTagKey: pulumi.String(\"purpose\"),\n\t\t\tTagValue: pulumi.String(\"data_ingestion\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_entitytagassignment\" \"catalog_tag\" {\n entity_type = \"catalogs\"\n entity_name = \"production_catalog\"\n tag_key = \"environment\"\n tag_value = \"production\"\n}\nresource \"databricks_entitytagassignment\" \"schema_tag\" {\n entity_type = \"schemas\"\n entity_name = \"production_catalog.sales_data\"\n tag_key = \"owner\"\n tag_value = \"sales-team\"\n}\nresource \"databricks_entitytagassignment\" \"table_tag\" {\n entity_type = \"tables\"\n entity_name = \"production_catalog.sales_data.customer_orders\"\n tag_key = \"data_classification\"\n tag_value = \"confidential\"\n}\nresource \"databricks_entitytagassignment\" \"column_tag\" {\n entity_type = \"columns\"\n entity_name = \"production_catalog.sales_data.customers.email_address\"\n tag_key = \"pii\"\n tag_value = \"email\"\n}\nresource \"databricks_entitytagassignment\" \"volume_tag\" {\n entity_type = \"volumes\"\n entity_name = \"production_catalog.raw_data.landing_zone\"\n tag_key = \"purpose\"\n tag_value = \"data_ingestion\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.EntityTagAssignment;\nimport com.pulumi.databricks.EntityTagAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var catalogTag = new EntityTagAssignment(\"catalogTag\", EntityTagAssignmentArgs.builder()\n .entityType(\"catalogs\")\n .entityName(\"production_catalog\")\n .tagKey(\"environment\")\n .tagValue(\"production\")\n .build());\n\n var schemaTag = new EntityTagAssignment(\"schemaTag\", EntityTagAssignmentArgs.builder()\n .entityType(\"schemas\")\n .entityName(\"production_catalog.sales_data\")\n .tagKey(\"owner\")\n .tagValue(\"sales-team\")\n .build());\n\n var tableTag = new EntityTagAssignment(\"tableTag\", EntityTagAssignmentArgs.builder()\n .entityType(\"tables\")\n .entityName(\"production_catalog.sales_data.customer_orders\")\n .tagKey(\"data_classification\")\n .tagValue(\"confidential\")\n .build());\n\n var columnTag = new EntityTagAssignment(\"columnTag\", EntityTagAssignmentArgs.builder()\n .entityType(\"columns\")\n .entityName(\"production_catalog.sales_data.customers.email_address\")\n .tagKey(\"pii\")\n .tagValue(\"email\")\n .build());\n\n var volumeTag = new EntityTagAssignment(\"volumeTag\", EntityTagAssignmentArgs.builder()\n .entityType(\"volumes\")\n .entityName(\"production_catalog.raw_data.landing_zone\")\n .tagKey(\"purpose\")\n .tagValue(\"data_ingestion\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n catalogTag:\n type: databricks:EntityTagAssignment\n name: catalog_tag\n properties:\n entityType: catalogs\n entityName: production_catalog\n tagKey: environment\n tagValue: production\n schemaTag:\n type: databricks:EntityTagAssignment\n name: schema_tag\n properties:\n entityType: schemas\n entityName: production_catalog.sales_data\n tagKey: owner\n tagValue: sales-team\n tableTag:\n type: databricks:EntityTagAssignment\n name: table_tag\n properties:\n entityType: tables\n entityName: production_catalog.sales_data.customer_orders\n tagKey: data_classification\n tagValue: confidential\n columnTag:\n type: databricks:EntityTagAssignment\n name: column_tag\n properties:\n entityType: columns\n entityName: production_catalog.sales_data.customers.email_address\n tagKey: pii\n tagValue: email\n volumeTag:\n type: databricks:EntityTagAssignment\n name: volume_tag\n properties:\n entityType: volumes\n entityName: production_catalog.raw_data.landing_zone\n tagKey: purpose\n tagValue: data_ingestion\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "entityName": { "type": "string", "description": "The fully qualified name of the entity to which the tag is assigned\n" }, "entityType": { "type": "string", "description": "The type of the entity to which the tag is assigned\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EntityTagAssignmentProviderConfig:EntityTagAssignmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "(string) - The source type of the tag assignment, e.g., user-assigned or system-assigned. Possible values are: `TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION`\n" }, "tagKey": { "type": "string", "description": "The key of the tag\n" }, "tagValue": { "type": "string", "description": "The value of the tag\n" }, "updateTime": { "type": "string", "description": "(string) - The timestamp when the tag assignment was last updated\n" }, "updatedBy": { "type": "string", "description": "(string) - The user or principal who updated the tag assignment\n" } }, "required": [ "entityName", "entityType", "providerConfig", "sourceType", "tagKey", "updateTime", "updatedBy" ], "inputProperties": { "entityName": { "type": "string", "description": "The fully qualified name of the entity to which the tag is assigned\n" }, "entityType": { "type": "string", "description": "The type of the entity to which the tag is assigned\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EntityTagAssignmentProviderConfig:EntityTagAssignmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "tagKey": { "type": "string", "description": "The key of the tag\n" }, "tagValue": { "type": "string", "description": "The value of the tag\n" } }, "requiredInputs": [ "entityName", "entityType", "tagKey" ], "stateInputs": { "description": "Input properties used for looking up and filtering EntityTagAssignment resources.\n", "properties": { "entityName": { "type": "string", "description": "The fully qualified name of the entity to which the tag is assigned\n" }, "entityType": { "type": "string", "description": "The type of the entity to which the tag is assigned\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EntityTagAssignmentProviderConfig:EntityTagAssignmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "(string) - The source type of the tag assignment, e.g., user-assigned or system-assigned. Possible values are: `TAG_ASSIGNMENT_SOURCE_TYPE_SYSTEM_DATA_CLASSIFICATION`\n" }, "tagKey": { "type": "string", "description": "The key of the tag\n" }, "tagValue": { "type": "string", "description": "The value of the tag\n" }, "updateTime": { "type": "string", "description": "(string) - The timestamp when the tag assignment was last updated\n" }, "updatedBy": { "type": "string", "description": "(string) - The user or principal who updated the tag assignment\n" } }, "type": "object" } }, "databricks:index/environmentsDefaultWorkspaceBaseEnvironment:EnvironmentsDefaultWorkspaceBaseEnvironment": { "description": "[![GA](https://img.shields.io/badge/Release_Stage-GA-green)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/environments)\n\nThe Default Workspace Base Environment is a singleton resource that configures which workspace base environments are applied by default to new notebooks in the workspace. Defaults can be set separately for CPU and GPU compute.\n\nWithout a default configured, new notebooks do not use a workspace base environment by default.\n\n## Example Usage\n\n### Set Default for CPU Compute\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", {cpuWorkspaceBaseEnvironment: \"workspace-base-environments/my-base-env-12345\"});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", cpu_workspace_base_environment=\"workspace-base-environments/my-base-env-12345\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", new()\n {\n CpuWorkspaceBaseEnvironment = \"workspace-base-environments/my-base-env-12345\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewEnvironmentsDefaultWorkspaceBaseEnvironment(ctx, \"this\", \u0026databricks.EnvironmentsDefaultWorkspaceBaseEnvironmentArgs{\n\t\t\tCpuWorkspaceBaseEnvironment: pulumi.String(\"workspace-base-environments/my-base-env-12345\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_environmentsdefaultworkspacebaseenvironment\" \"this\" {\n cpu_workspace_base_environment = \"workspace-base-environments/my-base-env-12345\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.EnvironmentsDefaultWorkspaceBaseEnvironment;\nimport com.pulumi.databricks.EnvironmentsDefaultWorkspaceBaseEnvironmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", EnvironmentsDefaultWorkspaceBaseEnvironmentArgs.builder()\n .cpuWorkspaceBaseEnvironment(\"workspace-base-environments/my-base-env-12345\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:EnvironmentsDefaultWorkspaceBaseEnvironment\n properties:\n cpuWorkspaceBaseEnvironment: workspace-base-environments/my-base-env-12345\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Set Defaults for Both CPU and GPU Compute\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst cpuEnv = new databricks.EnvironmentsWorkspaceBaseEnvironment(\"cpu_env\", {\n displayName: \"my-cpu-environment\",\n filepath: \"/Volumes/catalog/schema/volume/cpu-environment.yaml\",\n});\nconst gpuEnv = new databricks.EnvironmentsWorkspaceBaseEnvironment(\"gpu_env\", {\n displayName: \"my-gpu-environment\",\n filepath: \"/Volumes/catalog/schema/volume/gpu-environment.yaml\",\n baseEnvironmentType: \"GPU\",\n});\nconst _this = new databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", {\n cpuWorkspaceBaseEnvironment: cpuEnv.name,\n gpuWorkspaceBaseEnvironment: gpuEnv.name,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncpu_env = databricks.EnvironmentsWorkspaceBaseEnvironment(\"cpu_env\",\n display_name=\"my-cpu-environment\",\n filepath=\"/Volumes/catalog/schema/volume/cpu-environment.yaml\")\ngpu_env = databricks.EnvironmentsWorkspaceBaseEnvironment(\"gpu_env\",\n display_name=\"my-gpu-environment\",\n filepath=\"/Volumes/catalog/schema/volume/gpu-environment.yaml\",\n base_environment_type=\"GPU\")\nthis = databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\",\n cpu_workspace_base_environment=cpu_env.name,\n gpu_workspace_base_environment=gpu_env.name)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var cpuEnv = new Databricks.EnvironmentsWorkspaceBaseEnvironment(\"cpu_env\", new()\n {\n DisplayName = \"my-cpu-environment\",\n Filepath = \"/Volumes/catalog/schema/volume/cpu-environment.yaml\",\n });\n\n var gpuEnv = new Databricks.EnvironmentsWorkspaceBaseEnvironment(\"gpu_env\", new()\n {\n DisplayName = \"my-gpu-environment\",\n Filepath = \"/Volumes/catalog/schema/volume/gpu-environment.yaml\",\n BaseEnvironmentType = \"GPU\",\n });\n\n var @this = new Databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", new()\n {\n CpuWorkspaceBaseEnvironment = cpuEnv.Name,\n GpuWorkspaceBaseEnvironment = gpuEnv.Name,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcpuEnv, err := databricks.NewEnvironmentsWorkspaceBaseEnvironment(ctx, \"cpu_env\", \u0026databricks.EnvironmentsWorkspaceBaseEnvironmentArgs{\n\t\t\tDisplayName: pulumi.String(\"my-cpu-environment\"),\n\t\t\tFilepath: pulumi.String(\"/Volumes/catalog/schema/volume/cpu-environment.yaml\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tgpuEnv, err := databricks.NewEnvironmentsWorkspaceBaseEnvironment(ctx, \"gpu_env\", \u0026databricks.EnvironmentsWorkspaceBaseEnvironmentArgs{\n\t\t\tDisplayName: pulumi.String(\"my-gpu-environment\"),\n\t\t\tFilepath: pulumi.String(\"/Volumes/catalog/schema/volume/gpu-environment.yaml\"),\n\t\t\tBaseEnvironmentType: pulumi.String(\"GPU\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewEnvironmentsDefaultWorkspaceBaseEnvironment(ctx, \"this\", \u0026databricks.EnvironmentsDefaultWorkspaceBaseEnvironmentArgs{\n\t\t\tCpuWorkspaceBaseEnvironment: cpuEnv.Name,\n\t\t\tGpuWorkspaceBaseEnvironment: gpuEnv.Name,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_environmentsworkspacebaseenvironment\" \"cpu_env\" {\n display_name = \"my-cpu-environment\"\n filepath = \"/Volumes/catalog/schema/volume/cpu-environment.yaml\"\n}\nresource \"databricks_environmentsworkspacebaseenvironment\" \"gpu_env\" {\n display_name = \"my-gpu-environment\"\n filepath = \"/Volumes/catalog/schema/volume/gpu-environment.yaml\"\n base_environment_type = \"GPU\"\n}\nresource \"databricks_environmentsdefaultworkspacebaseenvironment\" \"this\" {\n cpu_workspace_base_environment = databricks_environmentsworkspacebaseenvironment.cpu_env.name\n gpu_workspace_base_environment = databricks_environmentsworkspacebaseenvironment.gpu_env.name\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.EnvironmentsWorkspaceBaseEnvironment;\nimport com.pulumi.databricks.EnvironmentsWorkspaceBaseEnvironmentArgs;\nimport com.pulumi.databricks.EnvironmentsDefaultWorkspaceBaseEnvironment;\nimport com.pulumi.databricks.EnvironmentsDefaultWorkspaceBaseEnvironmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var cpuEnv = new EnvironmentsWorkspaceBaseEnvironment(\"cpuEnv\", EnvironmentsWorkspaceBaseEnvironmentArgs.builder()\n .displayName(\"my-cpu-environment\")\n .filepath(\"/Volumes/catalog/schema/volume/cpu-environment.yaml\")\n .build());\n\n var gpuEnv = new EnvironmentsWorkspaceBaseEnvironment(\"gpuEnv\", EnvironmentsWorkspaceBaseEnvironmentArgs.builder()\n .displayName(\"my-gpu-environment\")\n .filepath(\"/Volumes/catalog/schema/volume/gpu-environment.yaml\")\n .baseEnvironmentType(\"GPU\")\n .build());\n\n var this_ = new EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", EnvironmentsDefaultWorkspaceBaseEnvironmentArgs.builder()\n .cpuWorkspaceBaseEnvironment(cpuEnv.name())\n .gpuWorkspaceBaseEnvironment(gpuEnv.name())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n cpuEnv:\n type: databricks:EnvironmentsWorkspaceBaseEnvironment\n name: cpu_env\n properties:\n displayName: my-cpu-environment\n filepath: /Volumes/catalog/schema/volume/cpu-environment.yaml\n gpuEnv:\n type: databricks:EnvironmentsWorkspaceBaseEnvironment\n name: gpu_env\n properties:\n displayName: my-gpu-environment\n filepath: /Volumes/catalog/schema/volume/gpu-environment.yaml\n baseEnvironmentType: GPU\n this:\n type: databricks:EnvironmentsDefaultWorkspaceBaseEnvironment\n properties:\n cpuWorkspaceBaseEnvironment: ${cpuEnv.name}\n gpuWorkspaceBaseEnvironment: ${gpuEnv.name}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Unset Both Defaults\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\", {});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\");\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewEnvironmentsDefaultWorkspaceBaseEnvironment(ctx, \"this\", nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_environmentsdefaultworkspacebaseenvironment\" \"this\" {\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.EnvironmentsDefaultWorkspaceBaseEnvironment;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new EnvironmentsDefaultWorkspaceBaseEnvironment(\"this\");\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:EnvironmentsDefaultWorkspaceBaseEnvironment\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "cpuWorkspaceBaseEnvironment": { "type": "string", "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}\n" }, "gpuWorkspaceBaseEnvironment": { "type": "string", "description": "The default workspace base environment for GPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}\n" }, "name": { "type": "string", "description": "(string) - The resource name of this singleton resource.\nFormat: default-workspace-base-environment\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig:EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "required": [ "name", "providerConfig" ], "inputProperties": { "cpuWorkspaceBaseEnvironment": { "type": "string", "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}\n" }, "gpuWorkspaceBaseEnvironment": { "type": "string", "description": "The default workspace base environment for GPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig:EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering EnvironmentsDefaultWorkspaceBaseEnvironment resources.\n", "properties": { "cpuWorkspaceBaseEnvironment": { "type": "string", "description": "The default workspace base environment for CPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}\n" }, "gpuWorkspaceBaseEnvironment": { "type": "string", "description": "The default workspace base environment for GPU compute.\nFormat: workspace-base-environments/{workspace_base_environment}\n" }, "name": { "type": "string", "description": "(string) - The resource name of this singleton resource.\nFormat: default-workspace-base-environment\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig:EnvironmentsDefaultWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "type": "object" } }, "databricks:index/environmentsWorkspaceBaseEnvironment:EnvironmentsWorkspaceBaseEnvironment": { "description": "[![GA](https://img.shields.io/badge/Release_Stage-GA-green)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/environments)\n\nA Workspace Base Environment is a shareable specification that defines a serverless environment version and additional Python dependencies for serverless notebooks and jobs.\n\nBy pre-materializing environments, Databricks reduces startup time and ensures consistent, reproducible environments across notebooks and jobs within the workspace.\n\n**Note:** Each workspace is limited to 10 workspace base environments.\n\n## Example Usage\n\n### Basic Example\n\nThis example creates a Workspace Base Environment referencing an environment YAML file stored in a UC Volume.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.EnvironmentsWorkspaceBaseEnvironment(\"this\", {\n displayName: \"my-environment\",\n filepath: \"/Volumes/catalog/schema/volume/environment.yaml\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.EnvironmentsWorkspaceBaseEnvironment(\"this\",\n display_name=\"my-environment\",\n filepath=\"/Volumes/catalog/schema/volume/environment.yaml\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.EnvironmentsWorkspaceBaseEnvironment(\"this\", new()\n {\n DisplayName = \"my-environment\",\n Filepath = \"/Volumes/catalog/schema/volume/environment.yaml\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewEnvironmentsWorkspaceBaseEnvironment(ctx, \"this\", \u0026databricks.EnvironmentsWorkspaceBaseEnvironmentArgs{\n\t\t\tDisplayName: pulumi.String(\"my-environment\"),\n\t\t\tFilepath: pulumi.String(\"/Volumes/catalog/schema/volume/environment.yaml\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_environmentsworkspacebaseenvironment\" \"this\" {\n display_name = \"my-environment\"\n filepath = \"/Volumes/catalog/schema/volume/environment.yaml\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.EnvironmentsWorkspaceBaseEnvironment;\nimport com.pulumi.databricks.EnvironmentsWorkspaceBaseEnvironmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new EnvironmentsWorkspaceBaseEnvironment(\"this\", EnvironmentsWorkspaceBaseEnvironmentArgs.builder()\n .displayName(\"my-environment\")\n .filepath(\"/Volumes/catalog/schema/volume/environment.yaml\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:EnvironmentsWorkspaceBaseEnvironment\n properties:\n displayName: my-environment\n filepath: /Volumes/catalog/schema/volume/environment.yaml\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example with GPU Compute Type\n\nThis example creates a GPU-specific Workspace Base Environment.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst gpuEnv = new databricks.EnvironmentsWorkspaceBaseEnvironment(\"gpu_env\", {\n displayName: \"my-gpu-environment\",\n filepath: \"/Volumes/catalog/schema/volume/gpu-environment.yaml\",\n baseEnvironmentType: \"GPU\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ngpu_env = databricks.EnvironmentsWorkspaceBaseEnvironment(\"gpu_env\",\n display_name=\"my-gpu-environment\",\n filepath=\"/Volumes/catalog/schema/volume/gpu-environment.yaml\",\n base_environment_type=\"GPU\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var gpuEnv = new Databricks.EnvironmentsWorkspaceBaseEnvironment(\"gpu_env\", new()\n {\n DisplayName = \"my-gpu-environment\",\n Filepath = \"/Volumes/catalog/schema/volume/gpu-environment.yaml\",\n BaseEnvironmentType = \"GPU\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewEnvironmentsWorkspaceBaseEnvironment(ctx, \"gpu_env\", \u0026databricks.EnvironmentsWorkspaceBaseEnvironmentArgs{\n\t\t\tDisplayName: pulumi.String(\"my-gpu-environment\"),\n\t\t\tFilepath: pulumi.String(\"/Volumes/catalog/schema/volume/gpu-environment.yaml\"),\n\t\t\tBaseEnvironmentType: pulumi.String(\"GPU\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_environmentsworkspacebaseenvironment\" \"gpu_env\" {\n display_name = \"my-gpu-environment\"\n filepath = \"/Volumes/catalog/schema/volume/gpu-environment.yaml\"\n base_environment_type = \"GPU\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.EnvironmentsWorkspaceBaseEnvironment;\nimport com.pulumi.databricks.EnvironmentsWorkspaceBaseEnvironmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var gpuEnv = new EnvironmentsWorkspaceBaseEnvironment(\"gpuEnv\", EnvironmentsWorkspaceBaseEnvironmentArgs.builder()\n .displayName(\"my-gpu-environment\")\n .filepath(\"/Volumes/catalog/schema/volume/gpu-environment.yaml\")\n .baseEnvironmentType(\"GPU\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n gpuEnv:\n type: databricks:EnvironmentsWorkspaceBaseEnvironment\n name: gpu_env\n properties:\n displayName: my-gpu-environment\n filepath: /Volumes/catalog/schema/volume/gpu-environment.yaml\n baseEnvironmentType: GPU\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "baseEnvironmentType": { "type": "string", "description": "The type of base environment (CPU or GPU). Possible values are: `CPU`, `GPU`\n" }, "createTime": { "type": "string", "description": "(string) - Timestamp when the environment was created\n" }, "creatorUserId": { "type": "string", "description": "(string) - User ID of the creator\n" }, "displayName": { "type": "string", "description": "Human-readable display name for the workspace base environment\n" }, "effectiveBaseEnvironmentType": { "type": "string" }, "filepath": { "type": "string", "description": "The WSFS or UC Volumes path to the environment YAML file\n" }, "isDefault": { "type": "boolean", "description": "(boolean) - Whether this is the default environment for the workspace\n" }, "lastUpdatedUserId": { "type": "string", "description": "(string) - User ID of the last user who updated the environment\n" }, "message": { "type": "string", "description": "(string) - Status message providing additional details about the environment status\n" }, "name": { "type": "string", "description": "(string) - The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EnvironmentsWorkspaceBaseEnvironmentProviderConfig:EnvironmentsWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "status": { "type": "string", "description": "(string) - The status of the materialized workspace base environment. Possible values are: `CREATED`, `EXPIRED`, `FAILED`, `INVALID`, `PENDING`, `REFRESHING`\n" }, "updateTime": { "type": "string", "description": "(string) - Timestamp when the environment was last updated\n" }, "workspaceBaseEnvironmentId": { "type": "string", "description": "The ID to use for the workspace base environment, which will become the final component of\nthe resource name.\nThis value should be 4-63 characters, and valid characters are /[a-z][0-9]-/\n" } }, "required": [ "createTime", "creatorUserId", "displayName", "effectiveBaseEnvironmentType", "isDefault", "lastUpdatedUserId", "message", "name", "providerConfig", "status", "updateTime", "workspaceBaseEnvironmentId" ], "inputProperties": { "baseEnvironmentType": { "type": "string", "description": "The type of base environment (CPU or GPU). Possible values are: `CPU`, `GPU`\n" }, "displayName": { "type": "string", "description": "Human-readable display name for the workspace base environment\n" }, "filepath": { "type": "string", "description": "The WSFS or UC Volumes path to the environment YAML file\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EnvironmentsWorkspaceBaseEnvironmentProviderConfig:EnvironmentsWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "workspaceBaseEnvironmentId": { "type": "string", "description": "The ID to use for the workspace base environment, which will become the final component of\nthe resource name.\nThis value should be 4-63 characters, and valid characters are /[a-z][0-9]-/\n" } }, "requiredInputs": [ "displayName" ], "stateInputs": { "description": "Input properties used for looking up and filtering EnvironmentsWorkspaceBaseEnvironment resources.\n", "properties": { "baseEnvironmentType": { "type": "string", "description": "The type of base environment (CPU or GPU). Possible values are: `CPU`, `GPU`\n" }, "createTime": { "type": "string", "description": "(string) - Timestamp when the environment was created\n" }, "creatorUserId": { "type": "string", "description": "(string) - User ID of the creator\n" }, "displayName": { "type": "string", "description": "Human-readable display name for the workspace base environment\n" }, "effectiveBaseEnvironmentType": { "type": "string" }, "filepath": { "type": "string", "description": "The WSFS or UC Volumes path to the environment YAML file\n" }, "isDefault": { "type": "boolean", "description": "(boolean) - Whether this is the default environment for the workspace\n" }, "lastUpdatedUserId": { "type": "string", "description": "(string) - User ID of the last user who updated the environment\n" }, "message": { "type": "string", "description": "(string) - Status message providing additional details about the environment status\n" }, "name": { "type": "string", "description": "(string) - The resource name of the workspace base environment.\nFormat: workspace-base-environments/{workspace-base-environment}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/EnvironmentsWorkspaceBaseEnvironmentProviderConfig:EnvironmentsWorkspaceBaseEnvironmentProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "status": { "type": "string", "description": "(string) - The status of the materialized workspace base environment. Possible values are: `CREATED`, `EXPIRED`, `FAILED`, `INVALID`, `PENDING`, `REFRESHING`\n" }, "updateTime": { "type": "string", "description": "(string) - Timestamp when the environment was last updated\n" }, "workspaceBaseEnvironmentId": { "type": "string", "description": "The ID to use for the workspace base environment, which will become the final component of\nthe resource name.\nThis value should be 4-63 characters, and valid characters are /[a-z][0-9]-/\n" } }, "type": "object" } }, "databricks:index/externalLocation:ExternalLocation": { "description": "To work with external tables, Unity Catalog introduces two new objects to access and work with external cloud storage:\n\n-\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003erepresent authentication methods to access cloud storage (e.g. an IAM role for Amazon S3 or a service principal for Azure Storage). Storage credentials are access-controlled to determine which users can use the credential.\n- \u003cspan pulumi-lang-nodejs=\"`databricks.ExternalLocation`\" pulumi-lang-dotnet=\"`databricks.ExternalLocation`\" pulumi-lang-go=\"`ExternalLocation`\" pulumi-lang-python=\"`ExternalLocation`\" pulumi-lang-yaml=\"`databricks.ExternalLocation`\" pulumi-lang-java=\"`databricks.ExternalLocation`\" pulumi-lang-hcl=\"`databricks_external_location`\"\u003e`databricks.ExternalLocation`\u003c/span\u003e are objects that combine a cloud storage path with a Storage Credential that can be used to access the location.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\nFor AWS\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst external = new databricks.StorageCredential(\"external\", {\n name: externalDataAccess.name,\n awsIamRole: {\n roleArn: externalDataAccess.arn,\n },\n comment: \"Managed by TF\",\n});\nconst some = new databricks.ExternalLocation(\"some\", {\n name: \"external\",\n url: `s3://${externalAwsS3Bucket.id}/some`,\n credentialName: external.id,\n comment: \"Managed by TF\",\n});\nconst someGrants = new databricks.Grants(\"some\", {\n externalLocation: some.id,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal = databricks.StorageCredential(\"external\",\n name=external_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": external_data_access[\"arn\"],\n },\n comment=\"Managed by TF\")\nsome = databricks.ExternalLocation(\"some\",\n name=\"external\",\n url=f\"s3://{external_aws_s3_bucket['id']}/some\",\n credential_name=external.id,\n comment=\"Managed by TF\")\nsome_grants = databricks.Grants(\"some\",\n external_location=some.id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.StorageCredential(\"external\", new()\n {\n Name = externalDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.StorageCredentialAwsIamRoleArgs\n {\n RoleArn = externalDataAccess.Arn,\n },\n Comment = \"Managed by TF\",\n });\n\n var some = new Databricks.ExternalLocation(\"some\", new()\n {\n Name = \"external\",\n Url = $\"s3://{externalAwsS3Bucket.Id}/some\",\n CredentialName = external.Id,\n Comment = \"Managed by TF\",\n });\n\n var someGrants = new Databricks.Grants(\"some\", new()\n {\n ExternalLocation = some.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewStorageCredential(ctx, \"external\", \u0026databricks.StorageCredentialArgs{\n\t\t\tName: pulumi.Any(externalDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.StorageCredentialAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(externalDataAccess.Arn),\n\t\t\t},\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsome, err := databricks.NewExternalLocation(ctx, \"some\", \u0026databricks.ExternalLocationArgs{\n\t\t\tName: pulumi.String(\"external\"),\n\t\t\tUrl: pulumi.Sprintf(\"s3://%v/some\", externalAwsS3Bucket.Id),\n\t\t\tCredentialName: external.ID(),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"some\", \u0026databricks.GrantsArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_storagecredential\" \"external\" {\n name = externalDataAccess.name\n aws_iam_role = {\n role_arn = externalDataAccess.arn\n }\n comment = \"Managed by TF\"\n}\nresource \"databricks_externallocation\" \"some\" {\n name = \"external\"\n url =\"s3://${externalAwsS3Bucket.id}/some\"\n credential_name = databricks_storagecredential.external.id\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"some\" {\n external_location = databricks_externallocation.some.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.StorageCredential;\nimport com.pulumi.databricks.StorageCredentialArgs;\nimport com.pulumi.databricks.inputs.StorageCredentialAwsIamRoleArgs;\nimport com.pulumi.databricks.ExternalLocation;\nimport com.pulumi.databricks.ExternalLocationArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new StorageCredential(\"external\", StorageCredentialArgs.builder()\n .name(externalDataAccess.name())\n .awsIamRole(StorageCredentialAwsIamRoleArgs.builder()\n .roleArn(externalDataAccess.arn())\n .build())\n .comment(\"Managed by TF\")\n .build());\n\n var some = new ExternalLocation(\"some\", ExternalLocationArgs.builder()\n .name(\"external\")\n .url(String.format(\"s3://%s/some\", externalAwsS3Bucket.id()))\n .credentialName(external.id())\n .comment(\"Managed by TF\")\n .build());\n\n var someGrants = new Grants(\"someGrants\", GrantsArgs.builder()\n .externalLocation(some.id())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:StorageCredential\n properties:\n name: ${externalDataAccess.name}\n awsIamRole:\n roleArn: ${externalDataAccess.arn}\n comment: Managed by TF\n some:\n type: databricks:ExternalLocation\n properties:\n name: external\n url: s3://${externalAwsS3Bucket.id}/some\n credentialName: ${external.id}\n comment: Managed by TF\n someGrants:\n type: databricks:Grants\n name: some\n properties:\n externalLocation: ${some.id}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor Azure\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\n\nconst external = new databricks.StorageCredential(\"external\", {\n name: extCred.displayName,\n azureServicePrincipal: {\n directoryId: tenantId,\n applicationId: extCred.applicationId,\n clientSecret: extCredAzureadApplicationPassword.value,\n },\n comment: \"Managed by TF\",\n}, {\n dependsOn: [_this],\n});\nconst some = new databricks.ExternalLocation(\"some\", {\n name: \"external\",\n url: std.format({\n input: \"abfss://%s@%s.dfs.core.windows.net\",\n args: [\n extStorage.name,\n extStorageAzurermStorageAccount.name,\n ],\n }).then(invoke =\u003e invoke.result),\n credentialName: external.id,\n comment: \"Managed by TF\",\n}, {\n dependsOn: [_this],\n});\nconst someGrants = new databricks.Grants(\"some\", {\n externalLocation: some.id,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_std as std\n\nexternal = databricks.StorageCredential(\"external\",\n name=ext_cred[\"displayName\"],\n azure_service_principal={\n \"directory_id\": tenant_id,\n \"application_id\": ext_cred[\"applicationId\"],\n \"client_secret\": ext_cred_azuread_application_password[\"value\"],\n },\n comment=\"Managed by TF\",\n opts = pulumi.ResourceOptions(depends_on=[this]))\nsome = databricks.ExternalLocation(\"some\",\n name=\"external\",\n url=std.format(input=\"abfss://%s@%s.dfs.core.windows.net\",\n args=[\n ext_storage[\"name\"],\n ext_storage_azurerm_storage_account[\"name\"],\n ]).result,\n credential_name=external.id,\n comment=\"Managed by TF\",\n opts = pulumi.ResourceOptions(depends_on=[this]))\nsome_grants = databricks.Grants(\"some\",\n external_location=some.id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.StorageCredential(\"external\", new()\n {\n Name = extCred.DisplayName,\n AzureServicePrincipal = new Databricks.Inputs.StorageCredentialAzureServicePrincipalArgs\n {\n DirectoryId = tenantId,\n ApplicationId = extCred.ApplicationId,\n ClientSecret = extCredAzureadApplicationPassword.Value,\n },\n Comment = \"Managed by TF\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n @this,\n },\n });\n\n var some = new Databricks.ExternalLocation(\"some\", new()\n {\n Name = \"external\",\n Url = Std.Format.Invoke(new()\n {\n Input = \"abfss://%s@%s.dfs.core.windows.net\",\n Args = new[]\n {\n extStorage.Name,\n extStorageAzurermStorageAccount.Name,\n },\n }).Apply(invoke =\u003e invoke.Result),\n CredentialName = external.Id,\n Comment = \"Managed by TF\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n @this,\n },\n });\n\n var someGrants = new Databricks.Grants(\"some\", new()\n {\n ExternalLocation = some.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewStorageCredential(ctx, \"external\", \u0026databricks.StorageCredentialArgs{\n\t\t\tName: pulumi.Any(extCred.DisplayName),\n\t\t\tAzureServicePrincipal: \u0026databricks.StorageCredentialAzureServicePrincipalArgs{\n\t\t\t\tDirectoryId: pulumi.Any(tenantId),\n\t\t\t\tApplicationId: pulumi.Any(extCred.ApplicationId),\n\t\t\t\tClientSecret: pulumi.Any(extCredAzureadApplicationPassword.Value),\n\t\t\t},\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthis,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tinvokeFormat, err := std.Format(ctx, \u0026std.FormatArgs{\n\t\t\tInput: \"abfss://%s@%s.dfs.core.windows.net\",\n\t\t\tArgs: []interface{}{\n\t\t\t\textStorage.Name,\n\t\t\t\textStorageAzurermStorageAccount.Name,\n\t\t\t},\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsome, err := databricks.NewExternalLocation(ctx, \"some\", \u0026databricks.ExternalLocationArgs{\n\t\t\tName: pulumi.String(\"external\"),\n\t\t\tUrl: pulumi.String(invokeFormat.Result),\n\t\t\tCredentialName: external.ID(),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthis,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"some\", \u0026databricks.GrantsArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n }\n}\n\ndata \"std_format\" \"invoke_0\" {\n input = \"abfss://%s@%s.dfs.core.windows.net\"\n args = [extStorage.name, extStorageAzurermStorageAccount.name]\n}\n\nresource \"databricks_storagecredential\" \"external\" {\n depends_on = [this]\n name = extCred.displayName\n azure_service_principal = {\n directory_id = tenantId\n application_id = extCred.applicationId\n client_secret = extCredAzureadApplicationPassword.value\n }\n comment = \"Managed by TF\"\n}\nresource \"databricks_externallocation\" \"some\" {\n depends_on = [this]\n name = \"external\"\n url = data.std_format.invoke_0.result\n credential_name = databricks_storagecredential.external.id\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"some\" {\n external_location = databricks_externallocation.some.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.StorageCredential;\nimport com.pulumi.databricks.StorageCredentialArgs;\nimport com.pulumi.databricks.inputs.StorageCredentialAzureServicePrincipalArgs;\nimport com.pulumi.databricks.ExternalLocation;\nimport com.pulumi.databricks.ExternalLocationArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.FormatArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new StorageCredential(\"external\", StorageCredentialArgs.builder()\n .name(extCred.displayName())\n .azureServicePrincipal(StorageCredentialAzureServicePrincipalArgs.builder()\n .directoryId(tenantId)\n .applicationId(extCred.applicationId())\n .clientSecret(extCredAzureadApplicationPassword.value())\n .build())\n .comment(\"Managed by TF\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(this_)\n .build());\n\n var some = new ExternalLocation(\"some\", ExternalLocationArgs.builder()\n .name(\"external\")\n .url(StdFunctions.format(FormatArgs.builder()\n .input(\"abfss://%s@%s.dfs.core.windows.net\")\n .args( \n extStorage.name(),\n extStorageAzurermStorageAccount.name())\n .build()).result())\n .credentialName(external.id())\n .comment(\"Managed by TF\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(this_)\n .build());\n\n var someGrants = new Grants(\"someGrants\", GrantsArgs.builder()\n .externalLocation(some.id())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:StorageCredential\n properties:\n name: ${extCred.displayName}\n azureServicePrincipal:\n directoryId: ${tenantId}\n applicationId: ${extCred.applicationId}\n clientSecret: ${extCredAzureadApplicationPassword.value}\n comment: Managed by TF\n options:\n dependsOn:\n - ${this}\n some:\n type: databricks:ExternalLocation\n properties:\n name: external\n url:\n fn::invoke:\n function: std:format\n arguments:\n input: abfss://%s@%s.dfs.core.windows.net\n args:\n - ${extStorage.name}\n - ${extStorageAzurermStorageAccount.name}\n return: result\n credentialName: ${external.id}\n comment: Managed by TF\n options:\n dependsOn:\n - ${this}\n someGrants:\n type: databricks:Grants\n name: some\n properties:\n externalLocation: ${some.id}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor GCP\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst ext = new databricks.StorageCredential(\"ext\", {\n name: \"the-creds\",\n databricksGcpServiceAccount: {},\n});\nconst some = new databricks.ExternalLocation(\"some\", {\n name: \"the-ext-location\",\n url: `gs://${extBucket.name}`,\n credentialName: ext.id,\n comment: \"Managed by TF\",\n});\nconst someGrants = new databricks.Grants(\"some\", {\n externalLocation: some.id,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\next = databricks.StorageCredential(\"ext\",\n name=\"the-creds\",\n databricks_gcp_service_account={})\nsome = databricks.ExternalLocation(\"some\",\n name=\"the-ext-location\",\n url=f\"gs://{ext_bucket['name']}\",\n credential_name=ext.id,\n comment=\"Managed by TF\")\nsome_grants = databricks.Grants(\"some\",\n external_location=some.id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ext = new Databricks.StorageCredential(\"ext\", new()\n {\n Name = \"the-creds\",\n DatabricksGcpServiceAccount = null,\n });\n\n var some = new Databricks.ExternalLocation(\"some\", new()\n {\n Name = \"the-ext-location\",\n Url = $\"gs://{extBucket.Name}\",\n CredentialName = ext.Id,\n Comment = \"Managed by TF\",\n });\n\n var someGrants = new Databricks.Grants(\"some\", new()\n {\n ExternalLocation = some.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\text, err := databricks.NewStorageCredential(ctx, \"ext\", \u0026databricks.StorageCredentialArgs{\n\t\t\tName: pulumi.String(\"the-creds\"),\n\t\t\tDatabricksGcpServiceAccount: \u0026databricks.StorageCredentialDatabricksGcpServiceAccountArgs{},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsome, err := databricks.NewExternalLocation(ctx, \"some\", \u0026databricks.ExternalLocationArgs{\n\t\t\tName: pulumi.String(\"the-ext-location\"),\n\t\t\tUrl: pulumi.Sprintf(\"gs://%v\", extBucket.Name),\n\t\t\tCredentialName: ext.ID(),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"some\", \u0026databricks.GrantsArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_storagecredential\" \"ext\" {\n name = \"the-creds\"\n databricks_gcp_service_account = {}\n}\nresource \"databricks_externallocation\" \"some\" {\n name = \"the-ext-location\"\n url =\"gs://${extBucket.name}\"\n credential_name = databricks_storagecredential.ext.id\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"some\" {\n external_location = databricks_externallocation.some.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.StorageCredential;\nimport com.pulumi.databricks.StorageCredentialArgs;\nimport com.pulumi.databricks.inputs.StorageCredentialDatabricksGcpServiceAccountArgs;\nimport com.pulumi.databricks.ExternalLocation;\nimport com.pulumi.databricks.ExternalLocationArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ext = new StorageCredential(\"ext\", StorageCredentialArgs.builder()\n .name(\"the-creds\")\n .databricksGcpServiceAccount(StorageCredentialDatabricksGcpServiceAccountArgs.builder()\n .build())\n .build());\n\n var some = new ExternalLocation(\"some\", ExternalLocationArgs.builder()\n .name(\"the-ext-location\")\n .url(String.format(\"gs://%s\", extBucket.name()))\n .credentialName(ext.id())\n .comment(\"Managed by TF\")\n .build());\n\n var someGrants = new Grants(\"someGrants\", GrantsArgs.builder()\n .externalLocation(some.id())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ext:\n type: databricks:StorageCredential\n properties:\n name: the-creds\n databricksGcpServiceAccount: {}\n some:\n type: databricks:ExternalLocation\n properties:\n name: the-ext-location\n url: gs://${extBucket.name}\n credentialName: ${ext.id}\n comment: Managed by TF\n someGrants:\n type: databricks:Grants\n name: some\n properties:\n externalLocation: ${some.id}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nExample \u003cspan pulumi-lang-nodejs=\"`encryptionDetails`\" pulumi-lang-dotnet=\"`EncryptionDetails`\" pulumi-lang-go=\"`encryptionDetails`\" pulumi-lang-python=\"`encryption_details`\" pulumi-lang-yaml=\"`encryptionDetails`\" pulumi-lang-java=\"`encryptionDetails`\" pulumi-lang-hcl=\"`encryption_details`\"\u003e`encryptionDetails`\u003c/span\u003e specifying SSE_S3 encryption:\n\n", "properties": { "browseOnly": { "type": "boolean" }, "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "createdAt": { "type": "integer", "description": "Time at which this external location was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of external location creator.\n" }, "credentialId": { "type": "string", "description": "Unique ID of the location's storage credential.\n" }, "credentialName": { "type": "string", "description": "Name of the\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003eto use with this external location.\n" }, "effectiveEnableFileEvents": { "type": "boolean" }, "effectiveFileEventQueue": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueue:ExternalLocationEffectiveFileEventQueue" }, "enableFileEvents": { "type": "boolean", "description": "indicates if managed file events are enabled for this external location. Requires \u003cspan pulumi-lang-nodejs=\"`fileEventQueue`\" pulumi-lang-dotnet=\"`FileEventQueue`\" pulumi-lang-go=\"`fileEventQueue`\" pulumi-lang-python=\"`file_event_queue`\" pulumi-lang-yaml=\"`fileEventQueue`\" pulumi-lang-java=\"`fileEventQueue`\" pulumi-lang-hcl=\"`file_event_queue`\"\u003e`fileEventQueue`\u003c/span\u003e block.\n" }, "encryptionDetails": { "$ref": "#/types/databricks:index/ExternalLocationEncryptionDetails:ExternalLocationEncryptionDetails" }, "fallback": { "type": "boolean", "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled (disabled by default), the access to the location falls back to cluster credentials if UC credentials are not sufficient.\n" }, "fileEventQueue": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueue:ExternalLocationFileEventQueue" }, "forceDestroy": { "type": "boolean", "description": "Destroy external location regardless of its dependents.\n" }, "forceUpdate": { "type": "boolean", "description": "Update external location regardless of its dependents.\n" }, "isolationMode": { "type": "string", "description": "Whether the external location is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the external location to `ISOLATION_MODE_ISOLATED` will automatically allow access from the current workspace.\n" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the external location owner.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ExternalLocationProviderConfig:ExternalLocationProviderConfig" }, "readOnly": { "type": "boolean", "description": "Indicates whether the external location is read-only.\n" }, "skipValidation": { "type": "boolean", "description": "Suppress validation errors if any \u0026 force save the external location\n" }, "updatedAt": { "type": "integer", "description": "Time at which external location this was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the external location.\n" }, "url": { "type": "string", "description": "Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure), `gs://[bucket-host]/[bucket-dir]` (GCP). If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.).\n" } }, "required": [ "browseOnly", "createdAt", "createdBy", "credentialId", "credentialName", "effectiveEnableFileEvents", "effectiveFileEventQueue", "isolationMode", "metastoreId", "name", "owner", "providerConfig", "updatedAt", "updatedBy", "url" ], "inputProperties": { "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "credentialName": { "type": "string", "description": "Name of the\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003eto use with this external location.\n" }, "effectiveFileEventQueue": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueue:ExternalLocationEffectiveFileEventQueue" }, "enableFileEvents": { "type": "boolean", "description": "indicates if managed file events are enabled for this external location. Requires \u003cspan pulumi-lang-nodejs=\"`fileEventQueue`\" pulumi-lang-dotnet=\"`FileEventQueue`\" pulumi-lang-go=\"`fileEventQueue`\" pulumi-lang-python=\"`file_event_queue`\" pulumi-lang-yaml=\"`fileEventQueue`\" pulumi-lang-java=\"`fileEventQueue`\" pulumi-lang-hcl=\"`file_event_queue`\"\u003e`fileEventQueue`\u003c/span\u003e block.\n" }, "encryptionDetails": { "$ref": "#/types/databricks:index/ExternalLocationEncryptionDetails:ExternalLocationEncryptionDetails" }, "fallback": { "type": "boolean", "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled (disabled by default), the access to the location falls back to cluster credentials if UC credentials are not sufficient.\n" }, "fileEventQueue": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueue:ExternalLocationFileEventQueue" }, "forceDestroy": { "type": "boolean", "description": "Destroy external location regardless of its dependents.\n" }, "forceUpdate": { "type": "boolean", "description": "Update external location regardless of its dependents.\n" }, "isolationMode": { "type": "string", "description": "Whether the external location is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the external location to `ISOLATION_MODE_ISOLATED` will automatically allow access from the current workspace.\n" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the external location owner.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ExternalLocationProviderConfig:ExternalLocationProviderConfig" }, "readOnly": { "type": "boolean", "description": "Indicates whether the external location is read-only.\n" }, "skipValidation": { "type": "boolean", "description": "Suppress validation errors if any \u0026 force save the external location\n" }, "url": { "type": "string", "description": "Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure), `gs://[bucket-host]/[bucket-dir]` (GCP). If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.).\n" } }, "requiredInputs": [ "credentialName", "url" ], "stateInputs": { "description": "Input properties used for looking up and filtering ExternalLocation resources.\n", "properties": { "browseOnly": { "type": "boolean" }, "comment": { "type": "string", "description": "User-supplied free-form text.\n" }, "createdAt": { "type": "integer", "description": "Time at which this external location was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of external location creator.\n" }, "credentialId": { "type": "string", "description": "Unique ID of the location's storage credential.\n" }, "credentialName": { "type": "string", "description": "Name of the\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003eto use with this external location.\n" }, "effectiveEnableFileEvents": { "type": "boolean" }, "effectiveFileEventQueue": { "$ref": "#/types/databricks:index/ExternalLocationEffectiveFileEventQueue:ExternalLocationEffectiveFileEventQueue" }, "enableFileEvents": { "type": "boolean", "description": "indicates if managed file events are enabled for this external location. Requires \u003cspan pulumi-lang-nodejs=\"`fileEventQueue`\" pulumi-lang-dotnet=\"`FileEventQueue`\" pulumi-lang-go=\"`fileEventQueue`\" pulumi-lang-python=\"`file_event_queue`\" pulumi-lang-yaml=\"`fileEventQueue`\" pulumi-lang-java=\"`fileEventQueue`\" pulumi-lang-hcl=\"`file_event_queue`\"\u003e`fileEventQueue`\u003c/span\u003e block.\n" }, "encryptionDetails": { "$ref": "#/types/databricks:index/ExternalLocationEncryptionDetails:ExternalLocationEncryptionDetails" }, "fallback": { "type": "boolean", "description": "Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled (disabled by default), the access to the location falls back to cluster credentials if UC credentials are not sufficient.\n" }, "fileEventQueue": { "$ref": "#/types/databricks:index/ExternalLocationFileEventQueue:ExternalLocationFileEventQueue" }, "forceDestroy": { "type": "boolean", "description": "Destroy external location regardless of its dependents.\n" }, "forceUpdate": { "type": "boolean", "description": "Update external location regardless of its dependents.\n" }, "isolationMode": { "type": "string", "description": "Whether the external location is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the external location to `ISOLATION_MODE_ISOLATED` will automatically allow access from the current workspace.\n" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "description": "Name of External Location, which must be unique within the databricks_metastore. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the external location owner.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ExternalLocationProviderConfig:ExternalLocationProviderConfig" }, "readOnly": { "type": "boolean", "description": "Indicates whether the external location is read-only.\n" }, "skipValidation": { "type": "boolean", "description": "Suppress validation errors if any \u0026 force save the external location\n" }, "updatedAt": { "type": "integer", "description": "Time at which external location this was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the external location.\n" }, "url": { "type": "string", "description": "Path URL in cloud storage, of the form: `s3://[bucket-host]/[bucket-dir]` (AWS), `abfss://[user]@[host]/[path]` (Azure), `gs://[bucket-host]/[bucket-dir]` (GCP). If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.).\n" } }, "type": "object" } }, "databricks:index/externalMetadata:ExternalMetadata": { "description": "[![Public Preview](https://img.shields.io/badge/Release_Stage-Public_Preview-yellowgreen)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/externalmetadata)\n\nTo enrich lineage with workloads that are run outside of Databricks (for example, first mile ETL or last mile BI),\nUnity Catalog is introducing the external metadata object. UC lets you add external metadata objects to augment the data lineage it captures automatically, giving you an end-to-end lineage view in UC. \nThis is useful when you want to capture where data came from (for example, Salesforce or MySQL) before it was ingested into UC or where data is being consumed outside UC (for example, Tableau or PowerBI).\n\n\u003e **Note** This resource can only be used with an workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.ExternalMetadata(\"this\", {\n name: \"security_events_stream\",\n systemType: \"KAFKA\",\n entityType: \"Topic\",\n url: \"https://kafka.com/12345\",\n description: \"A stream of security related events in the critical services.\",\n columns: [\n \"type\",\n \"message\",\n \"details\",\n \"date\",\n \"time\",\n ],\n properties: {\n topic: \"prod.security.events.raw\",\n enabled: \"true\",\n format: \"zstd\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.ExternalMetadata(\"this\",\n name=\"security_events_stream\",\n system_type=\"KAFKA\",\n entity_type=\"Topic\",\n url=\"https://kafka.com/12345\",\n description=\"A stream of security related events in the critical services.\",\n columns=[\n \"type\",\n \"message\",\n \"details\",\n \"date\",\n \"time\",\n ],\n properties={\n \"topic\": \"prod.security.events.raw\",\n \"enabled\": \"true\",\n \"format\": \"zstd\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.ExternalMetadata(\"this\", new()\n {\n Name = \"security_events_stream\",\n SystemType = \"KAFKA\",\n EntityType = \"Topic\",\n Url = \"https://kafka.com/12345\",\n Description = \"A stream of security related events in the critical services.\",\n Columns = new[]\n {\n \"type\",\n \"message\",\n \"details\",\n \"date\",\n \"time\",\n },\n Properties = \n {\n { \"topic\", \"prod.security.events.raw\" },\n { \"enabled\", \"true\" },\n { \"format\", \"zstd\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewExternalMetadata(ctx, \"this\", \u0026databricks.ExternalMetadataArgs{\n\t\t\tName: pulumi.String(\"security_events_stream\"),\n\t\t\tSystemType: pulumi.String(\"KAFKA\"),\n\t\t\tEntityType: pulumi.String(\"Topic\"),\n\t\t\tUrl: pulumi.String(\"https://kafka.com/12345\"),\n\t\t\tDescription: pulumi.String(\"A stream of security related events in the critical services.\"),\n\t\t\tColumns: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"type\"),\n\t\t\t\tpulumi.String(\"message\"),\n\t\t\t\tpulumi.String(\"details\"),\n\t\t\t\tpulumi.String(\"date\"),\n\t\t\t\tpulumi.String(\"time\"),\n\t\t\t},\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"topic\": pulumi.String(\"prod.security.events.raw\"),\n\t\t\t\t\"enabled\": pulumi.String(\"true\"),\n\t\t\t\t\"format\": pulumi.String(\"zstd\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_externalmetadata\" \"this\" {\n name = \"security_events_stream\"\n system_type = \"KAFKA\"\n entity_type = \"Topic\"\n url = \"https://kafka.com/12345\"\n description = \"A stream of security related events in the critical services.\"\n columns = [\"type\", \"message\", \"details\", \"date\", \"time\"]\n properties = {\n \"topic\" = \"prod.security.events.raw\"\n \"enabled\" = \"true\"\n \"format\" = \"zstd\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ExternalMetadata;\nimport com.pulumi.databricks.ExternalMetadataArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new ExternalMetadata(\"this\", ExternalMetadataArgs.builder()\n .name(\"security_events_stream\")\n .systemType(\"KAFKA\")\n .entityType(\"Topic\")\n .url(\"https://kafka.com/12345\")\n .description(\"A stream of security related events in the critical services.\")\n .columns( \n \"type\",\n \"message\",\n \"details\",\n \"date\",\n \"time\")\n .properties(Map.ofEntries(\n Map.entry(\"topic\", \"prod.security.events.raw\"),\n Map.entry(\"enabled\", \"true\"),\n Map.entry(\"format\", \"zstd\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:ExternalMetadata\n properties:\n name: security_events_stream\n systemType: KAFKA\n entityType: Topic\n url: https://kafka.com/12345\n description: A stream of security related events in the critical services.\n columns:\n - type\n - message\n - details\n - date\n - time\n properties:\n topic: prod.security.events.raw\n enabled: 'true'\n format: zstd\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "columns": { "type": "array", "items": { "type": "string" }, "description": "List of columns associated with the external metadata object\n" }, "createTime": { "type": "string", "description": "(string) - Time at which this external metadata object was created\n" }, "createdBy": { "type": "string", "description": "(string) - Username of external metadata object creator\n" }, "description": { "type": "string", "description": "User-provided free-form text description\n" }, "entityType": { "type": "string", "description": "Type of entity within the external system\n" }, "metastoreId": { "type": "string", "description": "(string) - Unique identifier of parent metastore\n" }, "name": { "type": "string", "description": "Name of the external metadata object\n" }, "owner": { "type": "string", "description": "Owner of the external metadata object\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of key-value properties attached to the external metadata object\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ExternalMetadataProviderConfig:ExternalMetadataProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "systemType": { "type": "string", "description": "Type of external system. Possible values are: `AMAZON_REDSHIFT`, `AZURE_SYNAPSE`, `CONFLUENT`, `DATABRICKS`, `GOOGLE_BIGQUERY`, `KAFKA`, `LOOKER`, `MICROSOFT_FABRIC`, `MICROSOFT_SQL_SERVER`, `MONGODB`, `MYSQL`, `ORACLE`, `OTHER`, `POSTGRESQL`, `POWER_BI`, `SALESFORCE`, `SAP`, `SERVICENOW`, `SNOWFLAKE`, `STREAM_NATIVE`, `TABLEAU`, `TERADATA`, `WORKDAY`\n" }, "updateTime": { "type": "string", "description": "(string) - Time at which this external metadata object was last modified\n" }, "updatedBy": { "type": "string", "description": "(string) - Username of user who last modified external metadata object\n" }, "url": { "type": "string", "description": "URL associated with the external metadata object\n" } }, "required": [ "createTime", "createdBy", "entityType", "metastoreId", "name", "providerConfig", "systemType", "updateTime", "updatedBy" ], "inputProperties": { "columns": { "type": "array", "items": { "type": "string" }, "description": "List of columns associated with the external metadata object\n" }, "description": { "type": "string", "description": "User-provided free-form text description\n" }, "entityType": { "type": "string", "description": "Type of entity within the external system\n" }, "name": { "type": "string", "description": "Name of the external metadata object\n" }, "owner": { "type": "string", "description": "Owner of the external metadata object\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of key-value properties attached to the external metadata object\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ExternalMetadataProviderConfig:ExternalMetadataProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "systemType": { "type": "string", "description": "Type of external system. Possible values are: `AMAZON_REDSHIFT`, `AZURE_SYNAPSE`, `CONFLUENT`, `DATABRICKS`, `GOOGLE_BIGQUERY`, `KAFKA`, `LOOKER`, `MICROSOFT_FABRIC`, `MICROSOFT_SQL_SERVER`, `MONGODB`, `MYSQL`, `ORACLE`, `OTHER`, `POSTGRESQL`, `POWER_BI`, `SALESFORCE`, `SAP`, `SERVICENOW`, `SNOWFLAKE`, `STREAM_NATIVE`, `TABLEAU`, `TERADATA`, `WORKDAY`\n" }, "url": { "type": "string", "description": "URL associated with the external metadata object\n" } }, "requiredInputs": [ "entityType", "systemType" ], "stateInputs": { "description": "Input properties used for looking up and filtering ExternalMetadata resources.\n", "properties": { "columns": { "type": "array", "items": { "type": "string" }, "description": "List of columns associated with the external metadata object\n" }, "createTime": { "type": "string", "description": "(string) - Time at which this external metadata object was created\n" }, "createdBy": { "type": "string", "description": "(string) - Username of external metadata object creator\n" }, "description": { "type": "string", "description": "User-provided free-form text description\n" }, "entityType": { "type": "string", "description": "Type of entity within the external system\n" }, "metastoreId": { "type": "string", "description": "(string) - Unique identifier of parent metastore\n" }, "name": { "type": "string", "description": "Name of the external metadata object\n" }, "owner": { "type": "string", "description": "Owner of the external metadata object\n" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of key-value properties attached to the external metadata object\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ExternalMetadataProviderConfig:ExternalMetadataProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "systemType": { "type": "string", "description": "Type of external system. Possible values are: `AMAZON_REDSHIFT`, `AZURE_SYNAPSE`, `CONFLUENT`, `DATABRICKS`, `GOOGLE_BIGQUERY`, `KAFKA`, `LOOKER`, `MICROSOFT_FABRIC`, `MICROSOFT_SQL_SERVER`, `MONGODB`, `MYSQL`, `ORACLE`, `OTHER`, `POSTGRESQL`, `POWER_BI`, `SALESFORCE`, `SAP`, `SERVICENOW`, `SNOWFLAKE`, `STREAM_NATIVE`, `TABLEAU`, `TERADATA`, `WORKDAY`\n" }, "updateTime": { "type": "string", "description": "(string) - Time at which this external metadata object was last modified\n" }, "updatedBy": { "type": "string", "description": "(string) - Username of user who last modified external metadata object\n" }, "url": { "type": "string", "description": "URL associated with the external metadata object\n" } }, "type": "object" } }, "databricks:index/featureEngineeringFeature:FeatureEngineeringFeature": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n", "properties": { "catalogName": { "type": "string", "description": "(string) - Name of parent catalog\n" }, "createdAt": { "type": "string", "description": "(string) - Time at which this feature was created\n" }, "createdBy": { "type": "string", "description": "(string) - Username of the feature creator\n" }, "description": { "type": "string", "description": "The description of the feature\n" }, "entities": { "type": "array", "items": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureEntity:FeatureEngineeringFeatureEntity" }, "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup\n" }, "filterCondition": { "type": "string", "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value\n" }, "function": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunction:FeatureEngineeringFeatureFunction", "description": "The function by which the feature is computed\n" }, "inputs": { "type": "array", "items": { "type": "string" }, "description": "Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed\n" }, "lineageContext": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureLineageContext:FeatureEngineeringFeatureLineageContext", "description": "Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users\n" }, "name": { "type": "string", "description": "(string) - Name of the feature, extracted from the full three-part name (catalog.schema.name)\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureProviderConfig:FeatureEngineeringFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "schemaName": { "type": "string", "description": "(string) - Name of parent schema relative to its parent catalog\n" }, "source": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSource:FeatureEngineeringFeatureSource", "description": "The data source of the feature\n" }, "timeWindow": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindow:FeatureEngineeringFeatureTimeWindow", "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed\n" }, "timeseriesColumn": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeseriesColumn:FeatureEngineeringFeatureTimeseriesColumn", "description": "Column recording time, used for point-in-time joins, backfills, and aggregations\n" } }, "required": [ "catalogName", "createdAt", "createdBy", "fullName", "function", "name", "providerConfig", "schemaName", "source" ], "inputProperties": { "description": { "type": "string", "description": "The description of the feature\n" }, "entities": { "type": "array", "items": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureEntity:FeatureEngineeringFeatureEntity" }, "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup\n" }, "filterCondition": { "type": "string", "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value\n" }, "function": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunction:FeatureEngineeringFeatureFunction", "description": "The function by which the feature is computed\n" }, "inputs": { "type": "array", "items": { "type": "string" }, "description": "Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed\n" }, "lineageContext": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureLineageContext:FeatureEngineeringFeatureLineageContext", "description": "Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureProviderConfig:FeatureEngineeringFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "source": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSource:FeatureEngineeringFeatureSource", "description": "The data source of the feature\n" }, "timeWindow": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindow:FeatureEngineeringFeatureTimeWindow", "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed\n" }, "timeseriesColumn": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeseriesColumn:FeatureEngineeringFeatureTimeseriesColumn", "description": "Column recording time, used for point-in-time joins, backfills, and aggregations\n" } }, "requiredInputs": [ "fullName", "function", "source" ], "stateInputs": { "description": "Input properties used for looking up and filtering FeatureEngineeringFeature resources.\n", "properties": { "catalogName": { "type": "string", "description": "(string) - Name of parent catalog\n" }, "createdAt": { "type": "string", "description": "(string) - Time at which this feature was created\n" }, "createdBy": { "type": "string", "description": "(string) - Username of the feature creator\n" }, "description": { "type": "string", "description": "The description of the feature\n" }, "entities": { "type": "array", "items": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureEntity:FeatureEngineeringFeatureEntity" }, "description": "The entity columns for the feature, used as aggregation keys and for query-time lookup\n" }, "filterCondition": { "type": "string", "description": "Deprecated: Use DeltaTableSource.filter_condition or KafkaSource.filter_condition instead. Kept for backwards compatibility.\nThe filter condition applied to the source data before aggregation\n" }, "fullName": { "type": "string", "description": "The full three-part name (catalog, schema, name) of the feature. This is the\nfeature's resource identifier; the catalog_name, schema_name, and name fields\nbelow are OUTPUT_ONLY decomposed views of this value\n" }, "function": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureFunction:FeatureEngineeringFeatureFunction", "description": "The function by which the feature is computed\n" }, "inputs": { "type": "array", "items": { "type": "string" }, "description": "Deprecated: Use AggregationFunction.inputs instead. Kept for backwards compatibility.\nThe input columns from which the feature is computed\n" }, "lineageContext": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureLineageContext:FeatureEngineeringFeatureLineageContext", "description": "Lineage context information for this feature.\nWARNING: This field is primarily intended for internal use by Databricks systems and\nis automatically populated when features are created through Databricks notebooks or jobs.\nUsers should not manually set this field as incorrect values may lead to inaccurate lineage tracking or unexpected behavior.\nThis field will be set by feature-engineering client and should be left unset by SDK and terraform users\n" }, "name": { "type": "string", "description": "(string) - Name of the feature, extracted from the full three-part name (catalog.schema.name)\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureProviderConfig:FeatureEngineeringFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "schemaName": { "type": "string", "description": "(string) - Name of parent schema relative to its parent catalog\n" }, "source": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureSource:FeatureEngineeringFeatureSource", "description": "The data source of the feature\n" }, "timeWindow": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeWindow:FeatureEngineeringFeatureTimeWindow", "description": "Deprecated: Use Function.aggregation_function.time_window instead. Kept for backwards compatibility.\nThe time window in which the feature is computed\n" }, "timeseriesColumn": { "$ref": "#/types/databricks:index/FeatureEngineeringFeatureTimeseriesColumn:FeatureEngineeringFeatureTimeseriesColumn", "description": "Column recording time, used for point-in-time joins, backfills, and aggregations\n" } }, "type": "object" } }, "databricks:index/featureEngineeringKafkaConfig:FeatureEngineeringKafkaConfig": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n", "properties": { "authConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfig:FeatureEngineeringKafkaConfigAuthConfig", "description": "Authentication configuration for connection to topics\n" }, "backfillSource": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigBackfillSource:FeatureEngineeringKafkaConfigBackfillSource", "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config\n" }, "bootstrapServers": { "type": "string", "description": "A comma-separated list of host/port pairs pointing to Kafka cluster\n" }, "extraOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)\n" }, "keySchema": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigKeySchema:FeatureEngineeringKafkaConfigKeySchema", "description": "Schema configuration for extracting message keys from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" }, "name": { "type": "string", "description": "(string) - Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigProviderConfig:FeatureEngineeringKafkaConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "subscriptionMode": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigSubscriptionMode:FeatureEngineeringKafkaConfigSubscriptionMode", "description": "Options to configure which Kafka topics to pull data from\n" }, "valueSchema": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigValueSchema:FeatureEngineeringKafkaConfigValueSchema", "description": "Schema configuration for extracting message values from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" } }, "required": [ "authConfig", "bootstrapServers", "name", "providerConfig", "subscriptionMode" ], "inputProperties": { "authConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfig:FeatureEngineeringKafkaConfigAuthConfig", "description": "Authentication configuration for connection to topics\n" }, "backfillSource": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigBackfillSource:FeatureEngineeringKafkaConfigBackfillSource", "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config\n" }, "bootstrapServers": { "type": "string", "description": "A comma-separated list of host/port pairs pointing to Kafka cluster\n" }, "extraOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)\n" }, "keySchema": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigKeySchema:FeatureEngineeringKafkaConfigKeySchema", "description": "Schema configuration for extracting message keys from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigProviderConfig:FeatureEngineeringKafkaConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "subscriptionMode": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigSubscriptionMode:FeatureEngineeringKafkaConfigSubscriptionMode", "description": "Options to configure which Kafka topics to pull data from\n" }, "valueSchema": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigValueSchema:FeatureEngineeringKafkaConfigValueSchema", "description": "Schema configuration for extracting message values from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" } }, "requiredInputs": [ "authConfig", "bootstrapServers", "subscriptionMode" ], "stateInputs": { "description": "Input properties used for looking up and filtering FeatureEngineeringKafkaConfig resources.\n", "properties": { "authConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigAuthConfig:FeatureEngineeringKafkaConfigAuthConfig", "description": "Authentication configuration for connection to topics\n" }, "backfillSource": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigBackfillSource:FeatureEngineeringKafkaConfigBackfillSource", "description": "A user-provided and managed source for backfilling data. Historical data is used when creating a training set from streaming features linked to this Kafka config.\nIn the future, a separate table will be maintained by Databricks for forward filling data.\nThe schema for this source must match exactly that of the key and value schemas specified for this Kafka config\n" }, "bootstrapServers": { "type": "string", "description": "A comma-separated list of host/port pairs pointing to Kafka cluster\n" }, "extraOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Catch-all for miscellaneous options. Keys should be source options or Kafka consumer options (kafka.*)\n" }, "keySchema": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigKeySchema:FeatureEngineeringKafkaConfigKeySchema", "description": "Schema configuration for extracting message keys from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" }, "name": { "type": "string", "description": "(string) - Name that uniquely identifies this Kafka config within the metastore. This will be the identifier used from the Feature object to reference these configs for a feature.\nCan be distinct from topic name\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigProviderConfig:FeatureEngineeringKafkaConfigProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "subscriptionMode": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigSubscriptionMode:FeatureEngineeringKafkaConfigSubscriptionMode", "description": "Options to configure which Kafka topics to pull data from\n" }, "valueSchema": { "$ref": "#/types/databricks:index/FeatureEngineeringKafkaConfigValueSchema:FeatureEngineeringKafkaConfigValueSchema", "description": "Schema configuration for extracting message values from topics. At least one of\u003cspan pulumi-lang-nodejs=\" keySchema \" pulumi-lang-dotnet=\" KeySchema \" pulumi-lang-go=\" keySchema \" pulumi-lang-python=\" key_schema \" pulumi-lang-yaml=\" keySchema \" pulumi-lang-java=\" keySchema \" pulumi-lang-hcl=\" key_schema \"\u003e keySchema \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" valueSchema \" pulumi-lang-dotnet=\" ValueSchema \" pulumi-lang-go=\" valueSchema \" pulumi-lang-python=\" value_schema \" pulumi-lang-yaml=\" valueSchema \" pulumi-lang-java=\" valueSchema \" pulumi-lang-hcl=\" value_schema \"\u003e valueSchema \u003c/span\u003emust be provided\n" } }, "type": "object" } }, "databricks:index/featureEngineeringMaterializedFeature:FeatureEngineeringMaterializedFeature": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n", "properties": { "cronSchedule": { "type": "string", "description": "The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone\n" }, "cronScheduleTrigger": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureCronScheduleTrigger:FeatureEngineeringMaterializedFeatureCronScheduleTrigger", "description": "A cron-based schedule trigger for the materialization pipeline\n" }, "featureName": { "type": "string", "description": "The full name of the feature in Unity Catalog\n" }, "isOnline": { "type": "boolean", "description": "(boolean) - True if this is an online materialized feature. False if it is an offline materialized feature\n" }, "lastMaterializationTime": { "type": "string", "description": "(string) - The timestamp when the pipeline last ran and updated the materialized feature values.\nIf the pipeline has not run yet, this field will be null\n" }, "materializedFeatureId": { "type": "string", "description": "(string) - Server-assigned unique identifier for the materialized feature\n" }, "offlineStoreConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureOfflineStoreConfig:FeatureEngineeringMaterializedFeatureOfflineStoreConfig", "description": "Destination for writing feature values to an offline Delta table\n" }, "onlineStoreConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureOnlineStoreConfig:FeatureEngineeringMaterializedFeatureOnlineStoreConfig", "description": "Destination for writing feature values to an online Lakebase table\n" }, "pipelineScheduleState": { "type": "string", "description": "The schedule state of the materialization pipeline. Possible values are: `ACTIVE`, `PAUSED`, `SNAPSHOT`\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureProviderConfig:FeatureEngineeringMaterializedFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "streamingMode": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureStreamingMode:FeatureEngineeringMaterializedFeatureStreamingMode", "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads\n" }, "tableName": { "type": "string", "description": "(string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only\n" }, "tableTrigger": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureTableTrigger:FeatureEngineeringMaterializedFeatureTableTrigger", "description": "A trigger that fires when the upstream source table changes\n" } }, "required": [ "featureName", "isOnline", "lastMaterializationTime", "materializedFeatureId", "providerConfig", "tableName" ], "inputProperties": { "cronSchedule": { "type": "string", "description": "The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone\n" }, "cronScheduleTrigger": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureCronScheduleTrigger:FeatureEngineeringMaterializedFeatureCronScheduleTrigger", "description": "A cron-based schedule trigger for the materialization pipeline\n" }, "featureName": { "type": "string", "description": "The full name of the feature in Unity Catalog\n" }, "offlineStoreConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureOfflineStoreConfig:FeatureEngineeringMaterializedFeatureOfflineStoreConfig", "description": "Destination for writing feature values to an offline Delta table\n" }, "onlineStoreConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureOnlineStoreConfig:FeatureEngineeringMaterializedFeatureOnlineStoreConfig", "description": "Destination for writing feature values to an online Lakebase table\n" }, "pipelineScheduleState": { "type": "string", "description": "The schedule state of the materialization pipeline. Possible values are: `ACTIVE`, `PAUSED`, `SNAPSHOT`\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureProviderConfig:FeatureEngineeringMaterializedFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "streamingMode": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureStreamingMode:FeatureEngineeringMaterializedFeatureStreamingMode", "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads\n" }, "tableTrigger": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureTableTrigger:FeatureEngineeringMaterializedFeatureTableTrigger", "description": "A trigger that fires when the upstream source table changes\n" } }, "requiredInputs": [ "featureName" ], "stateInputs": { "description": "Input properties used for looking up and filtering FeatureEngineeringMaterializedFeature resources.\n", "properties": { "cronSchedule": { "type": "string", "description": "The quartz cron expression that defines the schedule of the materialization pipeline. The schedule is evaluated in the UTC timezone\n" }, "cronScheduleTrigger": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureCronScheduleTrigger:FeatureEngineeringMaterializedFeatureCronScheduleTrigger", "description": "A cron-based schedule trigger for the materialization pipeline\n" }, "featureName": { "type": "string", "description": "The full name of the feature in Unity Catalog\n" }, "isOnline": { "type": "boolean", "description": "(boolean) - True if this is an online materialized feature. False if it is an offline materialized feature\n" }, "lastMaterializationTime": { "type": "string", "description": "(string) - The timestamp when the pipeline last ran and updated the materialized feature values.\nIf the pipeline has not run yet, this field will be null\n" }, "materializedFeatureId": { "type": "string", "description": "(string) - Server-assigned unique identifier for the materialized feature\n" }, "offlineStoreConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureOfflineStoreConfig:FeatureEngineeringMaterializedFeatureOfflineStoreConfig", "description": "Destination for writing feature values to an offline Delta table\n" }, "onlineStoreConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureOnlineStoreConfig:FeatureEngineeringMaterializedFeatureOnlineStoreConfig", "description": "Destination for writing feature values to an online Lakebase table\n" }, "pipelineScheduleState": { "type": "string", "description": "The schedule state of the materialization pipeline. Possible values are: `ACTIVE`, `PAUSED`, `SNAPSHOT`\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureProviderConfig:FeatureEngineeringMaterializedFeatureProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "streamingMode": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureStreamingMode:FeatureEngineeringMaterializedFeatureStreamingMode", "description": "The Structured Streaming trigger mode used for materialization. Real-time mode (RTM) targets\nsub-second latency for operational workloads; micro-batch mode (MBM) favors cost efficiency\nfor ETL and analytics workloads\n" }, "tableName": { "type": "string", "description": "(string) - The fully qualified Unity Catalog path to the table containing the materialized feature (Delta table or Lakebase table). Output only\n" }, "tableTrigger": { "$ref": "#/types/databricks:index/FeatureEngineeringMaterializedFeatureTableTrigger:FeatureEngineeringMaterializedFeatureTableTrigger", "description": "A trigger that fires when the upstream source table changes\n" } }, "type": "object" } }, "databricks:index/file:File": { "description": "This resource allows uploading and downloading files in databricks_volume.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e Currently the limit is 5GiB in octet-stream.\n\n\u003e Currently, only UC volumes are supported. The list of destinations may change.\n\n## Example Usage\n\nIn order to manage a file on Unity Catalog Volumes with Pulumi, you must specify the \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e attribute containing the full path to the file on the local filesystem.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n metastoreId: thisDatabricksMetastore.id,\n name: \"sandbox\",\n comment: \"this catalog is managed by terraform\",\n properties: {\n purpose: \"testing\",\n },\n});\nconst things = new databricks.Schema(\"things\", {\n catalogName: sandbox.name,\n name: \"things\",\n comment: \"this schema is managed by terraform\",\n properties: {\n kind: \"various\",\n },\n});\nconst _this = new databricks.Volume(\"this\", {\n name: \"quickstart_volume\",\n catalogName: sandbox.name,\n schemaName: things.name,\n volumeType: \"MANAGED\",\n comment: \"this volume is managed by terraform\",\n});\nconst thisFile = new databricks.File(\"this\", {\n source: \"/full/path/on/local/system\",\n path: pulumi.interpolate`${_this.volumePath}/fileName`,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n metastore_id=this_databricks_metastore[\"id\"],\n name=\"sandbox\",\n comment=\"this catalog is managed by terraform\",\n properties={\n \"purpose\": \"testing\",\n })\nthings = databricks.Schema(\"things\",\n catalog_name=sandbox.name,\n name=\"things\",\n comment=\"this schema is managed by terraform\",\n properties={\n \"kind\": \"various\",\n })\nthis = databricks.Volume(\"this\",\n name=\"quickstart_volume\",\n catalog_name=sandbox.name,\n schema_name=things.name,\n volume_type=\"MANAGED\",\n comment=\"this volume is managed by terraform\")\nthis_file = databricks.File(\"this\",\n source=\"/full/path/on/local/system\",\n path=this.volume_path.apply(lambda volume_path: f\"{volume_path}/fileName\"))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n MetastoreId = thisDatabricksMetastore.Id,\n Name = \"sandbox\",\n Comment = \"this catalog is managed by terraform\",\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var things = new Databricks.Schema(\"things\", new()\n {\n CatalogName = sandbox.Name,\n Name = \"things\",\n Comment = \"this schema is managed by terraform\",\n Properties = \n {\n { \"kind\", \"various\" },\n },\n });\n\n var @this = new Databricks.Volume(\"this\", new()\n {\n Name = \"quickstart_volume\",\n CatalogName = sandbox.Name,\n SchemaName = things.Name,\n VolumeType = \"MANAGED\",\n Comment = \"this volume is managed by terraform\",\n });\n\n var thisFile = new Databricks.File(\"this\", new()\n {\n Source = \"/full/path/on/local/system\",\n Path = @this.VolumePath.Apply(volumePath =\u003e $\"{volumePath}/fileName\"),\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsandbox, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tMetastoreId: pulumi.Any(thisDatabricksMetastore.Id),\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tComment: pulumi.String(\"this catalog is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthings, err := databricks.NewSchema(ctx, \"things\", \u0026databricks.SchemaArgs{\n\t\t\tCatalogName: sandbox.Name,\n\t\t\tName: pulumi.String(\"things\"),\n\t\t\tComment: pulumi.String(\"this schema is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"kind\": pulumi.String(\"various\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := databricks.NewVolume(ctx, \"this\", \u0026databricks.VolumeArgs{\n\t\t\tName: pulumi.String(\"quickstart_volume\"),\n\t\t\tCatalogName: sandbox.Name,\n\t\t\tSchemaName: things.Name,\n\t\t\tVolumeType: pulumi.String(\"MANAGED\"),\n\t\t\tComment: pulumi.String(\"this volume is managed by terraform\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewFile(ctx, \"this\", \u0026databricks.FileArgs{\n\t\t\tSource: pulumi.String(\"/full/path/on/local/system\"),\n\t\t\tPath: this.VolumePath.ApplyT(func(volumePath string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"%v/fileName\", volumePath), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n metastore_id = thisDatabricksMetastore.id\n name = \"sandbox\"\n comment = \"this catalog is managed by terraform\"\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_schema\" \"things\" {\n catalog_name = databricks_catalog.sandbox.name\n name = \"things\"\n comment = \"this schema is managed by terraform\"\n properties = {\n \"kind\" = \"various\"\n }\n}\nresource \"databricks_volume\" \"this\" {\n name = \"quickstart_volume\"\n catalog_name = databricks_catalog.sandbox.name\n schema_name = databricks_schema.things.name\n volume_type = \"MANAGED\"\n comment = \"this volume is managed by terraform\"\n}\nresource \"databricks_file\" \"this\" {\n source = \"/full/path/on/local/system\"\n path =\"${databricks_volume.this.volume_path}/fileName\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport com.pulumi.databricks.Schema;\nimport com.pulumi.databricks.SchemaArgs;\nimport com.pulumi.databricks.Volume;\nimport com.pulumi.databricks.VolumeArgs;\nimport com.pulumi.databricks.File;\nimport com.pulumi.databricks.FileArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .metastoreId(thisDatabricksMetastore.id())\n .name(\"sandbox\")\n .comment(\"this catalog is managed by terraform\")\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var things = new Schema(\"things\", SchemaArgs.builder()\n .catalogName(sandbox.name())\n .name(\"things\")\n .comment(\"this schema is managed by terraform\")\n .properties(Map.of(\"kind\", \"various\"))\n .build());\n\n var this_ = new Volume(\"this\", VolumeArgs.builder()\n .name(\"quickstart_volume\")\n .catalogName(sandbox.name())\n .schemaName(things.name())\n .volumeType(\"MANAGED\")\n .comment(\"this volume is managed by terraform\")\n .build());\n\n var thisFile = new File(\"thisFile\", FileArgs.builder()\n .source(\"/full/path/on/local/system\")\n .path(this_.volumePath().applyValue(_volumePath -\u003e String.format(\"%s/fileName\", _volumePath)))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n metastoreId: ${thisDatabricksMetastore.id}\n name: sandbox\n comment: this catalog is managed by terraform\n properties:\n purpose: testing\n things:\n type: databricks:Schema\n properties:\n catalogName: ${sandbox.name}\n name: things\n comment: this schema is managed by terraform\n properties:\n kind: various\n this:\n type: databricks:Volume\n properties:\n name: quickstart_volume\n catalogName: ${sandbox.name}\n schemaName: ${things.name}\n volumeType: MANAGED\n comment: this volume is managed by terraform\n thisFile:\n type: databricks:File\n name: this\n properties:\n source: /full/path/on/local/system\n path: ${this.volumePath}/fileName\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nYou can also inline sources through \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e attribute.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\n\nconst initScript = new databricks.File(\"init_script\", {\n contentBase64: std.base64encode({\n input: `#!/bin/bash\necho \\\\\"Hello World\\\\\"\n`,\n }).then(invoke =\u003e invoke.result),\n path: `${_this.volumePath}/fileName`,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_std as std\n\ninit_script = databricks.File(\"init_script\",\n content_base64=std.base64encode(input=\"\"\"#!/bin/bash\necho \\\"Hello World\\\"\n\"\"\").result,\n path=f\"{this['volumePath']}/fileName\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var initScript = new Databricks.File(\"init_script\", new()\n {\n ContentBase64 = Std.Base64encode.Invoke(new()\n {\n Input = @\"#!/bin/bash\necho \\\"\"Hello World\\\"\"\n\",\n }).Apply(invoke =\u003e invoke.Result),\n Path = $\"{@this.VolumePath}/fileName\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinvokeBase64encode, err := std.Base64encode(ctx, \u0026std.Base64encodeArgs{\n\t\t\tInput: \"#!/bin/bash\\necho \\\\\\\"Hello World\\\\\\\"\\n\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewFile(ctx, \"init_script\", \u0026databricks.FileArgs{\n\t\t\tContentBase64: pulumi.String(invokeBase64encode.Result),\n\t\t\tPath: pulumi.Sprintf(\"%v/fileName\", this.VolumePath),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n }\n}\n\nresource \"databricks_file\" \"init_script\" {\n content_base64 = base64encode(\"#!/bin/bash\\necho \\\\\\\"Hello World\\\\\\\"\\n\")\n path =\"${this.volumePath}/fileName\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.File;\nimport com.pulumi.databricks.FileArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.Base64encodeArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var initScript = new File(\"initScript\", FileArgs.builder()\n .contentBase64(StdFunctions.base64encode(Base64encodeArgs.builder()\n .input(\"\"\"\n#!/bin/bash\necho \\\"Hello World\\\"\n \"\"\")\n .build()).result())\n .path(String.format(\"%s/fileName\", this_.volumePath()))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n initScript:\n type: databricks:File\n name: init_script\n properties:\n contentBase64:\n fn::invoke:\n function: std:base64encode\n arguments:\n input: |\n #!/bin/bash\n echo \\\"Hello World\\\"\n return: result\n path: ${this.volumePath}/fileName\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.WorkspaceFile\n\" pulumi-lang-dotnet=\" databricks.WorkspaceFile\n\" pulumi-lang-go=\" WorkspaceFile\n\" pulumi-lang-python=\" WorkspaceFile\n\" pulumi-lang-yaml=\" databricks.WorkspaceFile\n\" pulumi-lang-java=\" databricks.WorkspaceFile\n\" pulumi-lang-hcl=\" databricks_workspace_file\n\"\u003e databricks.WorkspaceFile\n\u003c/span\u003e* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Volume \" pulumi-lang-dotnet=\" databricks.Volume \" pulumi-lang-go=\" Volume \" pulumi-lang-python=\" Volume \" pulumi-lang-yaml=\" databricks.Volume \" pulumi-lang-java=\" databricks.Volume \" pulumi-lang-hcl=\" databricks_volume \"\u003e databricks.Volume \u003c/span\u003eto manage [volumes within Unity Catalog](https://docs.databricks.com/en/connect/unity-catalog/volumes.html).\n\n", "properties": { "contentBase64": { "type": "string", "description": "Contents in base 64 format. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e.\n" }, "fileSize": { "type": "integer", "description": "The file size of the file that is being tracked by this resource in bytes.\n" }, "md5": { "type": "string" }, "modificationTime": { "type": "string", "description": "The last time stamp when the file was modified\n" }, "path": { "type": "string", "description": "The path of the file in which you wish to save. For example, `/Volumes/main/default/volume1/file.txt`.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/FileProviderConfig:FileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteFileModified": { "type": "boolean" }, "source": { "type": "string", "description": "The full absolute path to the file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e.\n" } }, "required": [ "fileSize", "modificationTime", "path", "providerConfig" ], "inputProperties": { "contentBase64": { "type": "string", "description": "Contents in base 64 format. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e.\n" }, "md5": { "type": "string" }, "path": { "type": "string", "description": "The path of the file in which you wish to save. For example, `/Volumes/main/default/volume1/file.txt`.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/FileProviderConfig:FileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteFileModified": { "type": "boolean" }, "source": { "type": "string", "description": "The full absolute path to the file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e.\n" } }, "requiredInputs": [ "path" ], "stateInputs": { "description": "Input properties used for looking up and filtering File resources.\n", "properties": { "contentBase64": { "type": "string", "description": "Contents in base 64 format. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e.\n" }, "fileSize": { "type": "integer", "description": "The file size of the file that is being tracked by this resource in bytes.\n" }, "md5": { "type": "string" }, "modificationTime": { "type": "string", "description": "The last time stamp when the file was modified\n" }, "path": { "type": "string", "description": "The path of the file in which you wish to save. For example, `/Volumes/main/default/volume1/file.txt`.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/FileProviderConfig:FileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "remoteFileModified": { "type": "boolean" }, "source": { "type": "string", "description": "The full absolute path to the file. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e.\n" } }, "type": "object" } }, "databricks:index/gitCredential:GitCredential": { "description": "This resource allows you to manage credentials for [Databricks Repos](https://docs.databricks.com/repos.html) using [Git Credentials API](https://docs.databricks.com/dev-tools/api/latest/gitcredentials.html).\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n### Git credential that uses personal access token\n\nYou can declare Pulumi-managed Git credential using following code:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst ado = new databricks.GitCredential(\"ado\", {\n gitUsername: \"myuser\",\n gitProvider: \"azureDevOpsServices\",\n personalAccessToken: \"sometoken\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nado = databricks.GitCredential(\"ado\",\n git_username=\"myuser\",\n git_provider=\"azureDevOpsServices\",\n personal_access_token=\"sometoken\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ado = new Databricks.GitCredential(\"ado\", new()\n {\n GitUsername = \"myuser\",\n GitProvider = \"azureDevOpsServices\",\n PersonalAccessToken = \"sometoken\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGitCredential(ctx, \"ado\", \u0026databricks.GitCredentialArgs{\n\t\t\tGitUsername: pulumi.String(\"myuser\"),\n\t\t\tGitProvider: pulumi.String(\"azureDevOpsServices\"),\n\t\t\tPersonalAccessToken: pulumi.String(\"sometoken\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_gitcredential\" \"ado\" {\n git_username = \"myuser\"\n git_provider = \"azureDevOpsServices\"\n personal_access_token = \"sometoken\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.GitCredential;\nimport com.pulumi.databricks.GitCredentialArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ado = new GitCredential(\"ado\", GitCredentialArgs.builder()\n .gitUsername(\"myuser\")\n .gitProvider(\"azureDevOpsServices\")\n .personalAccessToken(\"sometoken\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ado:\n type: databricks:GitCredential\n properties:\n gitUsername: myuser\n gitProvider: azureDevOpsServices\n personalAccessToken: sometoken\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Git credential configuration for Azure Service Principal and Azure DevOps\n\nDatabricks now supports Azure service principal federation to Azure DevOps. Follow the [documentation](https://learn.microsoft.com/en-us/azure/databricks/repos/automate-with-ms-entra) on how to configure service principal federation, and after everything is configured, it could be used as simple as:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst ado = new databricks.GitCredential(\"ado\", {gitProvider: \"azureDevOpsServicesAad\"});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nado = databricks.GitCredential(\"ado\", git_provider=\"azureDevOpsServicesAad\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var ado = new Databricks.GitCredential(\"ado\", new()\n {\n GitProvider = \"azureDevOpsServicesAad\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGitCredential(ctx, \"ado\", \u0026databricks.GitCredentialArgs{\n\t\t\tGitProvider: pulumi.String(\"azureDevOpsServicesAad\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_gitcredential\" \"ado\" {\n git_provider = \"azureDevOpsServicesAad\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.GitCredential;\nimport com.pulumi.databricks.GitCredentialArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var ado = new GitCredential(\"ado\", GitCredentialArgs.builder()\n .gitProvider(\"azureDevOpsServicesAad\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n ado:\n type: databricks:GitCredential\n properties:\n gitProvider: azureDevOpsServicesAad\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Git credential for a service principal\n\nYou can manage Git credentials on behalf of a service principal by specifying \u003cspan pulumi-lang-nodejs=\"`principalId`\" pulumi-lang-dotnet=\"`PrincipalId`\" pulumi-lang-go=\"`principalId`\" pulumi-lang-python=\"`principal_id`\" pulumi-lang-yaml=\"`principalId`\" pulumi-lang-java=\"`principalId`\" pulumi-lang-hcl=\"`principal_id`\"\u003e`principalId`\u003c/span\u003e:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst spn = new databricks.GitCredential(\"spn\", {\n gitProvider: \"gitHub\",\n gitUsername: \"my-service-principal\",\n personalAccessToken: githubPat,\n principalId: databricksSpnId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nspn = databricks.GitCredential(\"spn\",\n git_provider=\"gitHub\",\n git_username=\"my-service-principal\",\n personal_access_token=github_pat,\n principal_id=databricks_spn_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var spn = new Databricks.GitCredential(\"spn\", new()\n {\n GitProvider = \"gitHub\",\n GitUsername = \"my-service-principal\",\n PersonalAccessToken = githubPat,\n PrincipalId = databricksSpnId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGitCredential(ctx, \"spn\", \u0026databricks.GitCredentialArgs{\n\t\t\tGitProvider: pulumi.String(\"gitHub\"),\n\t\t\tGitUsername: pulumi.String(\"my-service-principal\"),\n\t\t\tPersonalAccessToken: pulumi.Any(githubPat),\n\t\t\tPrincipalId: pulumi.Any(databricksSpnId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_gitcredential\" \"spn\" {\n git_provider = \"gitHub\"\n git_username = \"my-service-principal\"\n personal_access_token = githubPat\n principal_id = databricksSpnId\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.GitCredential;\nimport com.pulumi.databricks.GitCredentialArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var spn = new GitCredential(\"spn\", GitCredentialArgs.builder()\n .gitProvider(\"gitHub\")\n .gitUsername(\"my-service-principal\")\n .personalAccessToken(githubPat)\n .principalId(databricksSpnId)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n spn:\n type: databricks:GitCredential\n properties:\n gitProvider: gitHub\n gitUsername: my-service-principal\n personalAccessToken: ${githubPat}\n principalId: ${databricksSpnId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage Databricks Repos.\n\n", "properties": { "force": { "type": "boolean", "description": "specify if settings need to be enforced (i.e., to overwrite previously set credential for service principals).\n" }, "gitEmail": { "type": "string", "description": "The email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\n" }, "gitProvider": { "type": "string", "description": "case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult [Git Credentials API documentation](https://docs.databricks.com/dev-tools/api/latest/gitcredentials.html)): `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`, `azureDevOpsServicesAad`.\n" }, "gitUsername": { "type": "string", "description": "user name at Git provider. For most Git providers it is only used to set the Git committer \u0026 author names for commits, however it may be required for authentication depending on your Git provider / token requirements.\n" }, "isDefaultForProvider": { "type": "boolean", "description": "boolean flag specifying if the credential is the default for the given provider type.\n" }, "name": { "type": "string", "description": "the name of the git credential, used for identification and ease of lookup.\n" }, "personalAccessToken": { "type": "string", "description": "The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of `GITHUB_TOKEN`, `GITLAB_TOKEN`, or `AZDO_PERSONAL_ACCESS_TOKEN`, that has a non-empty value.\n", "secret": true }, "principalId": { "type": "string", "description": "The ID of the service principal whose credentials will be managed. Only service principal managers can use this field. When specified, the git credential is created or updated for the given service principal instead of the calling user.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GitCredentialProviderConfig:GitCredentialProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "required": [ "gitProvider", "name", "providerConfig" ], "inputProperties": { "force": { "type": "boolean", "description": "specify if settings need to be enforced (i.e., to overwrite previously set credential for service principals).\n" }, "gitEmail": { "type": "string", "description": "The email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\n" }, "gitProvider": { "type": "string", "description": "case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult [Git Credentials API documentation](https://docs.databricks.com/dev-tools/api/latest/gitcredentials.html)): `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`, `azureDevOpsServicesAad`.\n" }, "gitUsername": { "type": "string", "description": "user name at Git provider. For most Git providers it is only used to set the Git committer \u0026 author names for commits, however it may be required for authentication depending on your Git provider / token requirements.\n" }, "isDefaultForProvider": { "type": "boolean", "description": "boolean flag specifying if the credential is the default for the given provider type.\n" }, "name": { "type": "string", "description": "the name of the git credential, used for identification and ease of lookup.\n" }, "personalAccessToken": { "type": "string", "description": "The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of `GITHUB_TOKEN`, `GITLAB_TOKEN`, or `AZDO_PERSONAL_ACCESS_TOKEN`, that has a non-empty value.\n", "secret": true }, "principalId": { "type": "string", "description": "The ID of the service principal whose credentials will be managed. Only service principal managers can use this field. When specified, the git credential is created or updated for the given service principal instead of the calling user.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GitCredentialProviderConfig:GitCredentialProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "requiredInputs": [ "gitProvider" ], "stateInputs": { "description": "Input properties used for looking up and filtering GitCredential resources.\n", "properties": { "force": { "type": "boolean", "description": "specify if settings need to be enforced (i.e., to overwrite previously set credential for service principals).\n" }, "gitEmail": { "type": "string", "description": "The email associated with your Git provider user account. Used for authentication with the remote repository and also sets the author \u0026 committer identity for commits.\n" }, "gitProvider": { "type": "string", "description": "case insensitive name of the Git provider. Following values are supported right now (could be a subject for a change, consult [Git Credentials API documentation](https://docs.databricks.com/dev-tools/api/latest/gitcredentials.html)): `gitHub`, `gitHubEnterprise`, `bitbucketCloud`, `bitbucketServer`, `azureDevOpsServices`, `gitLab`, `gitLabEnterpriseEdition`, `awsCodeCommit`, `azureDevOpsServicesAad`.\n" }, "gitUsername": { "type": "string", "description": "user name at Git provider. For most Git providers it is only used to set the Git committer \u0026 author names for commits, however it may be required for authentication depending on your Git provider / token requirements.\n" }, "isDefaultForProvider": { "type": "boolean", "description": "boolean flag specifying if the credential is the default for the given provider type.\n" }, "name": { "type": "string", "description": "the name of the git credential, used for identification and ease of lookup.\n" }, "personalAccessToken": { "type": "string", "description": "The personal access token used to authenticate to the corresponding Git provider. If value is not provided, it's sourced from the first environment variable of `GITHUB_TOKEN`, `GITLAB_TOKEN`, or `AZDO_PERSONAL_ACCESS_TOKEN`, that has a non-empty value.\n", "secret": true }, "principalId": { "type": "string", "description": "The ID of the service principal whose credentials will be managed. Only service principal managers can use this field. When specified, the git credential is created or updated for the given service principal instead of the calling user.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GitCredentialProviderConfig:GitCredentialProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "type": "object" } }, "databricks:index/globalInitScript:GlobalInitScript": { "description": "This resource allows you to manage [global init scripts](https://docs.databricks.com/clusters/init-scripts.html#global-init-scripts), which are run on all\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand databricks_job.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n", "properties": { "contentBase64": { "type": "string", "description": "The base64-encoded source code global init script. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e. Use of \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances\n" }, "enabled": { "type": "boolean", "description": "specifies if the script is enabled for execution, or not\n" }, "md5": { "type": "string" }, "name": { "type": "string", "description": "the name of the script. It should be unique\n" }, "position": { "type": "integer", "description": "the position of a global init script, where \u003cspan pulumi-lang-nodejs=\"`0`\" pulumi-lang-dotnet=\"`0`\" pulumi-lang-go=\"`0`\" pulumi-lang-python=\"`0`\" pulumi-lang-yaml=\"`0`\" pulumi-lang-java=\"`0`\" pulumi-lang-hcl=\"`0`\"\u003e`0`\u003c/span\u003e represents the first global init script to run, \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e is the second global init script to run, and so on. When omitted, the script gets the last position.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GlobalInitScriptProviderConfig:GlobalInitScriptProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "source": { "type": "string", "description": "Path to script's source code on local filesystem. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e\n" } }, "required": [ "name", "position", "providerConfig" ], "inputProperties": { "contentBase64": { "type": "string", "description": "The base64-encoded source code global init script. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e. Use of \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances\n" }, "enabled": { "type": "boolean", "description": "specifies if the script is enabled for execution, or not\n" }, "md5": { "type": "string" }, "name": { "type": "string", "description": "the name of the script. It should be unique\n" }, "position": { "type": "integer", "description": "the position of a global init script, where \u003cspan pulumi-lang-nodejs=\"`0`\" pulumi-lang-dotnet=\"`0`\" pulumi-lang-go=\"`0`\" pulumi-lang-python=\"`0`\" pulumi-lang-yaml=\"`0`\" pulumi-lang-java=\"`0`\" pulumi-lang-hcl=\"`0`\"\u003e`0`\u003c/span\u003e represents the first global init script to run, \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e is the second global init script to run, and so on. When omitted, the script gets the last position.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GlobalInitScriptProviderConfig:GlobalInitScriptProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "source": { "type": "string", "description": "Path to script's source code on local filesystem. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering GlobalInitScript resources.\n", "properties": { "contentBase64": { "type": "string", "description": "The base64-encoded source code global init script. Conflicts with \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e. Use of \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e is discouraged, as it's increasing memory footprint of Pulumi state and should only be used in exceptional circumstances\n" }, "enabled": { "type": "boolean", "description": "specifies if the script is enabled for execution, or not\n" }, "md5": { "type": "string" }, "name": { "type": "string", "description": "the name of the script. It should be unique\n" }, "position": { "type": "integer", "description": "the position of a global init script, where \u003cspan pulumi-lang-nodejs=\"`0`\" pulumi-lang-dotnet=\"`0`\" pulumi-lang-go=\"`0`\" pulumi-lang-python=\"`0`\" pulumi-lang-yaml=\"`0`\" pulumi-lang-java=\"`0`\" pulumi-lang-hcl=\"`0`\"\u003e`0`\u003c/span\u003e represents the first global init script to run, \u003cspan pulumi-lang-nodejs=\"`1`\" pulumi-lang-dotnet=\"`1`\" pulumi-lang-go=\"`1`\" pulumi-lang-python=\"`1`\" pulumi-lang-yaml=\"`1`\" pulumi-lang-java=\"`1`\" pulumi-lang-hcl=\"`1`\"\u003e`1`\u003c/span\u003e is the second global init script to run, and so on. When omitted, the script gets the last position.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GlobalInitScriptProviderConfig:GlobalInitScriptProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "source": { "type": "string", "description": "Path to script's source code on local filesystem. Conflicts with \u003cspan pulumi-lang-nodejs=\"`contentBase64`\" pulumi-lang-dotnet=\"`ContentBase64`\" pulumi-lang-go=\"`contentBase64`\" pulumi-lang-python=\"`content_base64`\" pulumi-lang-yaml=\"`contentBase64`\" pulumi-lang-java=\"`contentBase64`\" pulumi-lang-hcl=\"`content_base64`\"\u003e`contentBase64`\u003c/span\u003e\n" } }, "type": "object" } }, "databricks:index/grant:Grant": { "description": "\u003e This article refers to the privileges and inheritance model in Privilege Model version 1.0. If you created your metastore during the public preview (before August 25, 2022), you can upgrade to Privilege Model version 1.0 following [Upgrade to privilege inheritance](https://docs.databricks.com/data-governance/unity-catalog/hive-metastore.html)\n\n\u003e Most of Unity Catalog APIs are only accessible via **workspace-level APIs**. This design may change in the future. Account-level principal grants can be assigned with any valid workspace as the Unity Catalog is decoupled from specific workspaces. More information in [the official documentation](https://docs.databricks.com/data-governance/unity-catalog/index.html).\n\n\u003e This resource is _authoritative_ for grants on securables for a given _singular_ principal. Configuring this resource for a securable will **OVERWRITE** any existing grants for the principal and changes made outside of Pulumi will be reset. Use\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003efor authoritative control of all grants on a securable.\n\nIn Unity Catalog all users initially have no access to data. Only Metastore Admins can create objects and can grant/revoke access on individual objects to users and groups. Every securable object in Unity Catalog has an owner. The owner can be any account-level user or group, called principals in general. The principal that creates an object becomes its owner. Owners receive `ALL_PRIVILEGES` on the securable object (e.g., `SELECT` and `MODIFY` on a table), as well as the permission to grant privileges to other principals.\n\nSecurable objects are hierarchical and privileges are inherited downward. The highest level object that privileges are inherited from is the catalog. This means that granting a privilege on a catalog or schema automatically grants the privilege to all current and future objects within the catalog or schema. Privileges that are granted on a metastore are not inherited.\n\nEvery \u003cspan pulumi-lang-nodejs=\"`databricks.Grant`\" pulumi-lang-dotnet=\"`databricks.Grant`\" pulumi-lang-go=\"`Grant`\" pulumi-lang-python=\"`Grant`\" pulumi-lang-yaml=\"`databricks.Grant`\" pulumi-lang-java=\"`databricks.Grant`\" pulumi-lang-hcl=\"`databricks_grant`\"\u003e`databricks.Grant`\u003c/span\u003e resource must have exactly one securable identifier and the following arguments:\n\n- \u003cspan pulumi-lang-nodejs=\"`principal`\" pulumi-lang-dotnet=\"`Principal`\" pulumi-lang-go=\"`principal`\" pulumi-lang-python=\"`principal`\" pulumi-lang-yaml=\"`principal`\" pulumi-lang-java=\"`principal`\" pulumi-lang-hcl=\"`principal`\"\u003e`principal`\u003c/span\u003e - User name, group name or service principal application ID.\n- \u003cspan pulumi-lang-nodejs=\"`privileges`\" pulumi-lang-dotnet=\"`Privileges`\" pulumi-lang-go=\"`privileges`\" pulumi-lang-python=\"`privileges`\" pulumi-lang-yaml=\"`privileges`\" pulumi-lang-java=\"`privileges`\" pulumi-lang-hcl=\"`privileges`\"\u003e`privileges`\u003c/span\u003e - One or more privileges that are specific to a securable type.\n- \u003cspan pulumi-lang-nodejs=\"`providerConfig`\" pulumi-lang-dotnet=\"`ProviderConfig`\" pulumi-lang-go=\"`providerConfig`\" pulumi-lang-python=\"`provider_config`\" pulumi-lang-yaml=\"`providerConfig`\" pulumi-lang-java=\"`providerConfig`\" pulumi-lang-hcl=\"`provider_config`\"\u003e`providerConfig`\u003c/span\u003e - (Optional) Configure the provider for management through account provider. This block consists of the following fields:\n - \u003cspan pulumi-lang-nodejs=\"`workspaceId`\" pulumi-lang-dotnet=\"`WorkspaceId`\" pulumi-lang-go=\"`workspaceId`\" pulumi-lang-python=\"`workspace_id`\" pulumi-lang-yaml=\"`workspaceId`\" pulumi-lang-java=\"`workspaceId`\" pulumi-lang-hcl=\"`workspace_id`\"\u003e`workspaceId`\u003c/span\u003e - (Required) Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n\nFor the latest list of privilege types that apply to each securable object in Unity Catalog, please refer to the [official documentation](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/privileges.html#privilege-types-by-securable-object-in-unity-catalog)\n\nUnlike the [SQL specification](https://docs.databricks.com/sql/language-manual/sql-ref-privileges.html#privilege-types), all privileges to be written with underscore instead of space, e.g. `CREATE_TABLE` and not `CREATE TABLE`.\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003efor the list of privilege types that apply to each securable object.\n\n## Metastore grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eMetastore grants for the list of privileges that apply to Metastores.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandboxDataEngineers = new databricks.Grant(\"sandbox_data_engineers\", {\n metastore: \"metastore_id\",\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\",\n ],\n});\nconst sandboxDataSharer = new databricks.Grant(\"sandbox_data_sharer\", {\n metastore: \"metastore_id\",\n principal: \"Data Sharer\",\n privileges: [\n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox_data_engineers = databricks.Grant(\"sandbox_data_engineers\",\n metastore=\"metastore_id\",\n principal=\"Data Engineers\",\n privileges=[\n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\",\n ])\nsandbox_data_sharer = databricks.Grant(\"sandbox_data_sharer\",\n metastore=\"metastore_id\",\n principal=\"Data Sharer\",\n privileges=[\n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandboxDataEngineers = new Databricks.Grant(\"sandbox_data_engineers\", new()\n {\n Metastore = \"metastore_id\",\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\",\n },\n });\n\n var sandboxDataSharer = new Databricks.Grant(\"sandbox_data_sharer\", new()\n {\n Metastore = \"metastore_id\",\n Principal = \"Data Sharer\",\n Privileges = new[]\n {\n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrant(ctx, \"sandbox_data_engineers\", \u0026databricks.GrantArgs{\n\t\t\tMetastore: pulumi.String(\"metastore_id\"),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"CREATE_CATALOG\"),\n\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_LOCATION\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"sandbox_data_sharer\", \u0026databricks.GrantArgs{\n\t\t\tMetastore: pulumi.String(\"metastore_id\"),\n\t\t\tPrincipal: pulumi.String(\"Data Sharer\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"CREATE_RECIPIENT\"),\n\t\t\t\tpulumi.String(\"CREATE_SHARE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grant\" \"sandbox_data_engineers\" {\n metastore = \"metastore_id\"\n principal = \"Data Engineers\"\n privileges = [\"CREATE_CATALOG\", \"CREATE_EXTERNAL_LOCATION\"]\n}\nresource \"databricks_grant\" \"sandbox_data_sharer\" {\n metastore = \"metastore_id\"\n principal = \"Data Sharer\"\n privileges = [\"CREATE_RECIPIENT\", \"CREATE_SHARE\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandboxDataEngineers = new Grant(\"sandboxDataEngineers\", GrantArgs.builder()\n .metastore(\"metastore_id\")\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\")\n .build());\n\n var sandboxDataSharer = new Grant(\"sandboxDataSharer\", GrantArgs.builder()\n .metastore(\"metastore_id\")\n .principal(\"Data Sharer\")\n .privileges( \n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandboxDataEngineers:\n type: databricks:Grant\n name: sandbox_data_engineers\n properties:\n metastore: metastore_id\n principal: Data Engineers\n privileges:\n - CREATE_CATALOG\n - CREATE_EXTERNAL_LOCATION\n sandboxDataSharer:\n type: databricks:Grant\n name: sandbox_data_sharer\n properties:\n metastore: metastore_id\n principal: Data Sharer\n privileges:\n - CREATE_RECIPIENT\n - CREATE_SHARE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Catalog grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eCatalog grants for the list of privileges that apply to Catalogs.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n name: \"sandbox\",\n comment: \"this catalog is managed by terraform\",\n properties: {\n purpose: \"testing\",\n },\n});\nconst sandboxDataScientists = new databricks.Grant(\"sandbox_data_scientists\", {\n catalog: sandbox.name,\n principal: \"Data Scientists\",\n privileges: [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\",\n ],\n});\nconst sandboxDataEngineers = new databricks.Grant(\"sandbox_data_engineers\", {\n catalog: sandbox.name,\n principal: \"Data Engineers\",\n privileges: [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\",\n ],\n});\nconst sandboxDataAnalyst = new databricks.Grant(\"sandbox_data_analyst\", {\n catalog: sandbox.name,\n principal: \"Data Analyst\",\n privileges: [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n name=\"sandbox\",\n comment=\"this catalog is managed by terraform\",\n properties={\n \"purpose\": \"testing\",\n })\nsandbox_data_scientists = databricks.Grant(\"sandbox_data_scientists\",\n catalog=sandbox.name,\n principal=\"Data Scientists\",\n privileges=[\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\",\n ])\nsandbox_data_engineers = databricks.Grant(\"sandbox_data_engineers\",\n catalog=sandbox.name,\n principal=\"Data Engineers\",\n privileges=[\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\",\n ])\nsandbox_data_analyst = databricks.Grant(\"sandbox_data_analyst\",\n catalog=sandbox.name,\n principal=\"Data Analyst\",\n privileges=[\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n Name = \"sandbox\",\n Comment = \"this catalog is managed by terraform\",\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var sandboxDataScientists = new Databricks.Grant(\"sandbox_data_scientists\", new()\n {\n Catalog = sandbox.Name,\n Principal = \"Data Scientists\",\n Privileges = new[]\n {\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\",\n },\n });\n\n var sandboxDataEngineers = new Databricks.Grant(\"sandbox_data_engineers\", new()\n {\n Catalog = sandbox.Name,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\",\n },\n });\n\n var sandboxDataAnalyst = new Databricks.Grant(\"sandbox_data_analyst\", new()\n {\n Catalog = sandbox.Name,\n Principal = \"Data Analyst\",\n Privileges = new[]\n {\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsandbox, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tComment: pulumi.String(\"this catalog is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"sandbox_data_scientists\", \u0026databricks.GrantArgs{\n\t\t\tCatalog: sandbox.Name,\n\t\t\tPrincipal: pulumi.String(\"Data Scientists\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_CATALOG\"),\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"CREATE_TABLE\"),\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"sandbox_data_engineers\", \u0026databricks.GrantArgs{\n\t\t\tCatalog: sandbox.Name,\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_CATALOG\"),\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"CREATE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"CREATE_TABLE\"),\n\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"sandbox_data_analyst\", \u0026databricks.GrantArgs{\n\t\t\tCatalog: sandbox.Name,\n\t\t\tPrincipal: pulumi.String(\"Data Analyst\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_CATALOG\"),\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n name = \"sandbox\"\n comment = \"this catalog is managed by terraform\"\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_grant\" \"sandbox_data_scientists\" {\n catalog = databricks_catalog.sandbox.name\n principal = \"Data Scientists\"\n privileges = [\"USE_CATALOG\", \"USE_SCHEMA\", \"CREATE_TABLE\", \"SELECT\"]\n}\nresource \"databricks_grant\" \"sandbox_data_engineers\" {\n catalog = databricks_catalog.sandbox.name\n principal = \"Data Engineers\"\n privileges = [\"USE_CATALOG\", \"USE_SCHEMA\", \"CREATE_SCHEMA\", \"CREATE_TABLE\", \"MODIFY\"]\n}\nresource \"databricks_grant\" \"sandbox_data_analyst\" {\n catalog = databricks_catalog.sandbox.name\n principal = \"Data Analyst\"\n privileges = [\"USE_CATALOG\", \"USE_SCHEMA\", \"SELECT\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .name(\"sandbox\")\n .comment(\"this catalog is managed by terraform\")\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var sandboxDataScientists = new Grant(\"sandboxDataScientists\", GrantArgs.builder()\n .catalog(sandbox.name())\n .principal(\"Data Scientists\")\n .privileges( \n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\")\n .build());\n\n var sandboxDataEngineers = new Grant(\"sandboxDataEngineers\", GrantArgs.builder()\n .catalog(sandbox.name())\n .principal(\"Data Engineers\")\n .privileges( \n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\")\n .build());\n\n var sandboxDataAnalyst = new Grant(\"sandboxDataAnalyst\", GrantArgs.builder()\n .catalog(sandbox.name())\n .principal(\"Data Analyst\")\n .privileges( \n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n name: sandbox\n comment: this catalog is managed by terraform\n properties:\n purpose: testing\n sandboxDataScientists:\n type: databricks:Grant\n name: sandbox_data_scientists\n properties:\n catalog: ${sandbox.name}\n principal: Data Scientists\n privileges:\n - USE_CATALOG\n - USE_SCHEMA\n - CREATE_TABLE\n - SELECT\n sandboxDataEngineers:\n type: databricks:Grant\n name: sandbox_data_engineers\n properties:\n catalog: ${sandbox.name}\n principal: Data Engineers\n privileges:\n - USE_CATALOG\n - USE_SCHEMA\n - CREATE_SCHEMA\n - CREATE_TABLE\n - MODIFY\n sandboxDataAnalyst:\n type: databricks:Grant\n name: sandbox_data_analyst\n properties:\n catalog: ${sandbox.name}\n principal: Data Analyst\n privileges:\n - USE_CATALOG\n - USE_SCHEMA\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Schema grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eSchema grants for the list of privileges that apply to Schemas.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst things = new databricks.Schema(\"things\", {\n catalogName: sandbox.id,\n name: \"things\",\n comment: \"this schema is managed by terraform\",\n properties: {\n kind: \"various\",\n },\n});\nconst thingsGrant = new databricks.Grant(\"things\", {\n schema: things.id,\n principal: \"Data Engineers\",\n privileges: [\n \"USE_SCHEMA\",\n \"MODIFY\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthings = databricks.Schema(\"things\",\n catalog_name=sandbox[\"id\"],\n name=\"things\",\n comment=\"this schema is managed by terraform\",\n properties={\n \"kind\": \"various\",\n })\nthings_grant = databricks.Grant(\"things\",\n schema=things.id,\n principal=\"Data Engineers\",\n privileges=[\n \"USE_SCHEMA\",\n \"MODIFY\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var things = new Databricks.Schema(\"things\", new()\n {\n CatalogName = sandbox.Id,\n Name = \"things\",\n Comment = \"this schema is managed by terraform\",\n Properties = \n {\n { \"kind\", \"various\" },\n },\n });\n\n var thingsGrant = new Databricks.Grant(\"things\", new()\n {\n Schema = things.Id,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"USE_SCHEMA\",\n \"MODIFY\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthings, err := databricks.NewSchema(ctx, \"things\", \u0026databricks.SchemaArgs{\n\t\t\tCatalogName: pulumi.Any(sandbox.Id),\n\t\t\tName: pulumi.String(\"things\"),\n\t\t\tComment: pulumi.String(\"this schema is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"kind\": pulumi.String(\"various\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"things\", \u0026databricks.GrantArgs{\n\t\t\tSchema: things.ID(),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_schema\" \"things\" {\n catalog_name = sandbox.id\n name = \"things\"\n comment = \"this schema is managed by terraform\"\n properties = {\n \"kind\" = \"various\"\n }\n}\nresource \"databricks_grant\" \"things\" {\n schema = databricks_schema.things.id\n principal = \"Data Engineers\"\n privileges = [\"USE_SCHEMA\", \"MODIFY\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Schema;\nimport com.pulumi.databricks.SchemaArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var things = new Schema(\"things\", SchemaArgs.builder()\n .catalogName(sandbox.id())\n .name(\"things\")\n .comment(\"this schema is managed by terraform\")\n .properties(Map.of(\"kind\", \"various\"))\n .build());\n\n var thingsGrant = new Grant(\"thingsGrant\", GrantArgs.builder()\n .schema(things.id())\n .principal(\"Data Engineers\")\n .privileges( \n \"USE_SCHEMA\",\n \"MODIFY\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n things:\n type: databricks:Schema\n properties:\n catalogName: ${sandbox.id}\n name: things\n comment: this schema is managed by terraform\n properties:\n kind: various\n thingsGrant:\n type: databricks:Grant\n name: things\n properties:\n schema: ${things.id}\n principal: Data Engineers\n privileges:\n - USE_SCHEMA\n - MODIFY\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Table grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eTable grants for the list of privileges that apply to Tables.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst customersDataEngineers = new databricks.Grant(\"customers_data_engineers\", {\n table: \"main.reporting.customers\",\n principal: \"Data Engineers\",\n privileges: [\n \"MODIFY\",\n \"SELECT\",\n ],\n});\nconst customersDataAnalysts = new databricks.Grant(\"customers_data_analysts\", {\n table: \"main.reporting.customers\",\n principal: \"Data Analysts\",\n privileges: [\"SELECT\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncustomers_data_engineers = databricks.Grant(\"customers_data_engineers\",\n table=\"main.reporting.customers\",\n principal=\"Data Engineers\",\n privileges=[\n \"MODIFY\",\n \"SELECT\",\n ])\ncustomers_data_analysts = databricks.Grant(\"customers_data_analysts\",\n table=\"main.reporting.customers\",\n principal=\"Data Analysts\",\n privileges=[\"SELECT\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var customersDataEngineers = new Databricks.Grant(\"customers_data_engineers\", new()\n {\n Table = \"main.reporting.customers\",\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"MODIFY\",\n \"SELECT\",\n },\n });\n\n var customersDataAnalysts = new Databricks.Grant(\"customers_data_analysts\", new()\n {\n Table = \"main.reporting.customers\",\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"SELECT\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrant(ctx, \"customers_data_engineers\", \u0026databricks.GrantArgs{\n\t\t\tTable: pulumi.String(\"main.reporting.customers\"),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"customers_data_analysts\", \u0026databricks.GrantArgs{\n\t\t\tTable: pulumi.String(\"main.reporting.customers\"),\n\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grant\" \"customers_data_engineers\" {\n table = \"main.reporting.customers\"\n principal = \"Data Engineers\"\n privileges = [\"MODIFY\", \"SELECT\"]\n}\nresource \"databricks_grant\" \"customers_data_analysts\" {\n table = \"main.reporting.customers\"\n principal = \"Data Analysts\"\n privileges = [\"SELECT\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var customersDataEngineers = new Grant(\"customersDataEngineers\", GrantArgs.builder()\n .table(\"main.reporting.customers\")\n .principal(\"Data Engineers\")\n .privileges( \n \"MODIFY\",\n \"SELECT\")\n .build());\n\n var customersDataAnalysts = new Grant(\"customersDataAnalysts\", GrantArgs.builder()\n .table(\"main.reporting.customers\")\n .principal(\"Data Analysts\")\n .privileges(\"SELECT\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n customersDataEngineers:\n type: databricks:Grant\n name: customers_data_engineers\n properties:\n table: main.reporting.customers\n principal: Data Engineers\n privileges:\n - MODIFY\n - SELECT\n customersDataAnalysts:\n type: databricks:Grant\n name: customers_data_analysts\n properties:\n table: main.reporting.customers\n principal: Data Analysts\n privileges:\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nYou can also apply grants dynamically with\u003cspan pulumi-lang-nodejs=\" databricks.getTables \" pulumi-lang-dotnet=\" databricks.getTables \" pulumi-lang-go=\" getTables \" pulumi-lang-python=\" get_tables \" pulumi-lang-yaml=\" databricks.getTables \" pulumi-lang-java=\" databricks.getTables \" pulumi-lang-hcl=\" data.databricks_tables \"\u003e databricks.getTables \u003c/span\u003edata resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nexport = async () =\u003e {\n const things = await databricks.getTables({\n catalogName: \"sandbox\",\n schemaName: \"things\",\n });\n const thingsGrant: databricks.Grant[] = [];\n for (const range of things.ids.map((v, k) =\u003e ({key: k, value: v}))) {\n thingsGrant.push(new databricks.Grant(`things-${range.key}`, {\n table: range.value,\n principal: \"sensitive\",\n privileges: [\n \"SELECT\",\n \"MODIFY\",\n ],\n }));\n }\n}\n```\n```python\nimport pulumi\nfrom typing import Any\nimport pulumi_databricks as databricks\n\nthings = databricks.get_tables(catalog_name=\"sandbox\",\n schema_name=\"things\")\nthings_grant: list[Any] = []\nfor range in [{\"key\": k, \"value\": v} for [k, v] in enumerate(things.ids)]:\n things_grant.append(databricks.Grant(f\"things-{range['key']}\",\n table=range[\"value\"],\n principal=\"sensitive\",\n privileges=[\n \"SELECT\",\n \"MODIFY\",\n ]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(async() =\u003e \n{\n var things = await Databricks.GetTables.InvokeAsync(new()\n {\n CatalogName = \"sandbox\",\n SchemaName = \"things\",\n });\n\n var thingsGrant = new List\u003cDatabricks.Grant\u003e();\n foreach (var range in )\n {\n thingsGrant.Add(new Databricks.Grant($\"things-{range.Key}\", new()\n {\n Table = range.Value,\n Principal = \"sensitive\",\n Privileges = new[]\n {\n \"SELECT\",\n \"MODIFY\",\n },\n }));\n }\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthings, err := databricks.GetTables(ctx, \u0026databricks.GetTablesArgs{\n\t\t\tCatalogName: \"sandbox\",\n\t\t\tSchemaName: \"things\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tvar thingsGrant []*databricks.Grant\n\t\tfor key0, val0 := range things.Ids {\n\t\t\t__res, err := databricks.NewGrant(ctx, fmt.Sprintf(\"things-%v\", key0), \u0026databricks.GrantArgs{\n\t\t\t\tTable: pulumi.String(pulumi.String(val0)),\n\t\t\t\tPrincipal: pulumi.String(\"sensitive\"),\n\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t},\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tthingsGrant = append(thingsGrant, __res)\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_gettables\" \"things\" {\n catalog_name = \"sandbox\"\n schema_name = \"things\"\n}\n\nresource \"databricks_grant\" \"things\" {\n for_each = data.databricks_gettables.things.ids\n table = each.value\n principal = \"sensitive\"\n privileges = [\"SELECT\", \"MODIFY\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetTablesArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport com.pulumi.codegen.internal.KeyedValue;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var things = DatabricksFunctions.getTables(GetTablesArgs.builder()\n .catalogName(\"sandbox\")\n .schemaName(\"things\")\n .build());\n\n final var thingsGrant = things.applyValue(getTablesResult -\u003e {\n final var resources = new ArrayList\u003cGrant\u003e();\n for (var range : KeyedValue.of(getTablesResult.ids())) {\n var resource = new Grant(\"thingsGrant-\" + range.key(), GrantArgs.builder()\n .table(range.value())\n .principal(\"sensitive\")\n .privileges( \n \"SELECT\",\n \"MODIFY\")\n .build());\n\n resources.add(resource);\n }\n\n return resources;\n });\n\n }\n}\n```\n```yaml\nresources:\n thingsGrant:\n type: databricks:Grant\n name: things\n properties:\n table: ${range.value}\n principal: sensitive\n privileges:\n - SELECT\n - MODIFY\n options: {}\nvariables:\n things:\n fn::invoke:\n function: databricks:getTables\n arguments:\n catalogName: sandbox\n schemaName: things\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## View grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eView grants for the list of privileges that apply to Views.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst customer360 = new databricks.Grant(\"customer360\", {\n table: \"main.reporting.customer360\",\n principal: \"Data Analysts\",\n privileges: [\"SELECT\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncustomer360 = databricks.Grant(\"customer360\",\n table=\"main.reporting.customer360\",\n principal=\"Data Analysts\",\n privileges=[\"SELECT\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var customer360 = new Databricks.Grant(\"customer360\", new()\n {\n Table = \"main.reporting.customer360\",\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"SELECT\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrant(ctx, \"customer360\", \u0026databricks.GrantArgs{\n\t\t\tTable: pulumi.String(\"main.reporting.customer360\"),\n\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grant\" \"customer360\" {\n table = \"main.reporting.customer360\"\n principal = \"Data Analysts\"\n privileges = [\"SELECT\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var customer360 = new Grant(\"customer360\", GrantArgs.builder()\n .table(\"main.reporting.customer360\")\n .principal(\"Data Analysts\")\n .privileges(\"SELECT\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n customer360:\n type: databricks:Grant\n properties:\n table: main.reporting.customer360\n principal: Data Analysts\n privileges:\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nYou can also apply grants dynamically with\u003cspan pulumi-lang-nodejs=\" databricks.getViews \" pulumi-lang-dotnet=\" databricks.getViews \" pulumi-lang-go=\" getViews \" pulumi-lang-python=\" get_views \" pulumi-lang-yaml=\" databricks.getViews \" pulumi-lang-java=\" databricks.getViews \" pulumi-lang-hcl=\" data.databricks_views \"\u003e databricks.getViews \u003c/span\u003edata resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nexport = async () =\u003e {\n const customers = await databricks.getViews({\n catalogName: \"main\",\n schemaName: \"customers\",\n });\n const customersGrant: databricks.Grant[] = [];\n for (const range of customers.ids.map((v, k) =\u003e ({key: k, value: v}))) {\n customersGrant.push(new databricks.Grant(`customers-${range.key}`, {\n table: range.value,\n principal: \"sensitive\",\n privileges: [\n \"SELECT\",\n \"MODIFY\",\n ],\n }));\n }\n}\n```\n```python\nimport pulumi\nfrom typing import Any\nimport pulumi_databricks as databricks\n\ncustomers = databricks.get_views(catalog_name=\"main\",\n schema_name=\"customers\")\ncustomers_grant: list[Any] = []\nfor range in [{\"key\": k, \"value\": v} for [k, v] in enumerate(customers.ids)]:\n customers_grant.append(databricks.Grant(f\"customers-{range['key']}\",\n table=range[\"value\"],\n principal=\"sensitive\",\n privileges=[\n \"SELECT\",\n \"MODIFY\",\n ]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(async() =\u003e \n{\n var customers = await Databricks.GetViews.InvokeAsync(new()\n {\n CatalogName = \"main\",\n SchemaName = \"customers\",\n });\n\n var customersGrant = new List\u003cDatabricks.Grant\u003e();\n foreach (var range in )\n {\n customersGrant.Add(new Databricks.Grant($\"customers-{range.Key}\", new()\n {\n Table = range.Value,\n Principal = \"sensitive\",\n Privileges = new[]\n {\n \"SELECT\",\n \"MODIFY\",\n },\n }));\n }\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcustomers, err := databricks.GetViews(ctx, \u0026databricks.GetViewsArgs{\n\t\t\tCatalogName: \"main\",\n\t\t\tSchemaName: \"customers\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tvar customersGrant []*databricks.Grant\n\t\tfor key0, val0 := range customers.Ids {\n\t\t\t__res, err := databricks.NewGrant(ctx, fmt.Sprintf(\"customers-%v\", key0), \u0026databricks.GrantArgs{\n\t\t\t\tTable: pulumi.String(pulumi.String(val0)),\n\t\t\t\tPrincipal: pulumi.String(\"sensitive\"),\n\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t},\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tcustomersGrant = append(customersGrant, __res)\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getviews\" \"customers\" {\n catalog_name = \"main\"\n schema_name = \"customers\"\n}\n\nresource \"databricks_grant\" \"customers\" {\n for_each = data.databricks_getviews.customers.ids\n table = each.value\n principal = \"sensitive\"\n privileges = [\"SELECT\", \"MODIFY\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetViewsArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport com.pulumi.codegen.internal.KeyedValue;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var customers = DatabricksFunctions.getViews(GetViewsArgs.builder()\n .catalogName(\"main\")\n .schemaName(\"customers\")\n .build());\n\n final var customersGrant = customers.applyValue(getViewsResult -\u003e {\n final var resources = new ArrayList\u003cGrant\u003e();\n for (var range : KeyedValue.of(getViewsResult.ids())) {\n var resource = new Grant(\"customersGrant-\" + range.key(), GrantArgs.builder()\n .table(range.value())\n .principal(\"sensitive\")\n .privileges( \n \"SELECT\",\n \"MODIFY\")\n .build());\n\n resources.add(resource);\n }\n\n return resources;\n });\n\n }\n}\n```\n```yaml\nresources:\n customersGrant:\n type: databricks:Grant\n name: customers\n properties:\n table: ${range.value}\n principal: sensitive\n privileges:\n - SELECT\n - MODIFY\n options: {}\nvariables:\n customers:\n fn::invoke:\n function: databricks:getViews\n arguments:\n catalogName: main\n schemaName: customers\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Volume grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eVolume grants for the list of privileges that apply to Volumes.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Volume(\"this\", {\n name: \"quickstart_volume\",\n catalogName: sandbox.name,\n schemaName: things.name,\n volumeType: \"EXTERNAL\",\n storageLocation: some.url,\n comment: \"this volume is managed by terraform\",\n});\nconst volume = new databricks.Grant(\"volume\", {\n volume: _this.id,\n principal: \"Data Engineers\",\n privileges: [\"WRITE_VOLUME\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Volume(\"this\",\n name=\"quickstart_volume\",\n catalog_name=sandbox[\"name\"],\n schema_name=things[\"name\"],\n volume_type=\"EXTERNAL\",\n storage_location=some[\"url\"],\n comment=\"this volume is managed by terraform\")\nvolume = databricks.Grant(\"volume\",\n volume=this.id,\n principal=\"Data Engineers\",\n privileges=[\"WRITE_VOLUME\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Volume(\"this\", new()\n {\n Name = \"quickstart_volume\",\n CatalogName = sandbox.Name,\n SchemaName = things.Name,\n VolumeType = \"EXTERNAL\",\n StorageLocation = some.Url,\n Comment = \"this volume is managed by terraform\",\n });\n\n var volume = new Databricks.Grant(\"volume\", new()\n {\n Volume = @this.Id,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"WRITE_VOLUME\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewVolume(ctx, \"this\", \u0026databricks.VolumeArgs{\n\t\t\tName: pulumi.String(\"quickstart_volume\"),\n\t\t\tCatalogName: pulumi.Any(sandbox.Name),\n\t\t\tSchemaName: pulumi.Any(things.Name),\n\t\t\tVolumeType: pulumi.String(\"EXTERNAL\"),\n\t\t\tStorageLocation: pulumi.Any(some.Url),\n\t\t\tComment: pulumi.String(\"this volume is managed by terraform\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"volume\", \u0026databricks.GrantArgs{\n\t\t\tVolume: this.ID(),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"WRITE_VOLUME\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_volume\" \"this\" {\n name = \"quickstart_volume\"\n catalog_name = sandbox.name\n schema_name = things.name\n volume_type = \"EXTERNAL\"\n storage_location = some.url\n comment = \"this volume is managed by terraform\"\n}\nresource \"databricks_grant\" \"volume\" {\n volume = databricks_volume.this.id\n principal = \"Data Engineers\"\n privileges = [\"WRITE_VOLUME\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Volume;\nimport com.pulumi.databricks.VolumeArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Volume(\"this\", VolumeArgs.builder()\n .name(\"quickstart_volume\")\n .catalogName(sandbox.name())\n .schemaName(things.name())\n .volumeType(\"EXTERNAL\")\n .storageLocation(some.url())\n .comment(\"this volume is managed by terraform\")\n .build());\n\n var volume = new Grant(\"volume\", GrantArgs.builder()\n .volume(this_.id())\n .principal(\"Data Engineers\")\n .privileges(\"WRITE_VOLUME\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Volume\n properties:\n name: quickstart_volume\n catalogName: ${sandbox.name}\n schemaName: ${things.name}\n volumeType: EXTERNAL\n storageLocation: ${some.url}\n comment: this volume is managed by terraform\n volume:\n type: databricks:Grant\n properties:\n volume: ${this.id}\n principal: Data Engineers\n privileges:\n - WRITE_VOLUME\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Registered model grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eRegistered model grants for the list of privileges that apply to Registered models.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst customersDataEngineers = new databricks.Grant(\"customers_data_engineers\", {\n model: \"main.reporting.customer_model\",\n principal: \"Data Engineers\",\n privileges: [\n \"APPLY_TAG\",\n \"EXECUTE\",\n ],\n});\nconst customersDataAnalysts = new databricks.Grant(\"customers_data_analysts\", {\n model: \"main.reporting.customer_model\",\n principal: \"Data Analysts\",\n privileges: [\"EXECUTE\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncustomers_data_engineers = databricks.Grant(\"customers_data_engineers\",\n model=\"main.reporting.customer_model\",\n principal=\"Data Engineers\",\n privileges=[\n \"APPLY_TAG\",\n \"EXECUTE\",\n ])\ncustomers_data_analysts = databricks.Grant(\"customers_data_analysts\",\n model=\"main.reporting.customer_model\",\n principal=\"Data Analysts\",\n privileges=[\"EXECUTE\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var customersDataEngineers = new Databricks.Grant(\"customers_data_engineers\", new()\n {\n Model = \"main.reporting.customer_model\",\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"APPLY_TAG\",\n \"EXECUTE\",\n },\n });\n\n var customersDataAnalysts = new Databricks.Grant(\"customers_data_analysts\", new()\n {\n Model = \"main.reporting.customer_model\",\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"EXECUTE\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrant(ctx, \"customers_data_engineers\", \u0026databricks.GrantArgs{\n\t\t\tModel: pulumi.String(\"main.reporting.customer_model\"),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"APPLY_TAG\"),\n\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"customers_data_analysts\", \u0026databricks.GrantArgs{\n\t\t\tModel: pulumi.String(\"main.reporting.customer_model\"),\n\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grant\" \"customers_data_engineers\" {\n model = \"main.reporting.customer_model\"\n principal = \"Data Engineers\"\n privileges = [\"APPLY_TAG\", \"EXECUTE\"]\n}\nresource \"databricks_grant\" \"customers_data_analysts\" {\n model = \"main.reporting.customer_model\"\n principal = \"Data Analysts\"\n privileges = [\"EXECUTE\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var customersDataEngineers = new Grant(\"customersDataEngineers\", GrantArgs.builder()\n .model(\"main.reporting.customer_model\")\n .principal(\"Data Engineers\")\n .privileges( \n \"APPLY_TAG\",\n \"EXECUTE\")\n .build());\n\n var customersDataAnalysts = new Grant(\"customersDataAnalysts\", GrantArgs.builder()\n .model(\"main.reporting.customer_model\")\n .principal(\"Data Analysts\")\n .privileges(\"EXECUTE\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n customersDataEngineers:\n type: databricks:Grant\n name: customers_data_engineers\n properties:\n model: main.reporting.customer_model\n principal: Data Engineers\n privileges:\n - APPLY_TAG\n - EXECUTE\n customersDataAnalysts:\n type: databricks:Grant\n name: customers_data_analysts\n properties:\n model: main.reporting.customer_model\n principal: Data Analysts\n privileges:\n - EXECUTE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Function grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eFunction grants for the list of privileges that apply to Registered models.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst udfDataEngineers = new databricks.Grant(\"udf_data_engineers\", {\n \"function\": \"main.reporting.udf\",\n principal: \"Data Engineers\",\n privileges: [\"EXECUTE\"],\n});\nconst udfDataAnalysts = new databricks.Grant(\"udf_data_analysts\", {\n \"function\": \"main.reporting.udf\",\n principal: \"Data Analysts\",\n privileges: [\"EXECUTE\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nudf_data_engineers = databricks.Grant(\"udf_data_engineers\",\n function=\"main.reporting.udf\",\n principal=\"Data Engineers\",\n privileges=[\"EXECUTE\"])\nudf_data_analysts = databricks.Grant(\"udf_data_analysts\",\n function=\"main.reporting.udf\",\n principal=\"Data Analysts\",\n privileges=[\"EXECUTE\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var udfDataEngineers = new Databricks.Grant(\"udf_data_engineers\", new()\n {\n Function = \"main.reporting.udf\",\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"EXECUTE\",\n },\n });\n\n var udfDataAnalysts = new Databricks.Grant(\"udf_data_analysts\", new()\n {\n Function = \"main.reporting.udf\",\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"EXECUTE\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrant(ctx, \"udf_data_engineers\", \u0026databricks.GrantArgs{\n\t\t\tFunction: pulumi.String(\"main.reporting.udf\"),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"udf_data_analysts\", \u0026databricks.GrantArgs{\n\t\t\tFunction: pulumi.String(\"main.reporting.udf\"),\n\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grant\" \"udf_data_engineers\" {\n function = \"main.reporting.udf\"\n principal = \"Data Engineers\"\n privileges = [\"EXECUTE\"]\n}\nresource \"databricks_grant\" \"udf_data_analysts\" {\n function = \"main.reporting.udf\"\n principal = \"Data Analysts\"\n privileges = [\"EXECUTE\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var udfDataEngineers = new Grant(\"udfDataEngineers\", GrantArgs.builder()\n .function(\"main.reporting.udf\")\n .principal(\"Data Engineers\")\n .privileges(\"EXECUTE\")\n .build());\n\n var udfDataAnalysts = new Grant(\"udfDataAnalysts\", GrantArgs.builder()\n .function(\"main.reporting.udf\")\n .principal(\"Data Analysts\")\n .privileges(\"EXECUTE\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n udfDataEngineers:\n type: databricks:Grant\n name: udf_data_engineers\n properties:\n function: main.reporting.udf\n principal: Data Engineers\n privileges:\n - EXECUTE\n udfDataAnalysts:\n type: databricks:Grant\n name: udf_data_analysts\n properties:\n function: main.reporting.udf\n principal: Data Analysts\n privileges:\n - EXECUTE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Service credential grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eService credential grants for the list of privileges that apply to Service credentials.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst external = new databricks.Credential(\"external\", {\n name: externalDataAccess.name,\n awsIamRole: {\n roleArn: externalDataAccess.arn,\n },\n purpose: \"SERVICE\",\n comment: \"Managed by TF\",\n});\nconst externalCreds = new databricks.Grant(\"external_creds\", {\n credential: external.databricksCredentialId,\n principal: \"Data Engineers\",\n privileges: [\"ACCESS\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal = databricks.Credential(\"external\",\n name=external_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": external_data_access[\"arn\"],\n },\n purpose=\"SERVICE\",\n comment=\"Managed by TF\")\nexternal_creds = databricks.Grant(\"external_creds\",\n credential=external.databricks_credential_id,\n principal=\"Data Engineers\",\n privileges=[\"ACCESS\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.Credential(\"external\", new()\n {\n Name = externalDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.CredentialAwsIamRoleArgs\n {\n RoleArn = externalDataAccess.Arn,\n },\n Purpose = \"SERVICE\",\n Comment = \"Managed by TF\",\n });\n\n var externalCreds = new Databricks.Grant(\"external_creds\", new()\n {\n Credential = external.DatabricksCredentialId,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"ACCESS\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewCredential(ctx, \"external\", \u0026databricks.CredentialArgs{\n\t\t\tName: pulumi.Any(externalDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.CredentialAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(externalDataAccess.Arn),\n\t\t\t},\n\t\t\tPurpose: pulumi.String(\"SERVICE\"),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"external_creds\", \u0026databricks.GrantArgs{\n\t\t\tCredential: external.DatabricksCredentialId,\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"ACCESS\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_credential\" \"external\" {\n name = externalDataAccess.name\n aws_iam_role = {\n role_arn = externalDataAccess.arn\n }\n purpose = \"SERVICE\"\n comment = \"Managed by TF\"\n}\nresource \"databricks_grant\" \"external_creds\" {\n credential = databricks_credential.external.databricks_credential_id\n principal = \"Data Engineers\"\n privileges = [\"ACCESS\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Credential;\nimport com.pulumi.databricks.CredentialArgs;\nimport com.pulumi.databricks.inputs.CredentialAwsIamRoleArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new Credential(\"external\", CredentialArgs.builder()\n .name(externalDataAccess.name())\n .awsIamRole(CredentialAwsIamRoleArgs.builder()\n .roleArn(externalDataAccess.arn())\n .build())\n .purpose(\"SERVICE\")\n .comment(\"Managed by TF\")\n .build());\n\n var externalCreds = new Grant(\"externalCreds\", GrantArgs.builder()\n .credential(external.databricksCredentialId())\n .principal(\"Data Engineers\")\n .privileges(\"ACCESS\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:Credential\n properties:\n name: ${externalDataAccess.name}\n awsIamRole:\n roleArn: ${externalDataAccess.arn}\n purpose: SERVICE\n comment: Managed by TF\n externalCreds:\n type: databricks:Grant\n name: external_creds\n properties:\n credential: ${external.databricksCredentialId}\n principal: Data Engineers\n privileges:\n - ACCESS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Storage credential grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eStorage credential grants for the list of privileges that apply to Storage credentials.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst external = new databricks.StorageCredential(\"external\", {\n name: externalDataAccess.name,\n awsIamRole: {\n roleArn: externalDataAccess.arn,\n },\n comment: \"Managed by TF\",\n});\nconst externalCreds = new databricks.Grant(\"external_creds\", {\n storageCredential: external.id,\n principal: \"Data Engineers\",\n privileges: [\"CREATE_EXTERNAL_TABLE\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal = databricks.StorageCredential(\"external\",\n name=external_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": external_data_access[\"arn\"],\n },\n comment=\"Managed by TF\")\nexternal_creds = databricks.Grant(\"external_creds\",\n storage_credential=external.id,\n principal=\"Data Engineers\",\n privileges=[\"CREATE_EXTERNAL_TABLE\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.StorageCredential(\"external\", new()\n {\n Name = externalDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.StorageCredentialAwsIamRoleArgs\n {\n RoleArn = externalDataAccess.Arn,\n },\n Comment = \"Managed by TF\",\n });\n\n var externalCreds = new Databricks.Grant(\"external_creds\", new()\n {\n StorageCredential = external.Id,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewStorageCredential(ctx, \"external\", \u0026databricks.StorageCredentialArgs{\n\t\t\tName: pulumi.Any(externalDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.StorageCredentialAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(externalDataAccess.Arn),\n\t\t\t},\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"external_creds\", \u0026databricks.GrantArgs{\n\t\t\tStorageCredential: external.ID(),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_storagecredential\" \"external\" {\n name = externalDataAccess.name\n aws_iam_role = {\n role_arn = externalDataAccess.arn\n }\n comment = \"Managed by TF\"\n}\nresource \"databricks_grant\" \"external_creds\" {\n storage_credential = databricks_storagecredential.external.id\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.StorageCredential;\nimport com.pulumi.databricks.StorageCredentialArgs;\nimport com.pulumi.databricks.inputs.StorageCredentialAwsIamRoleArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new StorageCredential(\"external\", StorageCredentialArgs.builder()\n .name(externalDataAccess.name())\n .awsIamRole(StorageCredentialAwsIamRoleArgs.builder()\n .roleArn(externalDataAccess.arn())\n .build())\n .comment(\"Managed by TF\")\n .build());\n\n var externalCreds = new Grant(\"externalCreds\", GrantArgs.builder()\n .storageCredential(external.id())\n .principal(\"Data Engineers\")\n .privileges(\"CREATE_EXTERNAL_TABLE\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:StorageCredential\n properties:\n name: ${externalDataAccess.name}\n awsIamRole:\n roleArn: ${externalDataAccess.arn}\n comment: Managed by TF\n externalCreds:\n type: databricks:Grant\n name: external_creds\n properties:\n storageCredential: ${external.id}\n principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## External location grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eExternal location grants for the list of privileges that apply to External locations.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst some = new databricks.ExternalLocation(\"some\", {\n name: \"external\",\n url: `s3://${externalAwsS3Bucket.id}/some`,\n credentialName: external.id,\n comment: \"Managed by TF\",\n});\nconst someDataEngineers = new databricks.Grant(\"some_data_engineers\", {\n externalLocation: some.id,\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n});\nconst someServicePrincipal = new databricks.Grant(\"some_service_principal\", {\n externalLocation: some.id,\n principal: mySp.applicationId,\n privileges: [\n \"USE_SCHEMA\",\n \"MODIFY\",\n ],\n});\nconst someGroup = new databricks.Grant(\"some_group\", {\n externalLocation: some.id,\n principal: myGroup.displayName,\n privileges: [\n \"USE_SCHEMA\",\n \"MODIFY\",\n ],\n});\nconst someUser = new databricks.Grant(\"some_user\", {\n externalLocation: some.id,\n principal: myUser.userName,\n privileges: [\n \"USE_SCHEMA\",\n \"MODIFY\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsome = databricks.ExternalLocation(\"some\",\n name=\"external\",\n url=f\"s3://{external_aws_s3_bucket['id']}/some\",\n credential_name=external[\"id\"],\n comment=\"Managed by TF\")\nsome_data_engineers = databricks.Grant(\"some_data_engineers\",\n external_location=some.id,\n principal=\"Data Engineers\",\n privileges=[\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ])\nsome_service_principal = databricks.Grant(\"some_service_principal\",\n external_location=some.id,\n principal=my_sp[\"applicationId\"],\n privileges=[\n \"USE_SCHEMA\",\n \"MODIFY\",\n ])\nsome_group = databricks.Grant(\"some_group\",\n external_location=some.id,\n principal=my_group[\"displayName\"],\n privileges=[\n \"USE_SCHEMA\",\n \"MODIFY\",\n ])\nsome_user = databricks.Grant(\"some_user\",\n external_location=some.id,\n principal=my_user[\"userName\"],\n privileges=[\n \"USE_SCHEMA\",\n \"MODIFY\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var some = new Databricks.ExternalLocation(\"some\", new()\n {\n Name = \"external\",\n Url = $\"s3://{externalAwsS3Bucket.Id}/some\",\n CredentialName = external.Id,\n Comment = \"Managed by TF\",\n });\n\n var someDataEngineers = new Databricks.Grant(\"some_data_engineers\", new()\n {\n ExternalLocation = some.Id,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n });\n\n var someServicePrincipal = new Databricks.Grant(\"some_service_principal\", new()\n {\n ExternalLocation = some.Id,\n Principal = mySp.ApplicationId,\n Privileges = new[]\n {\n \"USE_SCHEMA\",\n \"MODIFY\",\n },\n });\n\n var someGroup = new Databricks.Grant(\"some_group\", new()\n {\n ExternalLocation = some.Id,\n Principal = myGroup.DisplayName,\n Privileges = new[]\n {\n \"USE_SCHEMA\",\n \"MODIFY\",\n },\n });\n\n var someUser = new Databricks.Grant(\"some_user\", new()\n {\n ExternalLocation = some.Id,\n Principal = myUser.UserName,\n Privileges = new[]\n {\n \"USE_SCHEMA\",\n \"MODIFY\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsome, err := databricks.NewExternalLocation(ctx, \"some\", \u0026databricks.ExternalLocationArgs{\n\t\t\tName: pulumi.String(\"external\"),\n\t\t\tUrl: pulumi.Sprintf(\"s3://%v/some\", externalAwsS3Bucket.Id),\n\t\t\tCredentialName: pulumi.Any(external.Id),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"some_data_engineers\", \u0026databricks.GrantArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"some_service_principal\", \u0026databricks.GrantArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tPrincipal: pulumi.Any(mySp.ApplicationId),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"some_group\", \u0026databricks.GrantArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tPrincipal: pulumi.Any(myGroup.DisplayName),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"some_user\", \u0026databricks.GrantArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tPrincipal: pulumi.Any(myUser.UserName),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_externallocation\" \"some\" {\n name = \"external\"\n url =\"s3://${externalAwsS3Bucket.id}/some\"\n credential_name = external.id\n comment = \"Managed by TF\"\n}\nresource \"databricks_grant\" \"some_data_engineers\" {\n external_location = databricks_externallocation.some.id\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n}\nresource \"databricks_grant\" \"some_service_principal\" {\n external_location = databricks_externallocation.some.id\n principal = mySp.applicationId\n privileges = [\"USE_SCHEMA\", \"MODIFY\"]\n}\nresource \"databricks_grant\" \"some_group\" {\n external_location = databricks_externallocation.some.id\n principal = myGroup.displayName\n privileges = [\"USE_SCHEMA\", \"MODIFY\"]\n}\nresource \"databricks_grant\" \"some_user\" {\n external_location = databricks_externallocation.some.id\n principal = myUser.userName\n privileges = [\"USE_SCHEMA\", \"MODIFY\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ExternalLocation;\nimport com.pulumi.databricks.ExternalLocationArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var some = new ExternalLocation(\"some\", ExternalLocationArgs.builder()\n .name(\"external\")\n .url(String.format(\"s3://%s/some\", externalAwsS3Bucket.id()))\n .credentialName(external.id())\n .comment(\"Managed by TF\")\n .build());\n\n var someDataEngineers = new Grant(\"someDataEngineers\", GrantArgs.builder()\n .externalLocation(some.id())\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build());\n\n var someServicePrincipal = new Grant(\"someServicePrincipal\", GrantArgs.builder()\n .externalLocation(some.id())\n .principal(mySp.applicationId())\n .privileges( \n \"USE_SCHEMA\",\n \"MODIFY\")\n .build());\n\n var someGroup = new Grant(\"someGroup\", GrantArgs.builder()\n .externalLocation(some.id())\n .principal(myGroup.displayName())\n .privileges( \n \"USE_SCHEMA\",\n \"MODIFY\")\n .build());\n\n var someUser = new Grant(\"someUser\", GrantArgs.builder()\n .externalLocation(some.id())\n .principal(myUser.userName())\n .privileges( \n \"USE_SCHEMA\",\n \"MODIFY\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n some:\n type: databricks:ExternalLocation\n properties:\n name: external\n url: s3://${externalAwsS3Bucket.id}/some\n credentialName: ${external.id}\n comment: Managed by TF\n someDataEngineers:\n type: databricks:Grant\n name: some_data_engineers\n properties:\n externalLocation: ${some.id}\n principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n someServicePrincipal:\n type: databricks:Grant\n name: some_service_principal\n properties:\n externalLocation: ${some.id}\n principal: ${mySp.applicationId}\n privileges:\n - USE_SCHEMA\n - MODIFY\n someGroup:\n type: databricks:Grant\n name: some_group\n properties:\n externalLocation: ${some.id}\n principal: ${myGroup.displayName}\n privileges:\n - USE_SCHEMA\n - MODIFY\n someUser:\n type: databricks:Grant\n name: some_user\n properties:\n externalLocation: ${some.id}\n principal: ${myUser.userName}\n privileges:\n - USE_SCHEMA\n - MODIFY\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Connection grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eConnection grants for the list of privileges that apply to Connections.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst mysql = new databricks.Connection(\"mysql\", {\n name: \"mysql_connection\",\n connectionType: \"MYSQL\",\n comment: \"this is a connection to mysql db\",\n options: {\n host: \"test.mysql.database.azure.com\",\n port: \"3306\",\n user: \"user\",\n password: \"password\",\n },\n properties: {\n purpose: \"testing\",\n },\n});\nconst some = new databricks.Grant(\"some\", {\n foreignConnection: mysql.name,\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\",\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nmysql = databricks.Connection(\"mysql\",\n name=\"mysql_connection\",\n connection_type=\"MYSQL\",\n comment=\"this is a connection to mysql db\",\n options={\n \"host\": \"test.mysql.database.azure.com\",\n \"port\": \"3306\",\n \"user\": \"user\",\n \"password\": \"password\",\n },\n properties={\n \"purpose\": \"testing\",\n })\nsome = databricks.Grant(\"some\",\n foreign_connection=mysql.name,\n principal=\"Data Engineers\",\n privileges=[\n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\",\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var mysql = new Databricks.Connection(\"mysql\", new()\n {\n Name = \"mysql_connection\",\n ConnectionType = \"MYSQL\",\n Comment = \"this is a connection to mysql db\",\n Options = \n {\n { \"host\", \"test.mysql.database.azure.com\" },\n { \"port\", \"3306\" },\n { \"user\", \"user\" },\n { \"password\", \"password\" },\n },\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var some = new Databricks.Grant(\"some\", new()\n {\n ForeignConnection = mysql.Name,\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmysql, err := databricks.NewConnection(ctx, \"mysql\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"mysql_connection\"),\n\t\t\tConnectionType: pulumi.String(\"MYSQL\"),\n\t\t\tComment: pulumi.String(\"this is a connection to mysql db\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"host\": pulumi.String(\"test.mysql.database.azure.com\"),\n\t\t\t\t\"port\": pulumi.String(\"3306\"),\n\t\t\t\t\"user\": pulumi.String(\"user\"),\n\t\t\t\t\"password\": pulumi.String(\"password\"),\n\t\t\t},\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"some\", \u0026databricks.GrantArgs{\n\t\t\tForeignConnection: mysql.Name,\n\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"CREATE_FOREIGN_CATALOG\"),\n\t\t\t\tpulumi.String(\"USE_CONNECTION\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"mysql\" {\n name = \"mysql_connection\"\n connection_type = \"MYSQL\"\n comment = \"this is a connection to mysql db\"\n options = {\n \"host\" = \"test.mysql.database.azure.com\"\n \"port\" = \"3306\"\n \"user\" = \"user\"\n \"password\" = \"password\"\n }\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_grant\" \"some\" {\n foreign_connection = databricks_connection.mysql.name\n principal = \"Data Engineers\"\n privileges = [\"CREATE_FOREIGN_CATALOG\", \"USE_CONNECTION\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var mysql = new Connection(\"mysql\", ConnectionArgs.builder()\n .name(\"mysql_connection\")\n .connectionType(\"MYSQL\")\n .comment(\"this is a connection to mysql db\")\n .options(Map.ofEntries(\n Map.entry(\"host\", \"test.mysql.database.azure.com\"),\n Map.entry(\"port\", \"3306\"),\n Map.entry(\"user\", \"user\"),\n Map.entry(\"password\", \"password\")\n ))\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var some = new Grant(\"some\", GrantArgs.builder()\n .foreignConnection(mysql.name())\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n mysql:\n type: databricks:Connection\n properties:\n name: mysql_connection\n connectionType: MYSQL\n comment: this is a connection to mysql db\n options:\n host: test.mysql.database.azure.com\n port: '3306'\n user: user\n password: password\n properties:\n purpose: testing\n some:\n type: databricks:Grant\n properties:\n foreignConnection: ${mysql.name}\n principal: Data Engineers\n privileges:\n - CREATE_FOREIGN_CATALOG\n - USE_CONNECTION\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Delta Sharing share grants\n\nSee\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eDelta Sharing share grants for the list of privileges that apply to Delta Sharing shares.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst some = new databricks.Share(\"some\", {name: \"my_share\"});\nconst someRecipient = new databricks.Recipient(\"some\", {name: \"my_recipient\"});\nconst someGrant = new databricks.Grant(\"some\", {\n share: some.name,\n principal: someRecipient.name,\n privileges: [\"SELECT\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsome = databricks.Share(\"some\", name=\"my_share\")\nsome_recipient = databricks.Recipient(\"some\", name=\"my_recipient\")\nsome_grant = databricks.Grant(\"some\",\n share=some.name,\n principal=some_recipient.name,\n privileges=[\"SELECT\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var some = new Databricks.Share(\"some\", new()\n {\n Name = \"my_share\",\n });\n\n var someRecipient = new Databricks.Recipient(\"some\", new()\n {\n Name = \"my_recipient\",\n });\n\n var someGrant = new Databricks.Grant(\"some\", new()\n {\n Share = some.Name,\n Principal = someRecipient.Name,\n Privileges = new[]\n {\n \"SELECT\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsome, err := databricks.NewShare(ctx, \"some\", \u0026databricks.ShareArgs{\n\t\t\tName: pulumi.String(\"my_share\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsomeRecipient, err := databricks.NewRecipient(ctx, \"some\", \u0026databricks.RecipientArgs{\n\t\t\tName: pulumi.String(\"my_recipient\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrant(ctx, \"some\", \u0026databricks.GrantArgs{\n\t\t\tShare: some.Name,\n\t\t\tPrincipal: someRecipient.Name,\n\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_share\" \"some\" {\n name = \"my_share\"\n}\nresource \"databricks_recipient\" \"some\" {\n name = \"my_recipient\"\n}\nresource \"databricks_grant\" \"some\" {\n share = databricks_share.some.name\n principal = databricks_recipient.some.name\n privileges = [\"SELECT\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Share;\nimport com.pulumi.databricks.ShareArgs;\nimport com.pulumi.databricks.Recipient;\nimport com.pulumi.databricks.RecipientArgs;\nimport com.pulumi.databricks.Grant;\nimport com.pulumi.databricks.GrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var some = new Share(\"some\", ShareArgs.builder()\n .name(\"my_share\")\n .build());\n\n var someRecipient = new Recipient(\"someRecipient\", RecipientArgs.builder()\n .name(\"my_recipient\")\n .build());\n\n var someGrant = new Grant(\"someGrant\", GrantArgs.builder()\n .share(some.name())\n .principal(someRecipient.name())\n .privileges(\"SELECT\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n some:\n type: databricks:Share\n properties:\n name: my_share\n someRecipient:\n type: databricks:Recipient\n name: some\n properties:\n name: my_recipient\n someGrant:\n type: databricks:Grant\n name: some\n properties:\n share: ${some.name}\n principal: ${someRecipient.name}\n privileges:\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Other access control\n\nYou can control Databricks General Permissions through\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eresource.\n\n", "properties": { "catalog": { "type": "string" }, "credential": { "type": "string" }, "externalLocation": { "type": "string" }, "foreignConnection": { "type": "string" }, "function": { "type": "string" }, "metastore": { "type": "string" }, "model": { "type": "string" }, "pipeline": { "type": "string" }, "principal": { "type": "string" }, "privileges": { "type": "array", "items": { "type": "string" } }, "providerConfig": { "$ref": "#/types/databricks:index/GrantProviderConfig:GrantProviderConfig" }, "recipient": { "type": "string" }, "schema": { "type": "string" }, "share": { "type": "string" }, "storageCredential": { "type": "string" }, "table": { "type": "string" }, "volume": { "type": "string" } }, "required": [ "principal", "privileges", "providerConfig" ], "inputProperties": { "catalog": { "type": "string", "willReplaceOnChanges": true }, "credential": { "type": "string", "willReplaceOnChanges": true }, "externalLocation": { "type": "string", "willReplaceOnChanges": true }, "foreignConnection": { "type": "string", "willReplaceOnChanges": true }, "function": { "type": "string", "willReplaceOnChanges": true }, "metastore": { "type": "string", "willReplaceOnChanges": true }, "model": { "type": "string", "willReplaceOnChanges": true }, "pipeline": { "type": "string", "willReplaceOnChanges": true }, "principal": { "type": "string", "willReplaceOnChanges": true }, "privileges": { "type": "array", "items": { "type": "string" } }, "providerConfig": { "$ref": "#/types/databricks:index/GrantProviderConfig:GrantProviderConfig" }, "recipient": { "type": "string", "willReplaceOnChanges": true }, "schema": { "type": "string", "willReplaceOnChanges": true }, "share": { "type": "string", "willReplaceOnChanges": true }, "storageCredential": { "type": "string", "willReplaceOnChanges": true }, "table": { "type": "string", "willReplaceOnChanges": true }, "volume": { "type": "string", "willReplaceOnChanges": true } }, "requiredInputs": [ "principal", "privileges" ], "stateInputs": { "description": "Input properties used for looking up and filtering Grant resources.\n", "properties": { "catalog": { "type": "string", "willReplaceOnChanges": true }, "credential": { "type": "string", "willReplaceOnChanges": true }, "externalLocation": { "type": "string", "willReplaceOnChanges": true }, "foreignConnection": { "type": "string", "willReplaceOnChanges": true }, "function": { "type": "string", "willReplaceOnChanges": true }, "metastore": { "type": "string", "willReplaceOnChanges": true }, "model": { "type": "string", "willReplaceOnChanges": true }, "pipeline": { "type": "string", "willReplaceOnChanges": true }, "principal": { "type": "string", "willReplaceOnChanges": true }, "privileges": { "type": "array", "items": { "type": "string" } }, "providerConfig": { "$ref": "#/types/databricks:index/GrantProviderConfig:GrantProviderConfig" }, "recipient": { "type": "string", "willReplaceOnChanges": true }, "schema": { "type": "string", "willReplaceOnChanges": true }, "share": { "type": "string", "willReplaceOnChanges": true }, "storageCredential": { "type": "string", "willReplaceOnChanges": true }, "table": { "type": "string", "willReplaceOnChanges": true }, "volume": { "type": "string", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/grants:Grants": { "description": "\u003e This article refers to the privileges and inheritance model in Privilege Model version 1.0. If you created your metastore during the public preview (before August 25, 2022), you can upgrade to Privilege Model version 1.0 following [Upgrade to privilege inheritance](https://docs.databricks.com/data-governance/unity-catalog/hive-metastore.html)\n\n\u003e Most of Unity Catalog APIs are only accessible via **workspace-level APIs**. This design may change in the future. Account-level principal grants can be assigned with any valid workspace as the Unity Catalog is decoupled from specific workspaces. More information in [the official documentation](https://docs.databricks.com/data-governance/unity-catalog/index.html).\n\n\u003e This resource is _authoritative_ for grants on securables. Configuring this resource for a securable will **OVERWRITE** any existing grants and changes made outside of Pulumi will be reset. Use\u003cspan pulumi-lang-nodejs=\" databricks.Grant \" pulumi-lang-dotnet=\" databricks.Grant \" pulumi-lang-go=\" Grant \" pulumi-lang-python=\" Grant \" pulumi-lang-yaml=\" databricks.Grant \" pulumi-lang-java=\" databricks.Grant \" pulumi-lang-hcl=\" databricks_grant \"\u003e databricks.Grant \u003c/span\u003efor more granular grant management.\n\nIn Unity Catalog all users initially have no access to data. Only Metastore Admins can create objects and can grant/revoke access on individual objects to users and groups. Every securable object in Unity Catalog has an owner. The owner can be any account-level user or group, called principals in general. The principal that creates an object becomes its owner. Owners receive `ALL_PRIVILEGES` on the securable object (e.g., `SELECT` and `MODIFY` on a table), as well as the permission to grant privileges to other principals.\n\nSecurable objects are hierarchical and privileges are inherited downward. The highest level object that privileges are inherited from is the catalog. This means that granting a privilege on a catalog or schema automatically grants the privilege to all current and future objects within the catalog or schema. Privileges that are granted on a metastore are not inherited.\n\nEvery \u003cspan pulumi-lang-nodejs=\"`databricks.Grants`\" pulumi-lang-dotnet=\"`databricks.Grants`\" pulumi-lang-go=\"`Grants`\" pulumi-lang-python=\"`Grants`\" pulumi-lang-yaml=\"`databricks.Grants`\" pulumi-lang-java=\"`databricks.Grants`\" pulumi-lang-hcl=\"`databricks_grants`\"\u003e`databricks.Grants`\u003c/span\u003e resource must have exactly one securable identifier and one or more \u003cspan pulumi-lang-nodejs=\"`grant`\" pulumi-lang-dotnet=\"`Grant`\" pulumi-lang-go=\"`grant`\" pulumi-lang-python=\"`grant`\" pulumi-lang-yaml=\"`grant`\" pulumi-lang-java=\"`grant`\" pulumi-lang-hcl=\"`grant`\"\u003e`grant`\u003c/span\u003e blocks with the following arguments:\n\n- \u003cspan pulumi-lang-nodejs=\"`principal`\" pulumi-lang-dotnet=\"`Principal`\" pulumi-lang-go=\"`principal`\" pulumi-lang-python=\"`principal`\" pulumi-lang-yaml=\"`principal`\" pulumi-lang-java=\"`principal`\" pulumi-lang-hcl=\"`principal`\"\u003e`principal`\u003c/span\u003e - User name, group name or service principal application ID.\n- \u003cspan pulumi-lang-nodejs=\"`privileges`\" pulumi-lang-dotnet=\"`Privileges`\" pulumi-lang-go=\"`privileges`\" pulumi-lang-python=\"`privileges`\" pulumi-lang-yaml=\"`privileges`\" pulumi-lang-java=\"`privileges`\" pulumi-lang-hcl=\"`privileges`\"\u003e`privileges`\u003c/span\u003e - One or more privileges that are specific to a securable type.\n- \u003cspan pulumi-lang-nodejs=\"`providerConfig`\" pulumi-lang-dotnet=\"`ProviderConfig`\" pulumi-lang-go=\"`providerConfig`\" pulumi-lang-python=\"`provider_config`\" pulumi-lang-yaml=\"`providerConfig`\" pulumi-lang-java=\"`providerConfig`\" pulumi-lang-hcl=\"`provider_config`\"\u003e`providerConfig`\u003c/span\u003e - (Optional) Configure the provider for management through account provider. This block consists of the following fields:\n - \u003cspan pulumi-lang-nodejs=\"`workspaceId`\" pulumi-lang-dotnet=\"`WorkspaceId`\" pulumi-lang-go=\"`workspaceId`\" pulumi-lang-python=\"`workspace_id`\" pulumi-lang-yaml=\"`workspaceId`\" pulumi-lang-java=\"`workspaceId`\" pulumi-lang-hcl=\"`workspace_id`\"\u003e`workspaceId`\u003c/span\u003e - (Required) Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n\nFor the latest list of privilege types that apply to each securable object in Unity Catalog, please refer to the [official documentation](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/privileges.html#privilege-types-by-securable-object-in-unity-catalog)\n\nWhen applying grants using an identity with [`MANAGE` permission](https://docs.databricks.com/aws/en/data-governance/unity-catalog/manage-privileges/ownership#ownership-versus-the-manage-privilege), their `MANAGE` permission must also be defined, otherwise Pulumi will remove their permissions, leading to errors.\n\nUnlike the [SQL specification](https://docs.databricks.com/sql/language-manual/sql-ref-privileges.html#privilege-types), all privileges to be written with underscore instead of space, e.g. `CREATE_TABLE` and not `CREATE TABLE`. Below summarizes which privilege types apply to each securable object in the catalog:\n\n## Metastore grants\n\nYou can grant `CREATE_CATALOG`, `CREATE_CLEAN_ROOM`, `CREATE_CONNECTION`, `CREATE_EXTERNAL_LOCATION`, `CREATE_PROVIDER`, `CREATE_RECIPIENT`, `CREATE_SHARE`, `CREATE_SERVICE_CREDENTIAL`, `CREATE_STORAGE_CREDENTIAL`, `SET_SHARE_PERMISSION`, `USE_MARKETPLACE_ASSETS`, `USE_PROVIDER`, `USE_RECIPIENT`, and `USE_SHARE` privileges to\u003cspan pulumi-lang-nodejs=\" databricks.Metastore \" pulumi-lang-dotnet=\" databricks.Metastore \" pulumi-lang-go=\" Metastore \" pulumi-lang-python=\" Metastore \" pulumi-lang-yaml=\" databricks.Metastore \" pulumi-lang-java=\" databricks.Metastore \" pulumi-lang-hcl=\" databricks_metastore \"\u003e databricks.Metastore \u003c/span\u003eassigned to the workspace.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Grants(\"sandbox\", {\n metastore: \"metastore_id\",\n grants: [\n {\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\",\n ],\n },\n {\n principal: \"Data Sharer\",\n privileges: [\n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\",\n ],\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Grants(\"sandbox\",\n metastore=\"metastore_id\",\n grants=[\n {\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\",\n ],\n },\n {\n \"principal\": \"Data Sharer\",\n \"privileges\": [\n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\",\n ],\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Grants(\"sandbox\", new()\n {\n Metastore = \"metastore_id\",\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Sharer\",\n Privileges = new[]\n {\n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrants(ctx, \"sandbox\", \u0026databricks.GrantsArgs{\n\t\t\tMetastore: pulumi.String(\"metastore_id\"),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_CATALOG\"),\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_LOCATION\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Sharer\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_RECIPIENT\"),\n\t\t\t\t\t\tpulumi.String(\"CREATE_SHARE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grants\" \"sandbox\" {\n metastore = \"metastore_id\"\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_CATALOG\", \"CREATE_EXTERNAL_LOCATION\"]\n }\n grants {\n principal = \"Data Sharer\"\n privileges = [\"CREATE_RECIPIENT\", \"CREATE_SHARE\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Grants(\"sandbox\", GrantsArgs.builder()\n .metastore(\"metastore_id\")\n .grants( \n GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_CATALOG\",\n \"CREATE_EXTERNAL_LOCATION\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(\"Data Sharer\")\n .privileges( \n \"CREATE_RECIPIENT\",\n \"CREATE_SHARE\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Grants\n properties:\n metastore: metastore_id\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_CATALOG\n - CREATE_EXTERNAL_LOCATION\n - principal: Data Sharer\n privileges:\n - CREATE_RECIPIENT\n - CREATE_SHARE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Catalog grants\n\nYou can grant `ALL_PRIVILEGES`, `APPLY_TAG`, `CREATE_CONNECTION`, `CREATE_SCHEMA`, `MANAGE`, and `USE_CATALOG` privileges to\u003cspan pulumi-lang-nodejs=\" databricks.Catalog \" pulumi-lang-dotnet=\" databricks.Catalog \" pulumi-lang-go=\" Catalog \" pulumi-lang-python=\" Catalog \" pulumi-lang-yaml=\" databricks.Catalog \" pulumi-lang-java=\" databricks.Catalog \" pulumi-lang-hcl=\" databricks_catalog \"\u003e databricks.Catalog \u003c/span\u003especified in the \u003cspan pulumi-lang-nodejs=\"`catalog`\" pulumi-lang-dotnet=\"`Catalog`\" pulumi-lang-go=\"`catalog`\" pulumi-lang-python=\"`catalog`\" pulumi-lang-yaml=\"`catalog`\" pulumi-lang-java=\"`catalog`\" pulumi-lang-hcl=\"`catalog`\"\u003e`catalog`\u003c/span\u003e attribute. You can also grant `CREATE_FUNCTION`, `CREATE_TABLE`, `CREATE_VOLUME`, `EXECUTE`, `MODIFY`, `REFRESH`, `SELECT`, `READ_VOLUME`, `WRITE_VOLUME` and `USE_SCHEMA` at the catalog level to apply them to the pertinent current and future securable objects within the catalog:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n name: \"sandbox\",\n comment: \"this catalog is managed by terraform\",\n properties: {\n purpose: \"testing\",\n },\n});\nconst sandboxGrants = new databricks.Grants(\"sandbox\", {\n catalog: sandbox.name,\n grants: [\n {\n principal: \"Data Scientists\",\n privileges: [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\",\n ],\n },\n {\n principal: \"Data Engineers\",\n privileges: [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\",\n ],\n },\n {\n principal: \"Data Analyst\",\n privileges: [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\",\n ],\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n name=\"sandbox\",\n comment=\"this catalog is managed by terraform\",\n properties={\n \"purpose\": \"testing\",\n })\nsandbox_grants = databricks.Grants(\"sandbox\",\n catalog=sandbox.name,\n grants=[\n {\n \"principal\": \"Data Scientists\",\n \"privileges\": [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\",\n ],\n },\n {\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\",\n ],\n },\n {\n \"principal\": \"Data Analyst\",\n \"privileges\": [\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\",\n ],\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n Name = \"sandbox\",\n Comment = \"this catalog is managed by terraform\",\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var sandboxGrants = new Databricks.Grants(\"sandbox\", new()\n {\n Catalog = sandbox.Name,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Scientists\",\n Privileges = new[]\n {\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Analyst\",\n Privileges = new[]\n {\n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsandbox, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tComment: pulumi.String(\"this catalog is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"sandbox\", \u0026databricks.GrantsArgs{\n\t\t\tCatalog: sandbox.Name,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Scientists\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"USE_CATALOG\"),\n\t\t\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\t\t\tpulumi.String(\"CREATE_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"USE_CATALOG\"),\n\t\t\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\t\t\tpulumi.String(\"CREATE_SCHEMA\"),\n\t\t\t\t\t\tpulumi.String(\"CREATE_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Analyst\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"USE_CATALOG\"),\n\t\t\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n name = \"sandbox\"\n comment = \"this catalog is managed by terraform\"\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_grants\" \"sandbox\" {\n catalog = databricks_catalog.sandbox.name\n grants {\n principal = \"Data Scientists\"\n privileges = [\"USE_CATALOG\", \"USE_SCHEMA\", \"CREATE_TABLE\", \"SELECT\"]\n }\n grants {\n principal = \"Data Engineers\"\n privileges = [\"USE_CATALOG\", \"USE_SCHEMA\", \"CREATE_SCHEMA\", \"CREATE_TABLE\", \"MODIFY\"]\n }\n grants {\n principal = \"Data Analyst\"\n privileges = [\"USE_CATALOG\", \"USE_SCHEMA\", \"SELECT\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .name(\"sandbox\")\n .comment(\"this catalog is managed by terraform\")\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var sandboxGrants = new Grants(\"sandboxGrants\", GrantsArgs.builder()\n .catalog(sandbox.name())\n .grants( \n GrantsGrantArgs.builder()\n .principal(\"Data Scientists\")\n .privileges( \n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_TABLE\",\n \"SELECT\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"CREATE_SCHEMA\",\n \"CREATE_TABLE\",\n \"MODIFY\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(\"Data Analyst\")\n .privileges( \n \"USE_CATALOG\",\n \"USE_SCHEMA\",\n \"SELECT\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n name: sandbox\n comment: this catalog is managed by terraform\n properties:\n purpose: testing\n sandboxGrants:\n type: databricks:Grants\n name: sandbox\n properties:\n catalog: ${sandbox.name}\n grants:\n - principal: Data Scientists\n privileges:\n - USE_CATALOG\n - USE_SCHEMA\n - CREATE_TABLE\n - SELECT\n - principal: Data Engineers\n privileges:\n - USE_CATALOG\n - USE_SCHEMA\n - CREATE_SCHEMA\n - CREATE_TABLE\n - MODIFY\n - principal: Data Analyst\n privileges:\n - USE_CATALOG\n - USE_SCHEMA\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Schema grants\n\nYou can grant `ALL_PRIVILEGES`, `APPLY_TAG`, `CREATE_FUNCTION`, `CREATE_TABLE`, `CREATE_VOLUME`, `MANAGE` and `USE_SCHEMA` privileges to _`catalog.schema`_ specified in the \u003cspan pulumi-lang-nodejs=\"`schema`\" pulumi-lang-dotnet=\"`Schema`\" pulumi-lang-go=\"`schema`\" pulumi-lang-python=\"`schema`\" pulumi-lang-yaml=\"`schema`\" pulumi-lang-java=\"`schema`\" pulumi-lang-hcl=\"`schema`\"\u003e`schema`\u003c/span\u003e attribute. You can also grant `EXECUTE`, `MODIFY`, `REFRESH`, `SELECT`, `READ_VOLUME`, `WRITE_VOLUME` at the schema level to apply them to the pertinent current and future securable objects within the schema:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst things = new databricks.Schema(\"things\", {\n catalogName: sandbox.id,\n name: \"things\",\n comment: \"this schema is managed by terraform\",\n properties: {\n kind: \"various\",\n },\n});\nconst thingsGrants = new databricks.Grants(\"things\", {\n schema: things.id,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\n \"USE_SCHEMA\",\n \"MODIFY\",\n ],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthings = databricks.Schema(\"things\",\n catalog_name=sandbox[\"id\"],\n name=\"things\",\n comment=\"this schema is managed by terraform\",\n properties={\n \"kind\": \"various\",\n })\nthings_grants = databricks.Grants(\"things\",\n schema=things.id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"USE_SCHEMA\",\n \"MODIFY\",\n ],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var things = new Databricks.Schema(\"things\", new()\n {\n CatalogName = sandbox.Id,\n Name = \"things\",\n Comment = \"this schema is managed by terraform\",\n Properties = \n {\n { \"kind\", \"various\" },\n },\n });\n\n var thingsGrants = new Databricks.Grants(\"things\", new()\n {\n Schema = things.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"USE_SCHEMA\",\n \"MODIFY\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthings, err := databricks.NewSchema(ctx, \"things\", \u0026databricks.SchemaArgs{\n\t\t\tCatalogName: pulumi.Any(sandbox.Id),\n\t\t\tName: pulumi.String(\"things\"),\n\t\t\tComment: pulumi.String(\"this schema is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"kind\": pulumi.String(\"various\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"things\", \u0026databricks.GrantsArgs{\n\t\t\tSchema: things.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"USE_SCHEMA\"),\n\t\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_schema\" \"things\" {\n catalog_name = sandbox.id\n name = \"things\"\n comment = \"this schema is managed by terraform\"\n properties = {\n \"kind\" = \"various\"\n }\n}\nresource \"databricks_grants\" \"things\" {\n schema = databricks_schema.things.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"USE_SCHEMA\", \"MODIFY\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Schema;\nimport com.pulumi.databricks.SchemaArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var things = new Schema(\"things\", SchemaArgs.builder()\n .catalogName(sandbox.id())\n .name(\"things\")\n .comment(\"this schema is managed by terraform\")\n .properties(Map.of(\"kind\", \"various\"))\n .build());\n\n var thingsGrants = new Grants(\"thingsGrants\", GrantsArgs.builder()\n .schema(things.id())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"USE_SCHEMA\",\n \"MODIFY\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n things:\n type: databricks:Schema\n properties:\n catalogName: ${sandbox.id}\n name: things\n comment: this schema is managed by terraform\n properties:\n kind: various\n thingsGrants:\n type: databricks:Grants\n name: things\n properties:\n schema: ${things.id}\n grants:\n - principal: Data Engineers\n privileges:\n - USE_SCHEMA\n - MODIFY\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Table grants\n\nYou can grant `ALL_PRIVILEGES`, `APPLY_TAG`, `MANAGE`, `SELECT` and `MODIFY` privileges to _`catalog.schema.table`_ specified in the \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e attribute.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst customers = new databricks.Grants(\"customers\", {\n table: \"main.reporting.customers\",\n grants: [\n {\n principal: \"Data Engineers\",\n privileges: [\n \"MODIFY\",\n \"SELECT\",\n ],\n },\n {\n principal: \"Data Analysts\",\n privileges: [\"SELECT\"],\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncustomers = databricks.Grants(\"customers\",\n table=\"main.reporting.customers\",\n grants=[\n {\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"MODIFY\",\n \"SELECT\",\n ],\n },\n {\n \"principal\": \"Data Analysts\",\n \"privileges\": [\"SELECT\"],\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var customers = new Databricks.Grants(\"customers\", new()\n {\n Table = \"main.reporting.customers\",\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"MODIFY\",\n \"SELECT\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"SELECT\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrants(ctx, \"customers\", \u0026databricks.GrantsArgs{\n\t\t\tTable: pulumi.String(\"main.reporting.customers\"),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grants\" \"customers\" {\n table = \"main.reporting.customers\"\n grants {\n principal = \"Data Engineers\"\n privileges = [\"MODIFY\", \"SELECT\"]\n }\n grants {\n principal = \"Data Analysts\"\n privileges = [\"SELECT\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var customers = new Grants(\"customers\", GrantsArgs.builder()\n .table(\"main.reporting.customers\")\n .grants( \n GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"MODIFY\",\n \"SELECT\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(\"Data Analysts\")\n .privileges(\"SELECT\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n customers:\n type: databricks:Grants\n properties:\n table: main.reporting.customers\n grants:\n - principal: Data Engineers\n privileges:\n - MODIFY\n - SELECT\n - principal: Data Analysts\n privileges:\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nYou can also apply grants dynamically with\u003cspan pulumi-lang-nodejs=\" databricks.getTables \" pulumi-lang-dotnet=\" databricks.getTables \" pulumi-lang-go=\" getTables \" pulumi-lang-python=\" get_tables \" pulumi-lang-yaml=\" databricks.getTables \" pulumi-lang-java=\" databricks.getTables \" pulumi-lang-hcl=\" data.databricks_tables \"\u003e databricks.getTables \u003c/span\u003edata resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nexport = async () =\u003e {\n const things = await databricks.getTables({\n catalogName: \"sandbox\",\n schemaName: \"things\",\n });\n const thingsGrants: databricks.Grants[] = [];\n for (const range of things.ids.map((v, k) =\u003e ({key: k, value: v}))) {\n thingsGrants.push(new databricks.Grants(`things-${range.key}`, {\n table: range.value,\n grants: [{\n principal: \"sensitive\",\n privileges: [\n \"SELECT\",\n \"MODIFY\",\n ],\n }],\n }));\n }\n}\n```\n```python\nimport pulumi\nfrom typing import Any\nimport pulumi_databricks as databricks\n\nthings = databricks.get_tables(catalog_name=\"sandbox\",\n schema_name=\"things\")\nthings_grants: list[Any] = []\nfor range in [{\"key\": k, \"value\": v} for [k, v] in enumerate(things.ids)]:\n things_grants.append(databricks.Grants(f\"things-{range['key']}\",\n table=range[\"value\"],\n grants=[{\n \"principal\": \"sensitive\",\n \"privileges\": [\n \"SELECT\",\n \"MODIFY\",\n ],\n }]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(async() =\u003e \n{\n var things = await Databricks.GetTables.InvokeAsync(new()\n {\n CatalogName = \"sandbox\",\n SchemaName = \"things\",\n });\n\n var thingsGrants = new List\u003cDatabricks.Grants\u003e();\n foreach (var range in )\n {\n thingsGrants.Add(new Databricks.Grants($\"things-{range.Key}\", new()\n {\n Table = range.Value,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"sensitive\",\n Privileges = new[]\n {\n \"SELECT\",\n \"MODIFY\",\n },\n },\n },\n }));\n }\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthings, err := databricks.GetTables(ctx, \u0026databricks.GetTablesArgs{\n\t\t\tCatalogName: \"sandbox\",\n\t\t\tSchemaName: \"things\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tvar thingsGrants []*databricks.Grants\n\t\tfor key0, val0 := range things.Ids {\n\t\t\t__res, err := databricks.NewGrants(ctx, fmt.Sprintf(\"things-%v\", key0), \u0026databricks.GrantsArgs{\n\t\t\t\tTable: pulumi.String(pulumi.String(val0)),\n\t\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\t\tPrincipal: pulumi.String(\"sensitive\"),\n\t\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tthingsGrants = append(thingsGrants, __res)\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_gettables\" \"things\" {\n catalog_name = \"sandbox\"\n schema_name = \"things\"\n}\n\nresource \"databricks_grants\" \"things\" {\n for_each = data.databricks_gettables.things.ids\n table = each.value\n grants {\n principal = \"sensitive\"\n privileges = [\"SELECT\", \"MODIFY\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetTablesArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport com.pulumi.codegen.internal.KeyedValue;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var things = DatabricksFunctions.getTables(GetTablesArgs.builder()\n .catalogName(\"sandbox\")\n .schemaName(\"things\")\n .build());\n\n final var thingsGrants = things.applyValue(getTablesResult -\u003e {\n final var resources = new ArrayList\u003cGrants\u003e();\n for (var range : KeyedValue.of(getTablesResult.ids())) {\n var resource = new Grants(\"thingsGrants-\" + range.key(), GrantsArgs.builder()\n .table(range.value())\n .grants(GrantsGrantArgs.builder()\n .principal(\"sensitive\")\n .privileges( \n \"SELECT\",\n \"MODIFY\")\n .build())\n .build());\n\n resources.add(resource);\n }\n\n return resources;\n });\n\n }\n}\n```\n```yaml\nresources:\n thingsGrants:\n type: databricks:Grants\n name: things\n properties:\n table: ${range.value}\n grants:\n - principal: sensitive\n privileges:\n - SELECT\n - MODIFY\n options: {}\nvariables:\n things:\n fn::invoke:\n function: databricks:getTables\n arguments:\n catalogName: sandbox\n schemaName: things\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## View grants\n\nYou can grant `ALL_PRIVILEGES`, `APPLY_TAG`, `MANAGE` and `SELECT` privileges to _`catalog.schema.view`_ specified in \u003cspan pulumi-lang-nodejs=\"`table`\" pulumi-lang-dotnet=\"`Table`\" pulumi-lang-go=\"`table`\" pulumi-lang-python=\"`table`\" pulumi-lang-yaml=\"`table`\" pulumi-lang-java=\"`table`\" pulumi-lang-hcl=\"`table`\"\u003e`table`\u003c/span\u003e attribute.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst customer360 = new databricks.Grants(\"customer360\", {\n table: \"main.reporting.customer360\",\n grants: [{\n principal: \"Data Analysts\",\n privileges: [\"SELECT\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncustomer360 = databricks.Grants(\"customer360\",\n table=\"main.reporting.customer360\",\n grants=[{\n \"principal\": \"Data Analysts\",\n \"privileges\": [\"SELECT\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var customer360 = new Databricks.Grants(\"customer360\", new()\n {\n Table = \"main.reporting.customer360\",\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"SELECT\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrants(ctx, \"customer360\", \u0026databricks.GrantsArgs{\n\t\t\tTable: pulumi.String(\"main.reporting.customer360\"),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grants\" \"customer360\" {\n table = \"main.reporting.customer360\"\n grants {\n principal = \"Data Analysts\"\n privileges = [\"SELECT\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var customer360 = new Grants(\"customer360\", GrantsArgs.builder()\n .table(\"main.reporting.customer360\")\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Analysts\")\n .privileges(\"SELECT\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n customer360:\n type: databricks:Grants\n properties:\n table: main.reporting.customer360\n grants:\n - principal: Data Analysts\n privileges:\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nYou can also apply grants dynamically with\u003cspan pulumi-lang-nodejs=\" databricks.getViews \" pulumi-lang-dotnet=\" databricks.getViews \" pulumi-lang-go=\" getViews \" pulumi-lang-python=\" get_views \" pulumi-lang-yaml=\" databricks.getViews \" pulumi-lang-java=\" databricks.getViews \" pulumi-lang-hcl=\" data.databricks_views \"\u003e databricks.getViews \u003c/span\u003edata resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nexport = async () =\u003e {\n const customers = await databricks.getViews({\n catalogName: \"main\",\n schemaName: \"customers\",\n });\n const customersGrants: databricks.Grants[] = [];\n for (const range of customers.ids.map((v, k) =\u003e ({key: k, value: v}))) {\n customersGrants.push(new databricks.Grants(`customers-${range.key}`, {\n table: range.value,\n grants: [{\n principal: \"sensitive\",\n privileges: [\n \"SELECT\",\n \"MODIFY\",\n ],\n }],\n }));\n }\n}\n```\n```python\nimport pulumi\nfrom typing import Any\nimport pulumi_databricks as databricks\n\ncustomers = databricks.get_views(catalog_name=\"main\",\n schema_name=\"customers\")\ncustomers_grants: list[Any] = []\nfor range in [{\"key\": k, \"value\": v} for [k, v] in enumerate(customers.ids)]:\n customers_grants.append(databricks.Grants(f\"customers-{range['key']}\",\n table=range[\"value\"],\n grants=[{\n \"principal\": \"sensitive\",\n \"privileges\": [\n \"SELECT\",\n \"MODIFY\",\n ],\n }]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(async() =\u003e \n{\n var customers = await Databricks.GetViews.InvokeAsync(new()\n {\n CatalogName = \"main\",\n SchemaName = \"customers\",\n });\n\n var customersGrants = new List\u003cDatabricks.Grants\u003e();\n foreach (var range in )\n {\n customersGrants.Add(new Databricks.Grants($\"customers-{range.Key}\", new()\n {\n Table = range.Value,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"sensitive\",\n Privileges = new[]\n {\n \"SELECT\",\n \"MODIFY\",\n },\n },\n },\n }));\n }\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcustomers, err := databricks.GetViews(ctx, \u0026databricks.GetViewsArgs{\n\t\t\tCatalogName: \"main\",\n\t\t\tSchemaName: \"customers\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tvar customersGrants []*databricks.Grants\n\t\tfor key0, val0 := range customers.Ids {\n\t\t\t__res, err := databricks.NewGrants(ctx, fmt.Sprintf(\"customers-%v\", key0), \u0026databricks.GrantsArgs{\n\t\t\t\tTable: pulumi.String(pulumi.String(val0)),\n\t\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\t\tPrincipal: pulumi.String(\"sensitive\"),\n\t\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t\t\tpulumi.String(\"MODIFY\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tcustomersGrants = append(customersGrants, __res)\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getviews\" \"customers\" {\n catalog_name = \"main\"\n schema_name = \"customers\"\n}\n\nresource \"databricks_grants\" \"customers\" {\n for_each = data.databricks_getviews.customers.ids\n table = each.value\n grants {\n principal = \"sensitive\"\n privileges = [\"SELECT\", \"MODIFY\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetViewsArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport com.pulumi.codegen.internal.KeyedValue;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var customers = DatabricksFunctions.getViews(GetViewsArgs.builder()\n .catalogName(\"main\")\n .schemaName(\"customers\")\n .build());\n\n final var customersGrants = customers.applyValue(getViewsResult -\u003e {\n final var resources = new ArrayList\u003cGrants\u003e();\n for (var range : KeyedValue.of(getViewsResult.ids())) {\n var resource = new Grants(\"customersGrants-\" + range.key(), GrantsArgs.builder()\n .table(range.value())\n .grants(GrantsGrantArgs.builder()\n .principal(\"sensitive\")\n .privileges( \n \"SELECT\",\n \"MODIFY\")\n .build())\n .build());\n\n resources.add(resource);\n }\n\n return resources;\n });\n\n }\n}\n```\n```yaml\nresources:\n customersGrants:\n type: databricks:Grants\n name: customers\n properties:\n table: ${range.value}\n grants:\n - principal: sensitive\n privileges:\n - SELECT\n - MODIFY\n options: {}\nvariables:\n customers:\n fn::invoke:\n function: databricks:getViews\n arguments:\n catalogName: main\n schemaName: customers\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Volume grants\n\nYou can grant `ALL_PRIVILEGES`, `APPLY_TAG`, `MANAGE`, `READ_VOLUME` and `WRITE_VOLUME` privileges to _`catalog.schema.volume`_ specified in the \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e attribute.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Volume(\"this\", {\n name: \"quickstart_volume\",\n catalogName: sandbox.name,\n schemaName: things.name,\n volumeType: \"EXTERNAL\",\n storageLocation: some.url,\n comment: \"this volume is managed by terraform\",\n});\nconst volume = new databricks.Grants(\"volume\", {\n volume: _this.id,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\"WRITE_VOLUME\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Volume(\"this\",\n name=\"quickstart_volume\",\n catalog_name=sandbox[\"name\"],\n schema_name=things[\"name\"],\n volume_type=\"EXTERNAL\",\n storage_location=some[\"url\"],\n comment=\"this volume is managed by terraform\")\nvolume = databricks.Grants(\"volume\",\n volume=this.id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"WRITE_VOLUME\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Volume(\"this\", new()\n {\n Name = \"quickstart_volume\",\n CatalogName = sandbox.Name,\n SchemaName = things.Name,\n VolumeType = \"EXTERNAL\",\n StorageLocation = some.Url,\n Comment = \"this volume is managed by terraform\",\n });\n\n var volume = new Databricks.Grants(\"volume\", new()\n {\n Volume = @this.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"WRITE_VOLUME\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewVolume(ctx, \"this\", \u0026databricks.VolumeArgs{\n\t\t\tName: pulumi.String(\"quickstart_volume\"),\n\t\t\tCatalogName: pulumi.Any(sandbox.Name),\n\t\t\tSchemaName: pulumi.Any(things.Name),\n\t\t\tVolumeType: pulumi.String(\"EXTERNAL\"),\n\t\t\tStorageLocation: pulumi.Any(some.Url),\n\t\t\tComment: pulumi.String(\"this volume is managed by terraform\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"volume\", \u0026databricks.GrantsArgs{\n\t\t\tVolume: this.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"WRITE_VOLUME\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_volume\" \"this\" {\n name = \"quickstart_volume\"\n catalog_name = sandbox.name\n schema_name = things.name\n volume_type = \"EXTERNAL\"\n storage_location = some.url\n comment = \"this volume is managed by terraform\"\n}\nresource \"databricks_grants\" \"volume\" {\n volume = databricks_volume.this.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"WRITE_VOLUME\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Volume;\nimport com.pulumi.databricks.VolumeArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Volume(\"this\", VolumeArgs.builder()\n .name(\"quickstart_volume\")\n .catalogName(sandbox.name())\n .schemaName(things.name())\n .volumeType(\"EXTERNAL\")\n .storageLocation(some.url())\n .comment(\"this volume is managed by terraform\")\n .build());\n\n var volume = new Grants(\"volume\", GrantsArgs.builder()\n .volume(this_.id())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"WRITE_VOLUME\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Volume\n properties:\n name: quickstart_volume\n catalogName: ${sandbox.name}\n schemaName: ${things.name}\n volumeType: EXTERNAL\n storageLocation: ${some.url}\n comment: this volume is managed by terraform\n volume:\n type: databricks:Grants\n properties:\n volume: ${this.id}\n grants:\n - principal: Data Engineers\n privileges:\n - WRITE_VOLUME\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Registered model grants\n\nYou can grant `ALL_PRIVILEGES`, `APPLY_TAG`, `EXECUTE`, and `MANAGE` privileges to _`catalog.schema.model`_ specified in the \u003cspan pulumi-lang-nodejs=\"`model`\" pulumi-lang-dotnet=\"`Model`\" pulumi-lang-go=\"`model`\" pulumi-lang-python=\"`model`\" pulumi-lang-yaml=\"`model`\" pulumi-lang-java=\"`model`\" pulumi-lang-hcl=\"`model`\"\u003e`model`\u003c/span\u003e attribute.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst customers = new databricks.Grants(\"customers\", {\n model: \"main.reporting.customer_model\",\n grants: [\n {\n principal: \"Data Engineers\",\n privileges: [\n \"APPLY_TAG\",\n \"EXECUTE\",\n ],\n },\n {\n principal: \"Data Analysts\",\n privileges: [\"EXECUTE\"],\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ncustomers = databricks.Grants(\"customers\",\n model=\"main.reporting.customer_model\",\n grants=[\n {\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"APPLY_TAG\",\n \"EXECUTE\",\n ],\n },\n {\n \"principal\": \"Data Analysts\",\n \"privileges\": [\"EXECUTE\"],\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var customers = new Databricks.Grants(\"customers\", new()\n {\n Model = \"main.reporting.customer_model\",\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"APPLY_TAG\",\n \"EXECUTE\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"EXECUTE\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrants(ctx, \"customers\", \u0026databricks.GrantsArgs{\n\t\t\tModel: pulumi.String(\"main.reporting.customer_model\"),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"APPLY_TAG\"),\n\t\t\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grants\" \"customers\" {\n model = \"main.reporting.customer_model\"\n grants {\n principal = \"Data Engineers\"\n privileges = [\"APPLY_TAG\", \"EXECUTE\"]\n }\n grants {\n principal = \"Data Analysts\"\n privileges = [\"EXECUTE\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var customers = new Grants(\"customers\", GrantsArgs.builder()\n .model(\"main.reporting.customer_model\")\n .grants( \n GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"APPLY_TAG\",\n \"EXECUTE\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(\"Data Analysts\")\n .privileges(\"EXECUTE\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n customers:\n type: databricks:Grants\n properties:\n model: main.reporting.customer_model\n grants:\n - principal: Data Engineers\n privileges:\n - APPLY_TAG\n - EXECUTE\n - principal: Data Analysts\n privileges:\n - EXECUTE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Function grants\n\nYou can grant `ALL_PRIVILEGES`, `EXECUTE`, and `MANAGE` privileges to _`catalog.schema.function`_ specified in the \u003cspan pulumi-lang-nodejs=\"`function`\" pulumi-lang-dotnet=\"`Function`\" pulumi-lang-go=\"`function`\" pulumi-lang-python=\"`function`\" pulumi-lang-yaml=\"`function`\" pulumi-lang-java=\"`function`\" pulumi-lang-hcl=\"`function`\"\u003e`function`\u003c/span\u003e attribute.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst udf = new databricks.Grants(\"udf\", {\n \"function\": \"main.reporting.udf\",\n grants: [\n {\n principal: \"Data Engineers\",\n privileges: [\"EXECUTE\"],\n },\n {\n principal: \"Data Analysts\",\n privileges: [\"EXECUTE\"],\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nudf = databricks.Grants(\"udf\",\n function=\"main.reporting.udf\",\n grants=[\n {\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"EXECUTE\"],\n },\n {\n \"principal\": \"Data Analysts\",\n \"privileges\": [\"EXECUTE\"],\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var udf = new Databricks.Grants(\"udf\", new()\n {\n Function = \"main.reporting.udf\",\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"EXECUTE\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Analysts\",\n Privileges = new[]\n {\n \"EXECUTE\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGrants(ctx, \"udf\", \u0026databricks.GrantsArgs{\n\t\t\tFunction: pulumi.String(\"main.reporting.udf\"),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Analysts\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"EXECUTE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_grants\" \"udf\" {\n function = \"main.reporting.udf\"\n grants {\n principal = \"Data Engineers\"\n privileges = [\"EXECUTE\"]\n }\n grants {\n principal = \"Data Analysts\"\n privileges = [\"EXECUTE\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var udf = new Grants(\"udf\", GrantsArgs.builder()\n .function(\"main.reporting.udf\")\n .grants( \n GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"EXECUTE\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(\"Data Analysts\")\n .privileges(\"EXECUTE\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n udf:\n type: databricks:Grants\n properties:\n function: main.reporting.udf\n grants:\n - principal: Data Engineers\n privileges:\n - EXECUTE\n - principal: Data Analysts\n privileges:\n - EXECUTE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Service credential grants\n\nYou can grant `ALL_PRIVILEGES`, `ACCESS`, `CREATE_CONNECTION`, and `MANAGE` privileges to\u003cspan pulumi-lang-nodejs=\" databricks.Credential \" pulumi-lang-dotnet=\" databricks.Credential \" pulumi-lang-go=\" Credential \" pulumi-lang-python=\" Credential \" pulumi-lang-yaml=\" databricks.Credential \" pulumi-lang-java=\" databricks.Credential \" pulumi-lang-hcl=\" databricks_credential \"\u003e databricks.Credential \u003c/span\u003eid specified in \u003cspan pulumi-lang-nodejs=\"`credential`\" pulumi-lang-dotnet=\"`Credential`\" pulumi-lang-go=\"`credential`\" pulumi-lang-python=\"`credential`\" pulumi-lang-yaml=\"`credential`\" pulumi-lang-java=\"`credential`\" pulumi-lang-hcl=\"`credential`\"\u003e`credential`\u003c/span\u003e attribute:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst external = new databricks.Credential(\"external\", {\n name: externalDataAccess.name,\n awsIamRole: {\n roleArn: externalDataAccess.arn,\n },\n purpose: \"SERVICE\",\n comment: \"Managed by TF\",\n});\nconst externalCreds = new databricks.Grants(\"external_creds\", {\n credential: external.databricksCredentialId,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\"CREATE_CONNECTION\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal = databricks.Credential(\"external\",\n name=external_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": external_data_access[\"arn\"],\n },\n purpose=\"SERVICE\",\n comment=\"Managed by TF\")\nexternal_creds = databricks.Grants(\"external_creds\",\n credential=external.databricks_credential_id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"CREATE_CONNECTION\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.Credential(\"external\", new()\n {\n Name = externalDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.CredentialAwsIamRoleArgs\n {\n RoleArn = externalDataAccess.Arn,\n },\n Purpose = \"SERVICE\",\n Comment = \"Managed by TF\",\n });\n\n var externalCreds = new Databricks.Grants(\"external_creds\", new()\n {\n Credential = external.DatabricksCredentialId,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_CONNECTION\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewCredential(ctx, \"external\", \u0026databricks.CredentialArgs{\n\t\t\tName: pulumi.Any(externalDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.CredentialAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(externalDataAccess.Arn),\n\t\t\t},\n\t\t\tPurpose: pulumi.String(\"SERVICE\"),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"external_creds\", \u0026databricks.GrantsArgs{\n\t\t\tCredential: external.DatabricksCredentialId,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_CONNECTION\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_credential\" \"external\" {\n name = externalDataAccess.name\n aws_iam_role = {\n role_arn = externalDataAccess.arn\n }\n purpose = \"SERVICE\"\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"external_creds\" {\n credential = databricks_credential.external.databricks_credential_id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_CONNECTION\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Credential;\nimport com.pulumi.databricks.CredentialArgs;\nimport com.pulumi.databricks.inputs.CredentialAwsIamRoleArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new Credential(\"external\", CredentialArgs.builder()\n .name(externalDataAccess.name())\n .awsIamRole(CredentialAwsIamRoleArgs.builder()\n .roleArn(externalDataAccess.arn())\n .build())\n .purpose(\"SERVICE\")\n .comment(\"Managed by TF\")\n .build());\n\n var externalCreds = new Grants(\"externalCreds\", GrantsArgs.builder()\n .credential(external.databricksCredentialId())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"CREATE_CONNECTION\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:Credential\n properties:\n name: ${externalDataAccess.name}\n awsIamRole:\n roleArn: ${externalDataAccess.arn}\n purpose: SERVICE\n comment: Managed by TF\n externalCreds:\n type: databricks:Grants\n name: external_creds\n properties:\n credential: ${external.databricksCredentialId}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_CONNECTION\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Storage credential grants\n\nYou can grant `ALL_PRIVILEGES`, `CREATE_EXTERNAL_LOCATION`, `CREATE_EXTERNAL_TABLE`, `MANAGE`, `READ_FILES` and `WRITE_FILES` privileges to\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003eid specified in \u003cspan pulumi-lang-nodejs=\"`storageCredential`\" pulumi-lang-dotnet=\"`StorageCredential`\" pulumi-lang-go=\"`storageCredential`\" pulumi-lang-python=\"`storage_credential`\" pulumi-lang-yaml=\"`storageCredential`\" pulumi-lang-java=\"`storageCredential`\" pulumi-lang-hcl=\"`storage_credential`\"\u003e`storageCredential`\u003c/span\u003e attribute:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst external = new databricks.StorageCredential(\"external\", {\n name: externalDataAccess.name,\n awsIamRole: {\n roleArn: externalDataAccess.arn,\n },\n comment: \"Managed by TF\",\n});\nconst externalCreds = new databricks.Grants(\"external_creds\", {\n storageCredential: external.id,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\"CREATE_EXTERNAL_TABLE\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nexternal = databricks.StorageCredential(\"external\",\n name=external_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": external_data_access[\"arn\"],\n },\n comment=\"Managed by TF\")\nexternal_creds = databricks.Grants(\"external_creds\",\n storage_credential=external.id,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\"CREATE_EXTERNAL_TABLE\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var external = new Databricks.StorageCredential(\"external\", new()\n {\n Name = externalDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.StorageCredentialAwsIamRoleArgs\n {\n RoleArn = externalDataAccess.Arn,\n },\n Comment = \"Managed by TF\",\n });\n\n var externalCreds = new Databricks.Grants(\"external_creds\", new()\n {\n StorageCredential = external.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\texternal, err := databricks.NewStorageCredential(ctx, \"external\", \u0026databricks.StorageCredentialArgs{\n\t\t\tName: pulumi.Any(externalDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.StorageCredentialAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(externalDataAccess.Arn),\n\t\t\t},\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"external_creds\", \u0026databricks.GrantsArgs{\n\t\t\tStorageCredential: external.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_storagecredential\" \"external\" {\n name = externalDataAccess.name\n aws_iam_role = {\n role_arn = externalDataAccess.arn\n }\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"external_creds\" {\n storage_credential = databricks_storagecredential.external.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.StorageCredential;\nimport com.pulumi.databricks.StorageCredentialArgs;\nimport com.pulumi.databricks.inputs.StorageCredentialAwsIamRoleArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var external = new StorageCredential(\"external\", StorageCredentialArgs.builder()\n .name(externalDataAccess.name())\n .awsIamRole(StorageCredentialAwsIamRoleArgs.builder()\n .roleArn(externalDataAccess.arn())\n .build())\n .comment(\"Managed by TF\")\n .build());\n\n var externalCreds = new Grants(\"externalCreds\", GrantsArgs.builder()\n .storageCredential(external.id())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges(\"CREATE_EXTERNAL_TABLE\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n external:\n type: databricks:StorageCredential\n properties:\n name: ${externalDataAccess.name}\n awsIamRole:\n roleArn: ${externalDataAccess.arn}\n comment: Managed by TF\n externalCreds:\n type: databricks:Grants\n name: external_creds\n properties:\n storageCredential: ${external.id}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## External location grants\n\nYou can grant `ALL_PRIVILEGES`, `CREATE_EXTERNAL_TABLE`, `CREATE_MANAGED_STORAGE`, `CREATE EXTERNAL VOLUME`, `MANAGE`, `READ_FILES` and `WRITE_FILES` privileges to\u003cspan pulumi-lang-nodejs=\" databricks.ExternalLocation \" pulumi-lang-dotnet=\" databricks.ExternalLocation \" pulumi-lang-go=\" ExternalLocation \" pulumi-lang-python=\" ExternalLocation \" pulumi-lang-yaml=\" databricks.ExternalLocation \" pulumi-lang-java=\" databricks.ExternalLocation \" pulumi-lang-hcl=\" databricks_external_location \"\u003e databricks.ExternalLocation \u003c/span\u003eid specified in \u003cspan pulumi-lang-nodejs=\"`externalLocation`\" pulumi-lang-dotnet=\"`ExternalLocation`\" pulumi-lang-go=\"`externalLocation`\" pulumi-lang-python=\"`external_location`\" pulumi-lang-yaml=\"`externalLocation`\" pulumi-lang-java=\"`externalLocation`\" pulumi-lang-hcl=\"`external_location`\"\u003e`externalLocation`\u003c/span\u003e attribute:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst some = new databricks.ExternalLocation(\"some\", {\n name: \"external\",\n url: `s3://${externalAwsS3Bucket.id}/some`,\n credentialName: external.id,\n comment: \"Managed by TF\",\n});\nconst someGrants = new databricks.Grants(\"some\", {\n externalLocation: some.id,\n grants: [\n {\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n {\n principal: mySp.applicationId,\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n {\n principal: myGroup.displayName,\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n {\n principal: myUser.userName,\n privileges: [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsome = databricks.ExternalLocation(\"some\",\n name=\"external\",\n url=f\"s3://{external_aws_s3_bucket['id']}/some\",\n credential_name=external[\"id\"],\n comment=\"Managed by TF\")\nsome_grants = databricks.Grants(\"some\",\n external_location=some.id,\n grants=[\n {\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n {\n \"principal\": my_sp[\"applicationId\"],\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n {\n \"principal\": my_group[\"displayName\"],\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n {\n \"principal\": my_user[\"userName\"],\n \"privileges\": [\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n ],\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var some = new Databricks.ExternalLocation(\"some\", new()\n {\n Name = \"external\",\n Url = $\"s3://{externalAwsS3Bucket.Id}/some\",\n CredentialName = external.Id,\n Comment = \"Managed by TF\",\n });\n\n var someGrants = new Databricks.Grants(\"some\", new()\n {\n ExternalLocation = some.Id,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = mySp.ApplicationId,\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = myGroup.DisplayName,\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = myUser.UserName,\n Privileges = new[]\n {\n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsome, err := databricks.NewExternalLocation(ctx, \"some\", \u0026databricks.ExternalLocationArgs{\n\t\t\tName: pulumi.String(\"external\"),\n\t\t\tUrl: pulumi.Sprintf(\"s3://%v/some\", externalAwsS3Bucket.Id),\n\t\t\tCredentialName: pulumi.Any(external.Id),\n\t\t\tComment: pulumi.String(\"Managed by TF\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"some\", \u0026databricks.GrantsArgs{\n\t\t\tExternalLocation: some.ID(),\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.Any(mySp.ApplicationId),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.Any(myGroup.DisplayName),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.Any(myUser.UserName),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_EXTERNAL_TABLE\"),\n\t\t\t\t\t\tpulumi.String(\"READ_FILES\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_externallocation\" \"some\" {\n name = \"external\"\n url =\"s3://${externalAwsS3Bucket.id}/some\"\n credential_name = external.id\n comment = \"Managed by TF\"\n}\nresource \"databricks_grants\" \"some\" {\n external_location = databricks_externallocation.some.id\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n grants {\n principal = mySp.applicationId\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n grants {\n principal = myGroup.displayName\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n grants {\n principal = myUser.userName\n privileges = [\"CREATE_EXTERNAL_TABLE\", \"READ_FILES\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ExternalLocation;\nimport com.pulumi.databricks.ExternalLocationArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var some = new ExternalLocation(\"some\", ExternalLocationArgs.builder()\n .name(\"external\")\n .url(String.format(\"s3://%s/some\", externalAwsS3Bucket.id()))\n .credentialName(external.id())\n .comment(\"Managed by TF\")\n .build());\n\n var someGrants = new Grants(\"someGrants\", GrantsArgs.builder()\n .externalLocation(some.id())\n .grants( \n GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(mySp.applicationId())\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(myGroup.displayName())\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build(),\n GrantsGrantArgs.builder()\n .principal(myUser.userName())\n .privileges( \n \"CREATE_EXTERNAL_TABLE\",\n \"READ_FILES\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n some:\n type: databricks:ExternalLocation\n properties:\n name: external\n url: s3://${externalAwsS3Bucket.id}/some\n credentialName: ${external.id}\n comment: Managed by TF\n someGrants:\n type: databricks:Grants\n name: some\n properties:\n externalLocation: ${some.id}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n - principal: ${mySp.applicationId}\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n - principal: ${myGroup.displayName}\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n - principal: ${myUser.userName}\n privileges:\n - CREATE_EXTERNAL_TABLE\n - READ_FILES\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Connection grants\n\nYou can grant `ALL_PRIVILEGES`, `MANAGE`, `USE_CONNECTION` and `CREATE_FOREIGN_CATALOG` to\u003cspan pulumi-lang-nodejs=\" databricks.Connection \" pulumi-lang-dotnet=\" databricks.Connection \" pulumi-lang-go=\" Connection \" pulumi-lang-python=\" Connection \" pulumi-lang-yaml=\" databricks.Connection \" pulumi-lang-java=\" databricks.Connection \" pulumi-lang-hcl=\" databricks_connection \"\u003e databricks.Connection \u003c/span\u003especified in \u003cspan pulumi-lang-nodejs=\"`foreignConnection`\" pulumi-lang-dotnet=\"`ForeignConnection`\" pulumi-lang-go=\"`foreignConnection`\" pulumi-lang-python=\"`foreign_connection`\" pulumi-lang-yaml=\"`foreignConnection`\" pulumi-lang-java=\"`foreignConnection`\" pulumi-lang-hcl=\"`foreign_connection`\"\u003e`foreignConnection`\u003c/span\u003e attribute:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst mysql = new databricks.Connection(\"mysql\", {\n name: \"mysql_connection\",\n connectionType: \"MYSQL\",\n comment: \"this is a connection to mysql db\",\n options: {\n host: \"test.mysql.database.azure.com\",\n port: \"3306\",\n user: \"user\",\n password: \"password\",\n },\n properties: {\n purpose: \"testing\",\n },\n});\nconst some = new databricks.Grants(\"some\", {\n foreignConnection: mysql.name,\n grants: [{\n principal: \"Data Engineers\",\n privileges: [\n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\",\n ],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nmysql = databricks.Connection(\"mysql\",\n name=\"mysql_connection\",\n connection_type=\"MYSQL\",\n comment=\"this is a connection to mysql db\",\n options={\n \"host\": \"test.mysql.database.azure.com\",\n \"port\": \"3306\",\n \"user\": \"user\",\n \"password\": \"password\",\n },\n properties={\n \"purpose\": \"testing\",\n })\nsome = databricks.Grants(\"some\",\n foreign_connection=mysql.name,\n grants=[{\n \"principal\": \"Data Engineers\",\n \"privileges\": [\n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\",\n ],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var mysql = new Databricks.Connection(\"mysql\", new()\n {\n Name = \"mysql_connection\",\n ConnectionType = \"MYSQL\",\n Comment = \"this is a connection to mysql db\",\n Options = \n {\n { \"host\", \"test.mysql.database.azure.com\" },\n { \"port\", \"3306\" },\n { \"user\", \"user\" },\n { \"password\", \"password\" },\n },\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var some = new Databricks.Grants(\"some\", new()\n {\n ForeignConnection = mysql.Name,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = \"Data Engineers\",\n Privileges = new[]\n {\n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmysql, err := databricks.NewConnection(ctx, \"mysql\", \u0026databricks.ConnectionArgs{\n\t\t\tName: pulumi.String(\"mysql_connection\"),\n\t\t\tConnectionType: pulumi.String(\"MYSQL\"),\n\t\t\tComment: pulumi.String(\"this is a connection to mysql db\"),\n\t\t\tOptions: pulumi.StringMap{\n\t\t\t\t\"host\": pulumi.String(\"test.mysql.database.azure.com\"),\n\t\t\t\t\"port\": pulumi.String(\"3306\"),\n\t\t\t\t\"user\": pulumi.String(\"user\"),\n\t\t\t\t\"password\": pulumi.String(\"password\"),\n\t\t\t},\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"some\", \u0026databricks.GrantsArgs{\n\t\t\tForeignConnection: mysql.Name,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: pulumi.String(\"Data Engineers\"),\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"CREATE_FOREIGN_CATALOG\"),\n\t\t\t\t\t\tpulumi.String(\"USE_CONNECTION\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_connection\" \"mysql\" {\n name = \"mysql_connection\"\n connection_type = \"MYSQL\"\n comment = \"this is a connection to mysql db\"\n options = {\n \"host\" = \"test.mysql.database.azure.com\"\n \"port\" = \"3306\"\n \"user\" = \"user\"\n \"password\" = \"password\"\n }\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_grants\" \"some\" {\n foreign_connection = databricks_connection.mysql.name\n grants {\n principal = \"Data Engineers\"\n privileges = [\"CREATE_FOREIGN_CATALOG\", \"USE_CONNECTION\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Connection;\nimport com.pulumi.databricks.ConnectionArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var mysql = new Connection(\"mysql\", ConnectionArgs.builder()\n .name(\"mysql_connection\")\n .connectionType(\"MYSQL\")\n .comment(\"this is a connection to mysql db\")\n .options(Map.ofEntries(\n Map.entry(\"host\", \"test.mysql.database.azure.com\"),\n Map.entry(\"port\", \"3306\"),\n Map.entry(\"user\", \"user\"),\n Map.entry(\"password\", \"password\")\n ))\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var some = new Grants(\"some\", GrantsArgs.builder()\n .foreignConnection(mysql.name())\n .grants(GrantsGrantArgs.builder()\n .principal(\"Data Engineers\")\n .privileges( \n \"CREATE_FOREIGN_CATALOG\",\n \"USE_CONNECTION\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n mysql:\n type: databricks:Connection\n properties:\n name: mysql_connection\n connectionType: MYSQL\n comment: this is a connection to mysql db\n options:\n host: test.mysql.database.azure.com\n port: '3306'\n user: user\n password: password\n properties:\n purpose: testing\n some:\n type: databricks:Grants\n properties:\n foreignConnection: ${mysql.name}\n grants:\n - principal: Data Engineers\n privileges:\n - CREATE_FOREIGN_CATALOG\n - USE_CONNECTION\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Delta Sharing share grants\n\nYou can grant `SELECT` to\u003cspan pulumi-lang-nodejs=\" databricks.Recipient \" pulumi-lang-dotnet=\" databricks.Recipient \" pulumi-lang-go=\" Recipient \" pulumi-lang-python=\" Recipient \" pulumi-lang-yaml=\" databricks.Recipient \" pulumi-lang-java=\" databricks.Recipient \" pulumi-lang-hcl=\" databricks_recipient \"\u003e databricks.Recipient \u003c/span\u003eon\u003cspan pulumi-lang-nodejs=\" databricks.Share \" pulumi-lang-dotnet=\" databricks.Share \" pulumi-lang-go=\" Share \" pulumi-lang-python=\" Share \" pulumi-lang-yaml=\" databricks.Share \" pulumi-lang-java=\" databricks.Share \" pulumi-lang-hcl=\" databricks_share \"\u003e databricks.Share \u003c/span\u003ename specified in \u003cspan pulumi-lang-nodejs=\"`share`\" pulumi-lang-dotnet=\"`Share`\" pulumi-lang-go=\"`share`\" pulumi-lang-python=\"`share`\" pulumi-lang-yaml=\"`share`\" pulumi-lang-java=\"`share`\" pulumi-lang-hcl=\"`share`\"\u003e`share`\u003c/span\u003e attribute:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst some = new databricks.Share(\"some\", {name: \"my_share\"});\nconst someRecipient = new databricks.Recipient(\"some\", {name: \"my_recipient\"});\nconst someGrants = new databricks.Grants(\"some\", {\n share: some.name,\n grants: [{\n principal: someRecipient.name,\n privileges: [\"SELECT\"],\n }],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsome = databricks.Share(\"some\", name=\"my_share\")\nsome_recipient = databricks.Recipient(\"some\", name=\"my_recipient\")\nsome_grants = databricks.Grants(\"some\",\n share=some.name,\n grants=[{\n \"principal\": some_recipient.name,\n \"privileges\": [\"SELECT\"],\n }])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var some = new Databricks.Share(\"some\", new()\n {\n Name = \"my_share\",\n });\n\n var someRecipient = new Databricks.Recipient(\"some\", new()\n {\n Name = \"my_recipient\",\n });\n\n var someGrants = new Databricks.Grants(\"some\", new()\n {\n Share = some.Name,\n GrantDetails = new[]\n {\n new Databricks.Inputs.GrantsGrantArgs\n {\n Principal = someRecipient.Name,\n Privileges = new[]\n {\n \"SELECT\",\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsome, err := databricks.NewShare(ctx, \"some\", \u0026databricks.ShareArgs{\n\t\t\tName: pulumi.String(\"my_share\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsomeRecipient, err := databricks.NewRecipient(ctx, \"some\", \u0026databricks.RecipientArgs{\n\t\t\tName: pulumi.String(\"my_recipient\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGrants(ctx, \"some\", \u0026databricks.GrantsArgs{\n\t\t\tShare: some.Name,\n\t\t\tGrants: databricks.GrantsGrantArray{\n\t\t\t\t\u0026databricks.GrantsGrantArgs{\n\t\t\t\t\tPrincipal: someRecipient.Name,\n\t\t\t\t\tPrivileges: pulumi.StringArray{\n\t\t\t\t\t\tpulumi.String(\"SELECT\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_share\" \"some\" {\n name = \"my_share\"\n}\nresource \"databricks_recipient\" \"some\" {\n name = \"my_recipient\"\n}\nresource \"databricks_grants\" \"some\" {\n share = databricks_share.some.name\n grants {\n principal = databricks_recipient.some.name\n privileges = [\"SELECT\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Share;\nimport com.pulumi.databricks.ShareArgs;\nimport com.pulumi.databricks.Recipient;\nimport com.pulumi.databricks.RecipientArgs;\nimport com.pulumi.databricks.Grants;\nimport com.pulumi.databricks.GrantsArgs;\nimport com.pulumi.databricks.inputs.GrantsGrantArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var some = new Share(\"some\", ShareArgs.builder()\n .name(\"my_share\")\n .build());\n\n var someRecipient = new Recipient(\"someRecipient\", RecipientArgs.builder()\n .name(\"my_recipient\")\n .build());\n\n var someGrants = new Grants(\"someGrants\", GrantsArgs.builder()\n .share(some.name())\n .grants(GrantsGrantArgs.builder()\n .principal(someRecipient.name())\n .privileges(\"SELECT\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n some:\n type: databricks:Share\n properties:\n name: my_share\n someRecipient:\n type: databricks:Recipient\n name: some\n properties:\n name: my_recipient\n someGrants:\n type: databricks:Grants\n name: some\n properties:\n share: ${some.name}\n grants:\n - principal: ${someRecipient.name}\n privileges:\n - SELECT\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Other access control\n\nYou can control Databricks General Permissions through\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eresource.\n\n", "properties": { "catalog": { "type": "string" }, "credential": { "type": "string" }, "externalLocation": { "type": "string" }, "foreignConnection": { "type": "string" }, "function": { "type": "string" }, "grants": { "type": "array", "items": { "$ref": "#/types/databricks:index/GrantsGrant:GrantsGrant" }, "language": { "csharp": { "name": "GrantDetails" } } }, "metastore": { "type": "string" }, "model": { "type": "string" }, "pipeline": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/GrantsProviderConfig:GrantsProviderConfig" }, "recipient": { "type": "string" }, "schema": { "type": "string" }, "share": { "type": "string" }, "storageCredential": { "type": "string" }, "table": { "type": "string" }, "volume": { "type": "string" } }, "required": [ "grants", "providerConfig" ], "inputProperties": { "catalog": { "type": "string", "willReplaceOnChanges": true }, "credential": { "type": "string", "willReplaceOnChanges": true }, "externalLocation": { "type": "string", "willReplaceOnChanges": true }, "foreignConnection": { "type": "string", "willReplaceOnChanges": true }, "function": { "type": "string", "willReplaceOnChanges": true }, "grants": { "type": "array", "items": { "$ref": "#/types/databricks:index/GrantsGrant:GrantsGrant" }, "language": { "csharp": { "name": "GrantDetails" } } }, "metastore": { "type": "string", "willReplaceOnChanges": true }, "model": { "type": "string", "willReplaceOnChanges": true }, "pipeline": { "type": "string", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GrantsProviderConfig:GrantsProviderConfig" }, "recipient": { "type": "string", "willReplaceOnChanges": true }, "schema": { "type": "string", "willReplaceOnChanges": true }, "share": { "type": "string", "willReplaceOnChanges": true }, "storageCredential": { "type": "string", "willReplaceOnChanges": true }, "table": { "type": "string", "willReplaceOnChanges": true }, "volume": { "type": "string", "willReplaceOnChanges": true } }, "requiredInputs": [ "grants" ], "stateInputs": { "description": "Input properties used for looking up and filtering Grants resources.\n", "properties": { "catalog": { "type": "string", "willReplaceOnChanges": true }, "credential": { "type": "string", "willReplaceOnChanges": true }, "externalLocation": { "type": "string", "willReplaceOnChanges": true }, "foreignConnection": { "type": "string", "willReplaceOnChanges": true }, "function": { "type": "string", "willReplaceOnChanges": true }, "grants": { "type": "array", "items": { "$ref": "#/types/databricks:index/GrantsGrant:GrantsGrant" }, "language": { "csharp": { "name": "GrantDetails" } } }, "metastore": { "type": "string", "willReplaceOnChanges": true }, "model": { "type": "string", "willReplaceOnChanges": true }, "pipeline": { "type": "string", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GrantsProviderConfig:GrantsProviderConfig" }, "recipient": { "type": "string", "willReplaceOnChanges": true }, "schema": { "type": "string", "willReplaceOnChanges": true }, "share": { "type": "string", "willReplaceOnChanges": true }, "storageCredential": { "type": "string", "willReplaceOnChanges": true }, "table": { "type": "string", "willReplaceOnChanges": true }, "volume": { "type": "string", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/group:Group": { "description": "This resource allows you to manage both [account groups and workspace-local groups](https://docs.databricks.com/administration-guide/users-groups/groups.html). You can use the\u003cspan pulumi-lang-nodejs=\" databricks.GroupMember \" pulumi-lang-dotnet=\" databricks.GroupMember \" pulumi-lang-go=\" GroupMember \" pulumi-lang-python=\" GroupMember \" pulumi-lang-yaml=\" databricks.GroupMember \" pulumi-lang-java=\" databricks.GroupMember \" pulumi-lang-hcl=\" databricks_group_member \"\u003e databricks.GroupMember \u003c/span\u003eresource to assign Databricks users, service principals as well as other groups as members of the group. This is useful if you are using an application to sync users \u0026 groups with SCIM API.\n\n\u003e This resource can be used with an account or workspace-level provider.\n\n\u003e To assign an account level group to a workspace use databricks_mws_permission_assignment.\n\n\u003e Entitlements, like, \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`allowInstancePoolCreate`\" pulumi-lang-dotnet=\"`AllowInstancePoolCreate`\" pulumi-lang-go=\"`allowInstancePoolCreate`\" pulumi-lang-python=\"`allow_instance_pool_create`\" pulumi-lang-yaml=\"`allowInstancePoolCreate`\" pulumi-lang-java=\"`allowInstancePoolCreate`\" pulumi-lang-hcl=\"`allow_instance_pool_create`\"\u003e`allowInstancePoolCreate`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e applicable only for workspace-level groups. Use\u003cspan pulumi-lang-nodejs=\" databricks.Entitlements \" pulumi-lang-dotnet=\" databricks.Entitlements \" pulumi-lang-go=\" Entitlements \" pulumi-lang-python=\" Entitlements \" pulumi-lang-yaml=\" databricks.Entitlements \" pulumi-lang-java=\" databricks.Entitlements \" pulumi-lang-hcl=\" databricks_entitlements \"\u003e databricks.Entitlements \u003c/span\u003eresource to assign entitlements inside a workspace to account-level groups.\n\nTo create account groups in the Databricks account, the provider must be configured accordingly. On AWS deployment with `host = \"https://accounts.cloud.databricks.com\"` and \u003cspan pulumi-lang-nodejs=\"`accountId \" pulumi-lang-dotnet=\"`AccountId \" pulumi-lang-go=\"`accountId \" pulumi-lang-python=\"`account_id \" pulumi-lang-yaml=\"`accountId \" pulumi-lang-java=\"`accountId \" pulumi-lang-hcl=\"`account_id \"\u003e`accountId \u003c/span\u003e= \"00000000-0000-0000-0000-000000000000\"`. On Azure deployments `host = \"https://accounts.azuredatabricks.net\"`, \u003cspan pulumi-lang-nodejs=\"`accountId \" pulumi-lang-dotnet=\"`AccountId \" pulumi-lang-go=\"`accountId \" pulumi-lang-python=\"`account_id \" pulumi-lang-yaml=\"`accountId \" pulumi-lang-java=\"`accountId \" pulumi-lang-hcl=\"`account_id \"\u003e`accountId \u003c/span\u003e= \"00000000-0000-0000-0000-000000000000\"` and using AAD tokens as authentication.\n\nRecommended to use along with Identity Provider SCIM provisioning to populate users into those groups:\n\n* [Azure Active Directory](https://docs.microsoft.com/en-us/azure/databricks/administration-guide/users-groups/scim/aad)\n* [Okta](https://docs.databricks.com/administration-guide/users-groups/scim/okta.html)\n* [OneLogin](https://docs.databricks.com/administration-guide/users-groups/scim/onelogin.html)\n\n## Example Usage\n\nCreating some group\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Group(\"this\", {\n displayName: \"Some Group\",\n allowClusterCreate: true,\n allowInstancePoolCreate: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Group(\"this\",\n display_name=\"Some Group\",\n allow_cluster_create=True,\n allow_instance_pool_create=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Group(\"this\", new()\n {\n DisplayName = \"Some Group\",\n AllowClusterCreate = true,\n AllowInstancePoolCreate = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGroup(ctx, \"this\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Some Group\"),\n\t\t\tAllowClusterCreate: pulumi.Bool(true),\n\t\t\tAllowInstancePoolCreate: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"this\" {\n display_name = \"Some Group\"\n allow_cluster_create = true\n allow_instance_pool_create = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Group(\"this\", GroupArgs.builder()\n .displayName(\"Some Group\")\n .allowClusterCreate(true)\n .allowInstancePoolCreate(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Group\n properties:\n displayName: Some Group\n allowClusterCreate: true\n allowInstancePoolCreate: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nAdding\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003eas\u003cspan pulumi-lang-nodejs=\" databricks.GroupMember \" pulumi-lang-dotnet=\" databricks.GroupMember \" pulumi-lang-go=\" GroupMember \" pulumi-lang-python=\" GroupMember \" pulumi-lang-yaml=\" databricks.GroupMember \" pulumi-lang-java=\" databricks.GroupMember \" pulumi-lang-hcl=\" databricks_group_member \"\u003e databricks.GroupMember \u003c/span\u003eof some group\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Group(\"this\", {\n displayName: \"Some Group\",\n allowClusterCreate: true,\n allowInstancePoolCreate: true,\n});\nconst thisUser = new databricks.User(\"this\", {userName: \"someone@example.com\"});\nconst vipMember = new databricks.GroupMember(\"vip_member\", {\n groupId: _this.id,\n memberId: thisUser.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Group(\"this\",\n display_name=\"Some Group\",\n allow_cluster_create=True,\n allow_instance_pool_create=True)\nthis_user = databricks.User(\"this\", user_name=\"someone@example.com\")\nvip_member = databricks.GroupMember(\"vip_member\",\n group_id=this.id,\n member_id=this_user.id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Group(\"this\", new()\n {\n DisplayName = \"Some Group\",\n AllowClusterCreate = true,\n AllowInstancePoolCreate = true,\n });\n\n var thisUser = new Databricks.User(\"this\", new()\n {\n UserName = \"someone@example.com\",\n });\n\n var vipMember = new Databricks.GroupMember(\"vip_member\", new()\n {\n GroupId = @this.Id,\n MemberId = thisUser.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewGroup(ctx, \"this\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Some Group\"),\n\t\t\tAllowClusterCreate: pulumi.Bool(true),\n\t\t\tAllowInstancePoolCreate: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthisUser, err := databricks.NewUser(ctx, \"this\", \u0026databricks.UserArgs{\n\t\t\tUserName: pulumi.String(\"someone@example.com\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupMember(ctx, \"vip_member\", \u0026databricks.GroupMemberArgs{\n\t\t\tGroupId: this.ID(),\n\t\t\tMemberId: thisUser.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"this\" {\n display_name = \"Some Group\"\n allow_cluster_create = true\n allow_instance_pool_create = true\n}\nresource \"databricks_user\" \"this\" {\n user_name = \"someone@example.com\"\n}\nresource \"databricks_groupmember\" \"vip_member\" {\n group_id = databricks_group.this.id\n member_id = databricks_user.this.id\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.User;\nimport com.pulumi.databricks.UserArgs;\nimport com.pulumi.databricks.GroupMember;\nimport com.pulumi.databricks.GroupMemberArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Group(\"this\", GroupArgs.builder()\n .displayName(\"Some Group\")\n .allowClusterCreate(true)\n .allowInstancePoolCreate(true)\n .build());\n\n var thisUser = new User(\"thisUser\", UserArgs.builder()\n .userName(\"someone@example.com\")\n .build());\n\n var vipMember = new GroupMember(\"vipMember\", GroupMemberArgs.builder()\n .groupId(this_.id())\n .memberId(thisUser.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Group\n properties:\n displayName: Some Group\n allowClusterCreate: true\n allowInstancePoolCreate: true\n thisUser:\n type: databricks:User\n name: this\n properties:\n userName: someone@example.com\n vipMember:\n type: databricks:GroupMember\n name: vip_member\n properties:\n groupId: ${this.id}\n memberId: ${thisUser.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreating group in AWS Databricks account:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Group(\"this\", {displayName: \"Some Group\"});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Group(\"this\", display_name=\"Some Group\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Group(\"this\", new()\n {\n DisplayName = \"Some Group\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGroup(ctx, \"this\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Some Group\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"this\" {\n display_name = \"Some Group\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Group(\"this\", GroupArgs.builder()\n .displayName(\"Some Group\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Group\n properties:\n displayName: Some Group\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreating group in Azure Databricks account:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Group(\"this\", {displayName: \"Some Group\"});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Group(\"this\", display_name=\"Some Group\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Group(\"this\", new()\n {\n DisplayName = \"Some Group\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewGroup(ctx, \"this\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Some Group\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"this\" {\n display_name = \"Some Group\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Group(\"this\", GroupArgs.builder()\n .displayName(\"Some Group\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Group\n properties:\n displayName: Some Group\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "aclPrincipalId": { "type": "string", "description": "identifier for use in databricks_access_control_rule_set, e.g. `groups/Some Group`.\n" }, "allowClusterCreate": { "type": "boolean", "description": "This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" clusterId \" pulumi-lang-dotnet=\" ClusterId \" pulumi-lang-go=\" clusterId \" pulumi-lang-python=\" cluster_id \" pulumi-lang-yaml=\" clusterId \" pulumi-lang-java=\" clusterId \" pulumi-lang-hcl=\" cluster_id \"\u003e clusterId \u003c/span\u003eargument. Everyone without \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.\n" }, "allowInstancePoolCreate": { "type": "boolean", "description": "This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" instancePoolId \" pulumi-lang-dotnet=\" InstancePoolId \" pulumi-lang-go=\" instancePoolId \" pulumi-lang-python=\" instance_pool_id \" pulumi-lang-yaml=\" instancePoolId \" pulumi-lang-java=\" instancePoolId \" pulumi-lang-hcl=\" instance_pool_id \"\u003e instancePoolId \u003c/span\u003eargument.\n" }, "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "databricksSqlAccess": { "type": "boolean", "description": "This is a field to allow the group to have access to [Databricks SQL](https://databricks.com/product/databricks-sql) UI, [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one) and through databricks_sql_endpoint.\n" }, "displayName": { "type": "string", "description": "This is the display name for the given group.\n" }, "externalId": { "type": "string", "description": "ID of the group in an external identity provider.\n" }, "force": { "type": "boolean", "description": "Ignore `cannot create group: Group with name X already exists.` errors and implicitly import the specific group into Pulumi state, enforcing entitlements defined in the instance of resource. _This functionality is experimental_ and is designed to simplify corner cases, like Azure Active Directory synchronisation.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GroupProviderConfig:GroupProviderConfig" }, "url": { "type": "string" }, "workspaceAccess": { "type": "boolean", "description": "This is a field to allow the group to have access to a Databricks Workspace UI and [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one).\n" }, "workspaceConsume": { "type": "boolean", "description": "This is a field to allow the group to have access only to [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one). Couldn't be used with \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e.\n" } }, "required": [ "aclPrincipalId", "displayName", "providerConfig", "url" ], "inputProperties": { "aclPrincipalId": { "type": "string", "description": "identifier for use in databricks_access_control_rule_set, e.g. `groups/Some Group`.\n" }, "allowClusterCreate": { "type": "boolean", "description": "This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" clusterId \" pulumi-lang-dotnet=\" ClusterId \" pulumi-lang-go=\" clusterId \" pulumi-lang-python=\" cluster_id \" pulumi-lang-yaml=\" clusterId \" pulumi-lang-java=\" clusterId \" pulumi-lang-hcl=\" cluster_id \"\u003e clusterId \u003c/span\u003eargument. Everyone without \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.\n" }, "allowInstancePoolCreate": { "type": "boolean", "description": "This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" instancePoolId \" pulumi-lang-dotnet=\" InstancePoolId \" pulumi-lang-go=\" instancePoolId \" pulumi-lang-python=\" instance_pool_id \" pulumi-lang-yaml=\" instancePoolId \" pulumi-lang-java=\" instancePoolId \" pulumi-lang-hcl=\" instance_pool_id \"\u003e instancePoolId \u003c/span\u003eargument.\n" }, "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "databricksSqlAccess": { "type": "boolean", "description": "This is a field to allow the group to have access to [Databricks SQL](https://databricks.com/product/databricks-sql) UI, [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one) and through databricks_sql_endpoint.\n" }, "displayName": { "type": "string", "description": "This is the display name for the given group.\n" }, "externalId": { "type": "string", "description": "ID of the group in an external identity provider.\n", "willReplaceOnChanges": true }, "force": { "type": "boolean", "description": "Ignore `cannot create group: Group with name X already exists.` errors and implicitly import the specific group into Pulumi state, enforcing entitlements defined in the instance of resource. _This functionality is experimental_ and is designed to simplify corner cases, like Azure Active Directory synchronisation.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GroupProviderConfig:GroupProviderConfig" }, "url": { "type": "string" }, "workspaceAccess": { "type": "boolean", "description": "This is a field to allow the group to have access to a Databricks Workspace UI and [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one).\n" }, "workspaceConsume": { "type": "boolean", "description": "This is a field to allow the group to have access only to [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one). Couldn't be used with \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Group resources.\n", "properties": { "aclPrincipalId": { "type": "string", "description": "identifier for use in databricks_access_control_rule_set, e.g. `groups/Some Group`.\n" }, "allowClusterCreate": { "type": "boolean", "description": "This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" clusterId \" pulumi-lang-dotnet=\" ClusterId \" pulumi-lang-go=\" clusterId \" pulumi-lang-python=\" cluster_id \" pulumi-lang-yaml=\" clusterId \" pulumi-lang-java=\" clusterId \" pulumi-lang-hcl=\" cluster_id \"\u003e clusterId \u003c/span\u003eargument. Everyone without \u003cspan pulumi-lang-nodejs=\"`allowClusterCreate`\" pulumi-lang-dotnet=\"`AllowClusterCreate`\" pulumi-lang-go=\"`allowClusterCreate`\" pulumi-lang-python=\"`allow_cluster_create`\" pulumi-lang-yaml=\"`allowClusterCreate`\" pulumi-lang-java=\"`allowClusterCreate`\" pulumi-lang-hcl=\"`allow_cluster_create`\"\u003e`allowClusterCreate`\u003c/span\u003e argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.\n" }, "allowInstancePoolCreate": { "type": "boolean", "description": "This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" instancePoolId \" pulumi-lang-dotnet=\" InstancePoolId \" pulumi-lang-go=\" instancePoolId \" pulumi-lang-python=\" instance_pool_id \" pulumi-lang-yaml=\" instancePoolId \" pulumi-lang-java=\" instancePoolId \" pulumi-lang-hcl=\" instance_pool_id \"\u003e instancePoolId \u003c/span\u003eargument.\n" }, "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "databricksSqlAccess": { "type": "boolean", "description": "This is a field to allow the group to have access to [Databricks SQL](https://databricks.com/product/databricks-sql) UI, [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one) and through databricks_sql_endpoint.\n" }, "displayName": { "type": "string", "description": "This is the display name for the given group.\n" }, "externalId": { "type": "string", "description": "ID of the group in an external identity provider.\n", "willReplaceOnChanges": true }, "force": { "type": "boolean", "description": "Ignore `cannot create group: Group with name X already exists.` errors and implicitly import the specific group into Pulumi state, enforcing entitlements defined in the instance of resource. _This functionality is experimental_ and is designed to simplify corner cases, like Azure Active Directory synchronisation.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GroupProviderConfig:GroupProviderConfig" }, "url": { "type": "string" }, "workspaceAccess": { "type": "boolean", "description": "This is a field to allow the group to have access to a Databricks Workspace UI and [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one).\n" }, "workspaceConsume": { "type": "boolean", "description": "This is a field to allow the group to have access only to [Databricks One](https://docs.databricks.com/aws/en/workspace/databricks-one#who-can-access-databricks-one). Couldn't be used with \u003cspan pulumi-lang-nodejs=\"`workspaceAccess`\" pulumi-lang-dotnet=\"`WorkspaceAccess`\" pulumi-lang-go=\"`workspaceAccess`\" pulumi-lang-python=\"`workspace_access`\" pulumi-lang-yaml=\"`workspaceAccess`\" pulumi-lang-java=\"`workspaceAccess`\" pulumi-lang-hcl=\"`workspace_access`\"\u003e`workspaceAccess`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`databricksSqlAccess`\" pulumi-lang-dotnet=\"`DatabricksSqlAccess`\" pulumi-lang-go=\"`databricksSqlAccess`\" pulumi-lang-python=\"`databricks_sql_access`\" pulumi-lang-yaml=\"`databricksSqlAccess`\" pulumi-lang-java=\"`databricksSqlAccess`\" pulumi-lang-hcl=\"`databricks_sql_access`\"\u003e`databricksSqlAccess`\u003c/span\u003e.\n" } }, "type": "object" } }, "databricks:index/groupInstanceProfile:GroupInstanceProfile": { "description": "\u003e **Deprecated** Please migrate to databricks_group_role.\n\nThis resource allows you to attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_group.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst instanceProfile = new databricks.InstanceProfile(\"instance_profile\", {instanceProfileArn: \"my_instance_profile_arn\"});\nconst myGroup = new databricks.Group(\"my_group\", {displayName: \"my_group_name\"});\nconst myGroupInstanceProfile = new databricks.GroupInstanceProfile(\"my_group_instance_profile\", {\n groupId: myGroup.id,\n instanceProfileId: instanceProfile.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ninstance_profile = databricks.InstanceProfile(\"instance_profile\", instance_profile_arn=\"my_instance_profile_arn\")\nmy_group = databricks.Group(\"my_group\", display_name=\"my_group_name\")\nmy_group_instance_profile = databricks.GroupInstanceProfile(\"my_group_instance_profile\",\n group_id=my_group.id,\n instance_profile_id=instance_profile.id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var instanceProfile = new Databricks.InstanceProfile(\"instance_profile\", new()\n {\n InstanceProfileArn = \"my_instance_profile_arn\",\n });\n\n var myGroup = new Databricks.Group(\"my_group\", new()\n {\n DisplayName = \"my_group_name\",\n });\n\n var myGroupInstanceProfile = new Databricks.GroupInstanceProfile(\"my_group_instance_profile\", new()\n {\n GroupId = myGroup.Id,\n InstanceProfileId = instanceProfile.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinstanceProfile, err := databricks.NewInstanceProfile(ctx, \"instance_profile\", \u0026databricks.InstanceProfileArgs{\n\t\t\tInstanceProfileArn: pulumi.String(\"my_instance_profile_arn\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyGroup, err := databricks.NewGroup(ctx, \"my_group\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"my_group_name\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupInstanceProfile(ctx, \"my_group_instance_profile\", \u0026databricks.GroupInstanceProfileArgs{\n\t\t\tGroupId: myGroup.ID(),\n\t\t\tInstanceProfileId: instanceProfile.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_instanceprofile\" \"instance_profile\" {\n instance_profile_arn = \"my_instance_profile_arn\"\n}\nresource \"databricks_group\" \"my_group\" {\n display_name = \"my_group_name\"\n}\nresource \"databricks_groupinstanceprofile\" \"my_group_instance_profile\" {\n group_id = databricks_group.my_group.id\n instance_profile_id = databricks_instanceprofile.instance_profile.id\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.InstanceProfile;\nimport com.pulumi.databricks.InstanceProfileArgs;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.GroupInstanceProfile;\nimport com.pulumi.databricks.GroupInstanceProfileArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var instanceProfile = new InstanceProfile(\"instanceProfile\", InstanceProfileArgs.builder()\n .instanceProfileArn(\"my_instance_profile_arn\")\n .build());\n\n var myGroup = new Group(\"myGroup\", GroupArgs.builder()\n .displayName(\"my_group_name\")\n .build());\n\n var myGroupInstanceProfile = new GroupInstanceProfile(\"myGroupInstanceProfile\", GroupInstanceProfileArgs.builder()\n .groupId(myGroup.id())\n .instanceProfileId(instanceProfile.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instanceProfile:\n type: databricks:InstanceProfile\n name: instance_profile\n properties:\n instanceProfileArn: my_instance_profile_arn\n myGroup:\n type: databricks:Group\n name: my_group\n properties:\n displayName: my_group_name\n myGroupInstanceProfile:\n type: databricks:GroupInstanceProfile\n name: my_group_instance_profile\n properties:\n groupId: ${myGroup.id}\n instanceProfileId: ${instanceProfile.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getAwsBucketPolicy \" pulumi-lang-dotnet=\" databricks.getAwsBucketPolicy \" pulumi-lang-go=\" getAwsBucketPolicy \" pulumi-lang-python=\" get_aws_bucket_policy \" pulumi-lang-yaml=\" databricks.getAwsBucketPolicy \" pulumi-lang-java=\" databricks.getAwsBucketPolicy \" pulumi-lang-hcl=\" data.databricks_aws_bucket_policy \"\u003e databricks.getAwsBucketPolicy \u003c/span\u003edata to configure a simple access policy for AWS S3 buckets, so that Databricks can access data in it.\n*\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003eto create a\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003epolicy, which limits the ability to create clusters based on a set of rules.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eto manage [Account-level](https://docs.databricks.com/aws/en/admin/users-groups/groups) or [Workspace-level](https://docs.databricks.com/aws/en/admin/users-groups/workspace-local-groups) groups.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003emembers, entitlements and instance profiles.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GroupMember \" pulumi-lang-dotnet=\" databricks.GroupMember \" pulumi-lang-go=\" GroupMember \" pulumi-lang-python=\" GroupMember \" pulumi-lang-yaml=\" databricks.GroupMember \" pulumi-lang-java=\" databricks.GroupMember \" pulumi-lang-hcl=\" databricks_group_member \"\u003e databricks.GroupMember \u003c/span\u003eto attach users and groups as group members.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstancePool \" pulumi-lang-dotnet=\" databricks.InstancePool \" pulumi-lang-go=\" InstancePool \" pulumi-lang-python=\" InstancePool \" pulumi-lang-yaml=\" databricks.InstancePool \" pulumi-lang-java=\" databricks.InstancePool \" pulumi-lang-hcl=\" databricks_instance_pool \"\u003e databricks.InstancePool \u003c/span\u003eto manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eto manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount.\n*\u003cspan pulumi-lang-nodejs=\" databricks.UserInstanceProfile \" pulumi-lang-dotnet=\" databricks.UserInstanceProfile \" pulumi-lang-go=\" UserInstanceProfile \" pulumi-lang-python=\" UserInstanceProfile \" pulumi-lang-yaml=\" databricks.UserInstanceProfile \" pulumi-lang-java=\" databricks.UserInstanceProfile \" pulumi-lang-hcl=\" databricks_user_instance_profile \"\u003e databricks.UserInstanceProfile \u003c/span\u003eto attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_user.\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "groupId": { "type": "string", "description": "This is the id of the group resource.\n" }, "instanceProfileId": { "type": "string", "description": "This is the id of the instance profile resource.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GroupInstanceProfileProviderConfig:GroupInstanceProfileProviderConfig" } }, "required": [ "groupId", "instanceProfileId", "providerConfig" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "groupId": { "type": "string", "description": "This is the id of the group resource.\n", "willReplaceOnChanges": true }, "instanceProfileId": { "type": "string", "description": "This is the id of the instance profile resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GroupInstanceProfileProviderConfig:GroupInstanceProfileProviderConfig" } }, "requiredInputs": [ "groupId", "instanceProfileId" ], "stateInputs": { "description": "Input properties used for looking up and filtering GroupInstanceProfile resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "groupId": { "type": "string", "description": "This is the id of the group resource.\n", "willReplaceOnChanges": true }, "instanceProfileId": { "type": "string", "description": "This is the id of the instance profile resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GroupInstanceProfileProviderConfig:GroupInstanceProfileProviderConfig" } }, "type": "object" } }, "databricks:index/groupMember:GroupMember": { "description": "This resource allows you to attach users, service_principal, and groups as group members.\n\n\u003e This resource can be used with an account or workspace-level provider.\n\nTo attach members to groups in the Databricks account, the provider must be configured with `host = \"https://accounts.cloud.databricks.com\"` on AWS deployments or `host = \"https://accounts.azuredatabricks.net\"` and authenticate using AAD tokens on Azure deployments\n\n## Example Usage\n\nAfter the following example, Bradley would have direct membership in group B and transitive membership in group A.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst a = new databricks.Group(\"a\", {displayName: \"A\"});\nconst b = new databricks.Group(\"b\", {displayName: \"B\"});\nconst ab = new databricks.GroupMember(\"ab\", {\n groupId: a.id,\n memberId: b.id,\n});\nconst bradley = new databricks.User(\"bradley\", {userName: \"bradley@example.com\"});\nconst bb = new databricks.GroupMember(\"bb\", {\n groupId: b.id,\n memberId: bradley.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\na = databricks.Group(\"a\", display_name=\"A\")\nb = databricks.Group(\"b\", display_name=\"B\")\nab = databricks.GroupMember(\"ab\",\n group_id=a.id,\n member_id=b.id)\nbradley = databricks.User(\"bradley\", user_name=\"bradley@example.com\")\nbb = databricks.GroupMember(\"bb\",\n group_id=b.id,\n member_id=bradley.id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var a = new Databricks.Group(\"a\", new()\n {\n DisplayName = \"A\",\n });\n\n var b = new Databricks.Group(\"b\", new()\n {\n DisplayName = \"B\",\n });\n\n var ab = new Databricks.GroupMember(\"ab\", new()\n {\n GroupId = a.Id,\n MemberId = b.Id,\n });\n\n var bradley = new Databricks.User(\"bradley\", new()\n {\n UserName = \"bradley@example.com\",\n });\n\n var bb = new Databricks.GroupMember(\"bb\", new()\n {\n GroupId = b.Id,\n MemberId = bradley.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\ta, err := databricks.NewGroup(ctx, \"a\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"A\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tb, err := databricks.NewGroup(ctx, \"b\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"B\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupMember(ctx, \"ab\", \u0026databricks.GroupMemberArgs{\n\t\t\tGroupId: a.ID(),\n\t\t\tMemberId: b.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tbradley, err := databricks.NewUser(ctx, \"bradley\", \u0026databricks.UserArgs{\n\t\t\tUserName: pulumi.String(\"bradley@example.com\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupMember(ctx, \"bb\", \u0026databricks.GroupMemberArgs{\n\t\t\tGroupId: b.ID(),\n\t\t\tMemberId: bradley.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"a\" {\n display_name = \"A\"\n}\nresource \"databricks_group\" \"b\" {\n display_name = \"B\"\n}\nresource \"databricks_groupmember\" \"ab\" {\n group_id = databricks_group.a.id\n member_id = databricks_group.b.id\n}\nresource \"databricks_user\" \"bradley\" {\n user_name = \"bradley@example.com\"\n}\nresource \"databricks_groupmember\" \"bb\" {\n group_id = databricks_group.b.id\n member_id = databricks_user.bradley.id\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.GroupMember;\nimport com.pulumi.databricks.GroupMemberArgs;\nimport com.pulumi.databricks.User;\nimport com.pulumi.databricks.UserArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var a = new Group(\"a\", GroupArgs.builder()\n .displayName(\"A\")\n .build());\n\n var b = new Group(\"b\", GroupArgs.builder()\n .displayName(\"B\")\n .build());\n\n var ab = new GroupMember(\"ab\", GroupMemberArgs.builder()\n .groupId(a.id())\n .memberId(b.id())\n .build());\n\n var bradley = new User(\"bradley\", UserArgs.builder()\n .userName(\"bradley@example.com\")\n .build());\n\n var bb = new GroupMember(\"bb\", GroupMemberArgs.builder()\n .groupId(b.id())\n .memberId(bradley.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n a:\n type: databricks:Group\n properties:\n displayName: A\n b:\n type: databricks:Group\n properties:\n displayName: B\n ab:\n type: databricks:GroupMember\n properties:\n groupId: ${a.id}\n memberId: ${b.id}\n bradley:\n type: databricks:User\n properties:\n userName: bradley@example.com\n bb:\n type: databricks:GroupMember\n properties:\n groupId: ${b.id}\n memberId: ${bradley.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eto manage [Account-level](https://docs.databricks.com/aws/en/admin/users-groups/groups) or [Workspace-level](https://docs.databricks.com/aws/en/admin/users-groups/workspace-local-groups) groups.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003emembers, entitlements and instance profiles.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GroupInstanceProfile \" pulumi-lang-dotnet=\" databricks.GroupInstanceProfile \" pulumi-lang-go=\" GroupInstanceProfile \" pulumi-lang-python=\" GroupInstanceProfile \" pulumi-lang-yaml=\" databricks.GroupInstanceProfile \" pulumi-lang-java=\" databricks.GroupInstanceProfile \" pulumi-lang-hcl=\" databricks_group_instance_profile \"\u003e databricks.GroupInstanceProfile \u003c/span\u003eto attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_group.\n*\u003cspan pulumi-lang-nodejs=\" databricks.IpAccessList \" pulumi-lang-dotnet=\" databricks.IpAccessList \" pulumi-lang-go=\" IpAccessList \" pulumi-lang-python=\" IpAccessList \" pulumi-lang-yaml=\" databricks.IpAccessList \" pulumi-lang-java=\" databricks.IpAccessList \" pulumi-lang-hcl=\" databricks_ip_access_list \"\u003e databricks.IpAccessList \u003c/span\u003eto allow access from [predefined IP ranges](https://docs.databricks.com/security/network/ip-access-list.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.ServicePrincipal \" pulumi-lang-dotnet=\" databricks.ServicePrincipal \" pulumi-lang-go=\" ServicePrincipal \" pulumi-lang-python=\" ServicePrincipal \" pulumi-lang-yaml=\" databricks.ServicePrincipal \" pulumi-lang-java=\" databricks.ServicePrincipal \" pulumi-lang-hcl=\" databricks_service_principal \"\u003e databricks.ServicePrincipal \u003c/span\u003eto grant access to a workspace to an automation tool or application.\n*\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003eto [manage users](https://docs.databricks.com/administration-guide/users-groups/users.html), that could be added to\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003ewithin the workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003edata to retrieve information about databricks_user.\n*\u003cspan pulumi-lang-nodejs=\" databricks.UserInstanceProfile \" pulumi-lang-dotnet=\" databricks.UserInstanceProfile \" pulumi-lang-go=\" UserInstanceProfile \" pulumi-lang-python=\" UserInstanceProfile \" pulumi-lang-yaml=\" databricks.UserInstanceProfile \" pulumi-lang-java=\" databricks.UserInstanceProfile \" pulumi-lang-hcl=\" databricks_user_instance_profile \"\u003e databricks.UserInstanceProfile \u003c/span\u003eto attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_user.\n\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "groupId": { "type": "string", "description": "This is the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e attribute (SCIM ID) of the group resource.\n" }, "memberId": { "type": "string", "description": "This is the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e attribute (SCIM ID) of the group, service principal, or user.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GroupMemberProviderConfig:GroupMemberProviderConfig" } }, "required": [ "groupId", "memberId", "providerConfig" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "groupId": { "type": "string", "description": "This is the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e attribute (SCIM ID) of the group resource.\n", "willReplaceOnChanges": true }, "memberId": { "type": "string", "description": "This is the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e attribute (SCIM ID) of the group, service principal, or user.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GroupMemberProviderConfig:GroupMemberProviderConfig" } }, "requiredInputs": [ "groupId", "memberId" ], "stateInputs": { "description": "Input properties used for looking up and filtering GroupMember resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "groupId": { "type": "string", "description": "This is the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e attribute (SCIM ID) of the group resource.\n", "willReplaceOnChanges": true }, "memberId": { "type": "string", "description": "This is the \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e attribute (SCIM ID) of the group, service principal, or user.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GroupMemberProviderConfig:GroupMemberProviderConfig" } }, "type": "object" } }, "databricks:index/groupRole:GroupRole": { "description": "This resource allows you to attach a role to databricks_group. This role could be a pre-defined role such as account admin, or an instance profile ARN.\n\n\u003e This resource can be used with an account or workspace-level provider.\n\n## Example Usage\n\nAttach an instance profile to a group\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst instanceProfile = new databricks.InstanceProfile(\"instance_profile\", {instanceProfileArn: \"my_instance_profile_arn\"});\nconst myGroup = new databricks.Group(\"my_group\", {displayName: \"my_group_name\"});\nconst myGroupInstanceProfile = new databricks.GroupRole(\"my_group_instance_profile\", {\n groupId: myGroup.id,\n role: instanceProfile.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ninstance_profile = databricks.InstanceProfile(\"instance_profile\", instance_profile_arn=\"my_instance_profile_arn\")\nmy_group = databricks.Group(\"my_group\", display_name=\"my_group_name\")\nmy_group_instance_profile = databricks.GroupRole(\"my_group_instance_profile\",\n group_id=my_group.id,\n role=instance_profile.id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var instanceProfile = new Databricks.InstanceProfile(\"instance_profile\", new()\n {\n InstanceProfileArn = \"my_instance_profile_arn\",\n });\n\n var myGroup = new Databricks.Group(\"my_group\", new()\n {\n DisplayName = \"my_group_name\",\n });\n\n var myGroupInstanceProfile = new Databricks.GroupRole(\"my_group_instance_profile\", new()\n {\n GroupId = myGroup.Id,\n Role = instanceProfile.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinstanceProfile, err := databricks.NewInstanceProfile(ctx, \"instance_profile\", \u0026databricks.InstanceProfileArgs{\n\t\t\tInstanceProfileArn: pulumi.String(\"my_instance_profile_arn\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyGroup, err := databricks.NewGroup(ctx, \"my_group\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"my_group_name\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupRole(ctx, \"my_group_instance_profile\", \u0026databricks.GroupRoleArgs{\n\t\t\tGroupId: myGroup.ID(),\n\t\t\tRole: instanceProfile.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_instanceprofile\" \"instance_profile\" {\n instance_profile_arn = \"my_instance_profile_arn\"\n}\nresource \"databricks_group\" \"my_group\" {\n display_name = \"my_group_name\"\n}\nresource \"databricks_grouprole\" \"my_group_instance_profile\" {\n group_id = databricks_group.my_group.id\n role = databricks_instanceprofile.instance_profile.id\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.InstanceProfile;\nimport com.pulumi.databricks.InstanceProfileArgs;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.GroupRole;\nimport com.pulumi.databricks.GroupRoleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var instanceProfile = new InstanceProfile(\"instanceProfile\", InstanceProfileArgs.builder()\n .instanceProfileArn(\"my_instance_profile_arn\")\n .build());\n\n var myGroup = new Group(\"myGroup\", GroupArgs.builder()\n .displayName(\"my_group_name\")\n .build());\n\n var myGroupInstanceProfile = new GroupRole(\"myGroupInstanceProfile\", GroupRoleArgs.builder()\n .groupId(myGroup.id())\n .role(instanceProfile.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n instanceProfile:\n type: databricks:InstanceProfile\n name: instance_profile\n properties:\n instanceProfileArn: my_instance_profile_arn\n myGroup:\n type: databricks:Group\n name: my_group\n properties:\n displayName: my_group_name\n myGroupInstanceProfile:\n type: databricks:GroupRole\n name: my_group_instance_profile\n properties:\n groupId: ${myGroup.id}\n role: ${instanceProfile.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nAttach account admin role to an account-level group\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst myGroup = new databricks.Group(\"my_group\", {displayName: \"my_group_name\"});\nconst myGroupAccountAdmin = new databricks.GroupRole(\"my_group_account_admin\", {\n groupId: myGroup.id,\n role: \"account_admin\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nmy_group = databricks.Group(\"my_group\", display_name=\"my_group_name\")\nmy_group_account_admin = databricks.GroupRole(\"my_group_account_admin\",\n group_id=my_group.id,\n role=\"account_admin\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var myGroup = new Databricks.Group(\"my_group\", new()\n {\n DisplayName = \"my_group_name\",\n });\n\n var myGroupAccountAdmin = new Databricks.GroupRole(\"my_group_account_admin\", new()\n {\n GroupId = myGroup.Id,\n Role = \"account_admin\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tmyGroup, err := databricks.NewGroup(ctx, \"my_group\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"my_group_name\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupRole(ctx, \"my_group_account_admin\", \u0026databricks.GroupRoleArgs{\n\t\t\tGroupId: myGroup.ID(),\n\t\t\tRole: pulumi.String(\"account_admin\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"my_group\" {\n display_name = \"my_group_name\"\n}\nresource \"databricks_grouprole\" \"my_group_account_admin\" {\n group_id = databricks_group.my_group.id\n role = \"account_admin\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.GroupRole;\nimport com.pulumi.databricks.GroupRoleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var myGroup = new Group(\"myGroup\", GroupArgs.builder()\n .displayName(\"my_group_name\")\n .build());\n\n var myGroupAccountAdmin = new GroupRole(\"myGroupAccountAdmin\", GroupRoleArgs.builder()\n .groupId(myGroup.id())\n .role(\"account_admin\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n myGroup:\n type: databricks:Group\n name: my_group\n properties:\n displayName: my_group_name\n myGroupAccountAdmin:\n type: databricks:GroupRole\n name: my_group_account_admin\n properties:\n groupId: ${myGroup.id}\n role: account_admin\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getAwsBucketPolicy \" pulumi-lang-dotnet=\" databricks.getAwsBucketPolicy \" pulumi-lang-go=\" getAwsBucketPolicy \" pulumi-lang-python=\" get_aws_bucket_policy \" pulumi-lang-yaml=\" databricks.getAwsBucketPolicy \" pulumi-lang-java=\" databricks.getAwsBucketPolicy \" pulumi-lang-hcl=\" data.databricks_aws_bucket_policy \"\u003e databricks.getAwsBucketPolicy \u003c/span\u003edata to configure a simple access policy for AWS S3 buckets, so that Databricks can access data in it.\n*\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003eto create a\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003epolicy, which limits the ability to create clusters based on a set of rules.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eto manage [Account-level](https://docs.databricks.com/aws/en/admin/users-groups/groups) or [Workspace-level](https://docs.databricks.com/aws/en/admin/users-groups/workspace-local-groups) groups.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003emembers, entitlements and instance profiles.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GroupMember \" pulumi-lang-dotnet=\" databricks.GroupMember \" pulumi-lang-go=\" GroupMember \" pulumi-lang-python=\" GroupMember \" pulumi-lang-yaml=\" databricks.GroupMember \" pulumi-lang-java=\" databricks.GroupMember \" pulumi-lang-hcl=\" databricks_group_member \"\u003e databricks.GroupMember \u003c/span\u003eto attach users and groups as group members.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstancePool \" pulumi-lang-dotnet=\" databricks.InstancePool \" pulumi-lang-go=\" InstancePool \" pulumi-lang-python=\" InstancePool \" pulumi-lang-yaml=\" databricks.InstancePool \" pulumi-lang-java=\" databricks.InstancePool \" pulumi-lang-hcl=\" databricks_instance_pool \"\u003e databricks.InstancePool \u003c/span\u003eto manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eto manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount.\n*\u003cspan pulumi-lang-nodejs=\" databricks.UserInstanceProfile \" pulumi-lang-dotnet=\" databricks.UserInstanceProfile \" pulumi-lang-go=\" UserInstanceProfile \" pulumi-lang-python=\" UserInstanceProfile \" pulumi-lang-yaml=\" databricks.UserInstanceProfile \" pulumi-lang-java=\" databricks.UserInstanceProfile \" pulumi-lang-hcl=\" databricks_user_instance_profile \"\u003e databricks.UserInstanceProfile \u003c/span\u003eto attach\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003e(AWS) to databricks_user.\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "groupId": { "type": "string", "description": "This is the id of the group resource.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/GroupRoleProviderConfig:GroupRoleProviderConfig" }, "role": { "type": "string", "description": "Either a role name or the ARN/ID of the instance profile resource.\n" } }, "required": [ "groupId", "providerConfig", "role" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "groupId": { "type": "string", "description": "This is the id of the group resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GroupRoleProviderConfig:GroupRoleProviderConfig" }, "role": { "type": "string", "description": "Either a role name or the ARN/ID of the instance profile resource.\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "groupId", "role" ], "stateInputs": { "description": "Input properties used for looking up and filtering GroupRole resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "groupId": { "type": "string", "description": "This is the id of the group resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/GroupRoleProviderConfig:GroupRoleProviderConfig" }, "role": { "type": "string", "description": "Either a role name or the ARN/ID of the instance profile resource.\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/instancePool:InstancePool": { "description": "This resource allows you to manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances. An instance pool reduces cluster start and auto-scaling times by maintaining a set of idle, ready-to-use cloud instances. When a cluster attached to a pool needs an instance, it first attempts to allocate one of the pool's idle instances. If the pool has no idle instances, it expands by allocating a new instance from the instance provider in order to accommodate the cluster's request. When a cluster releases an instance, it returns to the pool and is free for another cluster to use. Only clusters attached to a pool can use that pool's idle instances.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e It is important to know that different cloud service providers have different \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`diskSpecs`\" pulumi-lang-dotnet=\"`DiskSpecs`\" pulumi-lang-go=\"`diskSpecs`\" pulumi-lang-python=\"`disk_specs`\" pulumi-lang-yaml=\"`diskSpecs`\" pulumi-lang-java=\"`diskSpecs`\" pulumi-lang-hcl=\"`disk_specs`\"\u003e`diskSpecs`\u003c/span\u003e and potentially other configurations.\n\n\u003e \"auto\" \u003cspan pulumi-lang-nodejs=\"`zoneId`\" pulumi-lang-dotnet=\"`ZoneId`\" pulumi-lang-go=\"`zoneId`\" pulumi-lang-python=\"`zone_id`\" pulumi-lang-yaml=\"`zoneId`\" pulumi-lang-java=\"`zoneId`\" pulumi-lang-hcl=\"`zone_id`\"\u003e`zoneId`\u003c/span\u003e is only supported for fleet node types.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst smallest = databricks.getNodeType({});\nconst smallestNodes = new databricks.InstancePool(\"smallest_nodes\", {\n instancePoolName: \"Smallest Nodes\",\n minIdleInstances: 0,\n maxCapacity: 300,\n nodeTypeId: smallest.then(smallest =\u003e smallest.id),\n awsAttributes: {\n availability: \"ON_DEMAND\",\n zoneId: \"us-east-1a\",\n spotBidPricePercent: 100,\n },\n idleInstanceAutoterminationMinutes: 10,\n diskSpec: {\n diskType: {\n ebsVolumeType: \"GENERAL_PURPOSE_SSD\",\n },\n diskSize: 80,\n diskCount: 1,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsmallest = databricks.get_node_type()\nsmallest_nodes = databricks.InstancePool(\"smallest_nodes\",\n instance_pool_name=\"Smallest Nodes\",\n min_idle_instances=0,\n max_capacity=300,\n node_type_id=smallest.id,\n aws_attributes={\n \"availability\": \"ON_DEMAND\",\n \"zone_id\": \"us-east-1a\",\n \"spot_bid_price_percent\": 100,\n },\n idle_instance_autotermination_minutes=10,\n disk_spec={\n \"disk_type\": {\n \"ebs_volume_type\": \"GENERAL_PURPOSE_SSD\",\n },\n \"disk_size\": 80,\n \"disk_count\": 1,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var smallest = Databricks.GetNodeType.Invoke();\n\n var smallestNodes = new Databricks.InstancePool(\"smallest_nodes\", new()\n {\n InstancePoolName = \"Smallest Nodes\",\n MinIdleInstances = 0,\n MaxCapacity = 300,\n NodeTypeId = smallest.Apply(getNodeTypeResult =\u003e getNodeTypeResult.Id),\n AwsAttributes = new Databricks.Inputs.InstancePoolAwsAttributesArgs\n {\n Availability = \"ON_DEMAND\",\n ZoneId = \"us-east-1a\",\n SpotBidPricePercent = 100,\n },\n IdleInstanceAutoterminationMinutes = 10,\n DiskSpec = new Databricks.Inputs.InstancePoolDiskSpecArgs\n {\n DiskType = new Databricks.Inputs.InstancePoolDiskSpecDiskTypeArgs\n {\n EbsVolumeType = \"GENERAL_PURPOSE_SSD\",\n },\n DiskSize = 80,\n DiskCount = 1,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsmallest, err := databricks.GetNodeType(ctx, \u0026databricks.GetNodeTypeArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewInstancePool(ctx, \"smallest_nodes\", \u0026databricks.InstancePoolArgs{\n\t\t\tInstancePoolName: pulumi.String(\"Smallest Nodes\"),\n\t\t\tMinIdleInstances: pulumi.Int(0),\n\t\t\tMaxCapacity: pulumi.Int(300),\n\t\t\tNodeTypeId: pulumi.String(pulumi.String(smallest.Id)),\n\t\t\tAwsAttributes: \u0026databricks.InstancePoolAwsAttributesArgs{\n\t\t\t\tAvailability: pulumi.String(\"ON_DEMAND\"),\n\t\t\t\tZoneId: pulumi.String(\"us-east-1a\"),\n\t\t\t\tSpotBidPricePercent: pulumi.Int(100),\n\t\t\t},\n\t\t\tIdleInstanceAutoterminationMinutes: pulumi.Int(10),\n\t\t\tDiskSpec: \u0026databricks.InstancePoolDiskSpecArgs{\n\t\t\t\tDiskType: \u0026databricks.InstancePoolDiskSpecDiskTypeArgs{\n\t\t\t\t\tEbsVolumeType: pulumi.String(\"GENERAL_PURPOSE_SSD\"),\n\t\t\t\t},\n\t\t\t\tDiskSize: pulumi.Int(80),\n\t\t\t\tDiskCount: pulumi.Int(1),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getnodetype\" \"smallest\" {\n}\n\nresource \"databricks_instancepool\" \"smallest_nodes\" {\n instance_pool_name = \"Smallest Nodes\"\n min_idle_instances = 0\n max_capacity = 300\n node_type_id = data.databricks_getnodetype.smallest.id\n aws_attributes = {\n availability = \"ON_DEMAND\"\n zone_id = \"us-east-1a\"\n spot_bid_price_percent = \"100\"\n }\n idle_instance_autotermination_minutes = 10\n disk_spec = {\n disk_type = {\n ebs_volume_type = \"GENERAL_PURPOSE_SSD\"\n }\n disk_size = 80\n disk_count = 1\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetNodeTypeArgs;\nimport com.pulumi.databricks.InstancePool;\nimport com.pulumi.databricks.InstancePoolArgs;\nimport com.pulumi.databricks.inputs.InstancePoolAwsAttributesArgs;\nimport com.pulumi.databricks.inputs.InstancePoolDiskSpecArgs;\nimport com.pulumi.databricks.inputs.InstancePoolDiskSpecDiskTypeArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var smallest = DatabricksFunctions.getNodeType(GetNodeTypeArgs.builder()\n .build());\n\n var smallestNodes = new InstancePool(\"smallestNodes\", InstancePoolArgs.builder()\n .instancePoolName(\"Smallest Nodes\")\n .minIdleInstances(0)\n .maxCapacity(300)\n .nodeTypeId(smallest.id())\n .awsAttributes(InstancePoolAwsAttributesArgs.builder()\n .availability(\"ON_DEMAND\")\n .zoneId(\"us-east-1a\")\n .spotBidPricePercent(100)\n .build())\n .idleInstanceAutoterminationMinutes(10)\n .diskSpec(InstancePoolDiskSpecArgs.builder()\n .diskType(InstancePoolDiskSpecDiskTypeArgs.builder()\n .ebsVolumeType(\"GENERAL_PURPOSE_SSD\")\n .build())\n .diskSize(80)\n .diskCount(1)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n smallestNodes:\n type: databricks:InstancePool\n name: smallest_nodes\n properties:\n instancePoolName: Smallest Nodes\n minIdleInstances: 0\n maxCapacity: 300\n nodeTypeId: ${smallest.id}\n awsAttributes:\n availability: ON_DEMAND\n zoneId: us-east-1a\n spotBidPricePercent: '100'\n idleInstanceAutoterminationMinutes: 10\n diskSpec:\n diskType:\n ebsVolumeType: GENERAL_PURPOSE_SSD\n diskSize: 80\n diskCount: 1\nvariables:\n smallest:\n fn::invoke:\n function: databricks:getNodeType\n arguments: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" databricks.User \" pulumi-lang-dotnet=\" databricks.User \" pulumi-lang-go=\" User \" pulumi-lang-python=\" User \" pulumi-lang-yaml=\" databricks.User \" pulumi-lang-java=\" databricks.User \" pulumi-lang-hcl=\" databricks_user \"\u003e databricks.User \u003c/span\u003ecan control which groups or individual users can create instance pools.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Manage* or *Attach to* individual instance pools.\n\n", "properties": { "awsAttributes": { "$ref": "#/types/databricks:index/InstancePoolAwsAttributes:InstancePoolAwsAttributes" }, "azureAttributes": { "$ref": "#/types/databricks:index/InstancePoolAzureAttributes:InstancePoolAzureAttributes" }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Additional tags for instance pool resources. Databricks tags all pool resources (e.g. AWS \u0026 Azure instances and Disk volumes). The tags of the instance pool will propagate to the clusters using the pool (see the [official documentation](https://docs.databricks.com/administration-guide/account-settings/usage-detail-tags-aws.html#tag-propagation)). Attempting to set the same tags in both cluster and instance pool will raise an error. *Databricks allows at most 43 custom tags.*\n" }, "diskSpec": { "$ref": "#/types/databricks:index/InstancePoolDiskSpec:InstancePoolDiskSpec" }, "enableElasticDisk": { "type": "boolean", "description": "(Bool) Autoscaling Local Storage: when enabled, the instances in the pool dynamically acquire additional disk space when they are running low on disk space.\n" }, "gcpAttributes": { "$ref": "#/types/databricks:index/InstancePoolGcpAttributes:InstancePoolGcpAttributes" }, "idleInstanceAutoterminationMinutes": { "type": "integer", "description": "(Integer) The number of minutes that idle instances in excess of the\u003cspan pulumi-lang-nodejs=\" minIdleInstances \" pulumi-lang-dotnet=\" MinIdleInstances \" pulumi-lang-go=\" minIdleInstances \" pulumi-lang-python=\" min_idle_instances \" pulumi-lang-yaml=\" minIdleInstances \" pulumi-lang-java=\" minIdleInstances \" pulumi-lang-hcl=\" min_idle_instances \"\u003e minIdleInstances \u003c/span\u003eare maintained by the pool before being terminated. If not specified, excess idle instances are terminated automatically after a default timeout period. If specified, the time must be between 0 and 10000 minutes. If you specify 0, excess idle instances are removed as soon as possible.\n" }, "instancePoolFleetAttributes": { "$ref": "#/types/databricks:index/InstancePoolInstancePoolFleetAttributes:InstancePoolInstancePoolFleetAttributes" }, "instancePoolId": { "type": "string" }, "instancePoolName": { "type": "string", "description": "(String) The name of the instance pool. This is required for create and edit operations. It must be unique, non-empty, and less than 100 characters.\n" }, "maxCapacity": { "type": "integer", "description": "(Integer) The maximum number of instances the pool can contain, including both idle instances and ones in use by clusters. Once the maximum capacity is reached, you cannot create new clusters from the pool and existing clusters cannot autoscale up until some instances are made idle in the pool via cluster termination or down-scaling. There is no default limit, but as a [best practice](https://docs.databricks.com/clusters/instance-pools/pool-best-practices.html#configure-pools-to-control-cost), this should be set based on anticipated usage.\n" }, "minIdleInstances": { "type": "integer", "description": "(Integer) The minimum number of idle instances maintained by the pool. This is in addition to any instances in use by active clusters.\n" }, "nodeTypeFlexibility": { "$ref": "#/types/databricks:index/InstancePoolNodeTypeFlexibility:InstancePoolNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e isn't available.\n" }, "nodeTypeId": { "type": "string", "description": "(String) The node type for the instances in the pool. All clusters attached to the pool inherit this node type and the pool's idle instances are allocated based on this type. You can retrieve a list of available node types by using the [List Node Types API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistnodetypes) call.\n" }, "preloadedDockerImages": { "type": "array", "items": { "$ref": "#/types/databricks:index/InstancePoolPreloadedDockerImage:InstancePoolPreloadedDockerImage" } }, "preloadedSparkVersions": { "type": "array", "items": { "type": "string" }, "description": "(List) A list with at most one runtime version the pool installs on each instance. Pool clusters that use a preloaded runtime version start faster as they do not have to wait for the image to download. You can retrieve them via\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003edata source or via [Runtime Versions API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistsparkversions) call.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/InstancePoolProviderConfig:InstancePoolProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "required": [ "idleInstanceAutoterminationMinutes", "instancePoolId", "instancePoolName", "providerConfig" ], "inputProperties": { "awsAttributes": { "$ref": "#/types/databricks:index/InstancePoolAwsAttributes:InstancePoolAwsAttributes", "willReplaceOnChanges": true }, "azureAttributes": { "$ref": "#/types/databricks:index/InstancePoolAzureAttributes:InstancePoolAzureAttributes", "willReplaceOnChanges": true }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Additional tags for instance pool resources. Databricks tags all pool resources (e.g. AWS \u0026 Azure instances and Disk volumes). The tags of the instance pool will propagate to the clusters using the pool (see the [official documentation](https://docs.databricks.com/administration-guide/account-settings/usage-detail-tags-aws.html#tag-propagation)). Attempting to set the same tags in both cluster and instance pool will raise an error. *Databricks allows at most 43 custom tags.*\n" }, "diskSpec": { "$ref": "#/types/databricks:index/InstancePoolDiskSpec:InstancePoolDiskSpec", "willReplaceOnChanges": true }, "enableElasticDisk": { "type": "boolean", "description": "(Bool) Autoscaling Local Storage: when enabled, the instances in the pool dynamically acquire additional disk space when they are running low on disk space.\n", "willReplaceOnChanges": true }, "gcpAttributes": { "$ref": "#/types/databricks:index/InstancePoolGcpAttributes:InstancePoolGcpAttributes", "willReplaceOnChanges": true }, "idleInstanceAutoterminationMinutes": { "type": "integer", "description": "(Integer) The number of minutes that idle instances in excess of the\u003cspan pulumi-lang-nodejs=\" minIdleInstances \" pulumi-lang-dotnet=\" MinIdleInstances \" pulumi-lang-go=\" minIdleInstances \" pulumi-lang-python=\" min_idle_instances \" pulumi-lang-yaml=\" minIdleInstances \" pulumi-lang-java=\" minIdleInstances \" pulumi-lang-hcl=\" min_idle_instances \"\u003e minIdleInstances \u003c/span\u003eare maintained by the pool before being terminated. If not specified, excess idle instances are terminated automatically after a default timeout period. If specified, the time must be between 0 and 10000 minutes. If you specify 0, excess idle instances are removed as soon as possible.\n" }, "instancePoolFleetAttributes": { "$ref": "#/types/databricks:index/InstancePoolInstancePoolFleetAttributes:InstancePoolInstancePoolFleetAttributes", "willReplaceOnChanges": true }, "instancePoolId": { "type": "string" }, "instancePoolName": { "type": "string", "description": "(String) The name of the instance pool. This is required for create and edit operations. It must be unique, non-empty, and less than 100 characters.\n" }, "maxCapacity": { "type": "integer", "description": "(Integer) The maximum number of instances the pool can contain, including both idle instances and ones in use by clusters. Once the maximum capacity is reached, you cannot create new clusters from the pool and existing clusters cannot autoscale up until some instances are made idle in the pool via cluster termination or down-scaling. There is no default limit, but as a [best practice](https://docs.databricks.com/clusters/instance-pools/pool-best-practices.html#configure-pools-to-control-cost), this should be set based on anticipated usage.\n" }, "minIdleInstances": { "type": "integer", "description": "(Integer) The minimum number of idle instances maintained by the pool. This is in addition to any instances in use by active clusters.\n" }, "nodeTypeFlexibility": { "$ref": "#/types/databricks:index/InstancePoolNodeTypeFlexibility:InstancePoolNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e isn't available.\n", "willReplaceOnChanges": true }, "nodeTypeId": { "type": "string", "description": "(String) The node type for the instances in the pool. All clusters attached to the pool inherit this node type and the pool's idle instances are allocated based on this type. You can retrieve a list of available node types by using the [List Node Types API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistnodetypes) call.\n", "willReplaceOnChanges": true }, "preloadedDockerImages": { "type": "array", "items": { "$ref": "#/types/databricks:index/InstancePoolPreloadedDockerImage:InstancePoolPreloadedDockerImage" }, "willReplaceOnChanges": true }, "preloadedSparkVersions": { "type": "array", "items": { "type": "string" }, "description": "(List) A list with at most one runtime version the pool installs on each instance. Pool clusters that use a preloaded runtime version start faster as they do not have to wait for the image to download. You can retrieve them via\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003edata source or via [Runtime Versions API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistsparkversions) call.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/InstancePoolProviderConfig:InstancePoolProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "requiredInputs": [ "idleInstanceAutoterminationMinutes", "instancePoolName" ], "stateInputs": { "description": "Input properties used for looking up and filtering InstancePool resources.\n", "properties": { "awsAttributes": { "$ref": "#/types/databricks:index/InstancePoolAwsAttributes:InstancePoolAwsAttributes", "willReplaceOnChanges": true }, "azureAttributes": { "$ref": "#/types/databricks:index/InstancePoolAzureAttributes:InstancePoolAzureAttributes", "willReplaceOnChanges": true }, "customTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Map) Additional tags for instance pool resources. Databricks tags all pool resources (e.g. AWS \u0026 Azure instances and Disk volumes). The tags of the instance pool will propagate to the clusters using the pool (see the [official documentation](https://docs.databricks.com/administration-guide/account-settings/usage-detail-tags-aws.html#tag-propagation)). Attempting to set the same tags in both cluster and instance pool will raise an error. *Databricks allows at most 43 custom tags.*\n" }, "diskSpec": { "$ref": "#/types/databricks:index/InstancePoolDiskSpec:InstancePoolDiskSpec", "willReplaceOnChanges": true }, "enableElasticDisk": { "type": "boolean", "description": "(Bool) Autoscaling Local Storage: when enabled, the instances in the pool dynamically acquire additional disk space when they are running low on disk space.\n", "willReplaceOnChanges": true }, "gcpAttributes": { "$ref": "#/types/databricks:index/InstancePoolGcpAttributes:InstancePoolGcpAttributes", "willReplaceOnChanges": true }, "idleInstanceAutoterminationMinutes": { "type": "integer", "description": "(Integer) The number of minutes that idle instances in excess of the\u003cspan pulumi-lang-nodejs=\" minIdleInstances \" pulumi-lang-dotnet=\" MinIdleInstances \" pulumi-lang-go=\" minIdleInstances \" pulumi-lang-python=\" min_idle_instances \" pulumi-lang-yaml=\" minIdleInstances \" pulumi-lang-java=\" minIdleInstances \" pulumi-lang-hcl=\" min_idle_instances \"\u003e minIdleInstances \u003c/span\u003eare maintained by the pool before being terminated. If not specified, excess idle instances are terminated automatically after a default timeout period. If specified, the time must be between 0 and 10000 minutes. If you specify 0, excess idle instances are removed as soon as possible.\n" }, "instancePoolFleetAttributes": { "$ref": "#/types/databricks:index/InstancePoolInstancePoolFleetAttributes:InstancePoolInstancePoolFleetAttributes", "willReplaceOnChanges": true }, "instancePoolId": { "type": "string" }, "instancePoolName": { "type": "string", "description": "(String) The name of the instance pool. This is required for create and edit operations. It must be unique, non-empty, and less than 100 characters.\n" }, "maxCapacity": { "type": "integer", "description": "(Integer) The maximum number of instances the pool can contain, including both idle instances and ones in use by clusters. Once the maximum capacity is reached, you cannot create new clusters from the pool and existing clusters cannot autoscale up until some instances are made idle in the pool via cluster termination or down-scaling. There is no default limit, but as a [best practice](https://docs.databricks.com/clusters/instance-pools/pool-best-practices.html#configure-pools-to-control-cost), this should be set based on anticipated usage.\n" }, "minIdleInstances": { "type": "integer", "description": "(Integer) The minimum number of idle instances maintained by the pool. This is in addition to any instances in use by active clusters.\n" }, "nodeTypeFlexibility": { "$ref": "#/types/databricks:index/InstancePoolNodeTypeFlexibility:InstancePoolNodeTypeFlexibility", "description": "a block describing the alternative driver node types if \u003cspan pulumi-lang-nodejs=\"`nodeTypeId`\" pulumi-lang-dotnet=\"`NodeTypeId`\" pulumi-lang-go=\"`nodeTypeId`\" pulumi-lang-python=\"`node_type_id`\" pulumi-lang-yaml=\"`nodeTypeId`\" pulumi-lang-java=\"`nodeTypeId`\" pulumi-lang-hcl=\"`node_type_id`\"\u003e`nodeTypeId`\u003c/span\u003e isn't available.\n", "willReplaceOnChanges": true }, "nodeTypeId": { "type": "string", "description": "(String) The node type for the instances in the pool. All clusters attached to the pool inherit this node type and the pool's idle instances are allocated based on this type. You can retrieve a list of available node types by using the [List Node Types API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistnodetypes) call.\n", "willReplaceOnChanges": true }, "preloadedDockerImages": { "type": "array", "items": { "$ref": "#/types/databricks:index/InstancePoolPreloadedDockerImage:InstancePoolPreloadedDockerImage" }, "willReplaceOnChanges": true }, "preloadedSparkVersions": { "type": "array", "items": { "type": "string" }, "description": "(List) A list with at most one runtime version the pool installs on each instance. Pool clusters that use a preloaded runtime version start faster as they do not have to wait for the image to download. You can retrieve them via\u003cspan pulumi-lang-nodejs=\" databricks.getSparkVersion \" pulumi-lang-dotnet=\" databricks.getSparkVersion \" pulumi-lang-go=\" getSparkVersion \" pulumi-lang-python=\" get_spark_version \" pulumi-lang-yaml=\" databricks.getSparkVersion \" pulumi-lang-java=\" databricks.getSparkVersion \" pulumi-lang-hcl=\" data.databricks_spark_version \"\u003e databricks.getSparkVersion \u003c/span\u003edata source or via [Runtime Versions API](https://docs.databricks.com/dev-tools/api/latest/clusters.html#clusterclusterservicelistsparkversions) call.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/InstancePoolProviderConfig:InstancePoolProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "type": "object" } }, "databricks:index/instanceProfile:InstanceProfile": { "description": "This resource allows you to manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount. The following example demonstrates how to create an instance profile and create a cluster with it. When creating a new \u003cspan pulumi-lang-nodejs=\"`databricks.InstanceProfile`\" pulumi-lang-dotnet=\"`databricks.InstanceProfile`\" pulumi-lang-go=\"`InstanceProfile`\" pulumi-lang-python=\"`InstanceProfile`\" pulumi-lang-yaml=\"`databricks.InstanceProfile`\" pulumi-lang-java=\"`databricks.InstanceProfile`\" pulumi-lang-hcl=\"`databricks_instance_profile`\"\u003e`databricks.InstanceProfile`\u003c/span\u003e, Databricks validates that it has sufficient permissions to launch instances with the instance profile. This validation uses AWS dry-run mode for the [AWS EC2 RunInstances API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e Please switch to\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003ewith Unity Catalog to manage storage credentials, which provides a better and faster way for managing credential security.\n\n## Usage with Cluster Policies\n\nIt is advised to keep all common configurations in Cluster Policies to maintain control of the environments launched, so \u003cspan pulumi-lang-nodejs=\"`databricks.Cluster`\" pulumi-lang-dotnet=\"`databricks.Cluster`\" pulumi-lang-go=\"`Cluster`\" pulumi-lang-python=\"`Cluster`\" pulumi-lang-yaml=\"`databricks.Cluster`\" pulumi-lang-java=\"`databricks.Cluster`\" pulumi-lang-hcl=\"`databricks_cluster`\"\u003e`databricks.Cluster`\u003c/span\u003e above could be replaced with \u003cspan pulumi-lang-nodejs=\"`databricks.ClusterPolicy`\" pulumi-lang-dotnet=\"`databricks.ClusterPolicy`\" pulumi-lang-go=\"`ClusterPolicy`\" pulumi-lang-python=\"`ClusterPolicy`\" pulumi-lang-yaml=\"`databricks.ClusterPolicy`\" pulumi-lang-java=\"`databricks.ClusterPolicy`\" pulumi-lang-hcl=\"`databricks_cluster_policy`\"\u003e`databricks.ClusterPolicy`\u003c/span\u003e:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.ClusterPolicy(\"this\", {\n name: \"Policy with predefined instance profile\",\n definition: JSON.stringify({\n \"aws_attributes.instance_profile_arn\": {\n type: \"fixed\",\n value: shared.id,\n },\n }),\n});\n```\n```python\nimport pulumi\nimport json\nimport pulumi_databricks as databricks\n\nthis = databricks.ClusterPolicy(\"this\",\n name=\"Policy with predefined instance profile\",\n definition=json.dumps({\n \"aws_attributes.instance_profile_arn\": {\n \"type\": \"fixed\",\n \"value\": shared[\"id\"],\n },\n }))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text.Json;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.ClusterPolicy(\"this\", new()\n {\n Name = \"Policy with predefined instance profile\",\n Definition = JsonSerializer.Serialize(new Dictionary\u003cstring, object?\u003e\n {\n [\"aws_attributes.instance_profile_arn\"] = new Dictionary\u003cstring, object?\u003e\n {\n [\"type\"] = \"fixed\",\n [\"value\"] = shared.Id,\n },\n }),\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"encoding/json\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\ttmpJSON0, err := json.Marshal(map[string]interface{}{\n\t\t\t\"aws_attributes.instance_profile_arn\": map[string]interface{}{\n\t\t\t\t\"type\": \"fixed\",\n\t\t\t\t\"value\": shared.Id,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjson0 := string(tmpJSON0)\n\t\t_, err = databricks.NewClusterPolicy(ctx, \"this\", \u0026databricks.ClusterPolicyArgs{\n\t\t\tName: pulumi.String(\"Policy with predefined instance profile\"),\n\t\t\tDefinition: pulumi.String(pulumi.String(json0)),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_clusterpolicy\" \"this\" {\n name = \"Policy with predefined instance profile\"\n definition = jsonencode({\n \"aws_attributes.instance_profile_arn\" = {\n \"type\" = \"fixed\"\n \"value\" = shared.id\n }\n })\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ClusterPolicy;\nimport com.pulumi.databricks.ClusterPolicyArgs;\nimport static com.pulumi.codegen.internal.Serialization.*;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new ClusterPolicy(\"this\", ClusterPolicyArgs.builder()\n .name(\"Policy with predefined instance profile\")\n .definition(serializeJson(\n jsonObject(\n jsonProperty(\"aws_attributes.instance_profile_arn\", jsonObject(\n jsonProperty(\"type\", \"fixed\"),\n jsonProperty(\"value\", shared.id())\n ))\n )))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:ClusterPolicy\n properties:\n name: Policy with predefined instance profile\n definition:\n fn::toJSON:\n aws_attributes.instance_profile_arn:\n type: fixed\n value: ${shared.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Granting access to all users\n\nYou can make instance profile available to all users by associating it with the special group called \u003cspan pulumi-lang-nodejs=\"`users`\" pulumi-lang-dotnet=\"`Users`\" pulumi-lang-go=\"`users`\" pulumi-lang-python=\"`users`\" pulumi-lang-yaml=\"`users`\" pulumi-lang-java=\"`users`\" pulumi-lang-hcl=\"`users`\"\u003e`users`\u003c/span\u003e through\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata source.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.InstanceProfile(\"this\", {instanceProfileArn: shared.id});\nconst users = databricks.getGroup({\n displayName: \"users\",\n});\nconst all = new databricks.GroupInstanceProfile(\"all\", {\n groupId: users.then(users =\u003e users.id),\n instanceProfileId: _this.id,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.InstanceProfile(\"this\", instance_profile_arn=shared[\"id\"])\nusers = databricks.get_group(display_name=\"users\")\nall = databricks.GroupInstanceProfile(\"all\",\n group_id=users.id,\n instance_profile_id=this.id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.InstanceProfile(\"this\", new()\n {\n InstanceProfileArn = shared.Id,\n });\n\n var users = Databricks.GetGroup.Invoke(new()\n {\n DisplayName = \"users\",\n });\n\n var all = new Databricks.GroupInstanceProfile(\"all\", new()\n {\n GroupId = users.Apply(getGroupResult =\u003e getGroupResult.Id),\n InstanceProfileId = @this.Id,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewInstanceProfile(ctx, \"this\", \u0026databricks.InstanceProfileArgs{\n\t\t\tInstanceProfileArn: pulumi.Any(shared.Id),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tusers, err := databricks.GetGroup(ctx, \u0026databricks.LookupGroupArgs{\n\t\t\tDisplayName: \"users\",\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewGroupInstanceProfile(ctx, \"all\", \u0026databricks.GroupInstanceProfileArgs{\n\t\t\tGroupId: pulumi.String(pulumi.String(users.Id)),\n\t\t\tInstanceProfileId: this.ID(),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getgroup\" \"users\" {\n display_name = \"users\"\n}\n\nresource \"databricks_instanceprofile\" \"this\" {\n instance_profile_arn = shared.id\n}\nresource \"databricks_groupinstanceprofile\" \"all\" {\n group_id = data.databricks_getgroup.users.id\n instance_profile_id = databricks_instanceprofile.this.id\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.InstanceProfile;\nimport com.pulumi.databricks.InstanceProfileArgs;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetGroupArgs;\nimport com.pulumi.databricks.GroupInstanceProfile;\nimport com.pulumi.databricks.GroupInstanceProfileArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new InstanceProfile(\"this\", InstanceProfileArgs.builder()\n .instanceProfileArn(shared.id())\n .build());\n\n final var users = DatabricksFunctions.getGroup(GetGroupArgs.builder()\n .displayName(\"users\")\n .build());\n\n var all = new GroupInstanceProfile(\"all\", GroupInstanceProfileArgs.builder()\n .groupId(users.id())\n .instanceProfileId(this_.id())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:InstanceProfile\n properties:\n instanceProfileArn: ${shared.id}\n all:\n type: databricks:GroupInstanceProfile\n properties:\n groupId: ${users.id}\n instanceProfileId: ${this.id}\nvariables:\n users:\n fn::invoke:\n function: databricks:getGroup\n arguments:\n displayName: users\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "iamRoleArn": { "type": "string", "description": "The AWS IAM role ARN of the role associated with the instance profile. It must have the form `arn:aws:iam::\u003caccount-id\u003e:role/\u003cname\u003e`. This field is required if your role name and instance profile name do not match and you want to use the instance profile with Databricks SQL Serverless.\n" }, "instanceProfileArn": { "type": "string", "description": "`ARN` attribute of \u003cspan pulumi-lang-nodejs=\"`awsIamInstanceProfile`\" pulumi-lang-dotnet=\"`AwsIamInstanceProfile`\" pulumi-lang-go=\"`awsIamInstanceProfile`\" pulumi-lang-python=\"`aws_iam_instance_profile`\" pulumi-lang-yaml=\"`awsIamInstanceProfile`\" pulumi-lang-java=\"`awsIamInstanceProfile`\" pulumi-lang-hcl=\"`aws_iam_instance_profile`\"\u003e`awsIamInstanceProfile`\u003c/span\u003e output, the EC2 instance profile association to AWS IAM role. This ARN would be validated upon resource creation.\n" }, "isMetaInstanceProfile": { "type": "boolean", "description": "Whether the instance profile is a meta instance profile. Used only in [IAM credential passthrough](https://docs.databricks.com/security/credential-passthrough/iam-passthrough.html).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/InstanceProfileProviderConfig:InstanceProfileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "skipValidation": { "type": "boolean", "description": "**For advanced usage only.** If validation fails with an error message that does not indicate an IAM related permission issue, (e.g. \"Your requested instance type is not supported in your requested availability zone\"), you can pass this flag to skip the validation and forcibly add the instance profile.\n" } }, "required": [ "instanceProfileArn", "providerConfig", "skipValidation" ], "inputProperties": { "iamRoleArn": { "type": "string", "description": "The AWS IAM role ARN of the role associated with the instance profile. It must have the form `arn:aws:iam::\u003caccount-id\u003e:role/\u003cname\u003e`. This field is required if your role name and instance profile name do not match and you want to use the instance profile with Databricks SQL Serverless.\n" }, "instanceProfileArn": { "type": "string", "description": "`ARN` attribute of \u003cspan pulumi-lang-nodejs=\"`awsIamInstanceProfile`\" pulumi-lang-dotnet=\"`AwsIamInstanceProfile`\" pulumi-lang-go=\"`awsIamInstanceProfile`\" pulumi-lang-python=\"`aws_iam_instance_profile`\" pulumi-lang-yaml=\"`awsIamInstanceProfile`\" pulumi-lang-java=\"`awsIamInstanceProfile`\" pulumi-lang-hcl=\"`aws_iam_instance_profile`\"\u003e`awsIamInstanceProfile`\u003c/span\u003e output, the EC2 instance profile association to AWS IAM role. This ARN would be validated upon resource creation.\n" }, "isMetaInstanceProfile": { "type": "boolean", "description": "Whether the instance profile is a meta instance profile. Used only in [IAM credential passthrough](https://docs.databricks.com/security/credential-passthrough/iam-passthrough.html).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/InstanceProfileProviderConfig:InstanceProfileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "skipValidation": { "type": "boolean", "description": "**For advanced usage only.** If validation fails with an error message that does not indicate an IAM related permission issue, (e.g. \"Your requested instance type is not supported in your requested availability zone\"), you can pass this flag to skip the validation and forcibly add the instance profile.\n" } }, "requiredInputs": [ "instanceProfileArn" ], "stateInputs": { "description": "Input properties used for looking up and filtering InstanceProfile resources.\n", "properties": { "iamRoleArn": { "type": "string", "description": "The AWS IAM role ARN of the role associated with the instance profile. It must have the form `arn:aws:iam::\u003caccount-id\u003e:role/\u003cname\u003e`. This field is required if your role name and instance profile name do not match and you want to use the instance profile with Databricks SQL Serverless.\n" }, "instanceProfileArn": { "type": "string", "description": "`ARN` attribute of \u003cspan pulumi-lang-nodejs=\"`awsIamInstanceProfile`\" pulumi-lang-dotnet=\"`AwsIamInstanceProfile`\" pulumi-lang-go=\"`awsIamInstanceProfile`\" pulumi-lang-python=\"`aws_iam_instance_profile`\" pulumi-lang-yaml=\"`awsIamInstanceProfile`\" pulumi-lang-java=\"`awsIamInstanceProfile`\" pulumi-lang-hcl=\"`aws_iam_instance_profile`\"\u003e`awsIamInstanceProfile`\u003c/span\u003e output, the EC2 instance profile association to AWS IAM role. This ARN would be validated upon resource creation.\n" }, "isMetaInstanceProfile": { "type": "boolean", "description": "Whether the instance profile is a meta instance profile. Used only in [IAM credential passthrough](https://docs.databricks.com/security/credential-passthrough/iam-passthrough.html).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/InstanceProfileProviderConfig:InstanceProfileProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "skipValidation": { "type": "boolean", "description": "**For advanced usage only.** If validation fails with an error message that does not indicate an IAM related permission issue, (e.g. \"Your requested instance type is not supported in your requested availability zone\"), you can pass this flag to skip the validation and forcibly add the instance profile.\n" } }, "type": "object" } }, "databricks:index/ipAccessList:IpAccessList": { "description": "Security-conscious enterprises that use cloud SaaS applications need to restrict access to their own employees. Authentication helps to prove user identity, but that does not enforce network location of the users. Accessing a cloud service from an unsecured network can pose security risks to an enterprise, especially when the user may have authorized access to sensitive or personal data. Enterprise network perimeters apply security policies and limit access to external services (for example, firewalls, proxies, DLP, and logging), so access beyond these controls are assumed to be untrusted. Please see [IP Access List](https://docs.databricks.com/security/network/ip-access-list.html) for full feature documentation.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e The total number of IP addresses and CIDR scopes provided across all ACL Lists in a workspace can not exceed 1000. Refer to the docs above for specifics.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.WorkspaceConf(\"this\", {customConfig: {\n enableIpAccessLists: \"true\",\n}});\nconst allowed_list = new databricks.IpAccessList(\"allowed-list\", {\n label: \"allow_in\",\n listType: \"ALLOW\",\n ipAddresses: [\n \"1.1.1.1\",\n \"1.2.3.0/24\",\n \"1.2.5.0/24\",\n ],\n}, {\n dependsOn: [_this],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.WorkspaceConf(\"this\", custom_config={\n \"enableIpAccessLists\": \"true\",\n})\nallowed_list = databricks.IpAccessList(\"allowed-list\",\n label=\"allow_in\",\n list_type=\"ALLOW\",\n ip_addresses=[\n \"1.1.1.1\",\n \"1.2.3.0/24\",\n \"1.2.5.0/24\",\n ],\n opts = pulumi.ResourceOptions(depends_on=[this]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.WorkspaceConf(\"this\", new()\n {\n CustomConfig = \n {\n { \"enableIpAccessLists\", \"true\" },\n },\n });\n\n var allowed_list = new Databricks.IpAccessList(\"allowed-list\", new()\n {\n Label = \"allow_in\",\n ListType = \"ALLOW\",\n IpAddresses = new[]\n {\n \"1.1.1.1\",\n \"1.2.3.0/24\",\n \"1.2.5.0/24\",\n },\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n @this,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewWorkspaceConf(ctx, \"this\", \u0026databricks.WorkspaceConfArgs{\n\t\t\tCustomConfig: pulumi.StringMap{\n\t\t\t\t\"enableIpAccessLists\": pulumi.String(\"true\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewIpAccessList(ctx, \"allowed-list\", \u0026databricks.IpAccessListArgs{\n\t\t\tLabel: pulumi.String(\"allow_in\"),\n\t\t\tListType: pulumi.String(\"ALLOW\"),\n\t\t\tIpAddresses: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"1.1.1.1\"),\n\t\t\t\tpulumi.String(\"1.2.3.0/24\"),\n\t\t\t\tpulumi.String(\"1.2.5.0/24\"),\n\t\t\t},\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthis,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_workspaceconf\" \"this\" {\n custom_config = {\n \"enableIpAccessLists\" = true\n }\n}\nresource \"databricks_ipaccesslist\" \"allowed-list\" {\n depends_on = [databricks_workspaceconf.this]\n label = \"allow_in\"\n list_type = \"ALLOW\"\n ip_addresses = [\"1.1.1.1\", \"1.2.3.0/24\", \"1.2.5.0/24\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.WorkspaceConf;\nimport com.pulumi.databricks.WorkspaceConfArgs;\nimport com.pulumi.databricks.IpAccessList;\nimport com.pulumi.databricks.IpAccessListArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new WorkspaceConf(\"this\", WorkspaceConfArgs.builder()\n .customConfig(Map.of(\"enableIpAccessLists\", \"true\"))\n .build());\n\n var allowed_list = new IpAccessList(\"allowed-list\", IpAccessListArgs.builder()\n .label(\"allow_in\")\n .listType(\"ALLOW\")\n .ipAddresses( \n \"1.1.1.1\",\n \"1.2.3.0/24\",\n \"1.2.5.0/24\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(this_)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:WorkspaceConf\n properties:\n customConfig:\n enableIpAccessLists: true\n allowed-list:\n type: databricks:IpAccessList\n properties:\n label: allow_in\n listType: ALLOW\n ipAddresses:\n - 1.1.1.1\n - 1.2.3.0/24\n - 1.2.5.0/24\n options:\n dependsOn:\n - ${this}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n* Provisioning AWS Databricks workspaces with a Hub \u0026 Spoke firewall for data exfiltration protection guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-dotnet=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-go=\" MwsPrivateAccessSettings \" pulumi-lang-python=\" MwsPrivateAccessSettings \" pulumi-lang-yaml=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-java=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-hcl=\" databricks_mws_private_access_settings \"\u003e databricks.MwsPrivateAccessSettings \u003c/span\u003eto create a [Private Access Setting](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#step-5-create-a-private-access-settings-configuration-using-the-databricks-account-api) that can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource to create a [Databricks Workspace that leverages AWS PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003eto manage [access control](https://docs.databricks.com/security/access-control/index.html) in Databricks workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Grants \" pulumi-lang-dotnet=\" databricks.Grants \" pulumi-lang-go=\" Grants \" pulumi-lang-python=\" Grants \" pulumi-lang-yaml=\" databricks.Grants \" pulumi-lang-java=\" databricks.Grants \" pulumi-lang-hcl=\" databricks_grants \"\u003e databricks.Grants \u003c/span\u003eto manage data access in Unity Catalog.\n\n", "properties": { "enabled": { "type": "boolean", "description": "Boolean \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e indicating whether this list should be active. Defaults to \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "A string list of IP addresses and CIDR ranges.\n" }, "label": { "type": "string", "description": "This is the display name for the given IP ACL List.\n" }, "listType": { "type": "string", "description": "Can only be \"ALLOW\" or \"BLOCK\".\n" }, "providerConfig": { "$ref": "#/types/databricks:index/IpAccessListProviderConfig:IpAccessListProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "required": [ "ipAddresses", "label", "listType", "providerConfig" ], "inputProperties": { "enabled": { "type": "boolean", "description": "Boolean \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e indicating whether this list should be active. Defaults to \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "A string list of IP addresses and CIDR ranges.\n" }, "label": { "type": "string", "description": "This is the display name for the given IP ACL List.\n" }, "listType": { "type": "string", "description": "Can only be \"ALLOW\" or \"BLOCK\".\n" }, "providerConfig": { "$ref": "#/types/databricks:index/IpAccessListProviderConfig:IpAccessListProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "requiredInputs": [ "ipAddresses", "label", "listType" ], "stateInputs": { "description": "Input properties used for looking up and filtering IpAccessList resources.\n", "properties": { "enabled": { "type": "boolean", "description": "Boolean \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e indicating whether this list should be active. Defaults to \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "A string list of IP addresses and CIDR ranges.\n" }, "label": { "type": "string", "description": "This is the display name for the given IP ACL List.\n" }, "listType": { "type": "string", "description": "Can only be \"ALLOW\" or \"BLOCK\".\n" }, "providerConfig": { "$ref": "#/types/databricks:index/IpAccessListProviderConfig:IpAccessListProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" } }, "type": "object" } }, "databricks:index/job:Job": { "description": "The \u003cspan pulumi-lang-nodejs=\"`databricks.Job`\" pulumi-lang-dotnet=\"`databricks.Job`\" pulumi-lang-go=\"`Job`\" pulumi-lang-python=\"`Job`\" pulumi-lang-yaml=\"`databricks.Job`\" pulumi-lang-java=\"`databricks.Job`\" pulumi-lang-hcl=\"`databricks_job`\"\u003e`databricks.Job`\u003c/span\u003e resource allows you to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a databricks_cluster.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003e In Pulumi configuration, it is recommended to define tasks in alphabetical order of their \u003cspan pulumi-lang-nodejs=\"`taskKey`\" pulumi-lang-dotnet=\"`TaskKey`\" pulumi-lang-go=\"`taskKey`\" pulumi-lang-python=\"`task_key`\" pulumi-lang-yaml=\"`taskKey`\" pulumi-lang-java=\"`taskKey`\" pulumi-lang-hcl=\"`task_key`\"\u003e`taskKey`\u003c/span\u003e arguments, so that you get consistent and readable diff. Whenever tasks are added or removed, or \u003cspan pulumi-lang-nodejs=\"`taskKey`\" pulumi-lang-dotnet=\"`TaskKey`\" pulumi-lang-go=\"`taskKey`\" pulumi-lang-python=\"`task_key`\" pulumi-lang-yaml=\"`taskKey`\" pulumi-lang-java=\"`taskKey`\" pulumi-lang-hcl=\"`task_key`\"\u003e`taskKey`\u003c/span\u003e is renamed, you'll observe a change in the majority of tasks. It's related to the fact that the current version of the provider treats \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e blocks as an ordered list. Alternatively, \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block could have been an unordered set, though end-users would see the entire block replaced upon a change in single property of the task.\n\nIt is possible to create [a Databricks job](https://docs.databricks.com/aws/en/jobs/) using \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e blocks. A single task is defined with the \u003cspan pulumi-lang-nodejs=\"`task`\" pulumi-lang-dotnet=\"`Task`\" pulumi-lang-go=\"`task`\" pulumi-lang-python=\"`task`\" pulumi-lang-yaml=\"`task`\" pulumi-lang-java=\"`task`\" pulumi-lang-hcl=\"`task`\"\u003e`task`\u003c/span\u003e block containing one of the `*_task` blocks, \u003cspan pulumi-lang-nodejs=\"`taskKey`\" pulumi-lang-dotnet=\"`TaskKey`\" pulumi-lang-go=\"`taskKey`\" pulumi-lang-python=\"`task_key`\" pulumi-lang-yaml=\"`taskKey`\" pulumi-lang-java=\"`taskKey`\" pulumi-lang-hcl=\"`task_key`\"\u003e`taskKey`\u003c/span\u003e, and additional arguments described below.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Job(\"this\", {\n name: \"Job with multiple tasks\",\n description: \"This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\",\n jobClusters: [{\n jobClusterKey: \"j\",\n newCluster: {\n numWorkers: 2,\n sparkVersion: latest.id,\n nodeTypeId: smallest.id,\n },\n }],\n tasks: [\n {\n taskKey: \"a\",\n newCluster: {\n numWorkers: 1,\n sparkVersion: latest.id,\n nodeTypeId: smallest.id,\n },\n notebookTask: {\n notebookPath: thisDatabricksNotebook.path,\n },\n },\n {\n taskKey: \"b\",\n dependsOns: [{\n taskKey: \"a\",\n }],\n existingClusterId: shared.id,\n sparkJarTask: {\n mainClassName: \"com.acme.data.Main\",\n },\n },\n {\n taskKey: \"c\",\n jobClusterKey: \"j\",\n notebookTask: {\n notebookPath: thisDatabricksNotebook.path,\n },\n },\n {\n taskKey: \"d\",\n pipelineTask: {\n pipelineId: thisDatabricksPipeline.id,\n },\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Job(\"this\",\n name=\"Job with multiple tasks\",\n description=\"This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\",\n job_clusters=[{\n \"job_cluster_key\": \"j\",\n \"new_cluster\": {\n \"num_workers\": 2,\n \"spark_version\": latest[\"id\"],\n \"node_type_id\": smallest[\"id\"],\n },\n }],\n tasks=[\n {\n \"task_key\": \"a\",\n \"new_cluster\": {\n \"num_workers\": 1,\n \"spark_version\": latest[\"id\"],\n \"node_type_id\": smallest[\"id\"],\n },\n \"notebook_task\": {\n \"notebook_path\": this_databricks_notebook[\"path\"],\n },\n },\n {\n \"task_key\": \"b\",\n \"depends_ons\": [{\n \"task_key\": \"a\",\n }],\n \"existing_cluster_id\": shared[\"id\"],\n \"spark_jar_task\": {\n \"main_class_name\": \"com.acme.data.Main\",\n },\n },\n {\n \"task_key\": \"c\",\n \"job_cluster_key\": \"j\",\n \"notebook_task\": {\n \"notebook_path\": this_databricks_notebook[\"path\"],\n },\n },\n {\n \"task_key\": \"d\",\n \"pipeline_task\": {\n \"pipeline_id\": this_databricks_pipeline[\"id\"],\n },\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Job(\"this\", new()\n {\n Name = \"Job with multiple tasks\",\n Description = \"This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\",\n JobClusters = new[]\n {\n new Databricks.Inputs.JobJobClusterArgs\n {\n JobClusterKey = \"j\",\n NewCluster = new Databricks.Inputs.JobJobClusterNewClusterArgs\n {\n NumWorkers = 2,\n SparkVersion = latest.Id,\n NodeTypeId = smallest.Id,\n },\n },\n },\n Tasks = new[]\n {\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"a\",\n NewCluster = new Databricks.Inputs.JobTaskNewClusterArgs\n {\n NumWorkers = 1,\n SparkVersion = latest.Id,\n NodeTypeId = smallest.Id,\n },\n NotebookTask = new Databricks.Inputs.JobTaskNotebookTaskArgs\n {\n NotebookPath = thisDatabricksNotebook.Path,\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"b\",\n DependsOns = new[]\n {\n new Databricks.Inputs.JobTaskDependsOnArgs\n {\n TaskKey = \"a\",\n },\n },\n ExistingClusterId = shared.Id,\n SparkJarTask = new Databricks.Inputs.JobTaskSparkJarTaskArgs\n {\n MainClassName = \"com.acme.data.Main\",\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"c\",\n JobClusterKey = \"j\",\n NotebookTask = new Databricks.Inputs.JobTaskNotebookTaskArgs\n {\n NotebookPath = thisDatabricksNotebook.Path,\n },\n },\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"d\",\n PipelineTask = new Databricks.Inputs.JobTaskPipelineTaskArgs\n {\n PipelineId = thisDatabricksPipeline.Id,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewJob(ctx, \"this\", \u0026databricks.JobArgs{\n\t\t\tName: pulumi.String(\"Job with multiple tasks\"),\n\t\t\tDescription: pulumi.String(\"This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\"),\n\t\t\tJobClusters: databricks.JobJobClusterArray{\n\t\t\t\t\u0026databricks.JobJobClusterArgs{\n\t\t\t\t\tJobClusterKey: pulumi.String(\"j\"),\n\t\t\t\t\tNewCluster: \u0026databricks.JobJobClusterNewClusterArgs{\n\t\t\t\t\t\tNumWorkers: pulumi.Int(2),\n\t\t\t\t\t\tSparkVersion: pulumi.Any(latest.Id),\n\t\t\t\t\t\tNodeTypeId: pulumi.Any(smallest.Id),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tTasks: databricks.JobTaskArray{\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"a\"),\n\t\t\t\t\tNewCluster: \u0026databricks.JobTaskNewClusterArgs{\n\t\t\t\t\t\tNumWorkers: pulumi.Int(1),\n\t\t\t\t\t\tSparkVersion: pulumi.Any(latest.Id),\n\t\t\t\t\t\tNodeTypeId: pulumi.Any(smallest.Id),\n\t\t\t\t\t},\n\t\t\t\t\tNotebookTask: \u0026databricks.JobTaskNotebookTaskArgs{\n\t\t\t\t\t\tNotebookPath: pulumi.Any(thisDatabricksNotebook.Path),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"b\"),\n\t\t\t\t\tDependsOns: databricks.JobTaskDependsOnArray{\n\t\t\t\t\t\t\u0026databricks.JobTaskDependsOnArgs{\n\t\t\t\t\t\t\tTaskKey: pulumi.String(\"a\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tExistingClusterId: pulumi.Any(shared.Id),\n\t\t\t\t\tSparkJarTask: \u0026databricks.JobTaskSparkJarTaskArgs{\n\t\t\t\t\t\tMainClassName: pulumi.String(\"com.acme.data.Main\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"c\"),\n\t\t\t\t\tJobClusterKey: pulumi.String(\"j\"),\n\t\t\t\t\tNotebookTask: \u0026databricks.JobTaskNotebookTaskArgs{\n\t\t\t\t\t\tNotebookPath: pulumi.Any(thisDatabricksNotebook.Path),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"d\"),\n\t\t\t\t\tPipelineTask: \u0026databricks.JobTaskPipelineTaskArgs{\n\t\t\t\t\t\tPipelineId: pulumi.Any(thisDatabricksPipeline.Id),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_job\" \"this\" {\n name = \"Job with multiple tasks\"\n description = \"This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\"\n job_clusters {\n job_cluster_key = \"j\"\n new_cluster = {\n num_workers = 2\n spark_version = latest.id\n node_type_id = smallest.id\n }\n }\n tasks {\n task_key = \"a\"\n new_cluster = {\n num_workers = 1\n spark_version = latest.id\n node_type_id = smallest.id\n }\n notebook_task = {\n notebook_path = thisDatabricksNotebook.path\n }\n }\n tasks {\n task_key = \"b\"\n depends_ons {\n task_key = \"a\"\n }\n existing_cluster_id = shared.id\n spark_jar_task = {\n main_class_name = \"com.acme.data.Main\"\n }\n }\n tasks {\n task_key = \"c\"\n job_cluster_key = \"j\"\n notebook_task = {\n notebook_path = thisDatabricksNotebook.path\n }\n }\n tasks {\n task_key = \"d\"\n pipeline_task = {\n pipeline_id = thisDatabricksPipeline.id\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Job;\nimport com.pulumi.databricks.JobArgs;\nimport com.pulumi.databricks.inputs.JobJobClusterArgs;\nimport com.pulumi.databricks.inputs.JobJobClusterNewClusterArgs;\nimport com.pulumi.databricks.inputs.JobTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskNewClusterArgs;\nimport com.pulumi.databricks.inputs.JobTaskNotebookTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskSparkJarTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskPipelineTaskArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Job(\"this\", JobArgs.builder()\n .name(\"Job with multiple tasks\")\n .description(\"This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\")\n .jobClusters(JobJobClusterArgs.builder()\n .jobClusterKey(\"j\")\n .newCluster(JobJobClusterNewClusterArgs.builder()\n .numWorkers(2)\n .sparkVersion(latest.id())\n .nodeTypeId(smallest.id())\n .build())\n .build())\n .tasks( \n JobTaskArgs.builder()\n .taskKey(\"a\")\n .newCluster(JobTaskNewClusterArgs.builder()\n .numWorkers(1)\n .sparkVersion(latest.id())\n .nodeTypeId(smallest.id())\n .build())\n .notebookTask(JobTaskNotebookTaskArgs.builder()\n .notebookPath(thisDatabricksNotebook.path())\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"b\")\n .dependsOns(JobTaskDependsOnArgs.builder()\n .taskKey(\"a\")\n .build())\n .existingClusterId(shared.id())\n .sparkJarTask(JobTaskSparkJarTaskArgs.builder()\n .mainClassName(\"com.acme.data.Main\")\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"c\")\n .jobClusterKey(\"j\")\n .notebookTask(JobTaskNotebookTaskArgs.builder()\n .notebookPath(thisDatabricksNotebook.path())\n .build())\n .build(),\n JobTaskArgs.builder()\n .taskKey(\"d\")\n .pipelineTask(JobTaskPipelineTaskArgs.builder()\n .pipelineId(thisDatabricksPipeline.id())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Job\n properties:\n name: Job with multiple tasks\n description: This job executes multiple tasks on a shared job cluster, which will be provisioned as part of execution, and terminated once all tasks are finished.\n jobClusters:\n - jobClusterKey: j\n newCluster:\n numWorkers: 2\n sparkVersion: ${latest.id}\n nodeTypeId: ${smallest.id}\n tasks:\n - taskKey: a\n newCluster:\n numWorkers: 1\n sparkVersion: ${latest.id}\n nodeTypeId: ${smallest.id}\n notebookTask:\n notebookPath: ${thisDatabricksNotebook.path}\n - taskKey: b\n dependsOns:\n - taskKey: a\n existingClusterId: ${shared.id}\n sparkJarTask:\n mainClassName: com.acme.data.Main\n - taskKey: c\n jobClusterKey: j\n notebookTask:\n notebookPath: ${thisDatabricksNotebook.path}\n - taskKey: d\n pipelineTask:\n pipelineId: ${thisDatabricksPipeline.id}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\nBy default, all users can create and modify jobs unless an administrator [enables jobs access control](https://docs.databricks.com/administration-guide/access-control/jobs-acl.html). With jobs access control, individual permissions determine a user's abilities.\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Can View*, *Can Manage Run*, and *Can Manage*.\n*\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003ecan control which kinds of clusters users can create for jobs.\n\n", "properties": { "alwaysRunning": { "type": "boolean", "description": "(Bool) Whenever the job is always running, like a Spark Streaming application, on every update restart the current active run or start it again, if nothing it is not running. False by default. Any job runs are started with \u003cspan pulumi-lang-nodejs=\"`parameters`\" pulumi-lang-dotnet=\"`Parameters`\" pulumi-lang-go=\"`parameters`\" pulumi-lang-python=\"`parameters`\" pulumi-lang-yaml=\"`parameters`\" pulumi-lang-java=\"`parameters`\" pulumi-lang-hcl=\"`parameters`\"\u003e`parameters`\u003c/span\u003e specified in \u003cspan pulumi-lang-nodejs=\"`sparkJarTask`\" pulumi-lang-dotnet=\"`SparkJarTask`\" pulumi-lang-go=\"`sparkJarTask`\" pulumi-lang-python=\"`spark_jar_task`\" pulumi-lang-yaml=\"`sparkJarTask`\" pulumi-lang-java=\"`sparkJarTask`\" pulumi-lang-hcl=\"`spark_jar_task`\"\u003e`sparkJarTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`sparkSubmitTask`\" pulumi-lang-dotnet=\"`SparkSubmitTask`\" pulumi-lang-go=\"`sparkSubmitTask`\" pulumi-lang-python=\"`spark_submit_task`\" pulumi-lang-yaml=\"`sparkSubmitTask`\" pulumi-lang-java=\"`sparkSubmitTask`\" pulumi-lang-hcl=\"`spark_submit_task`\"\u003e`sparkSubmitTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`sparkPythonTask`\" pulumi-lang-dotnet=\"`SparkPythonTask`\" pulumi-lang-go=\"`sparkPythonTask`\" pulumi-lang-python=\"`spark_python_task`\" pulumi-lang-yaml=\"`sparkPythonTask`\" pulumi-lang-java=\"`sparkPythonTask`\" pulumi-lang-hcl=\"`spark_python_task`\"\u003e`sparkPythonTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`notebookTask`\" pulumi-lang-dotnet=\"`NotebookTask`\" pulumi-lang-go=\"`notebookTask`\" pulumi-lang-python=\"`notebook_task`\" pulumi-lang-yaml=\"`notebookTask`\" pulumi-lang-java=\"`notebookTask`\" pulumi-lang-hcl=\"`notebook_task`\"\u003e`notebookTask`\u003c/span\u003e blocks.\n", "deprecationMessage": "always_running will be replaced by\u003cspan pulumi-lang-nodejs=\" controlRunState \" pulumi-lang-dotnet=\" ControlRunState \" pulumi-lang-go=\" controlRunState \" pulumi-lang-python=\" control_run_state \" pulumi-lang-yaml=\" controlRunState \" pulumi-lang-java=\" controlRunState \" pulumi-lang-hcl=\" control_run_state \"\u003e controlRunState \u003c/span\u003ein the next major release." }, "budgetPolicyId": { "type": "string", "description": "The ID of the user-specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job.\n" }, "continuous": { "$ref": "#/types/databricks:index/JobContinuous:JobContinuous", "description": "Configuration block to configure pause status. See continuous Configuration Block.\n" }, "controlRunState": { "type": "boolean", "description": "(Bool) If true, the Databricks provider will stop and start the job as needed to ensure that the active run for the job reflects the deployed configuration. For continuous jobs, the provider respects the \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e by stopping the current active run. This flag cannot be set for non-continuous jobs.\n\nWhen migrating from \u003cspan pulumi-lang-nodejs=\"`alwaysRunning`\" pulumi-lang-dotnet=\"`AlwaysRunning`\" pulumi-lang-go=\"`alwaysRunning`\" pulumi-lang-python=\"`always_running`\" pulumi-lang-yaml=\"`alwaysRunning`\" pulumi-lang-java=\"`alwaysRunning`\" pulumi-lang-hcl=\"`always_running`\"\u003e`alwaysRunning`\u003c/span\u003e to \u003cspan pulumi-lang-nodejs=\"`controlRunState`\" pulumi-lang-dotnet=\"`ControlRunState`\" pulumi-lang-go=\"`controlRunState`\" pulumi-lang-python=\"`control_run_state`\" pulumi-lang-yaml=\"`controlRunState`\" pulumi-lang-java=\"`controlRunState`\" pulumi-lang-hcl=\"`control_run_state`\"\u003e`controlRunState`\u003c/span\u003e, set \u003cspan pulumi-lang-nodejs=\"`continuous`\" pulumi-lang-dotnet=\"`Continuous`\" pulumi-lang-go=\"`continuous`\" pulumi-lang-python=\"`continuous`\" pulumi-lang-yaml=\"`continuous`\" pulumi-lang-java=\"`continuous`\" pulumi-lang-hcl=\"`continuous`\"\u003e`continuous`\u003c/span\u003e as follows:\n\n" }, "dbtTask": { "$ref": "#/types/databricks:index/JobDbtTask:JobDbtTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "deployment": { "$ref": "#/types/databricks:index/JobDeployment:JobDeployment" }, "description": { "type": "string", "description": "An optional description for the job. The maximum length is 1024 characters in UTF-8 encoding.\n" }, "editMode": { "type": "string", "description": "If `\"UI_LOCKED\"`, the user interface for the job will be locked. If `\"EDITABLE\"` (the default), the user interface will be editable.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/JobEmailNotifications:JobEmailNotifications", "description": "(List) An optional set of email addresses notified when runs of this job begins, completes or fails. The default behavior is to not send any emails. This field is a block and is documented below.\n" }, "environments": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobEnvironment:JobEnvironment" } }, "existingClusterId": { "type": "string" }, "format": { "type": "string" }, "gitSource": { "$ref": "#/types/databricks:index/JobGitSource:JobGitSource", "description": "Specifies the a Git repository for task source code. See\u003cspan pulumi-lang-nodejs=\" gitSource \" pulumi-lang-dotnet=\" GitSource \" pulumi-lang-go=\" gitSource \" pulumi-lang-python=\" git_source \" pulumi-lang-yaml=\" gitSource \" pulumi-lang-java=\" gitSource \" pulumi-lang-hcl=\" git_source \"\u003e gitSource \u003c/span\u003eConfiguration Block below.\n" }, "health": { "$ref": "#/types/databricks:index/JobHealth:JobHealth", "description": "An optional block that specifies the health conditions for the job documented below.\n" }, "jobClusters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobJobCluster:JobJobCluster" }, "description": "A list of job\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003especifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings. *Multi-task syntax*\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobLibrary:JobLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "maxConcurrentRuns": { "type": "integer", "description": "(Integer) An optional maximum allowed number of concurrent runs of the job. Defaults to *1*.\n" }, "maxRetries": { "type": "integer", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "minRetryIntervalMillis": { "type": "integer", "description": "(Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.\n", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "name": { "type": "string", "description": "An optional name for the job. The default value is Untitled.\n" }, "newCluster": { "$ref": "#/types/databricks:index/JobNewCluster:JobNewCluster" }, "notebookTask": { "$ref": "#/types/databricks:index/JobNotebookTask:JobNotebookTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "notificationSettings": { "$ref": "#/types/databricks:index/JobNotificationSettings:JobNotificationSettings", "description": "An optional block controlling the notification settings on the job level documented below.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobParameter:JobParameter" }, "description": "Specifies job parameter for the job. See parameter Configuration Block\n" }, "performanceTarget": { "type": "string", "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. Supported values are:\n* `PERFORMANCE_OPTIMIZED`: (default value) Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n" }, "pipelineTask": { "$ref": "#/types/databricks:index/JobPipelineTask:JobPipelineTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "providerConfig": { "$ref": "#/types/databricks:index/JobProviderConfig:JobProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/JobPythonWheelTask:JobPythonWheelTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "queue": { "$ref": "#/types/databricks:index/JobQueue:JobQueue", "description": "The queue status for the job. See queue Configuration Block below.\n" }, "retryOnTimeout": { "type": "boolean", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "runAs": { "$ref": "#/types/databricks:index/JobRunAs:JobRunAs", "description": "The user or the service principal the job runs as. See\u003cspan pulumi-lang-nodejs=\" runAs \" pulumi-lang-dotnet=\" RunAs \" pulumi-lang-go=\" runAs \" pulumi-lang-python=\" run_as \" pulumi-lang-yaml=\" runAs \" pulumi-lang-java=\" runAs \" pulumi-lang-hcl=\" run_as \"\u003e runAs \u003c/span\u003eConfiguration Block below.\n" }, "runJobTask": { "$ref": "#/types/databricks:index/JobRunJobTask:JobRunJobTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "schedule": { "$ref": "#/types/databricks:index/JobSchedule:JobSchedule", "description": "An optional periodic schedule for this job. The default behavior is that the job runs when triggered by clicking Run Now in the Jobs UI or sending an API request to runNow. See schedule Configuration Block below.\n" }, "sparkJarTask": { "$ref": "#/types/databricks:index/JobSparkJarTask:JobSparkJarTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/JobSparkPythonTask:JobSparkPythonTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/JobSparkSubmitTask:JobSparkSubmitTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "An optional map of the tags associated with the job. See tags Configuration Map\n" }, "tasks": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTask:JobTask" }, "description": "A list of task specification that the job will execute. See task Configuration Block below.\n" }, "timeoutSeconds": { "type": "integer", "description": "(Integer) An optional timeout applied to each run of this job. The default behavior is to have no timeout.\n" }, "trigger": { "$ref": "#/types/databricks:index/JobTrigger:JobTrigger", "description": "The conditions that triggers the job to start. See trigger Configuration Block below.\n" }, "url": { "type": "string", "description": "URL of the job on the given workspace\n" }, "usagePolicyId": { "type": "string" }, "webhookNotifications": { "$ref": "#/types/databricks:index/JobWebhookNotifications:JobWebhookNotifications", "description": "(List) An optional set of system destinations (for example, webhook destinations or Slack) to be notified when runs of this job begins, completes or fails. The default behavior is to not send any notifications. This field is a block and is documented below.\n" } }, "required": [ "format", "name", "providerConfig", "runAs", "url" ], "inputProperties": { "alwaysRunning": { "type": "boolean", "description": "(Bool) Whenever the job is always running, like a Spark Streaming application, on every update restart the current active run or start it again, if nothing it is not running. False by default. Any job runs are started with \u003cspan pulumi-lang-nodejs=\"`parameters`\" pulumi-lang-dotnet=\"`Parameters`\" pulumi-lang-go=\"`parameters`\" pulumi-lang-python=\"`parameters`\" pulumi-lang-yaml=\"`parameters`\" pulumi-lang-java=\"`parameters`\" pulumi-lang-hcl=\"`parameters`\"\u003e`parameters`\u003c/span\u003e specified in \u003cspan pulumi-lang-nodejs=\"`sparkJarTask`\" pulumi-lang-dotnet=\"`SparkJarTask`\" pulumi-lang-go=\"`sparkJarTask`\" pulumi-lang-python=\"`spark_jar_task`\" pulumi-lang-yaml=\"`sparkJarTask`\" pulumi-lang-java=\"`sparkJarTask`\" pulumi-lang-hcl=\"`spark_jar_task`\"\u003e`sparkJarTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`sparkSubmitTask`\" pulumi-lang-dotnet=\"`SparkSubmitTask`\" pulumi-lang-go=\"`sparkSubmitTask`\" pulumi-lang-python=\"`spark_submit_task`\" pulumi-lang-yaml=\"`sparkSubmitTask`\" pulumi-lang-java=\"`sparkSubmitTask`\" pulumi-lang-hcl=\"`spark_submit_task`\"\u003e`sparkSubmitTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`sparkPythonTask`\" pulumi-lang-dotnet=\"`SparkPythonTask`\" pulumi-lang-go=\"`sparkPythonTask`\" pulumi-lang-python=\"`spark_python_task`\" pulumi-lang-yaml=\"`sparkPythonTask`\" pulumi-lang-java=\"`sparkPythonTask`\" pulumi-lang-hcl=\"`spark_python_task`\"\u003e`sparkPythonTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`notebookTask`\" pulumi-lang-dotnet=\"`NotebookTask`\" pulumi-lang-go=\"`notebookTask`\" pulumi-lang-python=\"`notebook_task`\" pulumi-lang-yaml=\"`notebookTask`\" pulumi-lang-java=\"`notebookTask`\" pulumi-lang-hcl=\"`notebook_task`\"\u003e`notebookTask`\u003c/span\u003e blocks.\n", "deprecationMessage": "always_running will be replaced by\u003cspan pulumi-lang-nodejs=\" controlRunState \" pulumi-lang-dotnet=\" ControlRunState \" pulumi-lang-go=\" controlRunState \" pulumi-lang-python=\" control_run_state \" pulumi-lang-yaml=\" controlRunState \" pulumi-lang-java=\" controlRunState \" pulumi-lang-hcl=\" control_run_state \"\u003e controlRunState \u003c/span\u003ein the next major release." }, "budgetPolicyId": { "type": "string", "description": "The ID of the user-specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job.\n" }, "continuous": { "$ref": "#/types/databricks:index/JobContinuous:JobContinuous", "description": "Configuration block to configure pause status. See continuous Configuration Block.\n" }, "controlRunState": { "type": "boolean", "description": "(Bool) If true, the Databricks provider will stop and start the job as needed to ensure that the active run for the job reflects the deployed configuration. For continuous jobs, the provider respects the \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e by stopping the current active run. This flag cannot be set for non-continuous jobs.\n\nWhen migrating from \u003cspan pulumi-lang-nodejs=\"`alwaysRunning`\" pulumi-lang-dotnet=\"`AlwaysRunning`\" pulumi-lang-go=\"`alwaysRunning`\" pulumi-lang-python=\"`always_running`\" pulumi-lang-yaml=\"`alwaysRunning`\" pulumi-lang-java=\"`alwaysRunning`\" pulumi-lang-hcl=\"`always_running`\"\u003e`alwaysRunning`\u003c/span\u003e to \u003cspan pulumi-lang-nodejs=\"`controlRunState`\" pulumi-lang-dotnet=\"`ControlRunState`\" pulumi-lang-go=\"`controlRunState`\" pulumi-lang-python=\"`control_run_state`\" pulumi-lang-yaml=\"`controlRunState`\" pulumi-lang-java=\"`controlRunState`\" pulumi-lang-hcl=\"`control_run_state`\"\u003e`controlRunState`\u003c/span\u003e, set \u003cspan pulumi-lang-nodejs=\"`continuous`\" pulumi-lang-dotnet=\"`Continuous`\" pulumi-lang-go=\"`continuous`\" pulumi-lang-python=\"`continuous`\" pulumi-lang-yaml=\"`continuous`\" pulumi-lang-java=\"`continuous`\" pulumi-lang-hcl=\"`continuous`\"\u003e`continuous`\u003c/span\u003e as follows:\n\n" }, "dbtTask": { "$ref": "#/types/databricks:index/JobDbtTask:JobDbtTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "deployment": { "$ref": "#/types/databricks:index/JobDeployment:JobDeployment" }, "description": { "type": "string", "description": "An optional description for the job. The maximum length is 1024 characters in UTF-8 encoding.\n" }, "editMode": { "type": "string", "description": "If `\"UI_LOCKED\"`, the user interface for the job will be locked. If `\"EDITABLE\"` (the default), the user interface will be editable.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/JobEmailNotifications:JobEmailNotifications", "description": "(List) An optional set of email addresses notified when runs of this job begins, completes or fails. The default behavior is to not send any emails. This field is a block and is documented below.\n" }, "environments": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobEnvironment:JobEnvironment" } }, "existingClusterId": { "type": "string" }, "format": { "type": "string" }, "gitSource": { "$ref": "#/types/databricks:index/JobGitSource:JobGitSource", "description": "Specifies the a Git repository for task source code. See\u003cspan pulumi-lang-nodejs=\" gitSource \" pulumi-lang-dotnet=\" GitSource \" pulumi-lang-go=\" gitSource \" pulumi-lang-python=\" git_source \" pulumi-lang-yaml=\" gitSource \" pulumi-lang-java=\" gitSource \" pulumi-lang-hcl=\" git_source \"\u003e gitSource \u003c/span\u003eConfiguration Block below.\n" }, "health": { "$ref": "#/types/databricks:index/JobHealth:JobHealth", "description": "An optional block that specifies the health conditions for the job documented below.\n" }, "jobClusters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobJobCluster:JobJobCluster" }, "description": "A list of job\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003especifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings. *Multi-task syntax*\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobLibrary:JobLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "maxConcurrentRuns": { "type": "integer", "description": "(Integer) An optional maximum allowed number of concurrent runs of the job. Defaults to *1*.\n" }, "maxRetries": { "type": "integer", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "minRetryIntervalMillis": { "type": "integer", "description": "(Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.\n", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "name": { "type": "string", "description": "An optional name for the job. The default value is Untitled.\n" }, "newCluster": { "$ref": "#/types/databricks:index/JobNewCluster:JobNewCluster" }, "notebookTask": { "$ref": "#/types/databricks:index/JobNotebookTask:JobNotebookTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "notificationSettings": { "$ref": "#/types/databricks:index/JobNotificationSettings:JobNotificationSettings", "description": "An optional block controlling the notification settings on the job level documented below.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobParameter:JobParameter" }, "description": "Specifies job parameter for the job. See parameter Configuration Block\n" }, "performanceTarget": { "type": "string", "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. Supported values are:\n* `PERFORMANCE_OPTIMIZED`: (default value) Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n" }, "pipelineTask": { "$ref": "#/types/databricks:index/JobPipelineTask:JobPipelineTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "providerConfig": { "$ref": "#/types/databricks:index/JobProviderConfig:JobProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/JobPythonWheelTask:JobPythonWheelTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "queue": { "$ref": "#/types/databricks:index/JobQueue:JobQueue", "description": "The queue status for the job. See queue Configuration Block below.\n" }, "retryOnTimeout": { "type": "boolean", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "runAs": { "$ref": "#/types/databricks:index/JobRunAs:JobRunAs", "description": "The user or the service principal the job runs as. See\u003cspan pulumi-lang-nodejs=\" runAs \" pulumi-lang-dotnet=\" RunAs \" pulumi-lang-go=\" runAs \" pulumi-lang-python=\" run_as \" pulumi-lang-yaml=\" runAs \" pulumi-lang-java=\" runAs \" pulumi-lang-hcl=\" run_as \"\u003e runAs \u003c/span\u003eConfiguration Block below.\n" }, "runJobTask": { "$ref": "#/types/databricks:index/JobRunJobTask:JobRunJobTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "schedule": { "$ref": "#/types/databricks:index/JobSchedule:JobSchedule", "description": "An optional periodic schedule for this job. The default behavior is that the job runs when triggered by clicking Run Now in the Jobs UI or sending an API request to runNow. See schedule Configuration Block below.\n" }, "sparkJarTask": { "$ref": "#/types/databricks:index/JobSparkJarTask:JobSparkJarTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/JobSparkPythonTask:JobSparkPythonTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/JobSparkSubmitTask:JobSparkSubmitTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "An optional map of the tags associated with the job. See tags Configuration Map\n" }, "tasks": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTask:JobTask" }, "description": "A list of task specification that the job will execute. See task Configuration Block below.\n" }, "timeoutSeconds": { "type": "integer", "description": "(Integer) An optional timeout applied to each run of this job. The default behavior is to have no timeout.\n" }, "trigger": { "$ref": "#/types/databricks:index/JobTrigger:JobTrigger", "description": "The conditions that triggers the job to start. See trigger Configuration Block below.\n" }, "usagePolicyId": { "type": "string" }, "webhookNotifications": { "$ref": "#/types/databricks:index/JobWebhookNotifications:JobWebhookNotifications", "description": "(List) An optional set of system destinations (for example, webhook destinations or Slack) to be notified when runs of this job begins, completes or fails. The default behavior is to not send any notifications. This field is a block and is documented below.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Job resources.\n", "properties": { "alwaysRunning": { "type": "boolean", "description": "(Bool) Whenever the job is always running, like a Spark Streaming application, on every update restart the current active run or start it again, if nothing it is not running. False by default. Any job runs are started with \u003cspan pulumi-lang-nodejs=\"`parameters`\" pulumi-lang-dotnet=\"`Parameters`\" pulumi-lang-go=\"`parameters`\" pulumi-lang-python=\"`parameters`\" pulumi-lang-yaml=\"`parameters`\" pulumi-lang-java=\"`parameters`\" pulumi-lang-hcl=\"`parameters`\"\u003e`parameters`\u003c/span\u003e specified in \u003cspan pulumi-lang-nodejs=\"`sparkJarTask`\" pulumi-lang-dotnet=\"`SparkJarTask`\" pulumi-lang-go=\"`sparkJarTask`\" pulumi-lang-python=\"`spark_jar_task`\" pulumi-lang-yaml=\"`sparkJarTask`\" pulumi-lang-java=\"`sparkJarTask`\" pulumi-lang-hcl=\"`spark_jar_task`\"\u003e`sparkJarTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`sparkSubmitTask`\" pulumi-lang-dotnet=\"`SparkSubmitTask`\" pulumi-lang-go=\"`sparkSubmitTask`\" pulumi-lang-python=\"`spark_submit_task`\" pulumi-lang-yaml=\"`sparkSubmitTask`\" pulumi-lang-java=\"`sparkSubmitTask`\" pulumi-lang-hcl=\"`spark_submit_task`\"\u003e`sparkSubmitTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`sparkPythonTask`\" pulumi-lang-dotnet=\"`SparkPythonTask`\" pulumi-lang-go=\"`sparkPythonTask`\" pulumi-lang-python=\"`spark_python_task`\" pulumi-lang-yaml=\"`sparkPythonTask`\" pulumi-lang-java=\"`sparkPythonTask`\" pulumi-lang-hcl=\"`spark_python_task`\"\u003e`sparkPythonTask`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`notebookTask`\" pulumi-lang-dotnet=\"`NotebookTask`\" pulumi-lang-go=\"`notebookTask`\" pulumi-lang-python=\"`notebook_task`\" pulumi-lang-yaml=\"`notebookTask`\" pulumi-lang-java=\"`notebookTask`\" pulumi-lang-hcl=\"`notebook_task`\"\u003e`notebookTask`\u003c/span\u003e blocks.\n", "deprecationMessage": "always_running will be replaced by\u003cspan pulumi-lang-nodejs=\" controlRunState \" pulumi-lang-dotnet=\" ControlRunState \" pulumi-lang-go=\" controlRunState \" pulumi-lang-python=\" control_run_state \" pulumi-lang-yaml=\" controlRunState \" pulumi-lang-java=\" controlRunState \" pulumi-lang-hcl=\" control_run_state \"\u003e controlRunState \u003c/span\u003ein the next major release." }, "budgetPolicyId": { "type": "string", "description": "The ID of the user-specified budget policy to use for this job. If not specified, a default budget policy may be applied when creating or modifying the job.\n" }, "continuous": { "$ref": "#/types/databricks:index/JobContinuous:JobContinuous", "description": "Configuration block to configure pause status. See continuous Configuration Block.\n" }, "controlRunState": { "type": "boolean", "description": "(Bool) If true, the Databricks provider will stop and start the job as needed to ensure that the active run for the job reflects the deployed configuration. For continuous jobs, the provider respects the \u003cspan pulumi-lang-nodejs=\"`pauseStatus`\" pulumi-lang-dotnet=\"`PauseStatus`\" pulumi-lang-go=\"`pauseStatus`\" pulumi-lang-python=\"`pause_status`\" pulumi-lang-yaml=\"`pauseStatus`\" pulumi-lang-java=\"`pauseStatus`\" pulumi-lang-hcl=\"`pause_status`\"\u003e`pauseStatus`\u003c/span\u003e by stopping the current active run. This flag cannot be set for non-continuous jobs.\n\nWhen migrating from \u003cspan pulumi-lang-nodejs=\"`alwaysRunning`\" pulumi-lang-dotnet=\"`AlwaysRunning`\" pulumi-lang-go=\"`alwaysRunning`\" pulumi-lang-python=\"`always_running`\" pulumi-lang-yaml=\"`alwaysRunning`\" pulumi-lang-java=\"`alwaysRunning`\" pulumi-lang-hcl=\"`always_running`\"\u003e`alwaysRunning`\u003c/span\u003e to \u003cspan pulumi-lang-nodejs=\"`controlRunState`\" pulumi-lang-dotnet=\"`ControlRunState`\" pulumi-lang-go=\"`controlRunState`\" pulumi-lang-python=\"`control_run_state`\" pulumi-lang-yaml=\"`controlRunState`\" pulumi-lang-java=\"`controlRunState`\" pulumi-lang-hcl=\"`control_run_state`\"\u003e`controlRunState`\u003c/span\u003e, set \u003cspan pulumi-lang-nodejs=\"`continuous`\" pulumi-lang-dotnet=\"`Continuous`\" pulumi-lang-go=\"`continuous`\" pulumi-lang-python=\"`continuous`\" pulumi-lang-yaml=\"`continuous`\" pulumi-lang-java=\"`continuous`\" pulumi-lang-hcl=\"`continuous`\"\u003e`continuous`\u003c/span\u003e as follows:\n\n" }, "dbtTask": { "$ref": "#/types/databricks:index/JobDbtTask:JobDbtTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "deployment": { "$ref": "#/types/databricks:index/JobDeployment:JobDeployment" }, "description": { "type": "string", "description": "An optional description for the job. The maximum length is 1024 characters in UTF-8 encoding.\n" }, "editMode": { "type": "string", "description": "If `\"UI_LOCKED\"`, the user interface for the job will be locked. If `\"EDITABLE\"` (the default), the user interface will be editable.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/JobEmailNotifications:JobEmailNotifications", "description": "(List) An optional set of email addresses notified when runs of this job begins, completes or fails. The default behavior is to not send any emails. This field is a block and is documented below.\n" }, "environments": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobEnvironment:JobEnvironment" } }, "existingClusterId": { "type": "string" }, "format": { "type": "string" }, "gitSource": { "$ref": "#/types/databricks:index/JobGitSource:JobGitSource", "description": "Specifies the a Git repository for task source code. See\u003cspan pulumi-lang-nodejs=\" gitSource \" pulumi-lang-dotnet=\" GitSource \" pulumi-lang-go=\" gitSource \" pulumi-lang-python=\" git_source \" pulumi-lang-yaml=\" gitSource \" pulumi-lang-java=\" gitSource \" pulumi-lang-hcl=\" git_source \"\u003e gitSource \u003c/span\u003eConfiguration Block below.\n" }, "health": { "$ref": "#/types/databricks:index/JobHealth:JobHealth", "description": "An optional block that specifies the health conditions for the job documented below.\n" }, "jobClusters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobJobCluster:JobJobCluster" }, "description": "A list of job\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003especifications that can be shared and reused by tasks of this job. Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in task settings. *Multi-task syntax*\n" }, "libraries": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobLibrary:JobLibrary" }, "description": "(List) An optional list of libraries to be installed on the cluster that will execute the job. See library Configuration Block below.\n" }, "maxConcurrentRuns": { "type": "integer", "description": "(Integer) An optional maximum allowed number of concurrent runs of the job. Defaults to *1*.\n" }, "maxRetries": { "type": "integer", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "minRetryIntervalMillis": { "type": "integer", "description": "(Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.\n", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "name": { "type": "string", "description": "An optional name for the job. The default value is Untitled.\n" }, "newCluster": { "$ref": "#/types/databricks:index/JobNewCluster:JobNewCluster" }, "notebookTask": { "$ref": "#/types/databricks:index/JobNotebookTask:JobNotebookTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "notificationSettings": { "$ref": "#/types/databricks:index/JobNotificationSettings:JobNotificationSettings", "description": "An optional block controlling the notification settings on the job level documented below.\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobParameter:JobParameter" }, "description": "Specifies job parameter for the job. See parameter Configuration Block\n" }, "performanceTarget": { "type": "string", "description": "The performance mode on a serverless job. The performance target determines the level of compute performance or cost-efficiency for the run. Supported values are:\n* `PERFORMANCE_OPTIMIZED`: (default value) Prioritizes fast startup and execution times through rapid scaling and optimized cluster performance.\n* `STANDARD`: Enables cost-efficient execution of serverless workloads.\n" }, "pipelineTask": { "$ref": "#/types/databricks:index/JobPipelineTask:JobPipelineTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "providerConfig": { "$ref": "#/types/databricks:index/JobProviderConfig:JobProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "pythonWheelTask": { "$ref": "#/types/databricks:index/JobPythonWheelTask:JobPythonWheelTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "queue": { "$ref": "#/types/databricks:index/JobQueue:JobQueue", "description": "The queue status for the job. See queue Configuration Block below.\n" }, "retryOnTimeout": { "type": "boolean", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "runAs": { "$ref": "#/types/databricks:index/JobRunAs:JobRunAs", "description": "The user or the service principal the job runs as. See\u003cspan pulumi-lang-nodejs=\" runAs \" pulumi-lang-dotnet=\" RunAs \" pulumi-lang-go=\" runAs \" pulumi-lang-python=\" run_as \" pulumi-lang-yaml=\" runAs \" pulumi-lang-java=\" runAs \" pulumi-lang-hcl=\" run_as \"\u003e runAs \u003c/span\u003eConfiguration Block below.\n" }, "runJobTask": { "$ref": "#/types/databricks:index/JobRunJobTask:JobRunJobTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "schedule": { "$ref": "#/types/databricks:index/JobSchedule:JobSchedule", "description": "An optional periodic schedule for this job. The default behavior is that the job runs when triggered by clicking Run Now in the Jobs UI or sending an API request to runNow. See schedule Configuration Block below.\n" }, "sparkJarTask": { "$ref": "#/types/databricks:index/JobSparkJarTask:JobSparkJarTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "sparkPythonTask": { "$ref": "#/types/databricks:index/JobSparkPythonTask:JobSparkPythonTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "sparkSubmitTask": { "$ref": "#/types/databricks:index/JobSparkSubmitTask:JobSparkSubmitTask", "deprecationMessage": "should be used inside a task block and not inside a job block" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "An optional map of the tags associated with the job. See tags Configuration Map\n" }, "tasks": { "type": "array", "items": { "$ref": "#/types/databricks:index/JobTask:JobTask" }, "description": "A list of task specification that the job will execute. See task Configuration Block below.\n" }, "timeoutSeconds": { "type": "integer", "description": "(Integer) An optional timeout applied to each run of this job. The default behavior is to have no timeout.\n" }, "trigger": { "$ref": "#/types/databricks:index/JobTrigger:JobTrigger", "description": "The conditions that triggers the job to start. See trigger Configuration Block below.\n" }, "url": { "type": "string", "description": "URL of the job on the given workspace\n" }, "usagePolicyId": { "type": "string" }, "webhookNotifications": { "$ref": "#/types/databricks:index/JobWebhookNotifications:JobWebhookNotifications", "description": "(List) An optional set of system destinations (for example, webhook destinations or Slack) to be notified when runs of this job begins, completes or fails. The default behavior is to not send any notifications. This field is a block and is documented below.\n" } }, "type": "object" } }, "databricks:index/knowledgeAssistant:KnowledgeAssistant": { "description": "[![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/knowledgeassistants)\n\n", "properties": { "createTime": { "type": "string", "description": "(string) - Creation timestamp\n" }, "creator": { "type": "string", "description": "(string) - The creator of the Knowledge Assistant\n" }, "description": { "type": "string", "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "displayName": { "type": "string", "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "endpointName": { "type": "string", "description": "(string) - The name of the knowledge assistant agent endpoint\n" }, "errorInfo": { "type": "string", "description": "(string) - Error details when the Knowledge Assistant is in FAILED state\n" }, "experimentId": { "type": "string", "description": "(string) - The MLflow experiment ID\n" }, "instructions": { "type": "string", "description": "Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in\u003cspan pulumi-lang-nodejs=\" updateMask \" pulumi-lang-dotnet=\" UpdateMask \" pulumi-lang-go=\" updateMask \" pulumi-lang-python=\" update_mask \" pulumi-lang-yaml=\" updateMask \" pulumi-lang-java=\" updateMask \" pulumi-lang-hcl=\" update_mask \"\u003e updateMask \u003c/span\u003eto\nmodify it\n" }, "name": { "type": "string", "description": "(string) - The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/KnowledgeAssistantProviderConfig:KnowledgeAssistantProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "state": { "type": "string", "description": "(string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: `ACTIVE`, `CREATING`, `FAILED`\n" } }, "required": [ "createTime", "creator", "description", "displayName", "endpointName", "errorInfo", "experimentId", "name", "providerConfig", "state" ], "inputProperties": { "description": { "type": "string", "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "displayName": { "type": "string", "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "instructions": { "type": "string", "description": "Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in\u003cspan pulumi-lang-nodejs=\" updateMask \" pulumi-lang-dotnet=\" UpdateMask \" pulumi-lang-go=\" updateMask \" pulumi-lang-python=\" update_mask \" pulumi-lang-yaml=\" updateMask \" pulumi-lang-java=\" updateMask \" pulumi-lang-hcl=\" update_mask \"\u003e updateMask \u003c/span\u003eto\nmodify it\n" }, "providerConfig": { "$ref": "#/types/databricks:index/KnowledgeAssistantProviderConfig:KnowledgeAssistantProviderConfig", "description": "Configure the provider for management through account provider.\n" } }, "requiredInputs": [ "description", "displayName" ], "stateInputs": { "description": "Input properties used for looking up and filtering KnowledgeAssistant resources.\n", "properties": { "createTime": { "type": "string", "description": "(string) - Creation timestamp\n" }, "creator": { "type": "string", "description": "(string) - The creator of the Knowledge Assistant\n" }, "description": { "type": "string", "description": "Description of what this agent can do (user-facing).\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "displayName": { "type": "string", "description": "The display name of the Knowledge Assistant, unique at workspace level.\nRequired when creating a Knowledge Assistant.\nWhen updating a Knowledge Assistant, optional unless included in\nupdate_mask\n" }, "endpointName": { "type": "string", "description": "(string) - The name of the knowledge assistant agent endpoint\n" }, "errorInfo": { "type": "string", "description": "(string) - Error details when the Knowledge Assistant is in FAILED state\n" }, "experimentId": { "type": "string", "description": "(string) - The MLflow experiment ID\n" }, "instructions": { "type": "string", "description": "Additional global instructions on how the agent should generate answers.\nOptional on create and update.\nWhen updating a Knowledge Assistant, include this field in\u003cspan pulumi-lang-nodejs=\" updateMask \" pulumi-lang-dotnet=\" UpdateMask \" pulumi-lang-go=\" updateMask \" pulumi-lang-python=\" update_mask \" pulumi-lang-yaml=\" updateMask \" pulumi-lang-java=\" updateMask \" pulumi-lang-hcl=\" update_mask \"\u003e updateMask \u003c/span\u003eto\nmodify it\n" }, "name": { "type": "string", "description": "(string) - The resource name of the Knowledge Assistant.\nFormat: knowledge-assistants/{knowledge_assistant_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/KnowledgeAssistantProviderConfig:KnowledgeAssistantProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "state": { "type": "string", "description": "(string) - State of the Knowledge Assistant. Not returned in List responses. Possible values are: `ACTIVE`, `CREATING`, `FAILED`\n" } }, "type": "object" } }, "databricks:index/knowledgeAssistantKnowledgeSource:KnowledgeAssistantKnowledgeSource": { "description": "[![Public Beta](https://img.shields.io/badge/Release_Stage-Public_Beta-orange)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n[API Documentation](https://docs.databricks.com/api/workspace/knowledgeassistants)\n\n", "properties": { "createTime": { "type": "string", "description": "(string) - Timestamp when this knowledge source was created\n" }, "description": { "type": "string", "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "displayName": { "type": "string", "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "fileTable": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceFileTable:KnowledgeAssistantKnowledgeSourceFileTable" }, "files": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceFiles:KnowledgeAssistantKnowledgeSourceFiles" }, "index": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceIndex:KnowledgeAssistantKnowledgeSourceIndex" }, "knowledgeCutoffTime": { "type": "string", "description": "(string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested\n" }, "name": { "type": "string", "description": "(string) - Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}\n" }, "parent": { "type": "string", "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceProviderConfig:KnowledgeAssistantKnowledgeSourceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "The type of the source: \"index\", \"files\", or \u003cspan pulumi-lang-nodejs=\"\"fileTable\"\" pulumi-lang-dotnet=\"\"FileTable\"\" pulumi-lang-go=\"\"fileTable\"\" pulumi-lang-python=\"\"file_table\"\" pulumi-lang-yaml=\"\"fileTable\"\" pulumi-lang-java=\"\"fileTable\"\" pulumi-lang-hcl=\"\"file_table\"\"\u003e\"fileTable\"\u003c/span\u003e.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored\n" }, "state": { "type": "string", "description": "(string) - Possible values are: `FAILED_UPDATE`, `UPDATED`, `UPDATING`\n" } }, "required": [ "createTime", "description", "displayName", "knowledgeCutoffTime", "name", "parent", "providerConfig", "sourceType", "state" ], "inputProperties": { "description": { "type": "string", "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "displayName": { "type": "string", "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "fileTable": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceFileTable:KnowledgeAssistantKnowledgeSourceFileTable" }, "files": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceFiles:KnowledgeAssistantKnowledgeSourceFiles" }, "index": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceIndex:KnowledgeAssistantKnowledgeSourceIndex" }, "parent": { "type": "string", "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceProviderConfig:KnowledgeAssistantKnowledgeSourceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "The type of the source: \"index\", \"files\", or \u003cspan pulumi-lang-nodejs=\"\"fileTable\"\" pulumi-lang-dotnet=\"\"FileTable\"\" pulumi-lang-go=\"\"fileTable\"\" pulumi-lang-python=\"\"file_table\"\" pulumi-lang-yaml=\"\"fileTable\"\" pulumi-lang-java=\"\"fileTable\"\" pulumi-lang-hcl=\"\"file_table\"\"\u003e\"fileTable\"\u003c/span\u003e.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored\n" } }, "requiredInputs": [ "description", "displayName", "parent", "sourceType" ], "stateInputs": { "description": "Input properties used for looking up and filtering KnowledgeAssistantKnowledgeSource resources.\n", "properties": { "createTime": { "type": "string", "description": "(string) - Timestamp when this knowledge source was created\n" }, "description": { "type": "string", "description": "Description of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "displayName": { "type": "string", "description": "Human-readable display name of the knowledge source.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, optional unless included in update_mask\n" }, "fileTable": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceFileTable:KnowledgeAssistantKnowledgeSourceFileTable" }, "files": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceFiles:KnowledgeAssistantKnowledgeSourceFiles" }, "index": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceIndex:KnowledgeAssistantKnowledgeSourceIndex" }, "knowledgeCutoffTime": { "type": "string", "description": "(string) - Timestamp representing the cutoff before which content in this knowledge source is being ingested\n" }, "name": { "type": "string", "description": "(string) - Full resource name:\nknowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}\n" }, "parent": { "type": "string", "description": "Parent resource where this source will be created.\nFormat: knowledge-assistants/{knowledge_assistant_id}\n" }, "providerConfig": { "$ref": "#/types/databricks:index/KnowledgeAssistantKnowledgeSourceProviderConfig:KnowledgeAssistantKnowledgeSourceProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "sourceType": { "type": "string", "description": "The type of the source: \"index\", \"files\", or \u003cspan pulumi-lang-nodejs=\"\"fileTable\"\" pulumi-lang-dotnet=\"\"FileTable\"\" pulumi-lang-go=\"\"fileTable\"\" pulumi-lang-python=\"\"file_table\"\" pulumi-lang-yaml=\"\"fileTable\"\" pulumi-lang-java=\"\"fileTable\"\" pulumi-lang-hcl=\"\"file_table\"\"\u003e\"fileTable\"\u003c/span\u003e.\nRequired when creating a Knowledge Source.\nWhen updating a Knowledge Source, this field is ignored\n" }, "state": { "type": "string", "description": "(string) - Possible values are: `FAILED_UPDATE`, `UPDATED`, `UPDATING`\n" } }, "type": "object" } }, "databricks:index/lakehouseMonitor:LakehouseMonitor": { "description": "\u003e This resource has been deprecated and will be removed soon. Please use the\u003cspan pulumi-lang-nodejs=\" databricks.QualityMonitor \" pulumi-lang-dotnet=\" databricks.QualityMonitor \" pulumi-lang-go=\" QualityMonitor \" pulumi-lang-python=\" QualityMonitor \" pulumi-lang-yaml=\" databricks.QualityMonitor \" pulumi-lang-java=\" databricks.QualityMonitor \" pulumi-lang-hcl=\" databricks_quality_monitor \"\u003e databricks.QualityMonitor \u003c/span\u003eresource instead.\n\nThis resource allows you to manage [Lakehouse Monitors](https://docs.databricks.com/en/lakehouse-monitoring/index.html) in Databricks. \n\nA \u003cspan pulumi-lang-nodejs=\"`databricks.LakehouseMonitor`\" pulumi-lang-dotnet=\"`databricks.LakehouseMonitor`\" pulumi-lang-go=\"`LakehouseMonitor`\" pulumi-lang-python=\"`LakehouseMonitor`\" pulumi-lang-yaml=\"`databricks.LakehouseMonitor`\" pulumi-lang-java=\"`databricks.LakehouseMonitor`\" pulumi-lang-hcl=\"`databricks_lakehouse_monitor`\"\u003e`databricks.LakehouseMonitor`\u003c/span\u003e is attached to a\u003cspan pulumi-lang-nodejs=\" databricks.SqlTable \" pulumi-lang-dotnet=\" databricks.SqlTable \" pulumi-lang-go=\" SqlTable \" pulumi-lang-python=\" SqlTable \" pulumi-lang-yaml=\" databricks.SqlTable \" pulumi-lang-java=\" databricks.SqlTable \" pulumi-lang-hcl=\" databricks_sql_table \"\u003e databricks.SqlTable \u003c/span\u003eand can be of type timeseries, snapshot or inference. \n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sandbox = new databricks.Catalog(\"sandbox\", {\n name: \"sandbox\",\n comment: \"this catalog is managed by terraform\",\n properties: {\n purpose: \"testing\",\n },\n});\nconst things = new databricks.Schema(\"things\", {\n catalogName: sandbox.id,\n name: \"things\",\n comment: \"this database is managed by terraform\",\n properties: {\n kind: \"various\",\n },\n});\nconst myTestTable = new databricks.SqlTable(\"myTestTable\", {\n catalogName: \"main\",\n schemaName: things.name,\n name: \"bar\",\n tableType: \"MANAGED\",\n dataSourceFormat: \"DELTA\",\n columns: [{\n name: \"timestamp\",\n type: \"int\",\n }],\n});\nconst testTimeseriesMonitor = new databricks.LakehouseMonitor(\"testTimeseriesMonitor\", {\n tableName: pulumi.interpolate`${sandbox.name}.${things.name}.${myTestTable.name}`,\n assetsDir: pulumi.interpolate`/Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}`,\n outputSchemaName: pulumi.interpolate`${sandbox.name}.${things.name}`,\n timeSeries: {\n granularities: [\"1 hour\"],\n timestampCol: \"timestamp\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsandbox = databricks.Catalog(\"sandbox\",\n name=\"sandbox\",\n comment=\"this catalog is managed by terraform\",\n properties={\n \"purpose\": \"testing\",\n })\nthings = databricks.Schema(\"things\",\n catalog_name=sandbox.id,\n name=\"things\",\n comment=\"this database is managed by terraform\",\n properties={\n \"kind\": \"various\",\n })\nmy_test_table = databricks.SqlTable(\"myTestTable\",\n catalog_name=\"main\",\n schema_name=things.name,\n name=\"bar\",\n table_type=\"MANAGED\",\n data_source_format=\"DELTA\",\n columns=[{\n \"name\": \"timestamp\",\n \"type\": \"int\",\n }])\ntest_timeseries_monitor = databricks.LakehouseMonitor(\"testTimeseriesMonitor\",\n table_name=pulumi.Output.all(\n sandboxName=sandbox.name,\n thingsName=things.name,\n myTestTableName=my_test_table.name\n).apply(lambda resolved_outputs: f\"{resolved_outputs['sandboxName']}.{resolved_outputs['thingsName']}.{resolved_outputs['myTestTableName']}\")\n,\n assets_dir=my_test_table.name.apply(lambda name: f\"/Shared/provider-test/databricks_lakehouse_monitoring/{name}\"),\n output_schema_name=pulumi.Output.all(\n sandboxName=sandbox.name,\n thingsName=things.name\n).apply(lambda resolved_outputs: f\"{resolved_outputs['sandboxName']}.{resolved_outputs['thingsName']}\")\n,\n time_series={\n \"granularities\": [\"1 hour\"],\n \"timestamp_col\": \"timestamp\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sandbox = new Databricks.Catalog(\"sandbox\", new()\n {\n Name = \"sandbox\",\n Comment = \"this catalog is managed by terraform\",\n Properties = \n {\n { \"purpose\", \"testing\" },\n },\n });\n\n var things = new Databricks.Schema(\"things\", new()\n {\n CatalogName = sandbox.Id,\n Name = \"things\",\n Comment = \"this database is managed by terraform\",\n Properties = \n {\n { \"kind\", \"various\" },\n },\n });\n\n var myTestTable = new Databricks.SqlTable(\"myTestTable\", new()\n {\n CatalogName = \"main\",\n SchemaName = things.Name,\n Name = \"bar\",\n TableType = \"MANAGED\",\n DataSourceFormat = \"DELTA\",\n Columns = new[]\n {\n new Databricks.Inputs.SqlTableColumnArgs\n {\n Name = \"timestamp\",\n Type = \"int\",\n },\n },\n });\n\n var testTimeseriesMonitor = new Databricks.LakehouseMonitor(\"testTimeseriesMonitor\", new()\n {\n TableName = Output.Tuple(sandbox.Name, things.Name, myTestTable.Name).Apply(values =\u003e\n {\n var sandboxName = values.Item1;\n var thingsName = values.Item2;\n var myTestTableName = values.Item3;\n return $\"{sandboxName}.{thingsName}.{myTestTableName}\";\n }),\n AssetsDir = myTestTable.Name.Apply(name =\u003e $\"/Shared/provider-test/databricks_lakehouse_monitoring/{name}\"),\n OutputSchemaName = Output.Tuple(sandbox.Name, things.Name).Apply(values =\u003e\n {\n var sandboxName = values.Item1;\n var thingsName = values.Item2;\n return $\"{sandboxName}.{thingsName}\";\n }),\n TimeSeries = new Databricks.Inputs.LakehouseMonitorTimeSeriesArgs\n {\n Granularities = new[]\n {\n \"1 hour\",\n },\n TimestampCol = \"timestamp\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsandbox, err := databricks.NewCatalog(ctx, \"sandbox\", \u0026databricks.CatalogArgs{\n\t\t\tName: pulumi.String(\"sandbox\"),\n\t\t\tComment: pulumi.String(\"this catalog is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"purpose\": pulumi.String(\"testing\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthings, err := databricks.NewSchema(ctx, \"things\", \u0026databricks.SchemaArgs{\n\t\t\tCatalogName: sandbox.ID(),\n\t\t\tName: pulumi.String(\"things\"),\n\t\t\tComment: pulumi.String(\"this database is managed by terraform\"),\n\t\t\tProperties: pulumi.StringMap{\n\t\t\t\t\"kind\": pulumi.String(\"various\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmyTestTable, err := databricks.NewSqlTable(ctx, \"myTestTable\", \u0026databricks.SqlTableArgs{\n\t\t\tCatalogName: pulumi.String(\"main\"),\n\t\t\tSchemaName: things.Name,\n\t\t\tName: pulumi.String(\"bar\"),\n\t\t\tTableType: pulumi.String(\"MANAGED\"),\n\t\t\tDataSourceFormat: pulumi.String(\"DELTA\"),\n\t\t\tColumns: databricks.SqlTableColumnArray{\n\t\t\t\t\u0026databricks.SqlTableColumnArgs{\n\t\t\t\t\tName: pulumi.String(\"timestamp\"),\n\t\t\t\t\tType: pulumi.String(\"int\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewLakehouseMonitor(ctx, \"testTimeseriesMonitor\", \u0026databricks.LakehouseMonitorArgs{\n\t\t\tTableName: pulumi.All(sandbox.Name, things.Name, myTestTable.Name).ApplyT(func(_args []interface{}) (string, error) {\n\t\t\t\tsandboxName := _args[0].(string)\n\t\t\t\tthingsName := _args[1].(string)\n\t\t\t\tmyTestTableName := _args[2].(string)\n\t\t\t\treturn fmt.Sprintf(\"%v.%v.%v\", sandboxName, thingsName, myTestTableName), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tAssetsDir: myTestTable.Name.ApplyT(func(name string) (string, error) {\n\t\t\t\treturn fmt.Sprintf(\"/Shared/provider-test/databricks_lakehouse_monitoring/%v\", name), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tOutputSchemaName: pulumi.All(sandbox.Name, things.Name).ApplyT(func(_args []interface{}) (string, error) {\n\t\t\t\tsandboxName := _args[0].(string)\n\t\t\t\tthingsName := _args[1].(string)\n\t\t\t\treturn fmt.Sprintf(\"%v.%v\", sandboxName, thingsName), nil\n\t\t\t}).(pulumi.StringOutput),\n\t\t\tTimeSeries: \u0026databricks.LakehouseMonitorTimeSeriesArgs{\n\t\t\t\tGranularities: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"1 hour\"),\n\t\t\t\t},\n\t\t\t\tTimestampCol: pulumi.String(\"timestamp\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_catalog\" \"sandbox\" {\n name = \"sandbox\"\n comment = \"this catalog is managed by terraform\"\n properties = {\n \"purpose\" = \"testing\"\n }\n}\nresource \"databricks_schema\" \"things\" {\n catalog_name = databricks_catalog.sandbox.id\n name = \"things\"\n comment = \"this database is managed by terraform\"\n properties = {\n \"kind\" = \"various\"\n }\n}\nresource \"databricks_sqltable\" \"myTestTable\" {\n catalog_name = \"main\"\n schema_name = databricks_schema.things.name\n name = \"bar\"\n table_type = \"MANAGED\"\n data_source_format = \"DELTA\"\n columns {\n name = \"timestamp\"\n type = \"int\"\n }\n}\nresource \"databricks_lakehousemonitor\" \"testTimeseriesMonitor\" {\n table_name =\"${databricks_catalog.sandbox.name}.${databricks_schema.things.name}.${databricks_sqltable.myTestTable.name}\"\n assets_dir =\"/Shared/provider-test/databricks_lakehouse_monitoring/${databricks_sqltable.myTestTable.name}\"\n output_schema_name =\"${databricks_catalog.sandbox.name}.${databricks_schema.things.name}\"\n time_series = {\n granularities = [\"1 hour\"]\n timestamp_col = \"timestamp\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Catalog;\nimport com.pulumi.databricks.CatalogArgs;\nimport com.pulumi.databricks.Schema;\nimport com.pulumi.databricks.SchemaArgs;\nimport com.pulumi.databricks.SqlTable;\nimport com.pulumi.databricks.SqlTableArgs;\nimport com.pulumi.databricks.inputs.SqlTableColumnArgs;\nimport com.pulumi.databricks.LakehouseMonitor;\nimport com.pulumi.databricks.LakehouseMonitorArgs;\nimport com.pulumi.databricks.inputs.LakehouseMonitorTimeSeriesArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sandbox = new Catalog(\"sandbox\", CatalogArgs.builder()\n .name(\"sandbox\")\n .comment(\"this catalog is managed by terraform\")\n .properties(Map.of(\"purpose\", \"testing\"))\n .build());\n\n var things = new Schema(\"things\", SchemaArgs.builder()\n .catalogName(sandbox.id())\n .name(\"things\")\n .comment(\"this database is managed by terraform\")\n .properties(Map.of(\"kind\", \"various\"))\n .build());\n\n var myTestTable = new SqlTable(\"myTestTable\", SqlTableArgs.builder()\n .catalogName(\"main\")\n .schemaName(things.name())\n .name(\"bar\")\n .tableType(\"MANAGED\")\n .dataSourceFormat(\"DELTA\")\n .columns(SqlTableColumnArgs.builder()\n .name(\"timestamp\")\n .type(\"int\")\n .build())\n .build());\n\n var testTimeseriesMonitor = new LakehouseMonitor(\"testTimeseriesMonitor\", LakehouseMonitorArgs.builder()\n .tableName(Output.tuple(sandbox.name(), things.name(), myTestTable.name()).applyValue(values -\u003e {\n var sandboxName = values.t1;\n var thingsName = values.t2;\n var myTestTableName = values.t3;\n return String.format(\"%s.%s.%s\", sandboxName,thingsName,myTestTableName);\n }))\n .assetsDir(myTestTable.name().applyValue(_name -\u003e String.format(\"/Shared/provider-test/databricks_lakehouse_monitoring/%s\", _name)))\n .outputSchemaName(Output.tuple(sandbox.name(), things.name()).applyValue(values -\u003e {\n var sandboxName = values.t1;\n var thingsName = values.t2;\n return String.format(\"%s.%s\", sandboxName,thingsName);\n }))\n .timeSeries(LakehouseMonitorTimeSeriesArgs.builder()\n .granularities(\"1 hour\")\n .timestampCol(\"timestamp\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sandbox:\n type: databricks:Catalog\n properties:\n name: sandbox\n comment: this catalog is managed by terraform\n properties:\n purpose: testing\n things:\n type: databricks:Schema\n properties:\n catalogName: ${sandbox.id}\n name: things\n comment: this database is managed by terraform\n properties:\n kind: various\n myTestTable:\n type: databricks:SqlTable\n properties:\n catalogName: main\n schemaName: ${things.name}\n name: bar\n tableType: MANAGED\n dataSourceFormat: DELTA\n columns:\n - name: timestamp\n type: int\n testTimeseriesMonitor:\n type: databricks:LakehouseMonitor\n properties:\n tableName: ${sandbox.name}.${things.name}.${myTestTable.name}\n assetsDir: /Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}\n outputSchemaName: ${sandbox.name}.${things.name}\n timeSeries:\n granularities:\n - 1 hour\n timestampCol: timestamp\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Inference Monitor\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst testMonitorInference = new databricks.LakehouseMonitor(\"testMonitorInference\", {\n tableName: `${sandbox.name}.${things.name}.${myTestTable.name}`,\n assetsDir: `/Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}`,\n outputSchemaName: `${sandbox.name}.${things.name}`,\n inferenceLog: {\n granularities: [\"1 hour\"],\n timestampCol: \"timestamp\",\n predictionCol: \"prediction\",\n modelIdCol: \"model_id\",\n problemType: \"PROBLEM_TYPE_REGRESSION\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ntest_monitor_inference = databricks.LakehouseMonitor(\"testMonitorInference\",\n table_name=f\"{sandbox['name']}.{things['name']}.{my_test_table['name']}\",\n assets_dir=f\"/Shared/provider-test/databricks_lakehouse_monitoring/{my_test_table['name']}\",\n output_schema_name=f\"{sandbox['name']}.{things['name']}\",\n inference_log={\n \"granularities\": [\"1 hour\"],\n \"timestamp_col\": \"timestamp\",\n \"prediction_col\": \"prediction\",\n \"model_id_col\": \"model_id\",\n \"problem_type\": \"PROBLEM_TYPE_REGRESSION\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var testMonitorInference = new Databricks.LakehouseMonitor(\"testMonitorInference\", new()\n {\n TableName = $\"{sandbox.Name}.{things.Name}.{myTestTable.Name}\",\n AssetsDir = $\"/Shared/provider-test/databricks_lakehouse_monitoring/{myTestTable.Name}\",\n OutputSchemaName = $\"{sandbox.Name}.{things.Name}\",\n InferenceLog = new Databricks.Inputs.LakehouseMonitorInferenceLogArgs\n {\n Granularities = new[]\n {\n \"1 hour\",\n },\n TimestampCol = \"timestamp\",\n PredictionCol = \"prediction\",\n ModelIdCol = \"model_id\",\n ProblemType = \"PROBLEM_TYPE_REGRESSION\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewLakehouseMonitor(ctx, \"testMonitorInference\", \u0026databricks.LakehouseMonitorArgs{\n\t\t\tTableName: pulumi.Sprintf(\"%v.%v.%v\", sandbox.Name, things.Name, myTestTable.Name),\n\t\t\tAssetsDir: pulumi.Sprintf(\"/Shared/provider-test/databricks_lakehouse_monitoring/%v\", myTestTable.Name),\n\t\t\tOutputSchemaName: pulumi.Sprintf(\"%v.%v\", sandbox.Name, things.Name),\n\t\t\tInferenceLog: \u0026databricks.LakehouseMonitorInferenceLogArgs{\n\t\t\t\tGranularities: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"1 hour\"),\n\t\t\t\t},\n\t\t\t\tTimestampCol: pulumi.String(\"timestamp\"),\n\t\t\t\tPredictionCol: pulumi.String(\"prediction\"),\n\t\t\t\tModelIdCol: pulumi.String(\"model_id\"),\n\t\t\t\tProblemType: pulumi.String(\"PROBLEM_TYPE_REGRESSION\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_lakehousemonitor\" \"testMonitorInference\" {\n table_name =\"${sandbox.name}.${things.name}.${myTestTable.name}\"\n assets_dir =\"/Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}\"\n output_schema_name =\"${sandbox.name}.${things.name}\"\n inference_log = {\n granularities = [\"1 hour\"]\n timestamp_col = \"timestamp\"\n prediction_col = \"prediction\"\n model_id_col = \"model_id\"\n problem_type = \"PROBLEM_TYPE_REGRESSION\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.LakehouseMonitor;\nimport com.pulumi.databricks.LakehouseMonitorArgs;\nimport com.pulumi.databricks.inputs.LakehouseMonitorInferenceLogArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var testMonitorInference = new LakehouseMonitor(\"testMonitorInference\", LakehouseMonitorArgs.builder()\n .tableName(String.format(\"%s.%s.%s\", sandbox.name(),things.name(),myTestTable.name()))\n .assetsDir(String.format(\"/Shared/provider-test/databricks_lakehouse_monitoring/%s\", myTestTable.name()))\n .outputSchemaName(String.format(\"%s.%s\", sandbox.name(),things.name()))\n .inferenceLog(LakehouseMonitorInferenceLogArgs.builder()\n .granularities(\"1 hour\")\n .timestampCol(\"timestamp\")\n .predictionCol(\"prediction\")\n .modelIdCol(\"model_id\")\n .problemType(\"PROBLEM_TYPE_REGRESSION\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n testMonitorInference:\n type: databricks:LakehouseMonitor\n properties:\n tableName: ${sandbox.name}.${things.name}.${myTestTable.name}\n assetsDir: /Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}\n outputSchemaName: ${sandbox.name}.${things.name}\n inferenceLog:\n granularities:\n - 1 hour\n timestampCol: timestamp\n predictionCol: prediction\n modelIdCol: model_id\n problemType: PROBLEM_TYPE_REGRESSION\n```\n\u003c!--End PulumiCodeChooser --\u003e\n### Snapshot Monitor\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst testMonitorInference = new databricks.LakehouseMonitor(\"testMonitorInference\", {\n tableName: `${sandbox.name}.${things.name}.${myTestTable.name}`,\n assetsDir: `/Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}`,\n outputSchemaName: `${sandbox.name}.${things.name}`,\n snapshot: {},\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ntest_monitor_inference = databricks.LakehouseMonitor(\"testMonitorInference\",\n table_name=f\"{sandbox['name']}.{things['name']}.{my_test_table['name']}\",\n assets_dir=f\"/Shared/provider-test/databricks_lakehouse_monitoring/{my_test_table['name']}\",\n output_schema_name=f\"{sandbox['name']}.{things['name']}\",\n snapshot={})\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var testMonitorInference = new Databricks.LakehouseMonitor(\"testMonitorInference\", new()\n {\n TableName = $\"{sandbox.Name}.{things.Name}.{myTestTable.Name}\",\n AssetsDir = $\"/Shared/provider-test/databricks_lakehouse_monitoring/{myTestTable.Name}\",\n OutputSchemaName = $\"{sandbox.Name}.{things.Name}\",\n Snapshot = null,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewLakehouseMonitor(ctx, \"testMonitorInference\", \u0026databricks.LakehouseMonitorArgs{\n\t\t\tTableName: pulumi.Sprintf(\"%v.%v.%v\", sandbox.Name, things.Name, myTestTable.Name),\n\t\t\tAssetsDir: pulumi.Sprintf(\"/Shared/provider-test/databricks_lakehouse_monitoring/%v\", myTestTable.Name),\n\t\t\tOutputSchemaName: pulumi.Sprintf(\"%v.%v\", sandbox.Name, things.Name),\n\t\t\tSnapshot: \u0026databricks.LakehouseMonitorSnapshotArgs{},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_lakehousemonitor\" \"testMonitorInference\" {\n table_name =\"${sandbox.name}.${things.name}.${myTestTable.name}\"\n assets_dir =\"/Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}\"\n output_schema_name =\"${sandbox.name}.${things.name}\"\n snapshot = {}\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.LakehouseMonitor;\nimport com.pulumi.databricks.LakehouseMonitorArgs;\nimport com.pulumi.databricks.inputs.LakehouseMonitorSnapshotArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var testMonitorInference = new LakehouseMonitor(\"testMonitorInference\", LakehouseMonitorArgs.builder()\n .tableName(String.format(\"%s.%s.%s\", sandbox.name(),things.name(),myTestTable.name()))\n .assetsDir(String.format(\"/Shared/provider-test/databricks_lakehouse_monitoring/%s\", myTestTable.name()))\n .outputSchemaName(String.format(\"%s.%s\", sandbox.name(),things.name()))\n .snapshot(LakehouseMonitorSnapshotArgs.builder()\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n testMonitorInference:\n type: databricks:LakehouseMonitor\n properties:\n tableName: ${sandbox.name}.${things.name}.${myTestTable.name}\n assetsDir: /Shared/provider-test/databricks_lakehouse_monitoring/${myTestTable.name}\n outputSchemaName: ${sandbox.name}.${things.name}\n snapshot: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Catalog\n\" pulumi-lang-dotnet=\" databricks.Catalog\n\" pulumi-lang-go=\" Catalog\n\" pulumi-lang-python=\" Catalog\n\" pulumi-lang-yaml=\" databricks.Catalog\n\" pulumi-lang-java=\" databricks.Catalog\n\" pulumi-lang-hcl=\" databricks_catalog\n\"\u003e databricks.Catalog\n\u003c/span\u003e*\u003cspan pulumi-lang-nodejs=\" databricks.Schema\n\" pulumi-lang-dotnet=\" databricks.Schema\n\" pulumi-lang-go=\" Schema\n\" pulumi-lang-python=\" Schema\n\" pulumi-lang-yaml=\" databricks.Schema\n\" pulumi-lang-java=\" databricks.Schema\n\" pulumi-lang-hcl=\" databricks_schema\n\"\u003e databricks.Schema\n\u003c/span\u003e*\u003cspan pulumi-lang-nodejs=\" databricks.SqlTable\n\" pulumi-lang-dotnet=\" databricks.SqlTable\n\" pulumi-lang-go=\" SqlTable\n\" pulumi-lang-python=\" SqlTable\n\" pulumi-lang-yaml=\" databricks.SqlTable\n\" pulumi-lang-java=\" databricks.SqlTable\n\" pulumi-lang-hcl=\" databricks_sql_table\n\"\u003e databricks.SqlTable\n\u003c/span\u003e\n", "properties": { "assetsDir": { "type": "string", "description": "The directory to store the monitoring assets (Eg. Dashboard and Metric Tables)\n" }, "baselineTableName": { "type": "string", "description": "Name of the baseline table from which drift metrics are computed from.Columns in the monitored table should also be present in the baseline\ntable.\n" }, "customMetrics": { "type": "array", "items": { "$ref": "#/types/databricks:index/LakehouseMonitorCustomMetric:LakehouseMonitorCustomMetric" }, "description": "Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).\n" }, "dashboardId": { "type": "string", "description": "The ID of the generated dashboard.\n" }, "dataClassificationConfig": { "$ref": "#/types/databricks:index/LakehouseMonitorDataClassificationConfig:LakehouseMonitorDataClassificationConfig", "description": "The data classification config for the monitor\n" }, "driftMetricsTableName": { "type": "string", "description": "The full name of the drift metrics table. Format: __catalog_name__.__schema_name__.__table_name__.\n" }, "inferenceLog": { "$ref": "#/types/databricks:index/LakehouseMonitorInferenceLog:LakehouseMonitorInferenceLog", "description": "Configuration for the inference log monitor\n" }, "latestMonitorFailureMsg": { "type": "string" }, "monitorVersion": { "type": "integer", "description": "The version of the monitor config (e.g. 1,2,3). If negative, the monitor may be corrupted\n" }, "notifications": { "$ref": "#/types/databricks:index/LakehouseMonitorNotifications:LakehouseMonitorNotifications", "description": "The notification settings for the monitor. The following optional blocks are supported, each consisting of the single string array field with name \u003cspan pulumi-lang-nodejs=\"`emailAddresses`\" pulumi-lang-dotnet=\"`EmailAddresses`\" pulumi-lang-go=\"`emailAddresses`\" pulumi-lang-python=\"`email_addresses`\" pulumi-lang-yaml=\"`emailAddresses`\" pulumi-lang-java=\"`emailAddresses`\" pulumi-lang-hcl=\"`email_addresses`\"\u003e`emailAddresses`\u003c/span\u003e containing a list of emails to notify:\n" }, "outputSchemaName": { "type": "string", "description": "Schema where output metric tables are created\n" }, "profileMetricsTableName": { "type": "string", "description": "The full name of the profile metrics table. Format: __catalog_name__.__schema_name__.__table_name__.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/LakehouseMonitorProviderConfig:LakehouseMonitorProviderConfig" }, "schedule": { "$ref": "#/types/databricks:index/LakehouseMonitorSchedule:LakehouseMonitorSchedule", "description": "The schedule for automatically updating and refreshing metric tables. This block consists of following fields:\n" }, "skipBuiltinDashboard": { "type": "boolean", "description": "Whether to skip creating a default dashboard summarizing data quality metrics.\n" }, "slicingExprs": { "type": "array", "items": { "type": "string" }, "description": "List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.\n" }, "snapshot": { "$ref": "#/types/databricks:index/LakehouseMonitorSnapshot:LakehouseMonitorSnapshot", "description": "Configuration for monitoring snapshot tables.\n" }, "status": { "type": "string", "description": "Status of the Monitor\n" }, "tableName": { "type": "string", "description": "The full name of the table to attach the monitor too. Its of the format {catalog}.{schema}.{tableName}\n" }, "timeSeries": { "$ref": "#/types/databricks:index/LakehouseMonitorTimeSeries:LakehouseMonitorTimeSeries", "description": "Configuration for monitoring timeseries tables.\n" }, "warehouseId": { "type": "string", "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running warehouse will be used.\n" } }, "required": [ "assetsDir", "dashboardId", "driftMetricsTableName", "monitorVersion", "outputSchemaName", "profileMetricsTableName", "providerConfig", "status", "tableName" ], "inputProperties": { "assetsDir": { "type": "string", "description": "The directory to store the monitoring assets (Eg. Dashboard and Metric Tables)\n" }, "baselineTableName": { "type": "string", "description": "Name of the baseline table from which drift metrics are computed from.Columns in the monitored table should also be present in the baseline\ntable.\n" }, "customMetrics": { "type": "array", "items": { "$ref": "#/types/databricks:index/LakehouseMonitorCustomMetric:LakehouseMonitorCustomMetric" }, "description": "Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).\n" }, "dataClassificationConfig": { "$ref": "#/types/databricks:index/LakehouseMonitorDataClassificationConfig:LakehouseMonitorDataClassificationConfig", "description": "The data classification config for the monitor\n" }, "inferenceLog": { "$ref": "#/types/databricks:index/LakehouseMonitorInferenceLog:LakehouseMonitorInferenceLog", "description": "Configuration for the inference log monitor\n" }, "latestMonitorFailureMsg": { "type": "string" }, "notifications": { "$ref": "#/types/databricks:index/LakehouseMonitorNotifications:LakehouseMonitorNotifications", "description": "The notification settings for the monitor. The following optional blocks are supported, each consisting of the single string array field with name \u003cspan pulumi-lang-nodejs=\"`emailAddresses`\" pulumi-lang-dotnet=\"`EmailAddresses`\" pulumi-lang-go=\"`emailAddresses`\" pulumi-lang-python=\"`email_addresses`\" pulumi-lang-yaml=\"`emailAddresses`\" pulumi-lang-java=\"`emailAddresses`\" pulumi-lang-hcl=\"`email_addresses`\"\u003e`emailAddresses`\u003c/span\u003e containing a list of emails to notify:\n" }, "outputSchemaName": { "type": "string", "description": "Schema where output metric tables are created\n" }, "providerConfig": { "$ref": "#/types/databricks:index/LakehouseMonitorProviderConfig:LakehouseMonitorProviderConfig" }, "schedule": { "$ref": "#/types/databricks:index/LakehouseMonitorSchedule:LakehouseMonitorSchedule", "description": "The schedule for automatically updating and refreshing metric tables. This block consists of following fields:\n" }, "skipBuiltinDashboard": { "type": "boolean", "description": "Whether to skip creating a default dashboard summarizing data quality metrics.\n" }, "slicingExprs": { "type": "array", "items": { "type": "string" }, "description": "List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.\n" }, "snapshot": { "$ref": "#/types/databricks:index/LakehouseMonitorSnapshot:LakehouseMonitorSnapshot", "description": "Configuration for monitoring snapshot tables.\n" }, "tableName": { "type": "string", "description": "The full name of the table to attach the monitor too. Its of the format {catalog}.{schema}.{tableName}\n" }, "timeSeries": { "$ref": "#/types/databricks:index/LakehouseMonitorTimeSeries:LakehouseMonitorTimeSeries", "description": "Configuration for monitoring timeseries tables.\n" }, "warehouseId": { "type": "string", "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running warehouse will be used.\n" } }, "requiredInputs": [ "assetsDir", "outputSchemaName", "tableName" ], "stateInputs": { "description": "Input properties used for looking up and filtering LakehouseMonitor resources.\n", "properties": { "assetsDir": { "type": "string", "description": "The directory to store the monitoring assets (Eg. Dashboard and Metric Tables)\n" }, "baselineTableName": { "type": "string", "description": "Name of the baseline table from which drift metrics are computed from.Columns in the monitored table should also be present in the baseline\ntable.\n" }, "customMetrics": { "type": "array", "items": { "$ref": "#/types/databricks:index/LakehouseMonitorCustomMetric:LakehouseMonitorCustomMetric" }, "description": "Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).\n" }, "dashboardId": { "type": "string", "description": "The ID of the generated dashboard.\n" }, "dataClassificationConfig": { "$ref": "#/types/databricks:index/LakehouseMonitorDataClassificationConfig:LakehouseMonitorDataClassificationConfig", "description": "The data classification config for the monitor\n" }, "driftMetricsTableName": { "type": "string", "description": "The full name of the drift metrics table. Format: __catalog_name__.__schema_name__.__table_name__.\n" }, "inferenceLog": { "$ref": "#/types/databricks:index/LakehouseMonitorInferenceLog:LakehouseMonitorInferenceLog", "description": "Configuration for the inference log monitor\n" }, "latestMonitorFailureMsg": { "type": "string" }, "monitorVersion": { "type": "integer", "description": "The version of the monitor config (e.g. 1,2,3). If negative, the monitor may be corrupted\n" }, "notifications": { "$ref": "#/types/databricks:index/LakehouseMonitorNotifications:LakehouseMonitorNotifications", "description": "The notification settings for the monitor. The following optional blocks are supported, each consisting of the single string array field with name \u003cspan pulumi-lang-nodejs=\"`emailAddresses`\" pulumi-lang-dotnet=\"`EmailAddresses`\" pulumi-lang-go=\"`emailAddresses`\" pulumi-lang-python=\"`email_addresses`\" pulumi-lang-yaml=\"`emailAddresses`\" pulumi-lang-java=\"`emailAddresses`\" pulumi-lang-hcl=\"`email_addresses`\"\u003e`emailAddresses`\u003c/span\u003e containing a list of emails to notify:\n" }, "outputSchemaName": { "type": "string", "description": "Schema where output metric tables are created\n" }, "profileMetricsTableName": { "type": "string", "description": "The full name of the profile metrics table. Format: __catalog_name__.__schema_name__.__table_name__.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/LakehouseMonitorProviderConfig:LakehouseMonitorProviderConfig" }, "schedule": { "$ref": "#/types/databricks:index/LakehouseMonitorSchedule:LakehouseMonitorSchedule", "description": "The schedule for automatically updating and refreshing metric tables. This block consists of following fields:\n" }, "skipBuiltinDashboard": { "type": "boolean", "description": "Whether to skip creating a default dashboard summarizing data quality metrics.\n" }, "slicingExprs": { "type": "array", "items": { "type": "string" }, "description": "List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.\n" }, "snapshot": { "$ref": "#/types/databricks:index/LakehouseMonitorSnapshot:LakehouseMonitorSnapshot", "description": "Configuration for monitoring snapshot tables.\n" }, "status": { "type": "string", "description": "Status of the Monitor\n" }, "tableName": { "type": "string", "description": "The full name of the table to attach the monitor too. Its of the format {catalog}.{schema}.{tableName}\n" }, "timeSeries": { "$ref": "#/types/databricks:index/LakehouseMonitorTimeSeries:LakehouseMonitorTimeSeries", "description": "Configuration for monitoring timeseries tables.\n" }, "warehouseId": { "type": "string", "description": "Optional argument to specify the warehouse for dashboard creation. If not specified, the first running warehouse will be used.\n" } }, "type": "object" } }, "databricks:index/library:Library": { "description": "Installs a [library](https://docs.databricks.com/libraries/index.html) on databricks_cluster. Each different type of library has a slightly different syntax. It's possible to set only one type of library within one resource. Otherwise, the plan will fail with an error.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e \u003cspan pulumi-lang-nodejs=\"`databricks.Library`\" pulumi-lang-dotnet=\"`databricks.Library`\" pulumi-lang-go=\"`Library`\" pulumi-lang-python=\"`Library`\" pulumi-lang-yaml=\"`databricks.Library`\" pulumi-lang-java=\"`databricks.Library`\" pulumi-lang-hcl=\"`databricks_library`\"\u003e`databricks.Library`\u003c/span\u003e resource would always start the associated cluster if it's not running, so make sure to have auto-termination configured. It's not possible to atomically change the version of the same library without cluster restart. Libraries are fully removed from the cluster only after restart.\n\n## Plugin Framework Migration\n\nThe library resource has been migrated from sdkv2 to plugin framework. If you encounter any problem with this resource and suspect it is due to the migration, you can fallback to sdkv2 by setting the environment variable in the following way `export USE_SDK_V2_RESOURCES=\u003cspan pulumi-lang-nodejs=\"\"databricks.Library\"\" pulumi-lang-dotnet=\"\"databricks.Library\"\" pulumi-lang-go=\"\"Library\"\" pulumi-lang-python=\"\"Library\"\" pulumi-lang-yaml=\"\"databricks.Library\"\" pulumi-lang-java=\"\"databricks.Library\"\" pulumi-lang-hcl=\"\"databricks_library\"\"\u003e\"databricks.Library\"\u003c/span\u003e`.\n\n\u003e **Upgrading from v1.114.0**: state written by v1.114.0 encodes \u003cspan pulumi-lang-nodejs=\"`providerConfig`\" pulumi-lang-dotnet=\"`ProviderConfig`\" pulumi-lang-go=\"`providerConfig`\" pulumi-lang-python=\"`provider_config`\" pulumi-lang-yaml=\"`providerConfig`\" pulumi-lang-java=\"`providerConfig`\" pulumi-lang-hcl=\"`provider_config`\"\u003e`providerConfig`\u003c/span\u003e as a single object instead of a list. After upgrading the provider, edit each \u003cspan pulumi-lang-nodejs=\"`databricks.Library`\" pulumi-lang-dotnet=\"`databricks.Library`\" pulumi-lang-go=\"`Library`\" pulumi-lang-python=\"`Library`\" pulumi-lang-yaml=\"`databricks.Library`\" pulumi-lang-java=\"`databricks.Library`\" pulumi-lang-hcl=\"`databricks_library`\"\u003e`databricks.Library`\u003c/span\u003e instance in your state file to convert `\u003cspan pulumi-lang-nodejs=\"\"providerConfig\"\" pulumi-lang-dotnet=\"\"ProviderConfig\"\" pulumi-lang-go=\"\"providerConfig\"\" pulumi-lang-python=\"\"provider_config\"\" pulumi-lang-yaml=\"\"providerConfig\"\" pulumi-lang-java=\"\"providerConfig\"\" pulumi-lang-hcl=\"\"provider_config\"\"\u003e\"providerConfig\"\u003c/span\u003e: {\u003cspan pulumi-lang-nodejs=\"\"workspaceId\"\" pulumi-lang-dotnet=\"\"WorkspaceId\"\" pulumi-lang-go=\"\"workspaceId\"\" pulumi-lang-python=\"\"workspace_id\"\" pulumi-lang-yaml=\"\"workspaceId\"\" pulumi-lang-java=\"\"workspaceId\"\" pulumi-lang-hcl=\"\"workspace_id\"\"\u003e\"workspaceId\"\u003c/span\u003e: \"X\"}` to `\u003cspan pulumi-lang-nodejs=\"\"providerConfig\"\" pulumi-lang-dotnet=\"\"ProviderConfig\"\" pulumi-lang-go=\"\"providerConfig\"\" pulumi-lang-python=\"\"provider_config\"\" pulumi-lang-yaml=\"\"providerConfig\"\" pulumi-lang-java=\"\"providerConfig\"\" pulumi-lang-hcl=\"\"provider_config\"\"\u003e\"providerConfig\"\u003c/span\u003e: null` (recommended if you didn't set \u003cspan pulumi-lang-nodejs=\"`providerConfig`\" pulumi-lang-dotnet=\"`ProviderConfig`\" pulumi-lang-go=\"`providerConfig`\" pulumi-lang-python=\"`provider_config`\" pulumi-lang-yaml=\"`providerConfig`\" pulumi-lang-java=\"`providerConfig`\" pulumi-lang-hcl=\"`provider_config`\"\u003e`providerConfig`\u003c/span\u003e in HCL) or to `\u003cspan pulumi-lang-nodejs=\"\"providerConfig\"\" pulumi-lang-dotnet=\"\"ProviderConfig\"\" pulumi-lang-go=\"\"providerConfig\"\" pulumi-lang-python=\"\"provider_config\"\" pulumi-lang-yaml=\"\"providerConfig\"\" pulumi-lang-java=\"\"providerConfig\"\" pulumi-lang-hcl=\"\"provider_config\"\"\u003e\"providerConfig\"\u003c/span\u003e: [{\u003cspan pulumi-lang-nodejs=\"\"workspaceId\"\" pulumi-lang-dotnet=\"\"WorkspaceId\"\" pulumi-lang-go=\"\"workspaceId\"\" pulumi-lang-python=\"\"workspace_id\"\" pulumi-lang-yaml=\"\"workspaceId\"\" pulumi-lang-java=\"\"workspaceId\"\" pulumi-lang-hcl=\"\"workspace_id\"\"\u003e\"workspaceId\"\u003c/span\u003e: \"X\"}]` (if you did). Without this edit, `pulumi preview` fails with `Error decoding ... missing expected `. Users on v1.113.0 are unaffected.\n\n## Installing library on all clusters\n\nYou can install libraries on all clusters with the help of \u003cspan pulumi-lang-nodejs=\"[databricks.getClusters \" pulumi-lang-dotnet=\"[databricks.getClusters \" pulumi-lang-go=\"[getClusters \" pulumi-lang-python=\"[get_clusters \" pulumi-lang-yaml=\"[databricks.getClusters \" pulumi-lang-java=\"[databricks.getClusters \" pulumi-lang-hcl=\"[data.databricks_clusters \"\u003e[databricks.getClusters \u003c/span\u003edata resource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nexport = async () =\u003e {\n const all = await databricks.getClusters({});\n const cli: databricks.Library[] = [];\n for (const range of all.ids.map((v, k) =\u003e ({key: k, value: v}))) {\n cli.push(new databricks.Library(`cli-${range.key}`, {\n clusterId: String(range.key),\n pypi: {\n \"package\": \"databricks-cli\",\n },\n }));\n }\n}\n```\n```python\nimport pulumi\nfrom typing import Any\nimport pulumi_databricks as databricks\n\nall = databricks.get_clusters()\ncli: list[Any] = []\nfor range in [{\"key\": k, \"value\": v} for [k, v] in enumerate(all.ids)]:\n cli.append(databricks.Library(f\"cli-{range['key']}\",\n cluster_id=str(range[\"key\"]),\n pypi={\n \"package\": \"databricks-cli\",\n }))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(async() =\u003e \n{\n var all = await Databricks.GetClusters.InvokeAsync();\n\n var cli = new List\u003cDatabricks.Library\u003e();\n foreach (var range in )\n {\n cli.Add(new Databricks.Library($\"cli-{range.Key}\", new()\n {\n ClusterId = range.Key,\n Pypi = new Databricks.Inputs.LibraryPypiArgs\n {\n Package = \"databricks-cli\",\n },\n }));\n }\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tall, err := databricks.GetClusters(ctx, \u0026databricks.GetClustersArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tvar cli []*databricks.Library\n\t\tfor key0, _ := range all.Ids {\n\t\t\t__res, err := databricks.NewLibrary(ctx, fmt.Sprintf(\"cli-%v\", key0), \u0026databricks.LibraryArgs{\n\t\t\t\tClusterId: pulumi.String(pulumi.Int(key0)),\n\t\t\t\tPypi: \u0026databricks.LibraryPypiArgs{\n\t\t\t\t\tPackage: pulumi.String(\"databricks-cli\"),\n\t\t\t\t},\n\t\t\t})\n\t\t\tif err != nil {\n\t\t\t\treturn err\n\t\t\t}\n\t\t\tcli = append(cli, __res)\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getclusters\" \"all\" {\n}\n\nresource \"databricks_library\" \"cli\" {\n for_each = data.databricks_getclusters.all.ids\n cluster_id = each.key\n pypi = {\n package = \"databricks-cli\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetClustersArgs;\nimport com.pulumi.databricks.Library;\nimport com.pulumi.databricks.LibraryArgs;\nimport com.pulumi.databricks.inputs.LibraryPypiArgs;\nimport com.pulumi.codegen.internal.KeyedValue;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var all = DatabricksFunctions.getClusters(GetClustersArgs.builder()\n .build());\n\n final var cli = all.applyValue(getClustersResult -\u003e {\n final var resources = new ArrayList\u003cLibrary\u003e();\n for (var range : KeyedValue.of(getClustersResult.ids())) {\n var resource = new Library(\"cli-\" + range.key(), LibraryArgs.builder()\n .clusterId(range.key())\n .pypi(LibraryPypiArgs.builder()\n .package_(\"databricks-cli\")\n .build())\n .build());\n\n resources.add(resource);\n }\n\n return resources;\n });\n\n }\n}\n```\n```yaml\nresources:\n cli:\n type: databricks:Library\n properties:\n clusterId: ${range.key}\n pypi:\n package: databricks-cli\n options: {}\nvariables:\n all:\n fn::invoke:\n function: databricks:getClusters\n arguments: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Java/Scala Maven\n\nInstalling artifacts from Maven repository. You can also optionally specify a \u003cspan pulumi-lang-nodejs=\"`repo`\" pulumi-lang-dotnet=\"`Repo`\" pulumi-lang-go=\"`repo`\" pulumi-lang-python=\"`repo`\" pulumi-lang-yaml=\"`repo`\" pulumi-lang-java=\"`repo`\" pulumi-lang-hcl=\"`repo`\"\u003e`repo`\u003c/span\u003e parameter for a custom Maven-style repository, that should be accessible without any authentication. Maven libraries are resolved in Databricks Control Plane, so repo should be accessible from it. It can even be properly configured [maven s3 wagon](https://github.com/seahen/maven-s3-wagon), [AWS CodeArtifact](https://aws.amazon.com/codeartifact/) or [Azure Artifacts](https://azure.microsoft.com/en-us/services/devops/artifacts/).\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst deequ = new databricks.Library(\"deequ\", {\n clusterId: _this.id,\n maven: {\n coordinates: \"com.amazon.deequ:deequ:1.0.4\",\n exclusions: [\"org.apache.avro:avro\"],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ndeequ = databricks.Library(\"deequ\",\n cluster_id=this[\"id\"],\n maven={\n \"coordinates\": \"com.amazon.deequ:deequ:1.0.4\",\n \"exclusions\": [\"org.apache.avro:avro\"],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var deequ = new Databricks.Library(\"deequ\", new()\n {\n ClusterId = @this.Id,\n Maven = new Databricks.Inputs.LibraryMavenArgs\n {\n Coordinates = \"com.amazon.deequ:deequ:1.0.4\",\n Exclusions = new[]\n {\n \"org.apache.avro:avro\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewLibrary(ctx, \"deequ\", \u0026databricks.LibraryArgs{\n\t\t\tClusterId: pulumi.Any(this.Id),\n\t\t\tMaven: \u0026databricks.LibraryMavenArgs{\n\t\t\t\tCoordinates: pulumi.String(\"com.amazon.deequ:deequ:1.0.4\"),\n\t\t\t\tExclusions: pulumi.StringArray{\n\t\t\t\t\tpulumi.String(\"org.apache.avro:avro\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_library\" \"deequ\" {\n cluster_id = this.id\n maven = {\n coordinates = \"com.amazon.deequ:deequ:1.0.4\"\n exclusions = [\"org.apache.avro:avro\"]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Library;\nimport com.pulumi.databricks.LibraryArgs;\nimport com.pulumi.databricks.inputs.LibraryMavenArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var deequ = new Library(\"deequ\", LibraryArgs.builder()\n .clusterId(this_.id())\n .maven(LibraryMavenArgs.builder()\n .coordinates(\"com.amazon.deequ:deequ:1.0.4\")\n .exclusions(\"org.apache.avro:avro\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n deequ:\n type: databricks:Library\n properties:\n clusterId: ${this.id}\n maven:\n coordinates: com.amazon.deequ:deequ:1.0.4\n exclusions:\n - org.apache.avro:avro\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Python PyPI\n\nInstalling Python PyPI artifacts. You can optionally also specify the \u003cspan pulumi-lang-nodejs=\"`repo`\" pulumi-lang-dotnet=\"`Repo`\" pulumi-lang-go=\"`repo`\" pulumi-lang-python=\"`repo`\" pulumi-lang-yaml=\"`repo`\" pulumi-lang-java=\"`repo`\" pulumi-lang-hcl=\"`repo`\"\u003e`repo`\u003c/span\u003e parameter for a custom PyPI mirror, which should be accessible without any authentication for the network that cluster runs in.\n\n\u003e \u003cspan pulumi-lang-nodejs=\"`repo`\" pulumi-lang-dotnet=\"`Repo`\" pulumi-lang-go=\"`repo`\" pulumi-lang-python=\"`repo`\" pulumi-lang-yaml=\"`repo`\" pulumi-lang-java=\"`repo`\" pulumi-lang-hcl=\"`repo`\"\u003e`repo`\u003c/span\u003e host should be accessible from the Internet by Databricks control plane. If connectivity to custom PyPI repositories is required, please modify cluster-node `/etc/pip.conf` through databricks_global_init_script.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst fbprophet = new databricks.Library(\"fbprophet\", {\n clusterId: _this.id,\n pypi: {\n \"package\": \"fbprophet==0.6\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nfbprophet = databricks.Library(\"fbprophet\",\n cluster_id=this[\"id\"],\n pypi={\n \"package\": \"fbprophet==0.6\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var fbprophet = new Databricks.Library(\"fbprophet\", new()\n {\n ClusterId = @this.Id,\n Pypi = new Databricks.Inputs.LibraryPypiArgs\n {\n Package = \"fbprophet==0.6\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewLibrary(ctx, \"fbprophet\", \u0026databricks.LibraryArgs{\n\t\t\tClusterId: pulumi.Any(this.Id),\n\t\t\tPypi: \u0026databricks.LibraryPypiArgs{\n\t\t\t\tPackage: pulumi.String(\"fbprophet==0.6\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_library\" \"fbprophet\" {\n cluster_id = this.id\n pypi = {\n package = \"fbprophet==0.6\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Library;\nimport com.pulumi.databricks.LibraryArgs;\nimport com.pulumi.databricks.inputs.LibraryPypiArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var fbprophet = new Library(\"fbprophet\", LibraryArgs.builder()\n .clusterId(this_.id())\n .pypi(LibraryPypiArgs.builder()\n .package_(\"fbprophet==0.6\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n fbprophet:\n type: databricks:Library\n properties:\n clusterId: ${this.id}\n pypi:\n package: fbprophet==0.6\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Python requirements files\n\nInstalling Python libraries listed in the `requirements.txt` file. Only Workspace paths and Unity Catalog Volumes paths are supported. Requires a cluster with DBR 15.0+.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst libraries = new databricks.Library(\"libraries\", {\n clusterId: _this.id,\n requirements: \"/Workspace/path/to/requirements.txt\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nlibraries = databricks.Library(\"libraries\",\n cluster_id=this[\"id\"],\n requirements=\"/Workspace/path/to/requirements.txt\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var libraries = new Databricks.Library(\"libraries\", new()\n {\n ClusterId = @this.Id,\n Requirements = \"/Workspace/path/to/requirements.txt\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewLibrary(ctx, \"libraries\", \u0026databricks.LibraryArgs{\n\t\t\tClusterId: pulumi.Any(this.Id),\n\t\t\tRequirements: pulumi.String(\"/Workspace/path/to/requirements.txt\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_library\" \"libraries\" {\n cluster_id = this.id\n requirements = \"/Workspace/path/to/requirements.txt\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Library;\nimport com.pulumi.databricks.LibraryArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var libraries = new Library(\"libraries\", LibraryArgs.builder()\n .clusterId(this_.id())\n .requirements(\"/Workspace/path/to/requirements.txt\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n libraries:\n type: databricks:Library\n properties:\n clusterId: ${this.id}\n requirements: /Workspace/path/to/requirements.txt\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## R CRan\n\nInstalling artifacts from CRan. You can also optionally specify a \u003cspan pulumi-lang-nodejs=\"`repo`\" pulumi-lang-dotnet=\"`Repo`\" pulumi-lang-go=\"`repo`\" pulumi-lang-python=\"`repo`\" pulumi-lang-yaml=\"`repo`\" pulumi-lang-java=\"`repo`\" pulumi-lang-hcl=\"`repo`\"\u003e`repo`\u003c/span\u003e parameter for a custom cran mirror.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst rkeops = new databricks.Library(\"rkeops\", {\n clusterId: _this.id,\n cran: {\n \"package\": \"rkeops\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nrkeops = databricks.Library(\"rkeops\",\n cluster_id=this[\"id\"],\n cran={\n \"package\": \"rkeops\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var rkeops = new Databricks.Library(\"rkeops\", new()\n {\n ClusterId = @this.Id,\n Cran = new Databricks.Inputs.LibraryCranArgs\n {\n Package = \"rkeops\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewLibrary(ctx, \"rkeops\", \u0026databricks.LibraryArgs{\n\t\t\tClusterId: pulumi.Any(this.Id),\n\t\t\tCran: \u0026databricks.LibraryCranArgs{\n\t\t\t\tPackage: pulumi.String(\"rkeops\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_library\" \"rkeops\" {\n cluster_id = this.id\n cran = {\n package = \"rkeops\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Library;\nimport com.pulumi.databricks.LibraryArgs;\nimport com.pulumi.databricks.inputs.LibraryCranArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var rkeops = new Library(\"rkeops\", LibraryArgs.builder()\n .clusterId(this_.id())\n .cran(LibraryCranArgs.builder()\n .package_(\"rkeops\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n rkeops:\n type: databricks:Library\n properties:\n clusterId: ${this.id}\n cran:\n package: rkeops\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getClusters \" pulumi-lang-dotnet=\" databricks.getClusters \" pulumi-lang-go=\" getClusters \" pulumi-lang-python=\" get_clusters \" pulumi-lang-yaml=\" databricks.getClusters \" pulumi-lang-java=\" databricks.getClusters \" pulumi-lang-hcl=\" data.databricks_clusters \"\u003e databricks.getClusters \u003c/span\u003edata to retrieve a list of\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eids.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.ClusterPolicy \" pulumi-lang-dotnet=\" databricks.ClusterPolicy \" pulumi-lang-go=\" ClusterPolicy \" pulumi-lang-python=\" ClusterPolicy \" pulumi-lang-yaml=\" databricks.ClusterPolicy \" pulumi-lang-java=\" databricks.ClusterPolicy \" pulumi-lang-hcl=\" databricks_cluster_policy \"\u003e databricks.ClusterPolicy \u003c/span\u003eto create a\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003epolicy, which limits the ability to create clusters based on a set of rules.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GlobalInitScript \" pulumi-lang-dotnet=\" databricks.GlobalInitScript \" pulumi-lang-go=\" GlobalInitScript \" pulumi-lang-python=\" GlobalInitScript \" pulumi-lang-yaml=\" databricks.GlobalInitScript \" pulumi-lang-java=\" databricks.GlobalInitScript \" pulumi-lang-hcl=\" databricks_global_init_script \"\u003e databricks.GlobalInitScript \u003c/span\u003eto manage [global init scripts](https://docs.databricks.com/clusters/init-scripts.html#global-init-scripts), which are run on all\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand databricks_job.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Job \" pulumi-lang-dotnet=\" databricks.Job \" pulumi-lang-go=\" Job \" pulumi-lang-python=\" Job \" pulumi-lang-yaml=\" databricks.Job \" pulumi-lang-java=\" databricks.Job \" pulumi-lang-hcl=\" databricks_job \"\u003e databricks.Job \u003c/span\u003eto manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a databricks_cluster.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Pipeline \" pulumi-lang-dotnet=\" databricks.Pipeline \" pulumi-lang-go=\" Pipeline \" pulumi-lang-python=\" Pipeline \" pulumi-lang-yaml=\" databricks.Pipeline \" pulumi-lang-java=\" databricks.Pipeline \" pulumi-lang-hcl=\" databricks_pipeline \"\u003e databricks.Pipeline \u003c/span\u003eto deploy [Lakeflow Declarative Pipelines](https://docs.databricks.com/aws/en/dlt).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "clusterId": { "type": "string", "description": "ID of the\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto install the library on.\n\nYou must specify exactly **one** of the following library types:\n" }, "cran": { "$ref": "#/types/databricks:index/LibraryCran:LibraryCran", "description": "Configuration block for a CRAN library. The block consists of the following fields:\n" }, "egg": { "type": "string", "description": "Path to the EGG library. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. Use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead.\n", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string", "description": "Path to the JAR library. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `/Workspace/path/to/library.jar`, `/Volumes/path/to/library.jar` or `s3://my-bucket/library.jar`. If S3 is used, make sure the cluster has read access to the library. You may need to launch the cluster with an IAM role to access the S3 URI.\n" }, "libraryId": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/LibraryMaven:LibraryMaven", "description": "Configuration block for a Maven library. The block consists of the following fields:\n" }, "providerConfig": { "$ref": "#/types/databricks:index/LibraryProviderConfig:LibraryProviderConfig", "description": "Configuration block for management through the account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/LibraryPypi:LibraryPypi", "description": "Configuration block for a PyPI library. The block consists of the following fields:\n" }, "requirements": { "type": "string", "description": "Path to the requirements.txt file. Only Workspace paths and Unity Catalog Volumes paths are supported. For example: `/Workspace/path/to/requirements.txt` or `/Volumes/path/to/requirements.txt`. Requires a cluster with DBR 15.0+.\n" }, "whl": { "type": "string", "description": "Path to the wheel library. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `/Workspace/path/to/library.whl`, `/Volumes/path/to/library.whl` or `s3://my-bucket/library.whl`. If S3 is used, make sure the cluster has read access to the library. You may need to launch the cluster with an IAM role to access the S3 URI.\n" } }, "required": [ "clusterId", "libraryId" ], "inputProperties": { "clusterId": { "type": "string", "description": "ID of the\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto install the library on.\n\nYou must specify exactly **one** of the following library types:\n" }, "cran": { "$ref": "#/types/databricks:index/LibraryCran:LibraryCran", "description": "Configuration block for a CRAN library. The block consists of the following fields:\n" }, "egg": { "type": "string", "description": "Path to the EGG library. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. Use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead.\n", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string", "description": "Path to the JAR library. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `/Workspace/path/to/library.jar`, `/Volumes/path/to/library.jar` or `s3://my-bucket/library.jar`. If S3 is used, make sure the cluster has read access to the library. You may need to launch the cluster with an IAM role to access the S3 URI.\n" }, "libraryId": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/LibraryMaven:LibraryMaven", "description": "Configuration block for a Maven library. The block consists of the following fields:\n" }, "providerConfig": { "$ref": "#/types/databricks:index/LibraryProviderConfig:LibraryProviderConfig", "description": "Configuration block for management through the account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/LibraryPypi:LibraryPypi", "description": "Configuration block for a PyPI library. The block consists of the following fields:\n" }, "requirements": { "type": "string", "description": "Path to the requirements.txt file. Only Workspace paths and Unity Catalog Volumes paths are supported. For example: `/Workspace/path/to/requirements.txt` or `/Volumes/path/to/requirements.txt`. Requires a cluster with DBR 15.0+.\n" }, "whl": { "type": "string", "description": "Path to the wheel library. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `/Workspace/path/to/library.whl`, `/Volumes/path/to/library.whl` or `s3://my-bucket/library.whl`. If S3 is used, make sure the cluster has read access to the library. You may need to launch the cluster with an IAM role to access the S3 URI.\n" } }, "requiredInputs": [ "clusterId" ], "stateInputs": { "description": "Input properties used for looking up and filtering Library resources.\n", "properties": { "clusterId": { "type": "string", "description": "ID of the\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto install the library on.\n\nYou must specify exactly **one** of the following library types:\n" }, "cran": { "$ref": "#/types/databricks:index/LibraryCran:LibraryCran", "description": "Configuration block for a CRAN library. The block consists of the following fields:\n" }, "egg": { "type": "string", "description": "Path to the EGG library. Installing Python egg files is deprecated and is not supported in Databricks Runtime 14.0 and above. Use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead.\n", "deprecationMessage": "The \u003cspan pulumi-lang-nodejs=\"`egg`\" pulumi-lang-dotnet=\"`Egg`\" pulumi-lang-go=\"`egg`\" pulumi-lang-python=\"`egg`\" pulumi-lang-yaml=\"`egg`\" pulumi-lang-java=\"`egg`\" pulumi-lang-hcl=\"`egg`\"\u003e`egg`\u003c/span\u003e library type is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`whl`\" pulumi-lang-dotnet=\"`Whl`\" pulumi-lang-go=\"`whl`\" pulumi-lang-python=\"`whl`\" pulumi-lang-yaml=\"`whl`\" pulumi-lang-java=\"`whl`\" pulumi-lang-hcl=\"`whl`\"\u003e`whl`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`pypi`\" pulumi-lang-dotnet=\"`Pypi`\" pulumi-lang-go=\"`pypi`\" pulumi-lang-python=\"`pypi`\" pulumi-lang-yaml=\"`pypi`\" pulumi-lang-java=\"`pypi`\" pulumi-lang-hcl=\"`pypi`\"\u003e`pypi`\u003c/span\u003e instead." }, "jar": { "type": "string", "description": "Path to the JAR library. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `/Workspace/path/to/library.jar`, `/Volumes/path/to/library.jar` or `s3://my-bucket/library.jar`. If S3 is used, make sure the cluster has read access to the library. You may need to launch the cluster with an IAM role to access the S3 URI.\n" }, "libraryId": { "type": "string" }, "maven": { "$ref": "#/types/databricks:index/LibraryMaven:LibraryMaven", "description": "Configuration block for a Maven library. The block consists of the following fields:\n" }, "providerConfig": { "$ref": "#/types/databricks:index/LibraryProviderConfig:LibraryProviderConfig", "description": "Configuration block for management through the account provider. This block consists of the following fields:\n" }, "pypi": { "$ref": "#/types/databricks:index/LibraryPypi:LibraryPypi", "description": "Configuration block for a PyPI library. The block consists of the following fields:\n" }, "requirements": { "type": "string", "description": "Path to the requirements.txt file. Only Workspace paths and Unity Catalog Volumes paths are supported. For example: `/Workspace/path/to/requirements.txt` or `/Volumes/path/to/requirements.txt`. Requires a cluster with DBR 15.0+.\n" }, "whl": { "type": "string", "description": "Path to the wheel library. Supported URIs include Workspace paths, Unity Catalog Volumes paths, and S3 URIs. For example: `/Workspace/path/to/library.whl`, `/Volumes/path/to/library.whl` or `s3://my-bucket/library.whl`. If S3 is used, make sure the cluster has read access to the library. You may need to launch the cluster with an IAM role to access the S3 URI.\n" } }, "type": "object" } }, "databricks:index/materializedFeaturesFeatureTag:MaterializedFeaturesFeatureTag": { "description": "[![Private Preview](https://img.shields.io/badge/Release_Stage-Private_Preview-blueviolet)](https://docs.databricks.com/aws/en/release-notes/release-types)\n\n", "properties": { "key": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MaterializedFeaturesFeatureTagProviderConfig:MaterializedFeaturesFeatureTagProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "value": { "type": "string" } }, "required": [ "key", "providerConfig" ], "inputProperties": { "key": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MaterializedFeaturesFeatureTagProviderConfig:MaterializedFeaturesFeatureTagProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "value": { "type": "string" } }, "requiredInputs": [ "key" ], "stateInputs": { "description": "Input properties used for looking up and filtering MaterializedFeaturesFeatureTag resources.\n", "properties": { "key": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MaterializedFeaturesFeatureTagProviderConfig:MaterializedFeaturesFeatureTagProviderConfig", "description": "Configure the provider for management through account provider.\n" }, "value": { "type": "string" } }, "type": "object" } }, "databricks:index/metastore:Metastore": { "description": "\u003e This resource can be used with an account or workspace-level provider.\n\nA 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.\n\nUnity 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).\n\nA Unity Catalog metastore can be created without a root location \u0026 credential to maintain strict separation of storage across catalogs or environments.\n\n## Example Usage\n\nFor AWS\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Metastore(\"this\", {\n name: \"primary\",\n storageRoot: `s3://${metastore.id}/metastore`,\n owner: \"uc admins\",\n region: \"us-east-1\",\n forceDestroy: true,\n});\nconst thisMetastoreAssignment = new databricks.MetastoreAssignment(\"this\", {\n metastoreId: _this.id,\n workspaceId: workspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Metastore(\"this\",\n name=\"primary\",\n storage_root=f\"s3://{metastore['id']}/metastore\",\n owner=\"uc admins\",\n region=\"us-east-1\",\n force_destroy=True)\nthis_metastore_assignment = databricks.MetastoreAssignment(\"this\",\n metastore_id=this.id,\n workspace_id=workspace_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Metastore(\"this\", new()\n {\n Name = \"primary\",\n StorageRoot = $\"s3://{metastore.Id}/metastore\",\n Owner = \"uc admins\",\n Region = \"us-east-1\",\n ForceDestroy = true,\n });\n\n var thisMetastoreAssignment = new Databricks.MetastoreAssignment(\"this\", new()\n {\n MetastoreId = @this.Id,\n WorkspaceId = workspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewMetastore(ctx, \"this\", \u0026databricks.MetastoreArgs{\n\t\t\tName: pulumi.String(\"primary\"),\n\t\t\tStorageRoot: pulumi.Sprintf(\"s3://%v/metastore\", metastore.Id),\n\t\t\tOwner: pulumi.String(\"uc admins\"),\n\t\t\tRegion: pulumi.String(\"us-east-1\"),\n\t\t\tForceDestroy: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMetastoreAssignment(ctx, \"this\", \u0026databricks.MetastoreAssignmentArgs{\n\t\t\tMetastoreId: this.ID(),\n\t\t\tWorkspaceId: pulumi.Any(workspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_metastore\" \"this\" {\n name = \"primary\"\n storage_root =\"s3://${metastore.id}/metastore\"\n owner = \"uc admins\"\n region = \"us-east-1\"\n force_destroy = true\n}\nresource \"databricks_metastoreassignment\" \"this\" {\n metastore_id = databricks_metastore.this.id\n workspace_id = workspaceId\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Metastore;\nimport com.pulumi.databricks.MetastoreArgs;\nimport com.pulumi.databricks.MetastoreAssignment;\nimport com.pulumi.databricks.MetastoreAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Metastore(\"this\", MetastoreArgs.builder()\n .name(\"primary\")\n .storageRoot(String.format(\"s3://%s/metastore\", metastore.id()))\n .owner(\"uc admins\")\n .region(\"us-east-1\")\n .forceDestroy(true)\n .build());\n\n var thisMetastoreAssignment = new MetastoreAssignment(\"thisMetastoreAssignment\", MetastoreAssignmentArgs.builder()\n .metastoreId(this_.id())\n .workspaceId(workspaceId)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Metastore\n properties:\n name: primary\n storageRoot: s3://${metastore.id}/metastore\n owner: uc admins\n region: us-east-1\n forceDestroy: true\n thisMetastoreAssignment:\n type: databricks:MetastoreAssignment\n name: this\n properties:\n metastoreId: ${this.id}\n workspaceId: ${workspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor Azure\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\n\nconst _this = new databricks.Metastore(\"this\", {\n name: \"primary\",\n storageRoot: std.format({\n input: \"abfss://%s@%s.dfs.core.windows.net/\",\n args: [\n unityCatalog.name,\n unityCatalogAzurermStorageAccount.name,\n ],\n }).then(invoke =\u003e invoke.result),\n owner: \"uc admins\",\n region: \"eastus\",\n forceDestroy: true,\n});\nconst thisMetastoreAssignment = new databricks.MetastoreAssignment(\"this\", {\n metastoreId: _this.id,\n workspaceId: workspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_std as std\n\nthis = databricks.Metastore(\"this\",\n name=\"primary\",\n storage_root=std.format(input=\"abfss://%s@%s.dfs.core.windows.net/\",\n args=[\n unity_catalog[\"name\"],\n unity_catalog_azurerm_storage_account[\"name\"],\n ]).result,\n owner=\"uc admins\",\n region=\"eastus\",\n force_destroy=True)\nthis_metastore_assignment = databricks.MetastoreAssignment(\"this\",\n metastore_id=this.id,\n workspace_id=workspace_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Metastore(\"this\", new()\n {\n Name = \"primary\",\n StorageRoot = Std.Format.Invoke(new()\n {\n Input = \"abfss://%s@%s.dfs.core.windows.net/\",\n Args = new[]\n {\n unityCatalog.Name,\n unityCatalogAzurermStorageAccount.Name,\n },\n }).Apply(invoke =\u003e invoke.Result),\n Owner = \"uc admins\",\n Region = \"eastus\",\n ForceDestroy = true,\n });\n\n var thisMetastoreAssignment = new Databricks.MetastoreAssignment(\"this\", new()\n {\n MetastoreId = @this.Id,\n WorkspaceId = workspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinvokeFormat, err := std.Format(ctx, \u0026std.FormatArgs{\n\t\t\tInput: \"abfss://%s@%s.dfs.core.windows.net/\",\n\t\t\tArgs: []interface{}{\n\t\t\t\tunityCatalog.Name,\n\t\t\t\tunityCatalogAzurermStorageAccount.Name,\n\t\t\t},\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := databricks.NewMetastore(ctx, \"this\", \u0026databricks.MetastoreArgs{\n\t\t\tName: pulumi.String(\"primary\"),\n\t\t\tStorageRoot: pulumi.String(invokeFormat.Result),\n\t\t\tOwner: pulumi.String(\"uc admins\"),\n\t\t\tRegion: pulumi.String(\"eastus\"),\n\t\t\tForceDestroy: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMetastoreAssignment(ctx, \"this\", \u0026databricks.MetastoreAssignmentArgs{\n\t\t\tMetastoreId: this.ID(),\n\t\t\tWorkspaceId: pulumi.Any(workspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n }\n}\n\ndata \"std_format\" \"invoke_0\" {\n input = \"abfss://%s@%s.dfs.core.windows.net/\"\n args = [unityCatalog.name, unityCatalogAzurermStorageAccount.name]\n}\n\nresource \"databricks_metastore\" \"this\" {\n name = \"primary\"\n storage_root = data.std_format.invoke_0.result\n owner = \"uc admins\"\n region = \"eastus\"\n force_destroy = true\n}\nresource \"databricks_metastoreassignment\" \"this\" {\n metastore_id = databricks_metastore.this.id\n workspace_id = workspaceId\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Metastore;\nimport com.pulumi.databricks.MetastoreArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.FormatArgs;\nimport com.pulumi.databricks.MetastoreAssignment;\nimport com.pulumi.databricks.MetastoreAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Metastore(\"this\", MetastoreArgs.builder()\n .name(\"primary\")\n .storageRoot(StdFunctions.format(FormatArgs.builder()\n .input(\"abfss://%s@%s.dfs.core.windows.net/\")\n .args( \n unityCatalog.name(),\n unityCatalogAzurermStorageAccount.name())\n .build()).result())\n .owner(\"uc admins\")\n .region(\"eastus\")\n .forceDestroy(true)\n .build());\n\n var thisMetastoreAssignment = new MetastoreAssignment(\"thisMetastoreAssignment\", MetastoreAssignmentArgs.builder()\n .metastoreId(this_.id())\n .workspaceId(workspaceId)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Metastore\n properties:\n name: primary\n storageRoot:\n fn::invoke:\n function: std:format\n arguments:\n input: abfss://%s@%s.dfs.core.windows.net/\n args:\n - ${unityCatalog.name}\n - ${unityCatalogAzurermStorageAccount.name}\n return: result\n owner: uc admins\n region: eastus\n forceDestroy: true\n thisMetastoreAssignment:\n type: databricks:MetastoreAssignment\n name: this\n properties:\n metastoreId: ${this.id}\n workspaceId: ${workspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor GCP\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Metastore(\"this\", {\n name: \"primary\",\n storageRoot: `gs://${unityMetastore.name}`,\n owner: \"uc admins\",\n region: us_east1,\n forceDestroy: true,\n});\nconst thisMetastoreAssignment = new databricks.MetastoreAssignment(\"this\", {\n metastoreId: _this.id,\n workspaceId: workspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Metastore(\"this\",\n name=\"primary\",\n storage_root=f\"gs://{unity_metastore['name']}\",\n owner=\"uc admins\",\n region=us_east1,\n force_destroy=True)\nthis_metastore_assignment = databricks.MetastoreAssignment(\"this\",\n metastore_id=this.id,\n workspace_id=workspace_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Metastore(\"this\", new()\n {\n Name = \"primary\",\n StorageRoot = $\"gs://{unityMetastore.Name}\",\n Owner = \"uc admins\",\n Region = us_east1,\n ForceDestroy = true,\n });\n\n var thisMetastoreAssignment = new Databricks.MetastoreAssignment(\"this\", new()\n {\n MetastoreId = @this.Id,\n WorkspaceId = workspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewMetastore(ctx, \"this\", \u0026databricks.MetastoreArgs{\n\t\t\tName: pulumi.String(\"primary\"),\n\t\t\tStorageRoot: pulumi.Sprintf(\"gs://%v\", unityMetastore.Name),\n\t\t\tOwner: pulumi.String(\"uc admins\"),\n\t\t\tRegion: pulumi.Any(us_east1),\n\t\t\tForceDestroy: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMetastoreAssignment(ctx, \"this\", \u0026databricks.MetastoreAssignmentArgs{\n\t\t\tMetastoreId: this.ID(),\n\t\t\tWorkspaceId: pulumi.Any(workspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_metastore\" \"this\" {\n name = \"primary\"\n storage_root =\"gs://${unityMetastore.name}\"\n owner = \"uc admins\"\n region = us-east1\n force_destroy = true\n}\nresource \"databricks_metastoreassignment\" \"this\" {\n metastore_id = databricks_metastore.this.id\n workspace_id = workspaceId\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Metastore;\nimport com.pulumi.databricks.MetastoreArgs;\nimport com.pulumi.databricks.MetastoreAssignment;\nimport com.pulumi.databricks.MetastoreAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Metastore(\"this\", MetastoreArgs.builder()\n .name(\"primary\")\n .storageRoot(String.format(\"gs://%s\", unityMetastore.name()))\n .owner(\"uc admins\")\n .region(us_east1)\n .forceDestroy(true)\n .build());\n\n var thisMetastoreAssignment = new MetastoreAssignment(\"thisMetastoreAssignment\", MetastoreAssignmentArgs.builder()\n .metastoreId(this_.id())\n .workspaceId(workspaceId)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Metastore\n properties:\n name: primary\n storageRoot: gs://${unityMetastore.name}\n owner: uc admins\n region: ${[\"us-east1\"]}\n forceDestroy: true\n thisMetastoreAssignment:\n type: databricks:MetastoreAssignment\n name: this\n properties:\n metastoreId: ${this.id}\n workspaceId: ${workspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "cloud": { "type": "string", "description": "Cloud vendor of the metastore home shard (e.g., \u003cspan pulumi-lang-nodejs=\"`aws`\" pulumi-lang-dotnet=\"`Aws`\" pulumi-lang-go=\"`aws`\" pulumi-lang-python=\"`aws`\" pulumi-lang-yaml=\"`aws`\" pulumi-lang-java=\"`aws`\" pulumi-lang-hcl=\"`aws`\"\u003e`aws`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`azure`\" pulumi-lang-dotnet=\"`Azure`\" pulumi-lang-go=\"`azure`\" pulumi-lang-python=\"`azure`\" pulumi-lang-yaml=\"`azure`\" pulumi-lang-java=\"`azure`\" pulumi-lang-hcl=\"`azure`\"\u003e`azure`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gcp`\" pulumi-lang-dotnet=\"`Gcp`\" pulumi-lang-go=\"`gcp`\" pulumi-lang-python=\"`gcp`\" pulumi-lang-yaml=\"`gcp`\" pulumi-lang-java=\"`gcp`\" pulumi-lang-hcl=\"`gcp`\"\u003e`gcp`\u003c/span\u003e).\n" }, "createdAt": { "type": "integer", "description": "Time at which the metastore was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of metastore creator.\n" }, "defaultDataAccessConfigId": { "type": "string", "description": "(Optional) Unique identifier of the metastore's default data access configuration.\n" }, "deltaSharingOrganizationName": { "type": "string", "description": "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.\n" }, "deltaSharingRecipientTokenLifetimeInSeconds": { "type": "integer", "description": "Required along with \u003cspan pulumi-lang-nodejs=\"`deltaSharingScope`\" pulumi-lang-dotnet=\"`DeltaSharingScope`\" pulumi-lang-go=\"`deltaSharingScope`\" pulumi-lang-python=\"`delta_sharing_scope`\" pulumi-lang-yaml=\"`deltaSharingScope`\" pulumi-lang-java=\"`deltaSharingScope`\" pulumi-lang-hcl=\"`delta_sharing_scope`\"\u003e`deltaSharingScope`\u003c/span\u003e. Used to set expiration duration in seconds on recipient data access tokens. Defaults to 31536000 (1 year).\n" }, "deltaSharingScope": { "type": "string", "description": "Required along with \u003cspan pulumi-lang-nodejs=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-dotnet=\"`DeltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-go=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-python=\"`delta_sharing_recipient_token_lifetime_in_seconds`\" pulumi-lang-yaml=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-java=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-hcl=\"`delta_sharing_recipient_token_lifetime_in_seconds`\"\u003e`deltaSharingRecipientTokenLifetimeInSeconds`\u003c/span\u003e. 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.\n" }, "externalAccessEnabled": { "type": "boolean", "description": "Whether to allow non-DBR clients to directly access entities under the metastore.\n" }, "forceDestroy": { "type": "boolean", "description": "Destroy metastore regardless of its contents.\n" }, "globalMetastoreId": { "type": "string", "description": "Globally unique metastore ID across clouds and regions, of the form `cloud:region:metastore_id`.\n" }, "metastoreId": { "type": "string", "description": "Unique identifier of the metastore.\n" }, "name": { "type": "string", "description": "Name of metastore.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the metastore owner.\n" }, "privilegeModelVersion": { "type": "string", "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreProviderConfig:MetastoreProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "region": { "type": "string", "description": "The region of the metastore\n" }, "storageRoot": { "type": "string", "description": "Path on cloud storage account, where managed \u003cspan pulumi-lang-nodejs=\"`databricks.Table`\" pulumi-lang-dotnet=\"`databricks.Table`\" pulumi-lang-go=\"`Table`\" pulumi-lang-python=\"`Table`\" pulumi-lang-yaml=\"`databricks.Table`\" pulumi-lang-java=\"`databricks.Table`\" pulumi-lang-hcl=\"`databricks_table`\"\u003e`databricks.Table`\u003c/span\u003e are stored. If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.). Change forces creation of a new resource. If no \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e is defined for the metastore, each catalog must have a \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e defined. **It's recommended to define \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e on the catalog level.\n" }, "storageRootCredentialId": { "type": "string", "description": "(Optional) UUID of storage credential to access the metastore storage_root.\n" }, "storageRootCredentialName": { "type": "string", "description": "Name of the storage credential to access the metastore storage_root.\n" }, "updatedAt": { "type": "integer", "description": "Time at which the metastore was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the metastore.\n" } }, "required": [ "cloud", "createdAt", "createdBy", "globalMetastoreId", "metastoreId", "name", "owner", "privilegeModelVersion", "providerConfig", "region", "updatedAt", "updatedBy" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "defaultDataAccessConfigId": { "type": "string", "description": "(Optional) Unique identifier of the metastore's default data access configuration.\n" }, "deltaSharingOrganizationName": { "type": "string", "description": "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.\n" }, "deltaSharingRecipientTokenLifetimeInSeconds": { "type": "integer", "description": "Required along with \u003cspan pulumi-lang-nodejs=\"`deltaSharingScope`\" pulumi-lang-dotnet=\"`DeltaSharingScope`\" pulumi-lang-go=\"`deltaSharingScope`\" pulumi-lang-python=\"`delta_sharing_scope`\" pulumi-lang-yaml=\"`deltaSharingScope`\" pulumi-lang-java=\"`deltaSharingScope`\" pulumi-lang-hcl=\"`delta_sharing_scope`\"\u003e`deltaSharingScope`\u003c/span\u003e. Used to set expiration duration in seconds on recipient data access tokens. Defaults to 31536000 (1 year).\n" }, "deltaSharingScope": { "type": "string", "description": "Required along with \u003cspan pulumi-lang-nodejs=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-dotnet=\"`DeltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-go=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-python=\"`delta_sharing_recipient_token_lifetime_in_seconds`\" pulumi-lang-yaml=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-java=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-hcl=\"`delta_sharing_recipient_token_lifetime_in_seconds`\"\u003e`deltaSharingRecipientTokenLifetimeInSeconds`\u003c/span\u003e. 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.\n" }, "externalAccessEnabled": { "type": "boolean", "description": "Whether to allow non-DBR clients to directly access entities under the metastore.\n" }, "forceDestroy": { "type": "boolean", "description": "Destroy metastore regardless of its contents.\n" }, "name": { "type": "string", "description": "Name of metastore.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the metastore owner.\n" }, "privilegeModelVersion": { "type": "string", "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreProviderConfig:MetastoreProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "region": { "type": "string", "description": "The region of the metastore\n" }, "storageRoot": { "type": "string", "description": "Path on cloud storage account, where managed \u003cspan pulumi-lang-nodejs=\"`databricks.Table`\" pulumi-lang-dotnet=\"`databricks.Table`\" pulumi-lang-go=\"`Table`\" pulumi-lang-python=\"`Table`\" pulumi-lang-yaml=\"`databricks.Table`\" pulumi-lang-java=\"`databricks.Table`\" pulumi-lang-hcl=\"`databricks_table`\"\u003e`databricks.Table`\u003c/span\u003e are stored. If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.). Change forces creation of a new resource. If no \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e is defined for the metastore, each catalog must have a \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e defined. **It's recommended to define \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e on the catalog level.\n", "willReplaceOnChanges": true }, "storageRootCredentialId": { "type": "string", "description": "(Optional) UUID of storage credential to access the metastore storage_root.\n" }, "storageRootCredentialName": { "type": "string", "description": "Name of the storage credential to access the metastore storage_root.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering Metastore resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "cloud": { "type": "string", "description": "Cloud vendor of the metastore home shard (e.g., \u003cspan pulumi-lang-nodejs=\"`aws`\" pulumi-lang-dotnet=\"`Aws`\" pulumi-lang-go=\"`aws`\" pulumi-lang-python=\"`aws`\" pulumi-lang-yaml=\"`aws`\" pulumi-lang-java=\"`aws`\" pulumi-lang-hcl=\"`aws`\"\u003e`aws`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`azure`\" pulumi-lang-dotnet=\"`Azure`\" pulumi-lang-go=\"`azure`\" pulumi-lang-python=\"`azure`\" pulumi-lang-yaml=\"`azure`\" pulumi-lang-java=\"`azure`\" pulumi-lang-hcl=\"`azure`\"\u003e`azure`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`gcp`\" pulumi-lang-dotnet=\"`Gcp`\" pulumi-lang-go=\"`gcp`\" pulumi-lang-python=\"`gcp`\" pulumi-lang-yaml=\"`gcp`\" pulumi-lang-java=\"`gcp`\" pulumi-lang-hcl=\"`gcp`\"\u003e`gcp`\u003c/span\u003e).\n" }, "createdAt": { "type": "integer", "description": "Time at which the metastore was created, in epoch milliseconds.\n" }, "createdBy": { "type": "string", "description": "Username of metastore creator.\n" }, "defaultDataAccessConfigId": { "type": "string", "description": "(Optional) Unique identifier of the metastore's default data access configuration.\n" }, "deltaSharingOrganizationName": { "type": "string", "description": "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.\n" }, "deltaSharingRecipientTokenLifetimeInSeconds": { "type": "integer", "description": "Required along with \u003cspan pulumi-lang-nodejs=\"`deltaSharingScope`\" pulumi-lang-dotnet=\"`DeltaSharingScope`\" pulumi-lang-go=\"`deltaSharingScope`\" pulumi-lang-python=\"`delta_sharing_scope`\" pulumi-lang-yaml=\"`deltaSharingScope`\" pulumi-lang-java=\"`deltaSharingScope`\" pulumi-lang-hcl=\"`delta_sharing_scope`\"\u003e`deltaSharingScope`\u003c/span\u003e. Used to set expiration duration in seconds on recipient data access tokens. Defaults to 31536000 (1 year).\n" }, "deltaSharingScope": { "type": "string", "description": "Required along with \u003cspan pulumi-lang-nodejs=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-dotnet=\"`DeltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-go=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-python=\"`delta_sharing_recipient_token_lifetime_in_seconds`\" pulumi-lang-yaml=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-java=\"`deltaSharingRecipientTokenLifetimeInSeconds`\" pulumi-lang-hcl=\"`delta_sharing_recipient_token_lifetime_in_seconds`\"\u003e`deltaSharingRecipientTokenLifetimeInSeconds`\u003c/span\u003e. 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.\n" }, "externalAccessEnabled": { "type": "boolean", "description": "Whether to allow non-DBR clients to directly access entities under the metastore.\n" }, "forceDestroy": { "type": "boolean", "description": "Destroy metastore regardless of its contents.\n" }, "globalMetastoreId": { "type": "string", "description": "Globally unique metastore ID across clouds and regions, of the form `cloud:region:metastore_id`.\n" }, "metastoreId": { "type": "string", "description": "Unique identifier of the metastore.\n" }, "name": { "type": "string", "description": "Name of metastore.\n" }, "owner": { "type": "string", "description": "Username/groupname/sp\u003cspan pulumi-lang-nodejs=\" applicationId \" pulumi-lang-dotnet=\" ApplicationId \" pulumi-lang-go=\" applicationId \" pulumi-lang-python=\" application_id \" pulumi-lang-yaml=\" applicationId \" pulumi-lang-java=\" applicationId \" pulumi-lang-hcl=\" application_id \"\u003e applicationId \u003c/span\u003eof the metastore owner.\n" }, "privilegeModelVersion": { "type": "string", "description": "Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreProviderConfig:MetastoreProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "region": { "type": "string", "description": "The region of the metastore\n" }, "storageRoot": { "type": "string", "description": "Path on cloud storage account, where managed \u003cspan pulumi-lang-nodejs=\"`databricks.Table`\" pulumi-lang-dotnet=\"`databricks.Table`\" pulumi-lang-go=\"`Table`\" pulumi-lang-python=\"`Table`\" pulumi-lang-yaml=\"`databricks.Table`\" pulumi-lang-java=\"`databricks.Table`\" pulumi-lang-hcl=\"`databricks_table`\"\u003e`databricks.Table`\u003c/span\u003e are stored. If the URL contains special characters, such as space, `\u0026`, etc., they should be percent-encoded (space \u003e `%20`, etc.). Change forces creation of a new resource. If no \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e is defined for the metastore, each catalog must have a \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e defined. **It's recommended to define \u003cspan pulumi-lang-nodejs=\"`storageRoot`\" pulumi-lang-dotnet=\"`StorageRoot`\" pulumi-lang-go=\"`storageRoot`\" pulumi-lang-python=\"`storage_root`\" pulumi-lang-yaml=\"`storageRoot`\" pulumi-lang-java=\"`storageRoot`\" pulumi-lang-hcl=\"`storage_root`\"\u003e`storageRoot`\u003c/span\u003e on the catalog level.\n", "willReplaceOnChanges": true }, "storageRootCredentialId": { "type": "string", "description": "(Optional) UUID of storage credential to access the metastore storage_root.\n" }, "storageRootCredentialName": { "type": "string", "description": "Name of the storage credential to access the metastore storage_root.\n" }, "updatedAt": { "type": "integer", "description": "Time at which the metastore was last modified, in epoch milliseconds.\n" }, "updatedBy": { "type": "string", "description": "Username of user who last modified the metastore.\n" } }, "type": "object" } }, "databricks:index/metastoreAssignment:MetastoreAssignment": { "description": "\u003e This resource can be used with an account or workspace-level provider.\n\nA single\u003cspan pulumi-lang-nodejs=\" databricks.Metastore \" pulumi-lang-dotnet=\" databricks.Metastore \" pulumi-lang-go=\" Metastore \" pulumi-lang-python=\" Metastore \" pulumi-lang-yaml=\" databricks.Metastore \" pulumi-lang-java=\" databricks.Metastore \" pulumi-lang-hcl=\" databricks_metastore \"\u003e databricks.Metastore \u003c/span\u003ecan 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.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Metastore(\"this\", {\n name: \"primary\",\n storageRoot: `s3://${metastore.id}/metastore`,\n owner: \"uc admins\",\n region: \"us-east-1\",\n forceDestroy: true,\n});\nconst thisMetastoreAssignment = new databricks.MetastoreAssignment(\"this\", {\n metastoreId: _this.id,\n workspaceId: workspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Metastore(\"this\",\n name=\"primary\",\n storage_root=f\"s3://{metastore['id']}/metastore\",\n owner=\"uc admins\",\n region=\"us-east-1\",\n force_destroy=True)\nthis_metastore_assignment = databricks.MetastoreAssignment(\"this\",\n metastore_id=this.id,\n workspace_id=workspace_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Metastore(\"this\", new()\n {\n Name = \"primary\",\n StorageRoot = $\"s3://{metastore.Id}/metastore\",\n Owner = \"uc admins\",\n Region = \"us-east-1\",\n ForceDestroy = true,\n });\n\n var thisMetastoreAssignment = new Databricks.MetastoreAssignment(\"this\", new()\n {\n MetastoreId = @this.Id,\n WorkspaceId = workspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewMetastore(ctx, \"this\", \u0026databricks.MetastoreArgs{\n\t\t\tName: pulumi.String(\"primary\"),\n\t\t\tStorageRoot: pulumi.Sprintf(\"s3://%v/metastore\", metastore.Id),\n\t\t\tOwner: pulumi.String(\"uc admins\"),\n\t\t\tRegion: pulumi.String(\"us-east-1\"),\n\t\t\tForceDestroy: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMetastoreAssignment(ctx, \"this\", \u0026databricks.MetastoreAssignmentArgs{\n\t\t\tMetastoreId: this.ID(),\n\t\t\tWorkspaceId: pulumi.Any(workspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_metastore\" \"this\" {\n name = \"primary\"\n storage_root =\"s3://${metastore.id}/metastore\"\n owner = \"uc admins\"\n region = \"us-east-1\"\n force_destroy = true\n}\nresource \"databricks_metastoreassignment\" \"this\" {\n metastore_id = databricks_metastore.this.id\n workspace_id = workspaceId\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Metastore;\nimport com.pulumi.databricks.MetastoreArgs;\nimport com.pulumi.databricks.MetastoreAssignment;\nimport com.pulumi.databricks.MetastoreAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Metastore(\"this\", MetastoreArgs.builder()\n .name(\"primary\")\n .storageRoot(String.format(\"s3://%s/metastore\", metastore.id()))\n .owner(\"uc admins\")\n .region(\"us-east-1\")\n .forceDestroy(true)\n .build());\n\n var thisMetastoreAssignment = new MetastoreAssignment(\"thisMetastoreAssignment\", MetastoreAssignmentArgs.builder()\n .metastoreId(this_.id())\n .workspaceId(workspaceId)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Metastore\n properties:\n name: primary\n storageRoot: s3://${metastore.id}/metastore\n owner: uc admins\n region: us-east-1\n forceDestroy: true\n thisMetastoreAssignment:\n type: databricks:MetastoreAssignment\n name: this\n properties:\n metastoreId: ${this.id}\n workspaceId: ${workspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "defaultCatalogName": { "type": "string", "description": "Default catalog used for this assignment. Please use\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003einstead.\n", "deprecationMessage": "Use\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003eresource instead" }, "metastoreId": { "type": "string", "description": "Unique identifier of the parent Metastore\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreAssignmentProviderConfig:MetastoreAssignmentProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "workspaceId": { "type": "string", "description": "id of the workspace for the assignment\n" } }, "required": [ "defaultCatalogName", "metastoreId", "providerConfig", "workspaceId" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "defaultCatalogName": { "type": "string", "description": "Default catalog used for this assignment. Please use\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003einstead.\n", "deprecationMessage": "Use\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003eresource instead" }, "metastoreId": { "type": "string", "description": "Unique identifier of the parent Metastore\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreAssignmentProviderConfig:MetastoreAssignmentProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "workspaceId": { "type": "string", "description": "id of the workspace for the assignment\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "metastoreId", "workspaceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MetastoreAssignment resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "defaultCatalogName": { "type": "string", "description": "Default catalog used for this assignment. Please use\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003einstead.\n", "deprecationMessage": "Use\u003cspan pulumi-lang-nodejs=\" databricks.DefaultNamespaceSetting \" pulumi-lang-dotnet=\" databricks.DefaultNamespaceSetting \" pulumi-lang-go=\" DefaultNamespaceSetting \" pulumi-lang-python=\" DefaultNamespaceSetting \" pulumi-lang-yaml=\" databricks.DefaultNamespaceSetting \" pulumi-lang-java=\" databricks.DefaultNamespaceSetting \" pulumi-lang-hcl=\" databricks_default_namespace_setting \"\u003e databricks.DefaultNamespaceSetting \u003c/span\u003eresource instead" }, "metastoreId": { "type": "string", "description": "Unique identifier of the parent Metastore\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreAssignmentProviderConfig:MetastoreAssignmentProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "workspaceId": { "type": "string", "description": "id of the workspace for the assignment\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/metastoreDataAccess:MetastoreDataAccess": { "description": "\u003e This resource can be used with an account or workspace-level provider.\n\nOptionally, each\u003cspan pulumi-lang-nodejs=\" databricks.Metastore \" pulumi-lang-dotnet=\" databricks.Metastore \" pulumi-lang-go=\" Metastore \" pulumi-lang-python=\" Metastore \" pulumi-lang-yaml=\" databricks.Metastore \" pulumi-lang-java=\" databricks.Metastore \" pulumi-lang-hcl=\" databricks_metastore \"\u003e databricks.Metastore \u003c/span\u003ecan have a default\u003cspan pulumi-lang-nodejs=\" databricks.StorageCredential \" pulumi-lang-dotnet=\" databricks.StorageCredential \" pulumi-lang-go=\" StorageCredential \" pulumi-lang-python=\" StorageCredential \" pulumi-lang-yaml=\" databricks.StorageCredential \" pulumi-lang-java=\" databricks.StorageCredential \" pulumi-lang-hcl=\" databricks_storage_credential \"\u003e databricks.StorageCredential \u003c/span\u003edefined as \u003cspan pulumi-lang-nodejs=\"`databricks.MetastoreDataAccess`\" pulumi-lang-dotnet=\"`databricks.MetastoreDataAccess`\" pulumi-lang-go=\"`MetastoreDataAccess`\" pulumi-lang-python=\"`MetastoreDataAccess`\" pulumi-lang-yaml=\"`databricks.MetastoreDataAccess`\" pulumi-lang-java=\"`databricks.MetastoreDataAccess`\" pulumi-lang-hcl=\"`databricks_metastore_data_access`\"\u003e`databricks.MetastoreDataAccess`\u003c/span\u003e. This will be used by Unity Catalog to access data in the root storage location if defined.\n\n## Example Usage\n\nFor AWS\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.Metastore(\"this\", {\n name: \"primary\",\n storageRoot: `s3://${metastore.id}/metastore`,\n owner: \"uc admins\",\n region: \"us-east-1\",\n forceDestroy: true,\n});\nconst thisMetastoreDataAccess = new databricks.MetastoreDataAccess(\"this\", {\n metastoreId: _this.id,\n name: metastoreDataAccess.name,\n awsIamRole: {\n roleArn: metastoreDataAccess.arn,\n },\n isDefault: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.Metastore(\"this\",\n name=\"primary\",\n storage_root=f\"s3://{metastore['id']}/metastore\",\n owner=\"uc admins\",\n region=\"us-east-1\",\n force_destroy=True)\nthis_metastore_data_access = databricks.MetastoreDataAccess(\"this\",\n metastore_id=this.id,\n name=metastore_data_access[\"name\"],\n aws_iam_role={\n \"role_arn\": metastore_data_access[\"arn\"],\n },\n is_default=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Metastore(\"this\", new()\n {\n Name = \"primary\",\n StorageRoot = $\"s3://{metastore.Id}/metastore\",\n Owner = \"uc admins\",\n Region = \"us-east-1\",\n ForceDestroy = true,\n });\n\n var thisMetastoreDataAccess = new Databricks.MetastoreDataAccess(\"this\", new()\n {\n MetastoreId = @this.Id,\n Name = metastoreDataAccess.Name,\n AwsIamRole = new Databricks.Inputs.MetastoreDataAccessAwsIamRoleArgs\n {\n RoleArn = metastoreDataAccess.Arn,\n },\n IsDefault = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tthis, err := databricks.NewMetastore(ctx, \"this\", \u0026databricks.MetastoreArgs{\n\t\t\tName: pulumi.String(\"primary\"),\n\t\t\tStorageRoot: pulumi.Sprintf(\"s3://%v/metastore\", metastore.Id),\n\t\t\tOwner: pulumi.String(\"uc admins\"),\n\t\t\tRegion: pulumi.String(\"us-east-1\"),\n\t\t\tForceDestroy: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMetastoreDataAccess(ctx, \"this\", \u0026databricks.MetastoreDataAccessArgs{\n\t\t\tMetastoreId: this.ID(),\n\t\t\tName: pulumi.Any(metastoreDataAccess.Name),\n\t\t\tAwsIamRole: \u0026databricks.MetastoreDataAccessAwsIamRoleArgs{\n\t\t\t\tRoleArn: pulumi.Any(metastoreDataAccess.Arn),\n\t\t\t},\n\t\t\tIsDefault: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_metastore\" \"this\" {\n name = \"primary\"\n storage_root =\"s3://${metastore.id}/metastore\"\n owner = \"uc admins\"\n region = \"us-east-1\"\n force_destroy = true\n}\nresource \"databricks_metastoredataaccess\" \"this\" {\n metastore_id = databricks_metastore.this.id\n name = metastoreDataAccess.name\n aws_iam_role = {\n role_arn = metastoreDataAccess.arn\n }\n is_default = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Metastore;\nimport com.pulumi.databricks.MetastoreArgs;\nimport com.pulumi.databricks.MetastoreDataAccess;\nimport com.pulumi.databricks.MetastoreDataAccessArgs;\nimport com.pulumi.databricks.inputs.MetastoreDataAccessAwsIamRoleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Metastore(\"this\", MetastoreArgs.builder()\n .name(\"primary\")\n .storageRoot(String.format(\"s3://%s/metastore\", metastore.id()))\n .owner(\"uc admins\")\n .region(\"us-east-1\")\n .forceDestroy(true)\n .build());\n\n var thisMetastoreDataAccess = new MetastoreDataAccess(\"thisMetastoreDataAccess\", MetastoreDataAccessArgs.builder()\n .metastoreId(this_.id())\n .name(metastoreDataAccess.name())\n .awsIamRole(MetastoreDataAccessAwsIamRoleArgs.builder()\n .roleArn(metastoreDataAccess.arn())\n .build())\n .isDefault(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Metastore\n properties:\n name: primary\n storageRoot: s3://${metastore.id}/metastore\n owner: uc admins\n region: us-east-1\n forceDestroy: true\n thisMetastoreDataAccess:\n type: databricks:MetastoreDataAccess\n name: this\n properties:\n metastoreId: ${this.id}\n name: ${metastoreDataAccess.name}\n awsIamRole:\n roleArn: ${metastoreDataAccess.arn}\n isDefault: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nFor Azure using managed identity as credential (recommended)\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\n\nconst _this = new databricks.Metastore(\"this\", {\n name: \"primary\",\n storageRoot: std.format({\n input: \"abfss://%s@%s.dfs.core.windows.net/\",\n args: [\n unityCatalog.name,\n unityCatalogAzurermStorageAccount.name,\n ],\n }).then(invoke =\u003e invoke.result),\n owner: \"uc admins\",\n region: \"eastus\",\n forceDestroy: true,\n});\nconst thisMetastoreDataAccess = new databricks.MetastoreDataAccess(\"this\", {\n metastoreId: _this.id,\n name: \"mi_dac\",\n azureManagedIdentity: {\n accessConnectorId: accessConnectorId,\n },\n isDefault: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_std as std\n\nthis = databricks.Metastore(\"this\",\n name=\"primary\",\n storage_root=std.format(input=\"abfss://%s@%s.dfs.core.windows.net/\",\n args=[\n unity_catalog[\"name\"],\n unity_catalog_azurerm_storage_account[\"name\"],\n ]).result,\n owner=\"uc admins\",\n region=\"eastus\",\n force_destroy=True)\nthis_metastore_data_access = databricks.MetastoreDataAccess(\"this\",\n metastore_id=this.id,\n name=\"mi_dac\",\n azure_managed_identity={\n \"access_connector_id\": access_connector_id,\n },\n is_default=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.Metastore(\"this\", new()\n {\n Name = \"primary\",\n StorageRoot = Std.Format.Invoke(new()\n {\n Input = \"abfss://%s@%s.dfs.core.windows.net/\",\n Args = new[]\n {\n unityCatalog.Name,\n unityCatalogAzurermStorageAccount.Name,\n },\n }).Apply(invoke =\u003e invoke.Result),\n Owner = \"uc admins\",\n Region = \"eastus\",\n ForceDestroy = true,\n });\n\n var thisMetastoreDataAccess = new Databricks.MetastoreDataAccess(\"this\", new()\n {\n MetastoreId = @this.Id,\n Name = \"mi_dac\",\n AzureManagedIdentity = new Databricks.Inputs.MetastoreDataAccessAzureManagedIdentityArgs\n {\n AccessConnectorId = accessConnectorId,\n },\n IsDefault = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tinvokeFormat, err := std.Format(ctx, \u0026std.FormatArgs{\n\t\t\tInput: \"abfss://%s@%s.dfs.core.windows.net/\",\n\t\t\tArgs: []interface{}{\n\t\t\t\tunityCatalog.Name,\n\t\t\t\tunityCatalogAzurermStorageAccount.Name,\n\t\t\t},\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := databricks.NewMetastore(ctx, \"this\", \u0026databricks.MetastoreArgs{\n\t\t\tName: pulumi.String(\"primary\"),\n\t\t\tStorageRoot: pulumi.String(invokeFormat.Result),\n\t\t\tOwner: pulumi.String(\"uc admins\"),\n\t\t\tRegion: pulumi.String(\"eastus\"),\n\t\t\tForceDestroy: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMetastoreDataAccess(ctx, \"this\", \u0026databricks.MetastoreDataAccessArgs{\n\t\t\tMetastoreId: this.ID(),\n\t\t\tName: pulumi.String(\"mi_dac\"),\n\t\t\tAzureManagedIdentity: \u0026databricks.MetastoreDataAccessAzureManagedIdentityArgs{\n\t\t\t\tAccessConnectorId: pulumi.Any(accessConnectorId),\n\t\t\t},\n\t\t\tIsDefault: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n }\n}\n\ndata \"std_format\" \"invoke_0\" {\n input = \"abfss://%s@%s.dfs.core.windows.net/\"\n args = [unityCatalog.name, unityCatalogAzurermStorageAccount.name]\n}\n\nresource \"databricks_metastore\" \"this\" {\n name = \"primary\"\n storage_root = data.std_format.invoke_0.result\n owner = \"uc admins\"\n region = \"eastus\"\n force_destroy = true\n}\nresource \"databricks_metastoredataaccess\" \"this\" {\n metastore_id = databricks_metastore.this.id\n name = \"mi_dac\"\n azure_managed_identity = {\n access_connector_id = accessConnectorId\n }\n is_default = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Metastore;\nimport com.pulumi.databricks.MetastoreArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.FormatArgs;\nimport com.pulumi.databricks.MetastoreDataAccess;\nimport com.pulumi.databricks.MetastoreDataAccessArgs;\nimport com.pulumi.databricks.inputs.MetastoreDataAccessAzureManagedIdentityArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new Metastore(\"this\", MetastoreArgs.builder()\n .name(\"primary\")\n .storageRoot(StdFunctions.format(FormatArgs.builder()\n .input(\"abfss://%s@%s.dfs.core.windows.net/\")\n .args( \n unityCatalog.name(),\n unityCatalogAzurermStorageAccount.name())\n .build()).result())\n .owner(\"uc admins\")\n .region(\"eastus\")\n .forceDestroy(true)\n .build());\n\n var thisMetastoreDataAccess = new MetastoreDataAccess(\"thisMetastoreDataAccess\", MetastoreDataAccessArgs.builder()\n .metastoreId(this_.id())\n .name(\"mi_dac\")\n .azureManagedIdentity(MetastoreDataAccessAzureManagedIdentityArgs.builder()\n .accessConnectorId(accessConnectorId)\n .build())\n .isDefault(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Metastore\n properties:\n name: primary\n storageRoot:\n fn::invoke:\n function: std:format\n arguments:\n input: abfss://%s@%s.dfs.core.windows.net/\n args:\n - ${unityCatalog.name}\n - ${unityCatalogAzurermStorageAccount.name}\n return: result\n owner: uc admins\n region: eastus\n forceDestroy: true\n thisMetastoreDataAccess:\n type: databricks:MetastoreDataAccess\n name: this\n properties:\n metastoreId: ${this.id}\n name: mi_dac\n azureManagedIdentity:\n accessConnectorId: ${accessConnectorId}\n isDefault: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n" }, "awsIamRole": { "$ref": "#/types/databricks:index/MetastoreDataAccessAwsIamRole:MetastoreDataAccessAwsIamRole" }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/MetastoreDataAccessAzureManagedIdentity:MetastoreDataAccessAzureManagedIdentity" }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/MetastoreDataAccessAzureServicePrincipal:MetastoreDataAccessAzureServicePrincipal" }, "cloudflareApiToken": { "$ref": "#/types/databricks:index/MetastoreDataAccessCloudflareApiToken:MetastoreDataAccessCloudflareApiToken" }, "comment": { "type": "string" }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/MetastoreDataAccessDatabricksGcpServiceAccount:MetastoreDataAccessDatabricksGcpServiceAccount" }, "forceDestroy": { "type": "boolean" }, "forceUpdate": { "type": "boolean" }, "gcpServiceAccountKey": { "$ref": "#/types/databricks:index/MetastoreDataAccessGcpServiceAccountKey:MetastoreDataAccessGcpServiceAccountKey" }, "isDefault": { "type": "boolean", "description": "whether to set this credential as the default for the metastore. In practice, this should always be true.\n" }, "isolationMode": { "type": "string" }, "metastoreId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreDataAccessProviderConfig:MetastoreDataAccessProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "readOnly": { "type": "boolean" }, "skipValidation": { "type": "boolean" } }, "required": [ "databricksGcpServiceAccount", "isolationMode", "metastoreId", "name", "owner", "providerConfig" ], "inputProperties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "awsIamRole": { "$ref": "#/types/databricks:index/MetastoreDataAccessAwsIamRole:MetastoreDataAccessAwsIamRole", "willReplaceOnChanges": true }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/MetastoreDataAccessAzureManagedIdentity:MetastoreDataAccessAzureManagedIdentity", "willReplaceOnChanges": true }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/MetastoreDataAccessAzureServicePrincipal:MetastoreDataAccessAzureServicePrincipal", "willReplaceOnChanges": true }, "cloudflareApiToken": { "$ref": "#/types/databricks:index/MetastoreDataAccessCloudflareApiToken:MetastoreDataAccessCloudflareApiToken", "willReplaceOnChanges": true }, "comment": { "type": "string", "willReplaceOnChanges": true }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/MetastoreDataAccessDatabricksGcpServiceAccount:MetastoreDataAccessDatabricksGcpServiceAccount" }, "forceDestroy": { "type": "boolean", "willReplaceOnChanges": true }, "forceUpdate": { "type": "boolean", "willReplaceOnChanges": true }, "gcpServiceAccountKey": { "$ref": "#/types/databricks:index/MetastoreDataAccessGcpServiceAccountKey:MetastoreDataAccessGcpServiceAccountKey", "willReplaceOnChanges": true }, "isDefault": { "type": "boolean", "description": "whether to set this credential as the default for the metastore. In practice, this should always be true.\n", "willReplaceOnChanges": true }, "isolationMode": { "type": "string" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "willReplaceOnChanges": true }, "owner": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreDataAccessProviderConfig:MetastoreDataAccessProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "readOnly": { "type": "boolean", "willReplaceOnChanges": true }, "skipValidation": { "type": "boolean", "willReplaceOnChanges": true } }, "stateInputs": { "description": "Input properties used for looking up and filtering MetastoreDataAccess resources.\n", "properties": { "api": { "type": "string", "description": "Specifies whether to use account-level or workspace-level API. Valid values are \u003cspan pulumi-lang-nodejs=\"`account`\" pulumi-lang-dotnet=\"`Account`\" pulumi-lang-go=\"`account`\" pulumi-lang-python=\"`account`\" pulumi-lang-yaml=\"`account`\" pulumi-lang-java=\"`account`\" pulumi-lang-hcl=\"`account`\"\u003e`account`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`workspace`\" pulumi-lang-dotnet=\"`Workspace`\" pulumi-lang-go=\"`workspace`\" pulumi-lang-python=\"`workspace`\" pulumi-lang-yaml=\"`workspace`\" pulumi-lang-java=\"`workspace`\" pulumi-lang-hcl=\"`workspace`\"\u003e`workspace`\u003c/span\u003e. When not set, the API level is inferred from the provider host.\n", "willReplaceOnChanges": true }, "awsIamRole": { "$ref": "#/types/databricks:index/MetastoreDataAccessAwsIamRole:MetastoreDataAccessAwsIamRole", "willReplaceOnChanges": true }, "azureManagedIdentity": { "$ref": "#/types/databricks:index/MetastoreDataAccessAzureManagedIdentity:MetastoreDataAccessAzureManagedIdentity", "willReplaceOnChanges": true }, "azureServicePrincipal": { "$ref": "#/types/databricks:index/MetastoreDataAccessAzureServicePrincipal:MetastoreDataAccessAzureServicePrincipal", "willReplaceOnChanges": true }, "cloudflareApiToken": { "$ref": "#/types/databricks:index/MetastoreDataAccessCloudflareApiToken:MetastoreDataAccessCloudflareApiToken", "willReplaceOnChanges": true }, "comment": { "type": "string", "willReplaceOnChanges": true }, "databricksGcpServiceAccount": { "$ref": "#/types/databricks:index/MetastoreDataAccessDatabricksGcpServiceAccount:MetastoreDataAccessDatabricksGcpServiceAccount" }, "forceDestroy": { "type": "boolean", "willReplaceOnChanges": true }, "forceUpdate": { "type": "boolean", "willReplaceOnChanges": true }, "gcpServiceAccountKey": { "$ref": "#/types/databricks:index/MetastoreDataAccessGcpServiceAccountKey:MetastoreDataAccessGcpServiceAccountKey", "willReplaceOnChanges": true }, "isDefault": { "type": "boolean", "description": "whether to set this credential as the default for the metastore. In practice, this should always be true.\n", "willReplaceOnChanges": true }, "isolationMode": { "type": "string" }, "metastoreId": { "type": "string" }, "name": { "type": "string", "willReplaceOnChanges": true }, "owner": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreDataAccessProviderConfig:MetastoreDataAccessProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "readOnly": { "type": "boolean", "willReplaceOnChanges": true }, "skipValidation": { "type": "boolean", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/metastoreProvider:MetastoreProvider": { "description": "In Delta Sharing, a provider is an entity that shares data with a recipient. Within a metastore, Unity Catalog provides the ability to create a provider which contains a list of shares that have been shared with you.\n\n\u003e This resource can only be used with a workspace-level provider!\n\nA \u003cspan pulumi-lang-nodejs=\"`databricks.MetastoreProvider`\" pulumi-lang-dotnet=\"`databricks.MetastoreProvider`\" pulumi-lang-go=\"`MetastoreProvider`\" pulumi-lang-python=\"`MetastoreProvider`\" pulumi-lang-yaml=\"`databricks.MetastoreProvider`\" pulumi-lang-java=\"`databricks.MetastoreProvider`\" pulumi-lang-hcl=\"`databricks_provider`\"\u003e`databricks.MetastoreProvider`\u003c/span\u003e is contained within\u003cspan pulumi-lang-nodejs=\" databricks.Metastore \" pulumi-lang-dotnet=\" databricks.Metastore \" pulumi-lang-go=\" Metastore \" pulumi-lang-python=\" Metastore \" pulumi-lang-yaml=\" databricks.Metastore \" pulumi-lang-java=\" databricks.Metastore \" pulumi-lang-hcl=\" databricks_metastore \"\u003e databricks.Metastore \u003c/span\u003eand can contain a list of shares that have been shared with you.\n\n\u003e Databricks to Databricks sharing automatically creates the provider.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst dbprovider = new databricks.MetastoreProvider(\"dbprovider\", {\n name: \"terraform-test-provider\",\n comment: \"made by terraform 2\",\n authenticationType: \"TOKEN\",\n recipientProfileStr: JSON.stringify({\n shareCredentialsVersion: 1,\n bearerToken: \"token\",\n endpoint: \"endpoint\",\n expirationTime: \"expiration-time\",\n }),\n});\n```\n```python\nimport pulumi\nimport json\nimport pulumi_databricks as databricks\n\ndbprovider = databricks.MetastoreProvider(\"dbprovider\",\n name=\"terraform-test-provider\",\n comment=\"made by terraform 2\",\n authentication_type=\"TOKEN\",\n recipient_profile_str=json.dumps({\n \"shareCredentialsVersion\": 1,\n \"bearerToken\": \"token\",\n \"endpoint\": \"endpoint\",\n \"expirationTime\": \"expiration-time\",\n }))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Text.Json;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var dbprovider = new Databricks.MetastoreProvider(\"dbprovider\", new()\n {\n Name = \"terraform-test-provider\",\n Comment = \"made by terraform 2\",\n AuthenticationType = \"TOKEN\",\n RecipientProfileStr = JsonSerializer.Serialize(new Dictionary\u003cstring, object?\u003e\n {\n [\"shareCredentialsVersion\"] = 1,\n [\"bearerToken\"] = \"token\",\n [\"endpoint\"] = \"endpoint\",\n [\"expirationTime\"] = \"expiration-time\",\n }),\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"encoding/json\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\ttmpJSON0, err := json.Marshal(map[string]interface{}{\n\t\t\t\"shareCredentialsVersion\": 1,\n\t\t\t\"bearerToken\": \"token\",\n\t\t\t\"endpoint\": \"endpoint\",\n\t\t\t\"expirationTime\": \"expiration-time\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tjson0 := string(tmpJSON0)\n\t\t_, err = databricks.NewMetastoreProvider(ctx, \"dbprovider\", \u0026databricks.MetastoreProviderArgs{\n\t\t\tName: pulumi.String(\"terraform-test-provider\"),\n\t\t\tComment: pulumi.String(\"made by terraform 2\"),\n\t\t\tAuthenticationType: pulumi.String(\"TOKEN\"),\n\t\t\tRecipientProfileStr: pulumi.String(pulumi.String(json0)),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_metastoreprovider\" \"dbprovider\" {\n name = \"terraform-test-provider\"\n comment = \"made by terraform 2\"\n authentication_type = \"TOKEN\"\n recipient_profile_str = jsonencode({\n \"shareCredentialsVersion\" = 1\n \"bearerToken\" = \"token\"\n \"endpoint\" = \"endpoint\"\n \"expirationTime\" = \"expiration-time\"\n })\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MetastoreProvider;\nimport com.pulumi.databricks.MetastoreProviderArgs;\nimport static com.pulumi.codegen.internal.Serialization.*;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var dbprovider = new MetastoreProvider(\"dbprovider\", MetastoreProviderArgs.builder()\n .name(\"terraform-test-provider\")\n .comment(\"made by terraform 2\")\n .authenticationType(\"TOKEN\")\n .recipientProfileStr(serializeJson(\n jsonObject(\n jsonProperty(\"shareCredentialsVersion\", 1),\n jsonProperty(\"bearerToken\", \"token\"),\n jsonProperty(\"endpoint\", \"endpoint\"),\n jsonProperty(\"expirationTime\", \"expiration-time\")\n )))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n dbprovider:\n type: databricks:MetastoreProvider\n properties:\n name: terraform-test-provider\n comment: made by terraform 2\n authenticationType: TOKEN\n recipientProfileStr:\n fn::toJSON:\n shareCredentialsVersion: 1\n bearerToken: token\n endpoint: endpoint\n expirationTime: expiration-time\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.getTables \" pulumi-lang-dotnet=\" databricks.getTables \" pulumi-lang-go=\" getTables \" pulumi-lang-python=\" get_tables \" pulumi-lang-yaml=\" databricks.getTables \" pulumi-lang-java=\" databricks.getTables \" pulumi-lang-hcl=\" data.databricks_tables \"\u003e databricks.getTables \u003c/span\u003edata to list tables within Unity Catalog.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getSchemas \" pulumi-lang-dotnet=\" databricks.getSchemas \" pulumi-lang-go=\" getSchemas \" pulumi-lang-python=\" get_schemas \" pulumi-lang-yaml=\" databricks.getSchemas \" pulumi-lang-java=\" databricks.getSchemas \" pulumi-lang-hcl=\" data.databricks_schemas \"\u003e databricks.getSchemas \u003c/span\u003edata to list schemas within Unity Catalog.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getCatalogs \" pulumi-lang-dotnet=\" databricks.getCatalogs \" pulumi-lang-go=\" getCatalogs \" pulumi-lang-python=\" get_catalogs \" pulumi-lang-yaml=\" databricks.getCatalogs \" pulumi-lang-java=\" databricks.getCatalogs \" pulumi-lang-hcl=\" data.databricks_catalogs \"\u003e databricks.getCatalogs \u003c/span\u003edata to list catalogs within Unity Catalog.\n", "properties": { "authenticationType": { "type": "string", "description": "The delta sharing authentication type. Valid values are `TOKEN`.\n" }, "comment": { "type": "string", "description": "Description about the provider.\n" }, "name": { "type": "string", "description": "Name of provider. Change forces creation of a new resource.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreProviderProviderConfig:MetastoreProviderProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "recipientProfileStr": { "type": "string", "description": "This is the json file that is created from a recipient url.\n", "secret": true } }, "required": [ "authenticationType", "name", "providerConfig", "recipientProfileStr" ], "inputProperties": { "authenticationType": { "type": "string", "description": "The delta sharing authentication type. Valid values are `TOKEN`.\n" }, "comment": { "type": "string", "description": "Description about the provider.\n" }, "name": { "type": "string", "description": "Name of provider. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreProviderProviderConfig:MetastoreProviderProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "recipientProfileStr": { "type": "string", "description": "This is the json file that is created from a recipient url.\n", "secret": true } }, "requiredInputs": [ "authenticationType", "recipientProfileStr" ], "stateInputs": { "description": "Input properties used for looking up and filtering MetastoreProvider resources.\n", "properties": { "authenticationType": { "type": "string", "description": "The delta sharing authentication type. Valid values are `TOKEN`.\n" }, "comment": { "type": "string", "description": "Description about the provider.\n" }, "name": { "type": "string", "description": "Name of provider. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MetastoreProviderProviderConfig:MetastoreProviderProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "recipientProfileStr": { "type": "string", "description": "This is the json file that is created from a recipient url.\n", "secret": true } }, "type": "object" } }, "databricks:index/mlflowExperiment:MlflowExperiment": { "description": "This resource allows you to manage [MLflow experiments](https://docs.databricks.com/data/data-sources/mlflow-experiment.html) in Databricks.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst me = databricks.getCurrentUser({});\nconst _this = new databricks.MlflowExperiment(\"this\", {\n name: me.then(me =\u003e `${me.home}/Sample`),\n artifactLocation: \"s3://bucket/my-experiment\",\n tags: [\n {\n key: \"key1\",\n value: \"value1\",\n },\n {\n key: \"key2\",\n value: \"value2\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nme = databricks.get_current_user()\nthis = databricks.MlflowExperiment(\"this\",\n name=f\"{me.home}/Sample\",\n artifact_location=\"s3://bucket/my-experiment\",\n tags=[\n {\n \"key\": \"key1\",\n \"value\": \"value1\",\n },\n {\n \"key\": \"key2\",\n \"value\": \"value2\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var me = Databricks.GetCurrentUser.Invoke();\n\n var @this = new Databricks.MlflowExperiment(\"this\", new()\n {\n Name = $\"{me.Apply(getCurrentUserResult =\u003e getCurrentUserResult.Home)}/Sample\",\n ArtifactLocation = \"s3://bucket/my-experiment\",\n Tags = new[]\n {\n new Databricks.Inputs.MlflowExperimentTagArgs\n {\n Key = \"key1\",\n Value = \"value1\",\n },\n new Databricks.Inputs.MlflowExperimentTagArgs\n {\n Key = \"key2\",\n Value = \"value2\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tme, err := databricks.GetCurrentUser(ctx, \u0026databricks.GetCurrentUserArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMlflowExperiment(ctx, \"this\", \u0026databricks.MlflowExperimentArgs{\n\t\t\tName: pulumi.Sprintf(\"%v/Sample\", me.Home),\n\t\t\tArtifactLocation: pulumi.String(\"s3://bucket/my-experiment\"),\n\t\t\tTags: databricks.MlflowExperimentTagArray{\n\t\t\t\t\u0026databricks.MlflowExperimentTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"key1\"),\n\t\t\t\t\tValue: pulumi.String(\"value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.MlflowExperimentTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"key2\"),\n\t\t\t\t\tValue: pulumi.String(\"value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getcurrentuser\" \"me\" {\n}\n\nresource \"databricks_mlflowexperiment\" \"this\" {\n name =\"${data.databricks_getcurrentuser.me.home}/Sample\"\n artifact_location = \"s3://bucket/my-experiment\"\n tags {\n key = \"key1\"\n value = \"value1\"\n }\n tags {\n key = \"key2\"\n value = \"value2\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetCurrentUserArgs;\nimport com.pulumi.databricks.MlflowExperiment;\nimport com.pulumi.databricks.MlflowExperimentArgs;\nimport com.pulumi.databricks.inputs.MlflowExperimentTagArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var me = DatabricksFunctions.getCurrentUser(GetCurrentUserArgs.builder()\n .build());\n\n var this_ = new MlflowExperiment(\"this\", MlflowExperimentArgs.builder()\n .name(String.format(\"%s/Sample\", me.home()))\n .artifactLocation(\"s3://bucket/my-experiment\")\n .tags( \n MlflowExperimentTagArgs.builder()\n .key(\"key1\")\n .value(\"value1\")\n .build(),\n MlflowExperimentTagArgs.builder()\n .key(\"key2\")\n .value(\"value2\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MlflowExperiment\n properties:\n name: ${me.home}/Sample\n artifactLocation: s3://bucket/my-experiment\n tags:\n - key: key1\n value: value1\n - key: key2\n value: value2\nvariables:\n me:\n fn::invoke:\n function: databricks:getCurrentUser\n arguments: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Read*, *Edit*, or *Manage* individual experiments.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.RegisteredModel \" pulumi-lang-dotnet=\" databricks.RegisteredModel \" pulumi-lang-go=\" RegisteredModel \" pulumi-lang-python=\" RegisteredModel \" pulumi-lang-yaml=\" databricks.RegisteredModel \" pulumi-lang-java=\" databricks.RegisteredModel \" pulumi-lang-hcl=\" databricks_registered_model \"\u003e databricks.RegisteredModel \u003c/span\u003eto create [Models in Unity Catalog](https://docs.databricks.com/en/mlflow/models-in-uc.html) in Databricks.\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Directory \" pulumi-lang-dotnet=\" databricks.Directory \" pulumi-lang-go=\" Directory \" pulumi-lang-python=\" Directory \" pulumi-lang-yaml=\" databricks.Directory \" pulumi-lang-java=\" databricks.Directory \" pulumi-lang-hcl=\" databricks_directory \"\u003e databricks.Directory \u003c/span\u003eto manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MlflowModel \" pulumi-lang-dotnet=\" databricks.MlflowModel \" pulumi-lang-go=\" MlflowModel \" pulumi-lang-python=\" MlflowModel \" pulumi-lang-yaml=\" databricks.MlflowModel \" pulumi-lang-java=\" databricks.MlflowModel \" pulumi-lang-hcl=\" databricks_mlflow_model \"\u003e databricks.MlflowModel \u003c/span\u003eto create models in the [workspace model registry](https://docs.databricks.com/en/mlflow/model-registry.html) in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003edata to export a notebook from Databricks Workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n\n", "properties": { "artifactLocation": { "type": "string", "description": "Path to artifact location of the MLflow experiment.\n" }, "creationTime": { "type": "integer" }, "description": { "type": "string", "deprecationMessage": "Remove the description attribute as it no longer is used and will be removed in a future version." }, "experimentId": { "type": "string" }, "lastUpdateTime": { "type": "integer" }, "lifecycleStage": { "type": "string" }, "name": { "type": "string", "description": "Name of MLflow experiment. It must be an absolute path within the Databricks workspace, e.g. `/Users/\u003csome-username\u003e/my-experiment`. For more information about changes to experiment naming conventions, see [mlflow docs](https://docs.databricks.com/applications/mlflow/experiments.html#experiment-migration).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowExperimentProviderConfig:MlflowExperimentProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/MlflowExperimentTag:MlflowExperimentTag" }, "description": "Tags for the MLflow experiment.\n" } }, "required": [ "creationTime", "experimentId", "lastUpdateTime", "lifecycleStage", "name", "providerConfig", "tags" ], "inputProperties": { "artifactLocation": { "type": "string", "description": "Path to artifact location of the MLflow experiment.\n", "willReplaceOnChanges": true }, "creationTime": { "type": "integer" }, "description": { "type": "string", "deprecationMessage": "Remove the description attribute as it no longer is used and will be removed in a future version." }, "experimentId": { "type": "string" }, "lastUpdateTime": { "type": "integer" }, "lifecycleStage": { "type": "string" }, "name": { "type": "string", "description": "Name of MLflow experiment. It must be an absolute path within the Databricks workspace, e.g. `/Users/\u003csome-username\u003e/my-experiment`. For more information about changes to experiment naming conventions, see [mlflow docs](https://docs.databricks.com/applications/mlflow/experiments.html#experiment-migration).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowExperimentProviderConfig:MlflowExperimentProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/MlflowExperimentTag:MlflowExperimentTag" }, "description": "Tags for the MLflow experiment.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering MlflowExperiment resources.\n", "properties": { "artifactLocation": { "type": "string", "description": "Path to artifact location of the MLflow experiment.\n", "willReplaceOnChanges": true }, "creationTime": { "type": "integer" }, "description": { "type": "string", "deprecationMessage": "Remove the description attribute as it no longer is used and will be removed in a future version." }, "experimentId": { "type": "string" }, "lastUpdateTime": { "type": "integer" }, "lifecycleStage": { "type": "string" }, "name": { "type": "string", "description": "Name of MLflow experiment. It must be an absolute path within the Databricks workspace, e.g. `/Users/\u003csome-username\u003e/my-experiment`. For more information about changes to experiment naming conventions, see [mlflow docs](https://docs.databricks.com/applications/mlflow/experiments.html#experiment-migration).\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowExperimentProviderConfig:MlflowExperimentProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/MlflowExperimentTag:MlflowExperimentTag" }, "description": "Tags for the MLflow experiment.\n" } }, "type": "object" } }, "databricks:index/mlflowModel:MlflowModel": { "description": "This resource allows you to create [MLflow models](https://docs.databricks.com/applications/mlflow/models.html) in Databricks.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e This documentation covers the Workspace Model Registry. Databricks recommends using Models in Unity Catalog. Models in Unity Catalog provides centralized model governance, cross-workspace access, lineage, and deployment.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst test = new databricks.MlflowModel(\"test\", {\n name: \"My MLflow Model\",\n description: \"My MLflow model description\",\n tags: [\n {\n key: \"key1\",\n value: \"value1\",\n },\n {\n key: \"key2\",\n value: \"value2\",\n },\n ],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ntest = databricks.MlflowModel(\"test\",\n name=\"My MLflow Model\",\n description=\"My MLflow model description\",\n tags=[\n {\n \"key\": \"key1\",\n \"value\": \"value1\",\n },\n {\n \"key\": \"key2\",\n \"value\": \"value2\",\n },\n ])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var test = new Databricks.MlflowModel(\"test\", new()\n {\n Name = \"My MLflow Model\",\n Description = \"My MLflow model description\",\n Tags = new[]\n {\n new Databricks.Inputs.MlflowModelTagArgs\n {\n Key = \"key1\",\n Value = \"value1\",\n },\n new Databricks.Inputs.MlflowModelTagArgs\n {\n Key = \"key2\",\n Value = \"value2\",\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMlflowModel(ctx, \"test\", \u0026databricks.MlflowModelArgs{\n\t\t\tName: pulumi.String(\"My MLflow Model\"),\n\t\t\tDescription: pulumi.String(\"My MLflow model description\"),\n\t\t\tTags: databricks.MlflowModelTagArray{\n\t\t\t\t\u0026databricks.MlflowModelTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"key1\"),\n\t\t\t\t\tValue: pulumi.String(\"value1\"),\n\t\t\t\t},\n\t\t\t\t\u0026databricks.MlflowModelTagArgs{\n\t\t\t\t\tKey: pulumi.String(\"key2\"),\n\t\t\t\t\tValue: pulumi.String(\"value2\"),\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mlflowmodel\" \"test\" {\n name = \"My MLflow Model\"\n description = \"My MLflow model description\"\n tags {\n key = \"key1\"\n value = \"value1\"\n }\n tags {\n key = \"key2\"\n value = \"value2\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MlflowModel;\nimport com.pulumi.databricks.MlflowModelArgs;\nimport com.pulumi.databricks.inputs.MlflowModelTagArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var test = new MlflowModel(\"test\", MlflowModelArgs.builder()\n .name(\"My MLflow Model\")\n .description(\"My MLflow model description\")\n .tags( \n MlflowModelTagArgs.builder()\n .key(\"key1\")\n .value(\"value1\")\n .build(),\n MlflowModelTagArgs.builder()\n .key(\"key2\")\n .value(\"value2\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n test:\n type: databricks:MlflowModel\n properties:\n name: My MLflow Model\n description: My MLflow model description\n tags:\n - key: key1\n value: value1\n - key: key2\n value: value2\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Read*, *Edit*, *Manage Staging Versions*, *Manage Production Versions*, and *Manage* individual models.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.RegisteredModel \" pulumi-lang-dotnet=\" databricks.RegisteredModel \" pulumi-lang-go=\" RegisteredModel \" pulumi-lang-python=\" RegisteredModel \" pulumi-lang-yaml=\" databricks.RegisteredModel \" pulumi-lang-java=\" databricks.RegisteredModel \" pulumi-lang-hcl=\" databricks_registered_model \"\u003e databricks.RegisteredModel \u003c/span\u003eto create [Models in Unity Catalog](https://docs.databricks.com/en/mlflow/models-in-uc.html) in Databricks.\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.ModelServing \" pulumi-lang-dotnet=\" databricks.ModelServing \" pulumi-lang-go=\" ModelServing \" pulumi-lang-python=\" ModelServing \" pulumi-lang-yaml=\" databricks.ModelServing \" pulumi-lang-java=\" databricks.ModelServing \" pulumi-lang-hcl=\" databricks_model_serving \"\u003e databricks.ModelServing \u003c/span\u003eto serve this model on a Databricks serving endpoint.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Directory \" pulumi-lang-dotnet=\" databricks.Directory \" pulumi-lang-go=\" Directory \" pulumi-lang-python=\" Directory \" pulumi-lang-yaml=\" databricks.Directory \" pulumi-lang-java=\" databricks.Directory \" pulumi-lang-hcl=\" databricks_directory \"\u003e databricks.Directory \u003c/span\u003eto manage directories in [Databricks Workspace](https://docs.databricks.com/workspace/workspace-objects.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MlflowExperiment \" pulumi-lang-dotnet=\" databricks.MlflowExperiment \" pulumi-lang-go=\" MlflowExperiment \" pulumi-lang-python=\" MlflowExperiment \" pulumi-lang-yaml=\" databricks.MlflowExperiment \" pulumi-lang-java=\" databricks.MlflowExperiment \" pulumi-lang-hcl=\" databricks_mlflow_experiment \"\u003e databricks.MlflowExperiment \u003c/span\u003eto manage [MLflow experiments](https://docs.databricks.com/data/data-sources/mlflow-experiment.html) in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003edata to export a notebook from Databricks Workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n\n", "properties": { "description": { "type": "string", "description": "The description of the MLflow model.\n" }, "name": { "type": "string", "description": "Name of MLflow model. Change of name triggers new resource.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowModelProviderConfig:MlflowModelProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "registeredModelId": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/MlflowModelTag:MlflowModelTag" }, "description": "Tags for the MLflow model.\n" } }, "required": [ "name", "providerConfig", "registeredModelId" ], "inputProperties": { "description": { "type": "string", "description": "The description of the MLflow model.\n" }, "name": { "type": "string", "description": "Name of MLflow model. Change of name triggers new resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowModelProviderConfig:MlflowModelProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/MlflowModelTag:MlflowModelTag" }, "description": "Tags for the MLflow model.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering MlflowModel resources.\n", "properties": { "description": { "type": "string", "description": "The description of the MLflow model.\n" }, "name": { "type": "string", "description": "Name of MLflow model. Change of name triggers new resource.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowModelProviderConfig:MlflowModelProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "registeredModelId": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/MlflowModelTag:MlflowModelTag" }, "description": "Tags for the MLflow model.\n" } }, "type": "object" } }, "databricks:index/mlflowWebhook:MlflowWebhook": { "description": "This resource allows you to create [MLflow Model Registry Webhooks](https://docs.databricks.com/applications/mlflow/model-registry-webhooks.html) in Databricks. Webhooks enable you to listen for Model Registry events so your integrations can automatically trigger actions. You can use webhooks to automate and integrate your machine learning pipeline with existing CI/CD tools and workflows. Webhooks allow trigger execution of a Databricks job or call a web service on specific event(s) that is generated in the MLflow Registry - stage transitioning, creation of registered model, creation of transition request, etc.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\n### Triggering Databricks job\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\n\nconst me = databricks.getCurrentUser({});\nconst latest = databricks.getSparkVersion({});\nconst smallest = databricks.getNodeType({\n localDisk: true,\n});\nconst _this = new databricks.Notebook(\"this\", {\n path: me.then(me =\u003e `${me.home}/MLFlowWebhook`),\n language: \"PYTHON\",\n contentBase64: std.base64encode({\n input: `import json\n \nevent_message = dbutils.widgets.get(\\\\\"event_message\\\\\")\nevent_message_dict = json.loads(event_message)\nprint(f\\\\\"event data={event_message_dict}\\\\\")\n`,\n }).then(invoke =\u003e invoke.result),\n});\nconst thisJob = new databricks.Job(\"this\", {\n name: me.then(me =\u003e `Pulumi MLflowWebhook Demo (${me.alphanumeric})`),\n tasks: [{\n taskKey: \"task1\",\n newCluster: {\n numWorkers: 1,\n sparkVersion: latest.then(latest =\u003e latest.id),\n nodeTypeId: smallest.then(smallest =\u003e smallest.id),\n },\n notebookTask: {\n notebookPath: _this.path,\n },\n }],\n});\nconst patForWebhook = new databricks.Token(\"pat_for_webhook\", {\n comment: \"MLflow Webhook\",\n lifetimeSeconds: 86400000,\n});\nconst job = new databricks.MlflowWebhook(\"job\", {\n events: [\"TRANSITION_REQUEST_CREATED\"],\n description: \"Databricks Job webhook trigger\",\n status: \"ACTIVE\",\n jobSpec: {\n jobId: thisJob.id,\n workspaceUrl: me.then(me =\u003e me.workspaceUrl),\n accessToken: patForWebhook.tokenValue,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_std as std\n\nme = databricks.get_current_user()\nlatest = databricks.get_spark_version()\nsmallest = databricks.get_node_type(local_disk=True)\nthis = databricks.Notebook(\"this\",\n path=f\"{me.home}/MLFlowWebhook\",\n language=\"PYTHON\",\n content_base64=std.base64encode(input=\"\"\"import json\n \nevent_message = dbutils.widgets.get(\\\"event_message\\\")\nevent_message_dict = json.loads(event_message)\nprint(f\\\"event data={event_message_dict}\\\")\n\"\"\").result)\nthis_job = databricks.Job(\"this\",\n name=f\"Pulumi MLflowWebhook Demo ({me.alphanumeric})\",\n tasks=[{\n \"task_key\": \"task1\",\n \"new_cluster\": {\n \"num_workers\": 1,\n \"spark_version\": latest.id,\n \"node_type_id\": smallest.id,\n },\n \"notebook_task\": {\n \"notebook_path\": this.path,\n },\n }])\npat_for_webhook = databricks.Token(\"pat_for_webhook\",\n comment=\"MLflow Webhook\",\n lifetime_seconds=86400000)\njob = databricks.MlflowWebhook(\"job\",\n events=[\"TRANSITION_REQUEST_CREATED\"],\n description=\"Databricks Job webhook trigger\",\n status=\"ACTIVE\",\n job_spec={\n \"job_id\": this_job.id,\n \"workspace_url\": me.workspace_url,\n \"access_token\": pat_for_webhook.token_value,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var me = Databricks.GetCurrentUser.Invoke();\n\n var latest = Databricks.GetSparkVersion.Invoke();\n\n var smallest = Databricks.GetNodeType.Invoke(new()\n {\n LocalDisk = true,\n });\n\n var @this = new Databricks.Notebook(\"this\", new()\n {\n Path = $\"{me.Apply(getCurrentUserResult =\u003e getCurrentUserResult.Home)}/MLFlowWebhook\",\n Language = \"PYTHON\",\n ContentBase64 = Std.Base64encode.Invoke(new()\n {\n Input = @\"import json\n \nevent_message = dbutils.widgets.get(\\\"\"event_message\\\"\")\nevent_message_dict = json.loads(event_message)\nprint(f\\\"\"event data={event_message_dict}\\\"\")\n\",\n }).Apply(invoke =\u003e invoke.Result),\n });\n\n var thisJob = new Databricks.Job(\"this\", new()\n {\n Name = $\"Pulumi MLflowWebhook Demo ({me.Apply(getCurrentUserResult =\u003e getCurrentUserResult.Alphanumeric)})\",\n Tasks = new[]\n {\n new Databricks.Inputs.JobTaskArgs\n {\n TaskKey = \"task1\",\n NewCluster = new Databricks.Inputs.JobTaskNewClusterArgs\n {\n NumWorkers = 1,\n SparkVersion = latest.Apply(getSparkVersionResult =\u003e getSparkVersionResult.Id),\n NodeTypeId = smallest.Apply(getNodeTypeResult =\u003e getNodeTypeResult.Id),\n },\n NotebookTask = new Databricks.Inputs.JobTaskNotebookTaskArgs\n {\n NotebookPath = @this.Path,\n },\n },\n },\n });\n\n var patForWebhook = new Databricks.Token(\"pat_for_webhook\", new()\n {\n Comment = \"MLflow Webhook\",\n LifetimeSeconds = 86400000,\n });\n\n var job = new Databricks.MlflowWebhook(\"job\", new()\n {\n Events = new[]\n {\n \"TRANSITION_REQUEST_CREATED\",\n },\n Description = \"Databricks Job webhook trigger\",\n Status = \"ACTIVE\",\n JobSpec = new Databricks.Inputs.MlflowWebhookJobSpecArgs\n {\n JobId = thisJob.Id,\n WorkspaceUrl = me.Apply(getCurrentUserResult =\u003e getCurrentUserResult.WorkspaceUrl),\n AccessToken = patForWebhook.TokenValue,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tme, err := databricks.GetCurrentUser(ctx, \u0026databricks.GetCurrentUserArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlatest, err := databricks.GetSparkVersion(ctx, \u0026databricks.GetSparkVersionArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsmallest, err := databricks.GetNodeType(ctx, \u0026databricks.GetNodeTypeArgs{\n\t\t\tLocalDisk: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tinvokeBase64encode, err := std.Base64encode(ctx, \u0026std.Base64encodeArgs{\n\t\t\tInput: `import json\n \nevent_message = dbutils.widgets.get(\\\"event_message\\\")\nevent_message_dict = json.loads(event_message)\nprint(f\\\"event data={event_message_dict}\\\")\n`,\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := databricks.NewNotebook(ctx, \"this\", \u0026databricks.NotebookArgs{\n\t\t\tPath: pulumi.Sprintf(\"%v/MLFlowWebhook\", me.Home),\n\t\t\tLanguage: pulumi.String(\"PYTHON\"),\n\t\t\tContentBase64: pulumi.String(invokeBase64encode.Result),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthisJob, err := databricks.NewJob(ctx, \"this\", \u0026databricks.JobArgs{\n\t\t\tName: pulumi.Sprintf(\"Pulumi MLflowWebhook Demo (%v)\", me.Alphanumeric),\n\t\t\tTasks: databricks.JobTaskArray{\n\t\t\t\t\u0026databricks.JobTaskArgs{\n\t\t\t\t\tTaskKey: pulumi.String(\"task1\"),\n\t\t\t\t\tNewCluster: \u0026databricks.JobTaskNewClusterArgs{\n\t\t\t\t\t\tNumWorkers: pulumi.Int(1),\n\t\t\t\t\t\tSparkVersion: pulumi.String(latest.Id),\n\t\t\t\t\t\tNodeTypeId: pulumi.String(smallest.Id),\n\t\t\t\t\t},\n\t\t\t\t\tNotebookTask: \u0026databricks.JobTaskNotebookTaskArgs{\n\t\t\t\t\t\tNotebookPath: this.Path,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tpatForWebhook, err := databricks.NewToken(ctx, \"pat_for_webhook\", \u0026databricks.TokenArgs{\n\t\t\tComment: pulumi.String(\"MLflow Webhook\"),\n\t\t\tLifetimeSeconds: pulumi.Int(86400000),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMlflowWebhook(ctx, \"job\", \u0026databricks.MlflowWebhookArgs{\n\t\t\tEvents: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"TRANSITION_REQUEST_CREATED\"),\n\t\t\t},\n\t\t\tDescription: pulumi.String(\"Databricks Job webhook trigger\"),\n\t\t\tStatus: pulumi.String(\"ACTIVE\"),\n\t\t\tJobSpec: \u0026databricks.MlflowWebhookJobSpecArgs{\n\t\t\t\tJobId: thisJob.ID(),\n\t\t\t\tWorkspaceUrl: pulumi.String(me.WorkspaceUrl),\n\t\t\t\tAccessToken: patForWebhook.TokenValue,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n }\n}\n\ndata \"databricks_getcurrentuser\" \"me\" {\n}\ndata \"databricks_getsparkversion\" \"latest\" {\n}\ndata \"databricks_getnodetype\" \"smallest\" {\n local_disk = true\n}\n\nresource \"databricks_notebook\" \"this\" {\n path =\"${data.databricks_getcurrentuser.me.home}/MLFlowWebhook\"\n language = \"PYTHON\"\n content_base64 = base64encode(\"import json\\n \\nevent_message = dbutils.widgets.get(\\\\\\\"event_message\\\\\\\")\\nevent_message_dict = json.loads(event_message)\\nprint(f\\\\\\\"event data={event_message_dict}\\\\\\\")\\n\")\n}\nresource \"databricks_job\" \"this\" {\n name =\"Pulumi MLflowWebhook Demo (${data.databricks_getcurrentuser.me.alphanumeric})\"\n tasks {\n task_key = \"task1\"\n new_cluster = {\n num_workers = 1\n spark_version = data.databricks_getsparkversion.latest.id\n node_type_id = data.databricks_getnodetype.smallest.id\n }\n notebook_task = {\n notebook_path = databricks_notebook.this.path\n }\n }\n}\nresource \"databricks_token\" \"pat_for_webhook\" {\n comment = \"MLflow Webhook\"\n lifetime_seconds = 86400000\n}\nresource \"databricks_mlflowwebhook\" \"job\" {\n events = [\"TRANSITION_REQUEST_CREATED\"]\n description = \"Databricks Job webhook trigger\"\n status = \"ACTIVE\"\n job_spec = {\n job_id = databricks_job.this.id\n workspace_url = data.databricks_getcurrentuser.me.workspace_url\n access_token = databricks_token.pat_for_webhook.token_value\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetCurrentUserArgs;\nimport com.pulumi.databricks.inputs.GetSparkVersionArgs;\nimport com.pulumi.databricks.inputs.GetNodeTypeArgs;\nimport com.pulumi.databricks.Notebook;\nimport com.pulumi.databricks.NotebookArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.Base64encodeArgs;\nimport com.pulumi.databricks.Job;\nimport com.pulumi.databricks.JobArgs;\nimport com.pulumi.databricks.inputs.JobTaskArgs;\nimport com.pulumi.databricks.inputs.JobTaskNewClusterArgs;\nimport com.pulumi.databricks.inputs.JobTaskNotebookTaskArgs;\nimport com.pulumi.databricks.Token;\nimport com.pulumi.databricks.TokenArgs;\nimport com.pulumi.databricks.MlflowWebhook;\nimport com.pulumi.databricks.MlflowWebhookArgs;\nimport com.pulumi.databricks.inputs.MlflowWebhookJobSpecArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var me = DatabricksFunctions.getCurrentUser(GetCurrentUserArgs.builder()\n .build());\n\n final var latest = DatabricksFunctions.getSparkVersion(GetSparkVersionArgs.builder()\n .build());\n\n final var smallest = DatabricksFunctions.getNodeType(GetNodeTypeArgs.builder()\n .localDisk(true)\n .build());\n\n var this_ = new Notebook(\"this\", NotebookArgs.builder()\n .path(String.format(\"%s/MLFlowWebhook\", me.home()))\n .language(\"PYTHON\")\n .contentBase64(StdFunctions.base64encode(Base64encodeArgs.builder()\n .input(\"\"\"\nimport json\n \nevent_message = dbutils.widgets.get(\\\"event_message\\\")\nevent_message_dict = json.loads(event_message)\nprint(f\\\"event data={event_message_dict}\\\")\n \"\"\")\n .build()).result())\n .build());\n\n var thisJob = new Job(\"thisJob\", JobArgs.builder()\n .name(String.format(\"Pulumi MLflowWebhook Demo (%s)\", me.alphanumeric()))\n .tasks(JobTaskArgs.builder()\n .taskKey(\"task1\")\n .newCluster(JobTaskNewClusterArgs.builder()\n .numWorkers(1)\n .sparkVersion(latest.id())\n .nodeTypeId(smallest.id())\n .build())\n .notebookTask(JobTaskNotebookTaskArgs.builder()\n .notebookPath(this_.path())\n .build())\n .build())\n .build());\n\n var patForWebhook = new Token(\"patForWebhook\", TokenArgs.builder()\n .comment(\"MLflow Webhook\")\n .lifetimeSeconds(86400000)\n .build());\n\n var job = new MlflowWebhook(\"job\", MlflowWebhookArgs.builder()\n .events(\"TRANSITION_REQUEST_CREATED\")\n .description(\"Databricks Job webhook trigger\")\n .status(\"ACTIVE\")\n .jobSpec(MlflowWebhookJobSpecArgs.builder()\n .jobId(thisJob.id())\n .workspaceUrl(me.workspaceUrl())\n .accessToken(patForWebhook.tokenValue())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Notebook\n properties:\n path: ${me.home}/MLFlowWebhook\n language: PYTHON\n contentBase64:\n fn::invoke:\n function: std:base64encode\n arguments:\n input: \"import json\\n \\nevent_message = dbutils.widgets.get(\\\\\\\"event_message\\\\\\\")\\nevent_message_dict = json.loads(event_message)\\nprint(f\\\\\\\"event data={event_message_dict}\\\\\\\")\\n\"\n return: result\n thisJob:\n type: databricks:Job\n name: this\n properties:\n name: Pulumi MLflowWebhook Demo (${me.alphanumeric})\n tasks:\n - taskKey: task1\n newCluster:\n numWorkers: 1\n sparkVersion: ${latest.id}\n nodeTypeId: ${smallest.id}\n notebookTask:\n notebookPath: ${this.path}\n patForWebhook:\n type: databricks:Token\n name: pat_for_webhook\n properties:\n comment: MLflow Webhook\n lifetimeSeconds: 8.64e+07\n job:\n type: databricks:MlflowWebhook\n properties:\n events:\n - TRANSITION_REQUEST_CREATED\n description: Databricks Job webhook trigger\n status: ACTIVE\n jobSpec:\n jobId: ${thisJob.id}\n workspaceUrl: ${me.workspaceUrl}\n accessToken: ${patForWebhook.tokenValue}\nvariables:\n me:\n fn::invoke:\n function: databricks:getCurrentUser\n arguments: {}\n latest:\n fn::invoke:\n function: databricks:getSparkVersion\n arguments: {}\n smallest:\n fn::invoke:\n function: databricks:getNodeType\n arguments:\n localDisk: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### POSTing to URL\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst url = new databricks.MlflowWebhook(\"url\", {\n events: [\"TRANSITION_REQUEST_CREATED\"],\n description: \"URL webhook trigger\",\n httpUrlSpec: {\n url: \"https://my_cool_host/webhook\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nurl = databricks.MlflowWebhook(\"url\",\n events=[\"TRANSITION_REQUEST_CREATED\"],\n description=\"URL webhook trigger\",\n http_url_spec={\n \"url\": \"https://my_cool_host/webhook\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var url = new Databricks.MlflowWebhook(\"url\", new()\n {\n Events = new[]\n {\n \"TRANSITION_REQUEST_CREATED\",\n },\n Description = \"URL webhook trigger\",\n HttpUrlSpec = new Databricks.Inputs.MlflowWebhookHttpUrlSpecArgs\n {\n Url = \"https://my_cool_host/webhook\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMlflowWebhook(ctx, \"url\", \u0026databricks.MlflowWebhookArgs{\n\t\t\tEvents: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"TRANSITION_REQUEST_CREATED\"),\n\t\t\t},\n\t\t\tDescription: pulumi.String(\"URL webhook trigger\"),\n\t\t\tHttpUrlSpec: \u0026databricks.MlflowWebhookHttpUrlSpecArgs{\n\t\t\t\tUrl: pulumi.String(\"https://my_cool_host/webhook\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mlflowwebhook\" \"url\" {\n events = [\"TRANSITION_REQUEST_CREATED\"]\n description = \"URL webhook trigger\"\n http_url_spec = {\n url = \"https://my_cool_host/webhook\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MlflowWebhook;\nimport com.pulumi.databricks.MlflowWebhookArgs;\nimport com.pulumi.databricks.inputs.MlflowWebhookHttpUrlSpecArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var url = new MlflowWebhook(\"url\", MlflowWebhookArgs.builder()\n .events(\"TRANSITION_REQUEST_CREATED\")\n .description(\"URL webhook trigger\")\n .httpUrlSpec(MlflowWebhookHttpUrlSpecArgs.builder()\n .url(\"https://my_cool_host/webhook\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n url:\n type: databricks:MlflowWebhook\n properties:\n events:\n - TRANSITION_REQUEST_CREATED\n description: URL webhook trigger\n httpUrlSpec:\n url: https://my_cool_host/webhook\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n* MLflow webhooks could be configured only by workspace admins.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Directory \" pulumi-lang-dotnet=\" databricks.Directory \" pulumi-lang-go=\" Directory \" pulumi-lang-python=\" Directory \" pulumi-lang-yaml=\" databricks.Directory \" pulumi-lang-java=\" databricks.Directory \" pulumi-lang-hcl=\" databricks_directory \"\u003e databricks.Directory \u003c/span\u003eto manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MlflowExperiment \" pulumi-lang-dotnet=\" databricks.MlflowExperiment \" pulumi-lang-go=\" MlflowExperiment \" pulumi-lang-python=\" MlflowExperiment \" pulumi-lang-yaml=\" databricks.MlflowExperiment \" pulumi-lang-java=\" databricks.MlflowExperiment \" pulumi-lang-hcl=\" databricks_mlflow_experiment \"\u003e databricks.MlflowExperiment \u003c/span\u003eto manage [MLflow experiments](https://docs.databricks.com/data/data-sources/mlflow-experiment.html) in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MlflowModel \" pulumi-lang-dotnet=\" databricks.MlflowModel \" pulumi-lang-go=\" MlflowModel \" pulumi-lang-python=\" MlflowModel \" pulumi-lang-yaml=\" databricks.MlflowModel \" pulumi-lang-java=\" databricks.MlflowModel \" pulumi-lang-hcl=\" databricks_mlflow_model \"\u003e databricks.MlflowModel \u003c/span\u003eto create [MLflow models](https://docs.databricks.com/applications/mlflow/models.html) in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003edata to export a notebook from Databricks Workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "description": { "type": "string", "description": "Optional description of the MLflow webhook.\n" }, "events": { "type": "array", "items": { "type": "string" }, "description": "The list of events that will trigger execution of Databricks job or POSTing to an URL, for example, `MODEL_VERSION_CREATED`, `MODEL_VERSION_TRANSITIONED_STAGE`, `TRANSITION_REQUEST_CREATED`, etc. Refer to the [Webhooks API documentation](https://docs.databricks.com/dev-tools/api/latest/mlflow.html#operation/create-registry-webhook) for a full list of supported events.\n\nConfiguration must include one of \u003cspan pulumi-lang-nodejs=\"`httpUrlSpec`\" pulumi-lang-dotnet=\"`HttpUrlSpec`\" pulumi-lang-go=\"`httpUrlSpec`\" pulumi-lang-python=\"`http_url_spec`\" pulumi-lang-yaml=\"`httpUrlSpec`\" pulumi-lang-java=\"`httpUrlSpec`\" pulumi-lang-hcl=\"`http_url_spec`\"\u003e`httpUrlSpec`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`jobSpec`\" pulumi-lang-dotnet=\"`JobSpec`\" pulumi-lang-go=\"`jobSpec`\" pulumi-lang-python=\"`job_spec`\" pulumi-lang-yaml=\"`jobSpec`\" pulumi-lang-java=\"`jobSpec`\" pulumi-lang-hcl=\"`job_spec`\"\u003e`jobSpec`\u003c/span\u003e blocks, but not both.\n" }, "httpUrlSpec": { "$ref": "#/types/databricks:index/MlflowWebhookHttpUrlSpec:MlflowWebhookHttpUrlSpec" }, "jobSpec": { "$ref": "#/types/databricks:index/MlflowWebhookJobSpec:MlflowWebhookJobSpec" }, "modelName": { "type": "string", "description": "Name of MLflow model for which webhook will be created. If the model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowWebhookProviderConfig:MlflowWebhookProviderConfig" }, "status": { "type": "string", "description": "Optional status of webhook. Possible values are `ACTIVE`, `TEST_MODE`, `DISABLED`. Default is `ACTIVE`.\n" } }, "required": [ "events", "providerConfig" ], "inputProperties": { "description": { "type": "string", "description": "Optional description of the MLflow webhook.\n" }, "events": { "type": "array", "items": { "type": "string" }, "description": "The list of events that will trigger execution of Databricks job or POSTing to an URL, for example, `MODEL_VERSION_CREATED`, `MODEL_VERSION_TRANSITIONED_STAGE`, `TRANSITION_REQUEST_CREATED`, etc. Refer to the [Webhooks API documentation](https://docs.databricks.com/dev-tools/api/latest/mlflow.html#operation/create-registry-webhook) for a full list of supported events.\n\nConfiguration must include one of \u003cspan pulumi-lang-nodejs=\"`httpUrlSpec`\" pulumi-lang-dotnet=\"`HttpUrlSpec`\" pulumi-lang-go=\"`httpUrlSpec`\" pulumi-lang-python=\"`http_url_spec`\" pulumi-lang-yaml=\"`httpUrlSpec`\" pulumi-lang-java=\"`httpUrlSpec`\" pulumi-lang-hcl=\"`http_url_spec`\"\u003e`httpUrlSpec`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`jobSpec`\" pulumi-lang-dotnet=\"`JobSpec`\" pulumi-lang-go=\"`jobSpec`\" pulumi-lang-python=\"`job_spec`\" pulumi-lang-yaml=\"`jobSpec`\" pulumi-lang-java=\"`jobSpec`\" pulumi-lang-hcl=\"`job_spec`\"\u003e`jobSpec`\u003c/span\u003e blocks, but not both.\n" }, "httpUrlSpec": { "$ref": "#/types/databricks:index/MlflowWebhookHttpUrlSpec:MlflowWebhookHttpUrlSpec" }, "jobSpec": { "$ref": "#/types/databricks:index/MlflowWebhookJobSpec:MlflowWebhookJobSpec" }, "modelName": { "type": "string", "description": "Name of MLflow model for which webhook will be created. If the model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowWebhookProviderConfig:MlflowWebhookProviderConfig" }, "status": { "type": "string", "description": "Optional status of webhook. Possible values are `ACTIVE`, `TEST_MODE`, `DISABLED`. Default is `ACTIVE`.\n" } }, "requiredInputs": [ "events" ], "stateInputs": { "description": "Input properties used for looking up and filtering MlflowWebhook resources.\n", "properties": { "description": { "type": "string", "description": "Optional description of the MLflow webhook.\n" }, "events": { "type": "array", "items": { "type": "string" }, "description": "The list of events that will trigger execution of Databricks job or POSTing to an URL, for example, `MODEL_VERSION_CREATED`, `MODEL_VERSION_TRANSITIONED_STAGE`, `TRANSITION_REQUEST_CREATED`, etc. Refer to the [Webhooks API documentation](https://docs.databricks.com/dev-tools/api/latest/mlflow.html#operation/create-registry-webhook) for a full list of supported events.\n\nConfiguration must include one of \u003cspan pulumi-lang-nodejs=\"`httpUrlSpec`\" pulumi-lang-dotnet=\"`HttpUrlSpec`\" pulumi-lang-go=\"`httpUrlSpec`\" pulumi-lang-python=\"`http_url_spec`\" pulumi-lang-yaml=\"`httpUrlSpec`\" pulumi-lang-java=\"`httpUrlSpec`\" pulumi-lang-hcl=\"`http_url_spec`\"\u003e`httpUrlSpec`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`jobSpec`\" pulumi-lang-dotnet=\"`JobSpec`\" pulumi-lang-go=\"`jobSpec`\" pulumi-lang-python=\"`job_spec`\" pulumi-lang-yaml=\"`jobSpec`\" pulumi-lang-java=\"`jobSpec`\" pulumi-lang-hcl=\"`job_spec`\"\u003e`jobSpec`\u003c/span\u003e blocks, but not both.\n" }, "httpUrlSpec": { "$ref": "#/types/databricks:index/MlflowWebhookHttpUrlSpec:MlflowWebhookHttpUrlSpec" }, "jobSpec": { "$ref": "#/types/databricks:index/MlflowWebhookJobSpec:MlflowWebhookJobSpec" }, "modelName": { "type": "string", "description": "Name of MLflow model for which webhook will be created. If the model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/MlflowWebhookProviderConfig:MlflowWebhookProviderConfig" }, "status": { "type": "string", "description": "Optional status of webhook. Possible values are `ACTIVE`, `TEST_MODE`, `DISABLED`. Default is `ACTIVE`.\n" } }, "type": "object" } }, "databricks:index/modelServing:ModelServing": { "description": "This resource allows you to manage [Model Serving](https://docs.databricks.com/machine-learning/model-serving/index.html) endpoints in Databricks, including custom models, external models, and foundation models. For newer foundation models, including Llama 4, please use the\u003cspan pulumi-lang-nodejs=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-dotnet=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-go=\" ModelServingProvisionedThroughput \" pulumi-lang-python=\" ModelServingProvisionedThroughput \" pulumi-lang-yaml=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-java=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-hcl=\" databricks_model_serving_provisioned_throughput \"\u003e databricks.ModelServingProvisionedThroughput \u003c/span\u003eresource.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e If you replace \u003cspan pulumi-lang-nodejs=\"`servedModels`\" pulumi-lang-dotnet=\"`ServedModels`\" pulumi-lang-go=\"`servedModels`\" pulumi-lang-python=\"`served_models`\" pulumi-lang-yaml=\"`servedModels`\" pulumi-lang-java=\"`servedModels`\" pulumi-lang-hcl=\"`served_models`\"\u003e`servedModels`\u003c/span\u003e with \u003cspan pulumi-lang-nodejs=\"`servedEntities`\" pulumi-lang-dotnet=\"`ServedEntities`\" pulumi-lang-go=\"`servedEntities`\" pulumi-lang-python=\"`served_entities`\" pulumi-lang-yaml=\"`servedEntities`\" pulumi-lang-java=\"`servedEntities`\" pulumi-lang-hcl=\"`served_entities`\"\u003e`servedEntities`\u003c/span\u003e in an existing serving endpoint, the serving endpoint will briefly go into an update state (~30 seconds) and increment the config version.\n\n## Example Usage\n\nCreating a CPU serving endpoint\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.ModelServing(\"this\", {\n name: \"ads-serving-endpoint\",\n config: {\n servedEntities: [\n {\n name: \"prod_model\",\n entityName: \"ads-model\",\n entityVersion: \"2\",\n workloadSize: \"Small\",\n scaleToZeroEnabled: true,\n },\n {\n name: \"candidate_model\",\n entityName: \"ads-model\",\n entityVersion: \"4\",\n workloadSize: \"Small\",\n scaleToZeroEnabled: false,\n },\n ],\n trafficConfig: {\n routes: [\n {\n servedModelName: \"prod_model\",\n trafficPercentage: 90,\n },\n {\n servedModelName: \"candidate_model\",\n trafficPercentage: 10,\n },\n ],\n },\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.ModelServing(\"this\",\n name=\"ads-serving-endpoint\",\n config={\n \"served_entities\": [\n {\n \"name\": \"prod_model\",\n \"entity_name\": \"ads-model\",\n \"entity_version\": \"2\",\n \"workload_size\": \"Small\",\n \"scale_to_zero_enabled\": True,\n },\n {\n \"name\": \"candidate_model\",\n \"entity_name\": \"ads-model\",\n \"entity_version\": \"4\",\n \"workload_size\": \"Small\",\n \"scale_to_zero_enabled\": False,\n },\n ],\n \"traffic_config\": {\n \"routes\": [\n {\n \"served_model_name\": \"prod_model\",\n \"traffic_percentage\": 90,\n },\n {\n \"served_model_name\": \"candidate_model\",\n \"traffic_percentage\": 10,\n },\n ],\n },\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.ModelServing(\"this\", new()\n {\n Name = \"ads-serving-endpoint\",\n Config = new Databricks.Inputs.ModelServingConfigArgs\n {\n ServedEntities = new[]\n {\n new Databricks.Inputs.ModelServingConfigServedEntityArgs\n {\n Name = \"prod_model\",\n EntityName = \"ads-model\",\n EntityVersion = \"2\",\n WorkloadSize = \"Small\",\n ScaleToZeroEnabled = true,\n },\n new Databricks.Inputs.ModelServingConfigServedEntityArgs\n {\n Name = \"candidate_model\",\n EntityName = \"ads-model\",\n EntityVersion = \"4\",\n WorkloadSize = \"Small\",\n ScaleToZeroEnabled = false,\n },\n },\n TrafficConfig = new Databricks.Inputs.ModelServingConfigTrafficConfigArgs\n {\n Routes = new[]\n {\n new Databricks.Inputs.ModelServingConfigTrafficConfigRouteArgs\n {\n ServedModelName = \"prod_model\",\n TrafficPercentage = 90,\n },\n new Databricks.Inputs.ModelServingConfigTrafficConfigRouteArgs\n {\n ServedModelName = \"candidate_model\",\n TrafficPercentage = 10,\n },\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewModelServing(ctx, \"this\", \u0026databricks.ModelServingArgs{\n\t\t\tName: pulumi.String(\"ads-serving-endpoint\"),\n\t\t\tConfig: \u0026databricks.ModelServingConfigArgs{\n\t\t\t\tServedEntities: databricks.ModelServingConfigServedEntityArray{\n\t\t\t\t\t\u0026databricks.ModelServingConfigServedEntityArgs{\n\t\t\t\t\t\tName: pulumi.String(\"prod_model\"),\n\t\t\t\t\t\tEntityName: pulumi.String(\"ads-model\"),\n\t\t\t\t\t\tEntityVersion: pulumi.String(\"2\"),\n\t\t\t\t\t\tWorkloadSize: pulumi.String(\"Small\"),\n\t\t\t\t\t\tScaleToZeroEnabled: pulumi.Bool(true),\n\t\t\t\t\t},\n\t\t\t\t\t\u0026databricks.ModelServingConfigServedEntityArgs{\n\t\t\t\t\t\tName: pulumi.String(\"candidate_model\"),\n\t\t\t\t\t\tEntityName: pulumi.String(\"ads-model\"),\n\t\t\t\t\t\tEntityVersion: pulumi.String(\"4\"),\n\t\t\t\t\t\tWorkloadSize: pulumi.String(\"Small\"),\n\t\t\t\t\t\tScaleToZeroEnabled: pulumi.Bool(false),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tTrafficConfig: \u0026databricks.ModelServingConfigTrafficConfigArgs{\n\t\t\t\t\tRoutes: databricks.ModelServingConfigTrafficConfigRouteArray{\n\t\t\t\t\t\t\u0026databricks.ModelServingConfigTrafficConfigRouteArgs{\n\t\t\t\t\t\t\tServedModelName: pulumi.String(\"prod_model\"),\n\t\t\t\t\t\t\tTrafficPercentage: pulumi.Int(90),\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\u0026databricks.ModelServingConfigTrafficConfigRouteArgs{\n\t\t\t\t\t\t\tServedModelName: pulumi.String(\"candidate_model\"),\n\t\t\t\t\t\t\tTrafficPercentage: pulumi.Int(10),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_modelserving\" \"this\" {\n name = \"ads-serving-endpoint\"\n config = {\n served_entities = [{\n \"name\" = \"prod_model\"\n \"entityName\" = \"ads-model\"\n \"entityVersion\" = \"2\"\n \"workloadSize\" = \"Small\"\n \"scaleToZeroEnabled\" = true\n }, {\n \"name\" = \"candidate_model\"\n \"entityName\" = \"ads-model\"\n \"entityVersion\" = \"4\"\n \"workloadSize\" = \"Small\"\n \"scaleToZeroEnabled\" = false\n }]\n traffic_config = {\n routes = [{\n \"servedModelName\" = \"prod_model\"\n \"trafficPercentage\" = 90\n }, {\n \"servedModelName\" = \"candidate_model\"\n \"trafficPercentage\" = 10\n }]\n }\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ModelServing;\nimport com.pulumi.databricks.ModelServingArgs;\nimport com.pulumi.databricks.inputs.ModelServingConfigArgs;\nimport com.pulumi.databricks.inputs.ModelServingConfigTrafficConfigArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new ModelServing(\"this\", ModelServingArgs.builder()\n .name(\"ads-serving-endpoint\")\n .config(ModelServingConfigArgs.builder()\n .servedEntities( \n ModelServingConfigServedEntityArgs.builder()\n .name(\"prod_model\")\n .entityName(\"ads-model\")\n .entityVersion(\"2\")\n .workloadSize(\"Small\")\n .scaleToZeroEnabled(true)\n .build(),\n ModelServingConfigServedEntityArgs.builder()\n .name(\"candidate_model\")\n .entityName(\"ads-model\")\n .entityVersion(\"4\")\n .workloadSize(\"Small\")\n .scaleToZeroEnabled(false)\n .build())\n .trafficConfig(ModelServingConfigTrafficConfigArgs.builder()\n .routes( \n ModelServingConfigTrafficConfigRouteArgs.builder()\n .servedModelName(\"prod_model\")\n .trafficPercentage(90)\n .build(),\n ModelServingConfigTrafficConfigRouteArgs.builder()\n .servedModelName(\"candidate_model\")\n .trafficPercentage(10)\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:ModelServing\n properties:\n name: ads-serving-endpoint\n config:\n servedEntities:\n - name: prod_model\n entityName: ads-model\n entityVersion: '2'\n workloadSize: Small\n scaleToZeroEnabled: true\n - name: candidate_model\n entityName: ads-model\n entityVersion: '4'\n workloadSize: Small\n scaleToZeroEnabled: false\n trafficConfig:\n routes:\n - servedModelName: prod_model\n trafficPercentage: 90\n - servedModelName: candidate_model\n trafficPercentage: 10\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreating a Foundation Model endpoint\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst llama = new databricks.ModelServing(\"llama\", {\n name: \"llama_3_2_3b_instruct\",\n aiGateway: {\n usageTrackingConfig: {\n enabled: true,\n },\n },\n config: {\n servedEntities: [{\n name: \"meta_llama_v3_2_3b_instruct-3\",\n entityName: \"system.ai.llama_v3_2_3b_instruct\",\n entityVersion: \"2\",\n scaleToZeroEnabled: true,\n maxProvisionedThroughput: 44000,\n }],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nllama = databricks.ModelServing(\"llama\",\n name=\"llama_3_2_3b_instruct\",\n ai_gateway={\n \"usage_tracking_config\": {\n \"enabled\": True,\n },\n },\n config={\n \"served_entities\": [{\n \"name\": \"meta_llama_v3_2_3b_instruct-3\",\n \"entity_name\": \"system.ai.llama_v3_2_3b_instruct\",\n \"entity_version\": \"2\",\n \"scale_to_zero_enabled\": True,\n \"max_provisioned_throughput\": 44000,\n }],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var llama = new Databricks.ModelServing(\"llama\", new()\n {\n Name = \"llama_3_2_3b_instruct\",\n AiGateway = new Databricks.Inputs.ModelServingAiGatewayArgs\n {\n UsageTrackingConfig = new Databricks.Inputs.ModelServingAiGatewayUsageTrackingConfigArgs\n {\n Enabled = true,\n },\n },\n Config = new Databricks.Inputs.ModelServingConfigArgs\n {\n ServedEntities = new[]\n {\n new Databricks.Inputs.ModelServingConfigServedEntityArgs\n {\n Name = \"meta_llama_v3_2_3b_instruct-3\",\n EntityName = \"system.ai.llama_v3_2_3b_instruct\",\n EntityVersion = \"2\",\n ScaleToZeroEnabled = true,\n MaxProvisionedThroughput = 44000,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewModelServing(ctx, \"llama\", \u0026databricks.ModelServingArgs{\n\t\t\tName: pulumi.String(\"llama_3_2_3b_instruct\"),\n\t\t\tAiGateway: \u0026databricks.ModelServingAiGatewayArgs{\n\t\t\t\tUsageTrackingConfig: \u0026databricks.ModelServingAiGatewayUsageTrackingConfigArgs{\n\t\t\t\t\tEnabled: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t\tConfig: \u0026databricks.ModelServingConfigArgs{\n\t\t\t\tServedEntities: databricks.ModelServingConfigServedEntityArray{\n\t\t\t\t\t\u0026databricks.ModelServingConfigServedEntityArgs{\n\t\t\t\t\t\tName: pulumi.String(\"meta_llama_v3_2_3b_instruct-3\"),\n\t\t\t\t\t\tEntityName: pulumi.String(\"system.ai.llama_v3_2_3b_instruct\"),\n\t\t\t\t\t\tEntityVersion: pulumi.String(\"2\"),\n\t\t\t\t\t\tScaleToZeroEnabled: pulumi.Bool(true),\n\t\t\t\t\t\tMaxProvisionedThroughput: pulumi.Int(44000),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_modelserving\" \"llama\" {\n name = \"llama_3_2_3b_instruct\"\n ai_gateway = {\n usage_tracking_config = {\n enabled = true\n }\n }\n config = {\n served_entities = [{\n \"name\" = \"meta_llama_v3_2_3b_instruct-3\"\n \"entityName\" = \"system.ai.llama_v3_2_3b_instruct\"\n \"entityVersion\" = \"2\"\n \"scaleToZeroEnabled\" = true\n \"maxProvisionedThroughput\" = 44000\n }]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ModelServing;\nimport com.pulumi.databricks.ModelServingArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayUsageTrackingConfigArgs;\nimport com.pulumi.databricks.inputs.ModelServingConfigArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var llama = new ModelServing(\"llama\", ModelServingArgs.builder()\n .name(\"llama_3_2_3b_instruct\")\n .aiGateway(ModelServingAiGatewayArgs.builder()\n .usageTrackingConfig(ModelServingAiGatewayUsageTrackingConfigArgs.builder()\n .enabled(true)\n .build())\n .build())\n .config(ModelServingConfigArgs.builder()\n .servedEntities(ModelServingConfigServedEntityArgs.builder()\n .name(\"meta_llama_v3_2_3b_instruct-3\")\n .entityName(\"system.ai.llama_v3_2_3b_instruct\")\n .entityVersion(\"2\")\n .scaleToZeroEnabled(true)\n .maxProvisionedThroughput(44000)\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n llama:\n type: databricks:ModelServing\n properties:\n name: llama_3_2_3b_instruct\n aiGateway:\n usageTrackingConfig:\n enabled: true\n config:\n servedEntities:\n - name: meta_llama_v3_2_3b_instruct-3\n entityName: system.ai.llama_v3_2_3b_instruct\n entityVersion: '2'\n scaleToZeroEnabled: true\n maxProvisionedThroughput: 44000\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreating an External Model endpoint\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst gpt4o = new databricks.ModelServing(\"gpt_4o\", {\n name: \"gpt-4o-mini\",\n aiGateway: {\n usageTrackingConfig: {\n enabled: true,\n },\n rateLimits: [{\n calls: 10,\n key: \"endpoint\",\n renewalPeriod: \"minute\",\n }],\n inferenceTableConfig: {\n enabled: true,\n tableNamePrefix: \"gpt-4o-mini\",\n catalogName: \"ml\",\n schemaName: \"ai_gateway\",\n },\n guardrails: {\n input: {\n invalidKeywords: [\"SuperSecretProject\"],\n pii: {\n behavior: \"BLOCK\",\n },\n },\n output: {\n pii: {\n behavior: \"BLOCK\",\n },\n },\n },\n },\n config: {\n servedEntities: [{\n name: \"gpt-4o-mini\",\n externalModel: {\n name: \"gpt-4o-mini\",\n provider: \"openai\",\n task: \"llm/v1/chat\",\n openaiConfig: {\n openaiApiKey: \"{{secrets/llm_scope/openai_api_key}}\",\n },\n },\n }],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ngpt4o = databricks.ModelServing(\"gpt_4o\",\n name=\"gpt-4o-mini\",\n ai_gateway={\n \"usage_tracking_config\": {\n \"enabled\": True,\n },\n \"rate_limits\": [{\n \"calls\": 10,\n \"key\": \"endpoint\",\n \"renewal_period\": \"minute\",\n }],\n \"inference_table_config\": {\n \"enabled\": True,\n \"table_name_prefix\": \"gpt-4o-mini\",\n \"catalog_name\": \"ml\",\n \"schema_name\": \"ai_gateway\",\n },\n \"guardrails\": {\n \"input\": {\n \"invalid_keywords\": [\"SuperSecretProject\"],\n \"pii\": {\n \"behavior\": \"BLOCK\",\n },\n },\n \"output\": {\n \"pii\": {\n \"behavior\": \"BLOCK\",\n },\n },\n },\n },\n config={\n \"served_entities\": [{\n \"name\": \"gpt-4o-mini\",\n \"external_model\": {\n \"name\": \"gpt-4o-mini\",\n \"provider\": \"openai\",\n \"task\": \"llm/v1/chat\",\n \"openai_config\": {\n \"openai_api_key\": \"{{secrets/llm_scope/openai_api_key}}\",\n },\n },\n }],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var gpt4o = new Databricks.ModelServing(\"gpt_4o\", new()\n {\n Name = \"gpt-4o-mini\",\n AiGateway = new Databricks.Inputs.ModelServingAiGatewayArgs\n {\n UsageTrackingConfig = new Databricks.Inputs.ModelServingAiGatewayUsageTrackingConfigArgs\n {\n Enabled = true,\n },\n RateLimits = new[]\n {\n new Databricks.Inputs.ModelServingAiGatewayRateLimitArgs\n {\n Calls = 10,\n Key = \"endpoint\",\n RenewalPeriod = \"minute\",\n },\n },\n InferenceTableConfig = new Databricks.Inputs.ModelServingAiGatewayInferenceTableConfigArgs\n {\n Enabled = true,\n TableNamePrefix = \"gpt-4o-mini\",\n CatalogName = \"ml\",\n SchemaName = \"ai_gateway\",\n },\n Guardrails = new Databricks.Inputs.ModelServingAiGatewayGuardrailsArgs\n {\n Input = new Databricks.Inputs.ModelServingAiGatewayGuardrailsInputArgs\n {\n InvalidKeywords = new[]\n {\n \"SuperSecretProject\",\n },\n Pii = new Databricks.Inputs.ModelServingAiGatewayGuardrailsInputPiiArgs\n {\n Behavior = \"BLOCK\",\n },\n },\n Output = new Databricks.Inputs.ModelServingAiGatewayGuardrailsOutputArgs\n {\n Pii = new Databricks.Inputs.ModelServingAiGatewayGuardrailsOutputPiiArgs\n {\n Behavior = \"BLOCK\",\n },\n },\n },\n },\n Config = new Databricks.Inputs.ModelServingConfigArgs\n {\n ServedEntities = new[]\n {\n new Databricks.Inputs.ModelServingConfigServedEntityArgs\n {\n Name = \"gpt-4o-mini\",\n ExternalModel = new Databricks.Inputs.ModelServingConfigServedEntityExternalModelArgs\n {\n Name = \"gpt-4o-mini\",\n Provider = \"openai\",\n Task = \"llm/v1/chat\",\n OpenaiConfig = new Databricks.Inputs.ModelServingConfigServedEntityExternalModelOpenaiConfigArgs\n {\n OpenaiApiKey = \"{{secrets/llm_scope/openai_api_key}}\",\n },\n },\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewModelServing(ctx, \"gpt_4o\", \u0026databricks.ModelServingArgs{\n\t\t\tName: pulumi.String(\"gpt-4o-mini\"),\n\t\t\tAiGateway: \u0026databricks.ModelServingAiGatewayArgs{\n\t\t\t\tUsageTrackingConfig: \u0026databricks.ModelServingAiGatewayUsageTrackingConfigArgs{\n\t\t\t\t\tEnabled: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t\tRateLimits: databricks.ModelServingAiGatewayRateLimitArray{\n\t\t\t\t\t\u0026databricks.ModelServingAiGatewayRateLimitArgs{\n\t\t\t\t\t\tCalls: pulumi.Int(10),\n\t\t\t\t\t\tKey: pulumi.String(\"endpoint\"),\n\t\t\t\t\t\tRenewalPeriod: pulumi.String(\"minute\"),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\tInferenceTableConfig: \u0026databricks.ModelServingAiGatewayInferenceTableConfigArgs{\n\t\t\t\t\tEnabled: pulumi.Bool(true),\n\t\t\t\t\tTableNamePrefix: pulumi.String(\"gpt-4o-mini\"),\n\t\t\t\t\tCatalogName: pulumi.String(\"ml\"),\n\t\t\t\t\tSchemaName: pulumi.String(\"ai_gateway\"),\n\t\t\t\t},\n\t\t\t\tGuardrails: \u0026databricks.ModelServingAiGatewayGuardrailsArgs{\n\t\t\t\t\tInput: \u0026databricks.ModelServingAiGatewayGuardrailsInputTypeArgs{\n\t\t\t\t\t\tInvalidKeywords: pulumi.StringArray{\n\t\t\t\t\t\t\tpulumi.String(\"SuperSecretProject\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t\tPii: \u0026databricks.ModelServingAiGatewayGuardrailsInputPiiArgs{\n\t\t\t\t\t\t\tBehavior: pulumi.String(\"BLOCK\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t\tOutput: \u0026databricks.ModelServingAiGatewayGuardrailsOutputTypeArgs{\n\t\t\t\t\t\tPii: \u0026databricks.ModelServingAiGatewayGuardrailsOutputPiiArgs{\n\t\t\t\t\t\t\tBehavior: pulumi.String(\"BLOCK\"),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t\tConfig: \u0026databricks.ModelServingConfigArgs{\n\t\t\t\tServedEntities: databricks.ModelServingConfigServedEntityArray{\n\t\t\t\t\t\u0026databricks.ModelServingConfigServedEntityArgs{\n\t\t\t\t\t\tName: pulumi.String(\"gpt-4o-mini\"),\n\t\t\t\t\t\tExternalModel: \u0026databricks.ModelServingConfigServedEntityExternalModelArgs{\n\t\t\t\t\t\t\tName: pulumi.String(\"gpt-4o-mini\"),\n\t\t\t\t\t\t\tProvider: pulumi.String(\"openai\"),\n\t\t\t\t\t\t\tTask: pulumi.String(\"llm/v1/chat\"),\n\t\t\t\t\t\t\tOpenaiConfig: \u0026databricks.ModelServingConfigServedEntityExternalModelOpenaiConfigArgs{\n\t\t\t\t\t\t\t\tOpenaiApiKey: pulumi.String(\"{{secrets/llm_scope/openai_api_key}}\"),\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_modelserving\" \"gpt_4o\" {\n name = \"gpt-4o-mini\"\n ai_gateway = {\n usage_tracking_config = {\n enabled = true\n }\n rate_limits = [{\n \"calls\" = 10\n \"key\" = \"endpoint\"\n \"renewalPeriod\" = \"minute\"\n }]\n inference_table_config = {\n enabled = true\n table_name_prefix = \"gpt-4o-mini\"\n catalog_name = \"ml\"\n schema_name = \"ai_gateway\"\n }\n guardrails = {\n input = {\n invalid_keywords = [\"SuperSecretProject\"]\n pii = {\n behavior = \"BLOCK\"\n }\n }\n output = {\n pii = {\n behavior = \"BLOCK\"\n }\n }\n }\n }\n config = {\n served_entities = [{\n \"name\" = \"gpt-4o-mini\"\n \"externalModel\" = {\n \"name\" = \"gpt-4o-mini\"\n \"provider\" = \"openai\"\n \"task\" = \"llm/v1/chat\"\n \"openaiConfig\" = {\n \"openaiApiKey\" = \"{{secrets/llm_scope/openai_api_key}}\"\n }\n }\n }]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ModelServing;\nimport com.pulumi.databricks.ModelServingArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayUsageTrackingConfigArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayInferenceTableConfigArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayGuardrailsArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayGuardrailsInputArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayGuardrailsInputPiiArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayGuardrailsOutputArgs;\nimport com.pulumi.databricks.inputs.ModelServingAiGatewayGuardrailsOutputPiiArgs;\nimport com.pulumi.databricks.inputs.ModelServingConfigArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var gpt4o = new ModelServing(\"gpt4o\", ModelServingArgs.builder()\n .name(\"gpt-4o-mini\")\n .aiGateway(ModelServingAiGatewayArgs.builder()\n .usageTrackingConfig(ModelServingAiGatewayUsageTrackingConfigArgs.builder()\n .enabled(true)\n .build())\n .rateLimits(ModelServingAiGatewayRateLimitArgs.builder()\n .calls(10)\n .key(\"endpoint\")\n .renewalPeriod(\"minute\")\n .build())\n .inferenceTableConfig(ModelServingAiGatewayInferenceTableConfigArgs.builder()\n .enabled(true)\n .tableNamePrefix(\"gpt-4o-mini\")\n .catalogName(\"ml\")\n .schemaName(\"ai_gateway\")\n .build())\n .guardrails(ModelServingAiGatewayGuardrailsArgs.builder()\n .input(ModelServingAiGatewayGuardrailsInputArgs.builder()\n .invalidKeywords(\"SuperSecretProject\")\n .pii(ModelServingAiGatewayGuardrailsInputPiiArgs.builder()\n .behavior(\"BLOCK\")\n .build())\n .build())\n .output(ModelServingAiGatewayGuardrailsOutputArgs.builder()\n .pii(ModelServingAiGatewayGuardrailsOutputPiiArgs.builder()\n .behavior(\"BLOCK\")\n .build())\n .build())\n .build())\n .build())\n .config(ModelServingConfigArgs.builder()\n .servedEntities(ModelServingConfigServedEntityArgs.builder()\n .name(\"gpt-4o-mini\")\n .externalModel(ModelServingConfigServedEntityExternalModelArgs.builder()\n .name(\"gpt-4o-mini\")\n .provider(\"openai\")\n .task(\"llm/v1/chat\")\n .openaiConfig(ModelServingConfigServedEntityExternalModelOpenaiConfigArgs.builder()\n .openaiApiKey(\"{{secrets/llm_scope/openai_api_key}}\")\n .build())\n .build())\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n gpt4o:\n type: databricks:ModelServing\n name: gpt_4o\n properties:\n name: gpt-4o-mini\n aiGateway:\n usageTrackingConfig:\n enabled: true\n rateLimits:\n - calls: 10\n key: endpoint\n renewalPeriod: minute\n inferenceTableConfig:\n enabled: true\n tableNamePrefix: gpt-4o-mini\n catalogName: ml\n schemaName: ai_gateway\n guardrails:\n input:\n invalidKeywords:\n - SuperSecretProject\n pii:\n behavior: BLOCK\n output:\n pii:\n behavior: BLOCK\n config:\n servedEntities:\n - name: gpt-4o-mini\n externalModel:\n name: gpt-4o-mini\n provider: openai\n task: llm/v1/chat\n openaiConfig:\n openaiApiKey: '{{secrets/llm_scope/openai_api_key}}'\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Manage*, *Query* or *View* individual serving endpoints.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-dotnet=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-go=\" ModelServingProvisionedThroughput \" pulumi-lang-python=\" ModelServingProvisionedThroughput \" pulumi-lang-yaml=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-java=\" databricks.ModelServingProvisionedThroughput \" pulumi-lang-hcl=\" databricks_model_serving_provisioned_throughput \"\u003e databricks.ModelServingProvisionedThroughput \u003c/span\u003eto create [Foundation Model provisioned throughput](https://docs.databricks.com/aws/en/machine-learning/foundation-model-apis/deploy-prov-throughput-foundation-model-apis) endpoints in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.RegisteredModel \" pulumi-lang-dotnet=\" databricks.RegisteredModel \" pulumi-lang-go=\" RegisteredModel \" pulumi-lang-python=\" RegisteredModel \" pulumi-lang-yaml=\" databricks.RegisteredModel \" pulumi-lang-java=\" databricks.RegisteredModel \" pulumi-lang-hcl=\" databricks_registered_model \"\u003e databricks.RegisteredModel \u003c/span\u003eto create [Models in Unity Catalog](https://docs.databricks.com/en/mlflow/models-in-uc.html) in Databricks.\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Directory \" pulumi-lang-dotnet=\" databricks.Directory \" pulumi-lang-go=\" Directory \" pulumi-lang-python=\" Directory \" pulumi-lang-yaml=\" databricks.Directory \" pulumi-lang-java=\" databricks.Directory \" pulumi-lang-hcl=\" databricks_directory \"\u003e databricks.Directory \u003c/span\u003eto manage directories in [Databricks Workspace](https://docs.databricks.com/workspace/workspace-objects.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MlflowModel \" pulumi-lang-dotnet=\" databricks.MlflowModel \" pulumi-lang-go=\" MlflowModel \" pulumi-lang-python=\" MlflowModel \" pulumi-lang-yaml=\" databricks.MlflowModel \" pulumi-lang-java=\" databricks.MlflowModel \" pulumi-lang-hcl=\" databricks_mlflow_model \"\u003e databricks.MlflowModel \u003c/span\u003eto create models in the [workspace model registry](https://docs.databricks.com/en/mlflow/model-registry.html) in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003edata to export a notebook from Databricks Workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n\n", "properties": { "aiGateway": { "$ref": "#/types/databricks:index/ModelServingAiGateway:ModelServingAiGateway", "description": "A block with AI Gateway configuration for the serving endpoint. *Note: only external model endpoints are supported as of now.*\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this serving endpoint.\n" }, "config": { "$ref": "#/types/databricks:index/ModelServingConfig:ModelServingConfig", "description": "The model serving endpoint configuration. This is optional and can be added and modified after creation. If \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e was provided in a previous apply but is not provided in the current apply, no change to the model serving endpoint will occur. To recreate the model serving endpoint without the \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e block, the model serving endpoint must be destroyed and recreated.\n" }, "description": { "type": "string", "description": "The description of the model serving endpoint.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/ModelServingEmailNotifications:ModelServingEmailNotifications", "description": "A block with Email notification setting.\n" }, "endpointUrl": { "type": "string", "description": "Invocation url of the endpoint.\n" }, "name": { "type": "string", "description": "The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the updated name.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ModelServingProviderConfig:ModelServingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingRateLimit:ModelServingRateLimit" }, "description": "A list of rate limit blocks to be applied to the serving endpoint. *Note: only external and foundation model endpoints are supported as of now.*\n", "deprecationMessage": "Please use AI Gateway to manage rate limits." }, "routeOptimized": { "type": "boolean", "description": "A boolean enabling route optimization for the endpoint. *Note: only available for custom models.*\n" }, "servingEndpointId": { "type": "string", "description": "Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingTag:ModelServingTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" } }, "required": [ "config", "endpointUrl", "name", "providerConfig", "servingEndpointId" ], "inputProperties": { "aiGateway": { "$ref": "#/types/databricks:index/ModelServingAiGateway:ModelServingAiGateway", "description": "A block with AI Gateway configuration for the serving endpoint. *Note: only external model endpoints are supported as of now.*\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this serving endpoint.\n" }, "config": { "$ref": "#/types/databricks:index/ModelServingConfig:ModelServingConfig", "description": "The model serving endpoint configuration. This is optional and can be added and modified after creation. If \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e was provided in a previous apply but is not provided in the current apply, no change to the model serving endpoint will occur. To recreate the model serving endpoint without the \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e block, the model serving endpoint must be destroyed and recreated.\n" }, "description": { "type": "string", "description": "The description of the model serving endpoint.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/ModelServingEmailNotifications:ModelServingEmailNotifications", "description": "A block with Email notification setting.\n" }, "name": { "type": "string", "description": "The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the updated name.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/ModelServingProviderConfig:ModelServingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingRateLimit:ModelServingRateLimit" }, "description": "A list of rate limit blocks to be applied to the serving endpoint. *Note: only external and foundation model endpoints are supported as of now.*\n", "deprecationMessage": "Please use AI Gateway to manage rate limits." }, "routeOptimized": { "type": "boolean", "description": "A boolean enabling route optimization for the endpoint. *Note: only available for custom models.*\n", "willReplaceOnChanges": true }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingTag:ModelServingTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" } }, "stateInputs": { "description": "Input properties used for looking up and filtering ModelServing resources.\n", "properties": { "aiGateway": { "$ref": "#/types/databricks:index/ModelServingAiGateway:ModelServingAiGateway", "description": "A block with AI Gateway configuration for the serving endpoint. *Note: only external model endpoints are supported as of now.*\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this serving endpoint.\n" }, "config": { "$ref": "#/types/databricks:index/ModelServingConfig:ModelServingConfig", "description": "The model serving endpoint configuration. This is optional and can be added and modified after creation. If \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e was provided in a previous apply but is not provided in the current apply, no change to the model serving endpoint will occur. To recreate the model serving endpoint without the \u003cspan pulumi-lang-nodejs=\"`config`\" pulumi-lang-dotnet=\"`Config`\" pulumi-lang-go=\"`config`\" pulumi-lang-python=\"`config`\" pulumi-lang-yaml=\"`config`\" pulumi-lang-java=\"`config`\" pulumi-lang-hcl=\"`config`\"\u003e`config`\u003c/span\u003e block, the model serving endpoint must be destroyed and recreated.\n" }, "description": { "type": "string", "description": "The description of the model serving endpoint.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/ModelServingEmailNotifications:ModelServingEmailNotifications", "description": "A block with Email notification setting.\n" }, "endpointUrl": { "type": "string", "description": "Invocation url of the endpoint.\n" }, "name": { "type": "string", "description": "The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the updated name.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/ModelServingProviderConfig:ModelServingProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingRateLimit:ModelServingRateLimit" }, "description": "A list of rate limit blocks to be applied to the serving endpoint. *Note: only external and foundation model endpoints are supported as of now.*\n", "deprecationMessage": "Please use AI Gateway to manage rate limits." }, "routeOptimized": { "type": "boolean", "description": "A boolean enabling route optimization for the endpoint. *Note: only available for custom models.*\n", "willReplaceOnChanges": true }, "servingEndpointId": { "type": "string", "description": "Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingTag:ModelServingTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" } }, "type": "object" } }, "databricks:index/modelServingProvisionedThroughput:ModelServingProvisionedThroughput": { "description": "This resource allows you to manage [Foundation Model provisioned throughput](https://docs.databricks.com/aws/en/machine-learning/foundation-model-apis/deploy-prov-throughput-foundation-model-apis) endpoints in Databricks.\n\n\u003e This resource is currently in private preview, and only available for enrolled customers.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n## Example Usage\n\nCreating a Foundation Model provisioned throughput endpoint\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst llama = new databricks.ModelServingProvisionedThroughput(\"llama\", {\n aiGateway: {\n usageTrackingConfig: {\n enabled: true,\n },\n },\n config: {\n servedEntities: [{\n entityName: \"system.ai.llama-4-maverick\",\n entityVersion: \"1\",\n provisionedModelUnits: 100,\n }],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nllama = databricks.ModelServingProvisionedThroughput(\"llama\",\n ai_gateway={\n \"usage_tracking_config\": {\n \"enabled\": True,\n },\n },\n config={\n \"served_entities\": [{\n \"entity_name\": \"system.ai.llama-4-maverick\",\n \"entity_version\": \"1\",\n \"provisioned_model_units\": 100,\n }],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var llama = new Databricks.ModelServingProvisionedThroughput(\"llama\", new()\n {\n AiGateway = new Databricks.Inputs.ModelServingProvisionedThroughputAiGatewayArgs\n {\n UsageTrackingConfig = new Databricks.Inputs.ModelServingProvisionedThroughputAiGatewayUsageTrackingConfigArgs\n {\n Enabled = true,\n },\n },\n Config = new Databricks.Inputs.ModelServingProvisionedThroughputConfigArgs\n {\n ServedEntities = new[]\n {\n new Databricks.Inputs.ModelServingProvisionedThroughputConfigServedEntityArgs\n {\n EntityName = \"system.ai.llama-4-maverick\",\n EntityVersion = \"1\",\n ProvisionedModelUnits = 100,\n },\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewModelServingProvisionedThroughput(ctx, \"llama\", \u0026databricks.ModelServingProvisionedThroughputArgs{\n\t\t\tAiGateway: \u0026databricks.ModelServingProvisionedThroughputAiGatewayArgs{\n\t\t\t\tUsageTrackingConfig: \u0026databricks.ModelServingProvisionedThroughputAiGatewayUsageTrackingConfigArgs{\n\t\t\t\t\tEnabled: pulumi.Bool(true),\n\t\t\t\t},\n\t\t\t},\n\t\t\tConfig: \u0026databricks.ModelServingProvisionedThroughputConfigArgs{\n\t\t\t\tServedEntities: databricks.ModelServingProvisionedThroughputConfigServedEntityArray{\n\t\t\t\t\t\u0026databricks.ModelServingProvisionedThroughputConfigServedEntityArgs{\n\t\t\t\t\t\tEntityName: pulumi.String(\"system.ai.llama-4-maverick\"),\n\t\t\t\t\t\tEntityVersion: pulumi.String(\"1\"),\n\t\t\t\t\t\tProvisionedModelUnits: pulumi.Int(100),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_modelservingprovisionedthroughput\" \"llama\" {\n ai_gateway = {\n usage_tracking_config = {\n enabled = true\n }\n }\n config = {\n served_entities = [{\n \"entityName\" = \"system.ai.llama-4-maverick\"\n \"entityVersion\" = \"1\"\n \"provisionedModelUnits\" = 100\n }]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ModelServingProvisionedThroughput;\nimport com.pulumi.databricks.ModelServingProvisionedThroughputArgs;\nimport com.pulumi.databricks.inputs.ModelServingProvisionedThroughputAiGatewayArgs;\nimport com.pulumi.databricks.inputs.ModelServingProvisionedThroughputAiGatewayUsageTrackingConfigArgs;\nimport com.pulumi.databricks.inputs.ModelServingProvisionedThroughputConfigArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var llama = new ModelServingProvisionedThroughput(\"llama\", ModelServingProvisionedThroughputArgs.builder()\n .aiGateway(ModelServingProvisionedThroughputAiGatewayArgs.builder()\n .usageTrackingConfig(ModelServingProvisionedThroughputAiGatewayUsageTrackingConfigArgs.builder()\n .enabled(true)\n .build())\n .build())\n .config(ModelServingProvisionedThroughputConfigArgs.builder()\n .servedEntities(ModelServingProvisionedThroughputConfigServedEntityArgs.builder()\n .entityName(\"system.ai.llama-4-maverick\")\n .entityVersion(\"1\")\n .provisionedModelUnits(100)\n .build())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n llama:\n type: databricks:ModelServingProvisionedThroughput\n properties:\n aiGateway:\n usageTrackingConfig:\n enabled: true\n config:\n servedEntities:\n - entityName: system.ai.llama-4-maverick\n entityVersion: '1'\n provisionedModelUnits: 100\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Access Control\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Permissions \" pulumi-lang-dotnet=\" databricks.Permissions \" pulumi-lang-go=\" Permissions \" pulumi-lang-python=\" Permissions \" pulumi-lang-yaml=\" databricks.Permissions \" pulumi-lang-java=\" databricks.Permissions \" pulumi-lang-hcl=\" databricks_permissions \"\u003e databricks.Permissions \u003c/span\u003ecan control which groups or individual users can *Manage*, *Query* or *View* individual serving endpoints.\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.ModelServing \" pulumi-lang-dotnet=\" databricks.ModelServing \" pulumi-lang-go=\" ModelServing \" pulumi-lang-python=\" ModelServing \" pulumi-lang-yaml=\" databricks.ModelServing \" pulumi-lang-java=\" databricks.ModelServing \" pulumi-lang-hcl=\" databricks_model_serving \"\u003e databricks.ModelServing \u003c/span\u003eto create custom and external serving endpoints in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.RegisteredModel \" pulumi-lang-dotnet=\" databricks.RegisteredModel \" pulumi-lang-go=\" RegisteredModel \" pulumi-lang-python=\" RegisteredModel \" pulumi-lang-yaml=\" databricks.RegisteredModel \" pulumi-lang-java=\" databricks.RegisteredModel \" pulumi-lang-hcl=\" databricks_registered_model \"\u003e databricks.RegisteredModel \u003c/span\u003eto create [Models in Unity Catalog](https://docs.databricks.com/en/mlflow/models-in-uc.html) in Databricks.\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Directory \" pulumi-lang-dotnet=\" databricks.Directory \" pulumi-lang-go=\" Directory \" pulumi-lang-python=\" Directory \" pulumi-lang-yaml=\" databricks.Directory \" pulumi-lang-java=\" databricks.Directory \" pulumi-lang-hcl=\" databricks_directory \"\u003e databricks.Directory \u003c/span\u003eto manage directories in [Databricks Workspace](https://docs.databricks.com/workspace/workspace-objects.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MlflowModel \" pulumi-lang-dotnet=\" databricks.MlflowModel \" pulumi-lang-go=\" MlflowModel \" pulumi-lang-python=\" MlflowModel \" pulumi-lang-yaml=\" databricks.MlflowModel \" pulumi-lang-java=\" databricks.MlflowModel \" pulumi-lang-hcl=\" databricks_mlflow_model \"\u003e databricks.MlflowModel \u003c/span\u003eto create models in the [workspace model registry](https://docs.databricks.com/en/mlflow/model-registry.html) in Databricks.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003eto manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.Notebook \" pulumi-lang-dotnet=\" databricks.Notebook \" pulumi-lang-go=\" Notebook \" pulumi-lang-python=\" Notebook \" pulumi-lang-yaml=\" databricks.Notebook \" pulumi-lang-java=\" databricks.Notebook \" pulumi-lang-hcl=\" databricks_notebook \"\u003e databricks.Notebook \u003c/span\u003edata to export a notebook from Databricks Workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Repo \" pulumi-lang-dotnet=\" databricks.Repo \" pulumi-lang-go=\" Repo \" pulumi-lang-python=\" Repo \" pulumi-lang-yaml=\" databricks.Repo \" pulumi-lang-java=\" databricks.Repo \" pulumi-lang-hcl=\" databricks_repo \"\u003e databricks.Repo \u003c/span\u003eto manage [Databricks Repos](https://docs.databricks.com/repos.html).\n\n", "properties": { "aiGateway": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGateway:ModelServingProvisionedThroughputAiGateway", "description": "A block with AI Gateway configuration for the serving endpoint. *Note: only external model endpoints are supported as of now.*\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this serving endpoint.\n" }, "config": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputConfig:ModelServingProvisionedThroughputConfig", "description": "The model serving endpoint configuration.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputEmailNotifications:ModelServingProvisionedThroughputEmailNotifications", "description": "A block with Email notification setting.\n" }, "name": { "type": "string", "description": "The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the updated name.\n" }, "providerConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputProviderConfig:ModelServingProvisionedThroughputProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "servingEndpointId": { "type": "string", "description": "Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputTag:ModelServingProvisionedThroughputTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" } }, "required": [ "config", "name", "providerConfig", "servingEndpointId" ], "inputProperties": { "aiGateway": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGateway:ModelServingProvisionedThroughputAiGateway", "description": "A block with AI Gateway configuration for the serving endpoint. *Note: only external model endpoints are supported as of now.*\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this serving endpoint.\n" }, "config": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputConfig:ModelServingProvisionedThroughputConfig", "description": "The model serving endpoint configuration.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputEmailNotifications:ModelServingProvisionedThroughputEmailNotifications", "description": "A block with Email notification setting.\n" }, "name": { "type": "string", "description": "The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the updated name.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputProviderConfig:ModelServingProvisionedThroughputProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputTag:ModelServingProvisionedThroughputTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" } }, "requiredInputs": [ "config" ], "stateInputs": { "description": "Input properties used for looking up and filtering ModelServingProvisionedThroughput resources.\n", "properties": { "aiGateway": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputAiGateway:ModelServingProvisionedThroughputAiGateway", "description": "A block with AI Gateway configuration for the serving endpoint. *Note: only external model endpoints are supported as of now.*\n" }, "budgetPolicyId": { "type": "string", "description": "The Budget Policy ID set for this serving endpoint.\n" }, "config": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputConfig:ModelServingProvisionedThroughputConfig", "description": "The model serving endpoint configuration.\n" }, "emailNotifications": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputEmailNotifications:ModelServingProvisionedThroughputEmailNotifications", "description": "A block with Email notification setting.\n" }, "name": { "type": "string", "description": "The name of the model serving endpoint. This field is required and must be unique across a workspace. An endpoint name can consist of alphanumeric characters, dashes, and underscores. NOTE: Changing this name will delete the existing endpoint and create a new endpoint with the updated name.\n", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputProviderConfig:ModelServingProvisionedThroughputProviderConfig", "description": "Configure the provider for management through account provider. This block consists of the following fields:\n" }, "servingEndpointId": { "type": "string", "description": "Unique identifier of the serving endpoint primarily used to set permissions and refer to this instance for other operations.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/databricks:index/ModelServingProvisionedThroughputTag:ModelServingProvisionedThroughputTag" }, "description": "Tags to be attached to the serving endpoint and automatically propagated to billing logs.\n" } }, "type": "object" } }, "databricks:index/mount:Mount": { "description": "\u003e Please switch to databricks_volume. DBFS mounts are deprecated.\n\n\u003e This resource can only be used with a workspace-level provider!\n\n\u003e When \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e is not specified, it will create the smallest possible cluster in the default availability zone with name equal to or starting with `terraform-mount` for the shortest possible amount of time. To avoid mount failure due to potentially quota or capacity issues with the default cluster, we recommend specifying a cluster to use for mounting.\n\n\u003e CRUD operations on a databricks mount require a running cluster. Due to limitations of terraform and the databricks mounts APIs, if the cluster the mount was most recently created / updated using no longer exists AND the mount is destroyed as a part of a pulumi up, we mark it as deleted without cleaning it up from the workspace.\n\nThis resource will [mount your cloud storage](https://docs.databricks.com/data/databricks-file-system.html#mount-object-storage-to-dbfs) on `dbfs:/mnt/name`. Right now it supports mounting AWS S3, Azure (Blob Storage, ADLS Gen1 \u0026 Gen2), Google Cloud Storage. It is important to understand that this will start up the cluster if the cluster is terminated. The read and refresh terraform command will require a cluster and may take some time to validate the mount.\n\nThis resource provides two ways of mounting a storage account:\n\n1. Use a storage-specific configuration block - this could be used for the most cases, as it will fill most of the necessary details. Currently we support following configuration blocks:\n\n* \u003cspan pulumi-lang-nodejs=\"`s3`\" pulumi-lang-dotnet=\"`S3`\" pulumi-lang-go=\"`s3`\" pulumi-lang-python=\"`s3`\" pulumi-lang-yaml=\"`s3`\" pulumi-lang-java=\"`s3`\" pulumi-lang-hcl=\"`s3`\"\u003e`s3`\u003c/span\u003e - to [mount AWS S3](https://docs.databricks.com/data/data-sources/aws/amazon-s3.html)\n* \u003cspan pulumi-lang-nodejs=\"`gs`\" pulumi-lang-dotnet=\"`Gs`\" pulumi-lang-go=\"`gs`\" pulumi-lang-python=\"`gs`\" pulumi-lang-yaml=\"`gs`\" pulumi-lang-java=\"`gs`\" pulumi-lang-hcl=\"`gs`\"\u003e`gs`\u003c/span\u003e - to [mount Google Cloud Storage](https://docs.gcp.databricks.com/data/data-sources/google/gcs.html)\n* \u003cspan pulumi-lang-nodejs=\"`abfs`\" pulumi-lang-dotnet=\"`Abfs`\" pulumi-lang-go=\"`abfs`\" pulumi-lang-python=\"`abfs`\" pulumi-lang-yaml=\"`abfs`\" pulumi-lang-java=\"`abfs`\" pulumi-lang-hcl=\"`abfs`\"\u003e`abfs`\u003c/span\u003e - to [mount ADLS Gen2](https://docs.microsoft.com/en-us/azure/databricks/data/data-sources/azure/adls-gen2/) using Azure Blob Filesystem (ABFS) driver\n* \u003cspan pulumi-lang-nodejs=\"`adl`\" pulumi-lang-dotnet=\"`Adl`\" pulumi-lang-go=\"`adl`\" pulumi-lang-python=\"`adl`\" pulumi-lang-yaml=\"`adl`\" pulumi-lang-java=\"`adl`\" pulumi-lang-hcl=\"`adl`\"\u003e`adl`\u003c/span\u003e - to [mount ADLS Gen1](https://docs.microsoft.com/en-us/azure/databricks/data/data-sources/azure/azure-datalake) using Azure Data Lake (ADL) driver\n* \u003cspan pulumi-lang-nodejs=\"`wasb`\" pulumi-lang-dotnet=\"`Wasb`\" pulumi-lang-go=\"`wasb`\" pulumi-lang-python=\"`wasb`\" pulumi-lang-yaml=\"`wasb`\" pulumi-lang-java=\"`wasb`\" pulumi-lang-hcl=\"`wasb`\"\u003e`wasb`\u003c/span\u003e - to [mount Azure Blob Storage](https://docs.microsoft.com/en-us/azure/databricks/data/data-sources/azure/azure-storage) using Windows Azure Storage Blob (WASB) driver\n\n1. Use generic arguments - you have a responsibility for providing all necessary parameters that are required to mount specific storage. This is most flexible option\n\n## Common arguments\n\n* \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e - (Optional, String) Cluster to use for mounting. If no cluster is specified, a new cluster will be created and will mount the bucket for all of the clusters in this workspace. If the cluster is not running - it's going to be started, so be aware to set auto-termination rules on it.\n* \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e - (Optional, String) Name, under which mount will be accessible in `dbfs:/mnt/\u003cMOUNT_NAME\u003e`. If not specified, provider will try to infer it from depending on the resource type:\n * \u003cspan pulumi-lang-nodejs=\"`bucketName`\" pulumi-lang-dotnet=\"`BucketName`\" pulumi-lang-go=\"`bucketName`\" pulumi-lang-python=\"`bucket_name`\" pulumi-lang-yaml=\"`bucketName`\" pulumi-lang-java=\"`bucketName`\" pulumi-lang-hcl=\"`bucket_name`\"\u003e`bucketName`\u003c/span\u003e for AWS S3 and Google Cloud Storage\n * \u003cspan pulumi-lang-nodejs=\"`containerName`\" pulumi-lang-dotnet=\"`ContainerName`\" pulumi-lang-go=\"`containerName`\" pulumi-lang-python=\"`container_name`\" pulumi-lang-yaml=\"`containerName`\" pulumi-lang-java=\"`containerName`\" pulumi-lang-hcl=\"`container_name`\"\u003e`containerName`\u003c/span\u003e for ADLS Gen2 and Azure Blob Storage\n * \u003cspan pulumi-lang-nodejs=\"`storageResourceName`\" pulumi-lang-dotnet=\"`StorageResourceName`\" pulumi-lang-go=\"`storageResourceName`\" pulumi-lang-python=\"`storage_resource_name`\" pulumi-lang-yaml=\"`storageResourceName`\" pulumi-lang-java=\"`storageResourceName`\" pulumi-lang-hcl=\"`storage_resource_name`\"\u003e`storageResourceName`\u003c/span\u003e for ADLS Gen1\n* \u003cspan pulumi-lang-nodejs=\"`uri`\" pulumi-lang-dotnet=\"`Uri`\" pulumi-lang-go=\"`uri`\" pulumi-lang-python=\"`uri`\" pulumi-lang-yaml=\"`uri`\" pulumi-lang-java=\"`uri`\" pulumi-lang-hcl=\"`uri`\"\u003e`uri`\u003c/span\u003e - (Optional, String) the URI for accessing specific storage (`s3a://....`, `abfss://....`, `gs://....`, etc.)\n* \u003cspan pulumi-lang-nodejs=\"`extraConfigs`\" pulumi-lang-dotnet=\"`ExtraConfigs`\" pulumi-lang-go=\"`extraConfigs`\" pulumi-lang-python=\"`extra_configs`\" pulumi-lang-yaml=\"`extraConfigs`\" pulumi-lang-java=\"`extraConfigs`\" pulumi-lang-hcl=\"`extra_configs`\"\u003e`extraConfigs`\u003c/span\u003e - (Optional, String map) configuration parameters that are necessary for mounting of specific storage\n* \u003cspan pulumi-lang-nodejs=\"`resourceId`\" pulumi-lang-dotnet=\"`ResourceId`\" pulumi-lang-go=\"`resourceId`\" pulumi-lang-python=\"`resource_id`\" pulumi-lang-yaml=\"`resourceId`\" pulumi-lang-java=\"`resourceId`\" pulumi-lang-hcl=\"`resource_id`\"\u003e`resourceId`\u003c/span\u003e - (Optional, String) resource ID for a given storage account. Could be used to fill defaults, such as storage account \u0026 container names on Azure.\n* \u003cspan pulumi-lang-nodejs=\"`encryptionType`\" pulumi-lang-dotnet=\"`EncryptionType`\" pulumi-lang-go=\"`encryptionType`\" pulumi-lang-python=\"`encryption_type`\" pulumi-lang-yaml=\"`encryptionType`\" pulumi-lang-java=\"`encryptionType`\" pulumi-lang-hcl=\"`encryption_type`\"\u003e`encryptionType`\u003c/span\u003e - (Optional, String) encryption type. Currently used only for [AWS S3 mounts](https://docs.databricks.com/data/data-sources/aws/amazon-s3.html#encrypt-data-in-s3-buckets)\n\n### Example mounting ADLS Gen2 using uri and\u003cspan pulumi-lang-nodejs=\" extraConfigs\n\" pulumi-lang-dotnet=\" ExtraConfigs\n\" pulumi-lang-go=\" extraConfigs\n\" pulumi-lang-python=\" extra_configs\n\" pulumi-lang-yaml=\" extraConfigs\n\" pulumi-lang-java=\" extraConfigs\n\" pulumi-lang-hcl=\" extra_configs\n\"\u003e extraConfigs\n\u003c/span\u003e\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst tenantId = \"00000000-1111-2222-3333-444444444444\";\nconst clientId = \"55555555-6666-7777-8888-999999999999\";\nconst secretScope = \"some-kv\";\nconst secretKey = \"some-sp-secret\";\nconst container = \"test\";\nconst storageAcc = \"lrs\";\nconst _this = new databricks.Mount(\"this\", {\n name: \"tf-abfss\",\n uri: `abfss://${container}@${storageAcc}.dfs.core.windows.net`,\n extraConfigs: {\n \"fs.azure.account.auth.type\": \"OAuth\",\n \"fs.azure.account.oauth.provider.type\": \"org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\",\n \"fs.azure.account.oauth2.client.id\": clientId,\n \"fs.azure.account.oauth2.client.secret\": `{{secrets/${secretScope}/${secretKey}}}`,\n \"fs.azure.account.oauth2.client.endpoint\": `https://login.microsoftonline.com/${tenantId}/oauth2/token`,\n \"fs.azure.createRemoteFileSystemDuringInitialization\": \"false\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ntenant_id = \"00000000-1111-2222-3333-444444444444\"\nclient_id = \"55555555-6666-7777-8888-999999999999\"\nsecret_scope = \"some-kv\"\nsecret_key = \"some-sp-secret\"\ncontainer = \"test\"\nstorage_acc = \"lrs\"\nthis = databricks.Mount(\"this\",\n name=\"tf-abfss\",\n uri=f\"abfss://{container}@{storage_acc}.dfs.core.windows.net\",\n extra_configs={\n \"fs.azure.account.auth.type\": \"OAuth\",\n \"fs.azure.account.oauth.provider.type\": \"org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\",\n \"fs.azure.account.oauth2.client.id\": client_id,\n \"fs.azure.account.oauth2.client.secret\": f\"{{{{secrets/{secret_scope}/{secret_key}}}}}\",\n \"fs.azure.account.oauth2.client.endpoint\": f\"https://login.microsoftonline.com/{tenant_id}/oauth2/token\",\n \"fs.azure.createRemoteFileSystemDuringInitialization\": \"false\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var tenantId = \"00000000-1111-2222-3333-444444444444\";\n\n var clientId = \"55555555-6666-7777-8888-999999999999\";\n\n var secretScope = \"some-kv\";\n\n var secretKey = \"some-sp-secret\";\n\n var container = \"test\";\n\n var storageAcc = \"lrs\";\n\n var @this = new Databricks.Mount(\"this\", new()\n {\n Name = \"tf-abfss\",\n Uri = $\"abfss://{container}@{storageAcc}.dfs.core.windows.net\",\n ExtraConfigs = \n {\n { \"fs.azure.account.auth.type\", \"OAuth\" },\n { \"fs.azure.account.oauth.provider.type\", \"org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\" },\n { \"fs.azure.account.oauth2.client.id\", clientId },\n { \"fs.azure.account.oauth2.client.secret\", $\"{{{{secrets/{secretScope}/{secretKey}}}}}\" },\n { \"fs.azure.account.oauth2.client.endpoint\", $\"https://login.microsoftonline.com/{tenantId}/oauth2/token\" },\n { \"fs.azure.createRemoteFileSystemDuringInitialization\", \"false\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\ttenantId := \"00000000-1111-2222-3333-444444444444\"\n\t\tclientId := \"55555555-6666-7777-8888-999999999999\"\n\t\tsecretScope := \"some-kv\"\n\t\tsecretKey := \"some-sp-secret\"\n\t\tcontainer := \"test\"\n\t\tstorageAcc := \"lrs\"\n\t\t_, err := databricks.NewMount(ctx, \"this\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"tf-abfss\"),\n\t\t\tUri: pulumi.Sprintf(\"abfss://%v@%v.dfs.core.windows.net\", container, storageAcc),\n\t\t\tExtraConfigs: pulumi.StringMap{\n\t\t\t\t\"fs.azure.account.auth.type\": pulumi.String(\"OAuth\"),\n\t\t\t\t\"fs.azure.account.oauth.provider.type\": pulumi.String(\"org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\"),\n\t\t\t\t\"fs.azure.account.oauth2.client.id\": pulumi.String(pulumi.String(clientId)),\n\t\t\t\t\"fs.azure.account.oauth2.client.secret\": pulumi.Sprintf(\"{{secrets/%v/%v}}\", secretScope, secretKey),\n\t\t\t\t\"fs.azure.account.oauth2.client.endpoint\": pulumi.Sprintf(\"https://login.microsoftonline.com/%v/oauth2/token\", tenantId),\n\t\t\t\t\"fs.azure.createRemoteFileSystemDuringInitialization\": pulumi.String(\"false\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mount\" \"this\" {\n name = \"tf-abfss\"\n uri =\"abfss://${local.container}@${local.storageAcc}.dfs.core.windows.net\"\n extra_configs = {\n \"fs.azure.account.auth.type\" = \"OAuth\"\n \"fs.azure.account.oauth.provider.type\" = \"org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\"\n \"fs.azure.account.oauth2.client.id\" = local.clientId\n \"fs.azure.account.oauth2.client.secret\" =\"{{secrets/${local.secretScope}/${local.secretKey}}}\"\n \"fs.azure.account.oauth2.client.endpoint\" =\"https://login.microsoftonline.com/${local.tenantId}/oauth2/token\"\n \"fs.azure.createRemoteFileSystemDuringInitialization\" = \"false\"\n }\n}\nlocals {\n tenantId = \"00000000-1111-2222-3333-444444444444\"\n}\nlocals {\n clientId = \"55555555-6666-7777-8888-999999999999\"\n}\nlocals {\n secretScope = \"some-kv\"\n}\nlocals {\n secretKey = \"some-sp-secret\"\n}\nlocals {\n container = \"test\"\n}\nlocals {\n storageAcc = \"lrs\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var tenantId = \"00000000-1111-2222-3333-444444444444\";\n\n final var clientId = \"55555555-6666-7777-8888-999999999999\";\n\n final var secretScope = \"some-kv\";\n\n final var secretKey = \"some-sp-secret\";\n\n final var container = \"test\";\n\n final var storageAcc = \"lrs\";\n\n var this_ = new Mount(\"this\", MountArgs.builder()\n .name(\"tf-abfss\")\n .uri(String.format(\"abfss://%s@%s.dfs.core.windows.net\", container,storageAcc))\n .extraConfigs(Map.ofEntries(\n Map.entry(\"fs.azure.account.auth.type\", \"OAuth\"),\n Map.entry(\"fs.azure.account.oauth.provider.type\", \"org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\"),\n Map.entry(\"fs.azure.account.oauth2.client.id\", clientId),\n Map.entry(\"fs.azure.account.oauth2.client.secret\", String.format(\"{{{{secrets/%s/%s}}}}\", secretScope,secretKey)),\n Map.entry(\"fs.azure.account.oauth2.client.endpoint\", String.format(\"https://login.microsoftonline.com/%s/oauth2/token\", tenantId)),\n Map.entry(\"fs.azure.createRemoteFileSystemDuringInitialization\", \"false\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:Mount\n properties:\n name: tf-abfss\n uri: abfss://${container}@${storageAcc}.dfs.core.windows.net\n extraConfigs:\n fs.azure.account.auth.type: OAuth\n fs.azure.account.oauth.provider.type: org.apache.hadoop.fs.azurebfs.oauth2.ClientCredsTokenProvider\n fs.azure.account.oauth2.client.id: ${clientId}\n fs.azure.account.oauth2.client.secret: '{{secrets/${secretScope}/${secretKey}}}'\n fs.azure.account.oauth2.client.endpoint: https://login.microsoftonline.com/${tenantId}/oauth2/token\n fs.azure.createRemoteFileSystemDuringInitialization: 'false'\nvariables:\n tenantId: 00000000-1111-2222-3333-444444444444\n clientId: 55555555-6666-7777-8888-999999999999\n secretScope: some-kv\n secretKey: some-sp-secret\n container: test\n storageAcc: lrs\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example mounting ADLS Gen2 with AAD passthrough\n\n\u003e AAD passthrough is considered a legacy data access pattern. Use Unity Catalog for fine-grained data access control.\n\n\u003e Mounts using AAD passthrough cannot be created using a service principal.\n\nTo mount ALDS Gen2 with Azure Active Directory Credentials passthrough we need to execute the mount commands using the cluster configured with AAD Credentials passthrough \u0026 provide necessary configuration parameters (see [documentation](https://docs.microsoft.com/en-us/azure/databricks/security/credential-passthrough/adls-passthrough#--mount-azure-data-lake-storage-to-dbfs-using-credential-passthrough) for more details).\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as azurerm from \"@pulumi/azurerm\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Resource group for Databricks Workspace\nconst resourceGroup = config.require(\"resourceGroup\");\n// Name of the Databricks Workspace\nconst workspaceName = config.require(\"workspaceName\");\nconst _this = azurerm.DatabricksWorkspace({\n name: workspaceName,\n resourceGroupName: resourceGroup,\n});\nconst smallest = databricks.getNodeType({\n localDisk: true,\n});\nconst latest = databricks.getSparkVersion({});\nconst sharedPassthrough = new databricks.Cluster(\"shared_passthrough\", {\n clusterName: \"Shared Passthrough for mount\",\n sparkVersion: latest.then(latest =\u003e latest.id),\n nodeTypeId: smallest.then(smallest =\u003e smallest.id),\n autoterminationMinutes: 10,\n numWorkers: 1,\n sparkConf: {\n \"spark.databricks.cluster.profile\": \"serverless\",\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.passthrough.enabled\": \"true\",\n \"spark.databricks.pyspark.enableProcessIsolation\": \"true\",\n },\n customTags: {\n ResourceClass: \"Serverless\",\n },\n});\n// Name of the ADLS Gen2 storage container\nconst storageAcc = config.require(\"storageAcc\");\n// Name of container inside storage account\nconst container = config.require(\"container\");\nconst passthrough = new databricks.Mount(\"passthrough\", {\n name: \"passthrough-test\",\n clusterId: sharedPassthrough.id,\n uri: `abfss://${container}@${storageAcc}.dfs.core.windows.net`,\n extraConfigs: {\n \"fs.azure.account.auth.type\": \"CustomAccessToken\",\n \"fs.azure.account.custom.token.provider.class\": \"{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_azurerm as azurerm\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Resource group for Databricks Workspace\nresource_group = config.require(\"resourceGroup\")\n# Name of the Databricks Workspace\nworkspace_name = config.require(\"workspaceName\")\nthis = azurerm.databricks_workspace(name=workspace_name,\n resource_group_name=resource_group)\nsmallest = databricks.get_node_type(local_disk=True)\nlatest = databricks.get_spark_version()\nshared_passthrough = databricks.Cluster(\"shared_passthrough\",\n cluster_name=\"Shared Passthrough for mount\",\n spark_version=latest.id,\n node_type_id=smallest.id,\n autotermination_minutes=10,\n num_workers=1,\n spark_conf={\n \"spark.databricks.cluster.profile\": \"serverless\",\n \"spark.databricks.repl.allowedLanguages\": \"python,sql\",\n \"spark.databricks.passthrough.enabled\": \"true\",\n \"spark.databricks.pyspark.enableProcessIsolation\": \"true\",\n },\n custom_tags={\n \"ResourceClass\": \"Serverless\",\n })\n# Name of the ADLS Gen2 storage container\nstorage_acc = config.require(\"storageAcc\")\n# Name of container inside storage account\ncontainer = config.require(\"container\")\npassthrough = databricks.Mount(\"passthrough\",\n name=\"passthrough-test\",\n cluster_id=shared_passthrough.id,\n uri=f\"abfss://{container}@{storage_acc}.dfs.core.windows.net\",\n extra_configs={\n \"fs.azure.account.auth.type\": \"CustomAccessToken\",\n \"fs.azure.account.custom.token.provider.class\": \"{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Azurerm = Pulumi.Azurerm;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Resource group for Databricks Workspace\n var resourceGroup = config.Require(\"resourceGroup\");\n // Name of the Databricks Workspace\n var workspaceName = config.Require(\"workspaceName\");\n var @this = Azurerm.DatabricksWorkspace.Invoke(new()\n {\n Name = workspaceName,\n ResourceGroupName = resourceGroup,\n });\n\n var smallest = Databricks.GetNodeType.Invoke(new()\n {\n LocalDisk = true,\n });\n\n var latest = Databricks.GetSparkVersion.Invoke();\n\n var sharedPassthrough = new Databricks.Cluster(\"shared_passthrough\", new()\n {\n ClusterName = \"Shared Passthrough for mount\",\n SparkVersion = latest.Apply(getSparkVersionResult =\u003e getSparkVersionResult.Id),\n NodeTypeId = smallest.Apply(getNodeTypeResult =\u003e getNodeTypeResult.Id),\n AutoterminationMinutes = 10,\n NumWorkers = 1,\n SparkConf = \n {\n { \"spark.databricks.cluster.profile\", \"serverless\" },\n { \"spark.databricks.repl.allowedLanguages\", \"python,sql\" },\n { \"spark.databricks.passthrough.enabled\", \"true\" },\n { \"spark.databricks.pyspark.enableProcessIsolation\", \"true\" },\n },\n CustomTags = \n {\n { \"ResourceClass\", \"Serverless\" },\n },\n });\n\n // Name of the ADLS Gen2 storage container\n var storageAcc = config.Require(\"storageAcc\");\n // Name of container inside storage account\n var container = config.Require(\"container\");\n var passthrough = new Databricks.Mount(\"passthrough\", new()\n {\n Name = \"passthrough-test\",\n ClusterId = sharedPassthrough.Id,\n Uri = $\"abfss://{container}@{storageAcc}.dfs.core.windows.net\",\n ExtraConfigs = \n {\n { \"fs.azure.account.auth.type\", \"CustomAccessToken\" },\n { \"fs.azure.account.custom.token.provider.class\", \"{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}\" },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-azurerm/sdk/go/azurerm\"\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Resource group for Databricks Workspace\n\t\tresourceGroup := cfg.Require(\"resourceGroup\")\n\t\t// Name of the Databricks Workspace\n\t\tworkspaceName := cfg.Require(\"workspaceName\")\n\t\t_, err := azurerm.DatabricksWorkspace(ctx, map[string]interface{}{\n\t\t\t\"name\": workspaceName,\n\t\t\t\"resourceGroupName\": resourceGroup,\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsmallest, err := databricks.GetNodeType(ctx, \u0026databricks.GetNodeTypeArgs{\n\t\t\tLocalDisk: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlatest, err := databricks.GetSparkVersion(ctx, \u0026databricks.GetSparkVersionArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tsharedPassthrough, err := databricks.NewCluster(ctx, \"shared_passthrough\", \u0026databricks.ClusterArgs{\n\t\t\tClusterName: pulumi.String(\"Shared Passthrough for mount\"),\n\t\t\tSparkVersion: pulumi.String(pulumi.String(latest.Id)),\n\t\t\tNodeTypeId: pulumi.String(pulumi.String(smallest.Id)),\n\t\t\tAutoterminationMinutes: pulumi.Int(10),\n\t\t\tNumWorkers: pulumi.Int(1),\n\t\t\tSparkConf: pulumi.StringMap{\n\t\t\t\t\"spark.databricks.cluster.profile\": pulumi.String(\"serverless\"),\n\t\t\t\t\"spark.databricks.repl.allowedLanguages\": pulumi.String(\"python,sql\"),\n\t\t\t\t\"spark.databricks.passthrough.enabled\": pulumi.String(\"true\"),\n\t\t\t\t\"spark.databricks.pyspark.enableProcessIsolation\": pulumi.String(\"true\"),\n\t\t\t},\n\t\t\tCustomTags: pulumi.StringMap{\n\t\t\t\t\"ResourceClass\": pulumi.String(\"Serverless\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// Name of the ADLS Gen2 storage container\n\t\tstorageAcc := cfg.Require(\"storageAcc\")\n\t\t// Name of container inside storage account\n\t\tcontainer := cfg.Require(\"container\")\n\t\t_, err = databricks.NewMount(ctx, \"passthrough\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"passthrough-test\"),\n\t\t\tClusterId: sharedPassthrough.ID(),\n\t\t\tUri: pulumi.Sprintf(\"abfss://%v@%v.dfs.core.windows.net\", container, storageAcc),\n\t\t\tExtraConfigs: pulumi.StringMap{\n\t\t\t\t\"fs.azure.account.auth.type\": pulumi.String(\"CustomAccessToken\"),\n\t\t\t\t\"fs.azure.account.custom.token.provider.class\": pulumi.String(\"{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"azurerm_databricksworkspace\" \"this\" {\n name = var.workspaceName\n resource_group_name = var.resourceGroup\n}\ndata \"databricks_getnodetype\" \"smallest\" {\n local_disk = true\n}\ndata \"databricks_getsparkversion\" \"latest\" {\n}\n\nresource \"databricks_cluster\" \"shared_passthrough\" {\n cluster_name = \"Shared Passthrough for mount\"\n spark_version = data.databricks_getsparkversion.latest.id\n node_type_id = data.databricks_getnodetype.smallest.id\n autotermination_minutes = 10\n num_workers = 1\n spark_conf = {\n \"spark.databricks.cluster.profile\" = \"serverless\"\n \"spark.databricks.repl.allowedLanguages\" = \"python,sql\"\n \"spark.databricks.passthrough.enabled\" = \"true\"\n \"spark.databricks.pyspark.enableProcessIsolation\" = \"true\"\n }\n custom_tags = {\n \"ResourceClass\" = \"Serverless\"\n }\n}\nresource \"databricks_mount\" \"passthrough\" {\n name = \"passthrough-test\"\n cluster_id = databricks_cluster.shared_passthrough.id\n uri =\"abfss://${var.container}@${var.storageAcc}.dfs.core.windows.net\"\n extra_configs = {\n \"fs.azure.account.auth.type\" = \"CustomAccessToken\"\n \"fs.azure.account.custom.token.provider.class\" = \"{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}\"\n }\n}\nvariable \"resourceGroup\" {\n type = string\n description = \"Resource group for Databricks Workspace\"\n}\nvariable \"workspaceName\" {\n type = string\n description = \"Name of the Databricks Workspace\"\n}\nvariable \"storageAcc\" {\n type = string\n description = \"Name of the ADLS Gen2 storage container\"\n}\nvariable \"container\" {\n type = string\n description = \"Name of container inside storage account\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.azurerm.AzurermFunctions;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetNodeTypeArgs;\nimport com.pulumi.databricks.inputs.GetSparkVersionArgs;\nimport com.pulumi.databricks.Cluster;\nimport com.pulumi.databricks.ClusterArgs;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var resourceGroup = config.require(\"resourceGroup\");\n final var workspaceName = config.require(\"workspaceName\");\n final var this = AzurermFunctions.DatabricksWorkspace(Map.ofEntries(\n Map.entry(\"name\", workspaceName),\n Map.entry(\"resourceGroupName\", resourceGroup)\n ));\n\n final var smallest = DatabricksFunctions.getNodeType(GetNodeTypeArgs.builder()\n .localDisk(true)\n .build());\n\n final var latest = DatabricksFunctions.getSparkVersion(GetSparkVersionArgs.builder()\n .build());\n\n var sharedPassthrough = new Cluster(\"sharedPassthrough\", ClusterArgs.builder()\n .clusterName(\"Shared Passthrough for mount\")\n .sparkVersion(latest.id())\n .nodeTypeId(smallest.id())\n .autoterminationMinutes(10)\n .numWorkers(1)\n .sparkConf(Map.ofEntries(\n Map.entry(\"spark.databricks.cluster.profile\", \"serverless\"),\n Map.entry(\"spark.databricks.repl.allowedLanguages\", \"python,sql\"),\n Map.entry(\"spark.databricks.passthrough.enabled\", \"true\"),\n Map.entry(\"spark.databricks.pyspark.enableProcessIsolation\", \"true\")\n ))\n .customTags(Map.of(\"ResourceClass\", \"Serverless\"))\n .build());\n\n final var storageAcc = config.require(\"storageAcc\");\n final var container = config.require(\"container\");\n var passthrough = new Mount(\"passthrough\", MountArgs.builder()\n .name(\"passthrough-test\")\n .clusterId(sharedPassthrough.id())\n .uri(String.format(\"abfss://%s@%s.dfs.core.windows.net\", container,storageAcc))\n .extraConfigs(Map.ofEntries(\n Map.entry(\"fs.azure.account.auth.type\", \"CustomAccessToken\"),\n Map.entry(\"fs.azure.account.custom.token.provider.class\", \"{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}\")\n ))\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n resourceGroup:\n type: string\n workspaceName:\n type: string\n storageAcc:\n type: string\n container:\n type: string\nresources:\n sharedPassthrough:\n type: databricks:Cluster\n name: shared_passthrough\n properties:\n clusterName: Shared Passthrough for mount\n sparkVersion: ${latest.id}\n nodeTypeId: ${smallest.id}\n autoterminationMinutes: 10\n numWorkers: 1\n sparkConf:\n spark.databricks.cluster.profile: serverless\n spark.databricks.repl.allowedLanguages: python,sql\n spark.databricks.passthrough.enabled: 'true'\n spark.databricks.pyspark.enableProcessIsolation: 'true'\n customTags:\n ResourceClass: Serverless\n passthrough:\n type: databricks:Mount\n properties:\n name: passthrough-test\n clusterId: ${sharedPassthrough.id}\n uri: abfss://${container}@${storageAcc}.dfs.core.windows.net\n extraConfigs:\n fs.azure.account.auth.type: CustomAccessToken\n fs.azure.account.custom.token.provider.class: '{{sparkconf/spark.databricks.passthrough.adls.gen2.tokenProviderClassName}}'\nvariables:\n this:\n fn::invoke:\n function: azurerm:DatabricksWorkspace\n arguments:\n name: ${workspaceName}\n resourceGroupName: ${resourceGroup}\n smallest:\n fn::invoke:\n function: databricks:getNodeType\n arguments:\n localDisk: true\n latest:\n fn::invoke:\n function: databricks:getSparkVersion\n arguments: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## s3 block\n\nThis block allows specifying parameters for mounting of the ADLS Gen2. The following arguments are required inside the \u003cspan pulumi-lang-nodejs=\"`s3`\" pulumi-lang-dotnet=\"`S3`\" pulumi-lang-go=\"`s3`\" pulumi-lang-python=\"`s3`\" pulumi-lang-yaml=\"`s3`\" pulumi-lang-java=\"`s3`\" pulumi-lang-hcl=\"`s3`\"\u003e`s3`\u003c/span\u003e block:\n\n* \u003cspan pulumi-lang-nodejs=\"`instanceProfile`\" pulumi-lang-dotnet=\"`InstanceProfile`\" pulumi-lang-go=\"`instanceProfile`\" pulumi-lang-python=\"`instance_profile`\" pulumi-lang-yaml=\"`instanceProfile`\" pulumi-lang-java=\"`instanceProfile`\" pulumi-lang-hcl=\"`instance_profile`\"\u003e`instanceProfile`\u003c/span\u003e - (Optional) (String) ARN of registered instance profile for data access. If it's not specified, then the \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e should be provided, and the cluster should have an instance profile attached to it. If both \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e \u0026 \u003cspan pulumi-lang-nodejs=\"`instanceProfile`\" pulumi-lang-dotnet=\"`InstanceProfile`\" pulumi-lang-go=\"`instanceProfile`\" pulumi-lang-python=\"`instance_profile`\" pulumi-lang-yaml=\"`instanceProfile`\" pulumi-lang-java=\"`instanceProfile`\" pulumi-lang-hcl=\"`instance_profile`\"\u003e`instanceProfile`\u003c/span\u003e are specified, then \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e takes precedence.\n* \u003cspan pulumi-lang-nodejs=\"`bucketName`\" pulumi-lang-dotnet=\"`BucketName`\" pulumi-lang-go=\"`bucketName`\" pulumi-lang-python=\"`bucket_name`\" pulumi-lang-yaml=\"`bucketName`\" pulumi-lang-java=\"`bucketName`\" pulumi-lang-hcl=\"`bucket_name`\"\u003e`bucketName`\u003c/span\u003e - (Required) (String) S3 bucket name to be mounted.\n\n### Example of mounting S3\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\n// now you can do `%fs ls /mnt/experiments` in notebooks\nconst _this = new databricks.Mount(\"this\", {\n name: \"experiments\",\n s3: {\n instanceProfile: ds.id,\n bucketName: thisAwsS3Bucket.bucket,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\n# now you can do `%fs ls /mnt/experiments` in notebooks\nthis = databricks.Mount(\"this\",\n name=\"experiments\",\n s3={\n \"instance_profile\": ds[\"id\"],\n \"bucket_name\": this_aws_s3_bucket[\"bucket\"],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n // now you can do `%fs ls /mnt/experiments` in notebooks\n var @this = new Databricks.Mount(\"this\", new()\n {\n Name = \"experiments\",\n S3 = new Databricks.Inputs.MountS3Args\n {\n InstanceProfile = ds.Id,\n BucketName = thisAwsS3Bucket.Bucket,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t// now you can do `%fs ls /mnt/experiments` in notebooks\n\t\t_, err := databricks.NewMount(ctx, \"this\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"experiments\"),\n\t\t\tS3: \u0026databricks.MountS3Args{\n\t\t\t\tInstanceProfile: pulumi.Any(ds.Id),\n\t\t\t\tBucketName: pulumi.Any(thisAwsS3Bucket.Bucket),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n// now you can do `%fs ls /mnt/experiments` in notebooks\nresource \"databricks_mount\" \"this\" {\n name = \"experiments\"\n s3 = {\n instance_profile = ds.id\n bucket_name = thisAwsS3Bucket.bucket\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport com.pulumi.databricks.inputs.MountS3Args;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n // now you can do `%fs ls /mnt/experiments` in notebooks\n var this_ = new Mount(\"this\", MountArgs.builder()\n .name(\"experiments\")\n .s3(MountS3Args.builder()\n .instanceProfile(ds.id())\n .bucketName(thisAwsS3Bucket.bucket())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n # now you can do `%fs ls /mnt/experiments` in notebooks\n this:\n type: databricks:Mount\n properties:\n name: experiments\n s3:\n instanceProfile: ${ds.id}\n bucketName: ${thisAwsS3Bucket.bucket}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## abfs block\n\nThis block allows specifying parameters for mounting of the ADLS Gen2. The following arguments are required inside the \u003cspan pulumi-lang-nodejs=\"`abfs`\" pulumi-lang-dotnet=\"`Abfs`\" pulumi-lang-go=\"`abfs`\" pulumi-lang-python=\"`abfs`\" pulumi-lang-yaml=\"`abfs`\" pulumi-lang-java=\"`abfs`\" pulumi-lang-hcl=\"`abfs`\"\u003e`abfs`\u003c/span\u003e block:\n\n* \u003cspan pulumi-lang-nodejs=\"`clientId`\" pulumi-lang-dotnet=\"`ClientId`\" pulumi-lang-go=\"`clientId`\" pulumi-lang-python=\"`client_id`\" pulumi-lang-yaml=\"`clientId`\" pulumi-lang-java=\"`clientId`\" pulumi-lang-hcl=\"`client_id`\"\u003e`clientId`\u003c/span\u003e - (Required) (String) This is the\u003cspan pulumi-lang-nodejs=\" clientId \" pulumi-lang-dotnet=\" ClientId \" pulumi-lang-go=\" clientId \" pulumi-lang-python=\" client_id \" pulumi-lang-yaml=\" clientId \" pulumi-lang-java=\" clientId \" pulumi-lang-hcl=\" client_id \"\u003e clientId \u003c/span\u003e(Application Object ID) for the enterprise application for the service principal.\n* \u003cspan pulumi-lang-nodejs=\"`tenantId`\" pulumi-lang-dotnet=\"`TenantId`\" pulumi-lang-go=\"`tenantId`\" pulumi-lang-python=\"`tenant_id`\" pulumi-lang-yaml=\"`tenantId`\" pulumi-lang-java=\"`tenantId`\" pulumi-lang-hcl=\"`tenant_id`\"\u003e`tenantId`\u003c/span\u003e - (Optional) (String) This is your azure directory tenant id. It is required for creating the mount. (Could be omitted if Azure authentication is used, and we can extract \u003cspan pulumi-lang-nodejs=\"`tenantId`\" pulumi-lang-dotnet=\"`TenantId`\" pulumi-lang-go=\"`tenantId`\" pulumi-lang-python=\"`tenant_id`\" pulumi-lang-yaml=\"`tenantId`\" pulumi-lang-java=\"`tenantId`\" pulumi-lang-hcl=\"`tenant_id`\"\u003e`tenantId`\u003c/span\u003e from it).\n* \u003cspan pulumi-lang-nodejs=\"`clientSecretKey`\" pulumi-lang-dotnet=\"`ClientSecretKey`\" pulumi-lang-go=\"`clientSecretKey`\" pulumi-lang-python=\"`client_secret_key`\" pulumi-lang-yaml=\"`clientSecretKey`\" pulumi-lang-java=\"`clientSecretKey`\" pulumi-lang-hcl=\"`client_secret_key`\"\u003e`clientSecretKey`\u003c/span\u003e - (Required) (String) This is the secret key in which your service principal/enterprise app client secret will be stored.\n* \u003cspan pulumi-lang-nodejs=\"`clientSecretScope`\" pulumi-lang-dotnet=\"`ClientSecretScope`\" pulumi-lang-go=\"`clientSecretScope`\" pulumi-lang-python=\"`client_secret_scope`\" pulumi-lang-yaml=\"`clientSecretScope`\" pulumi-lang-java=\"`clientSecretScope`\" pulumi-lang-hcl=\"`client_secret_scope`\"\u003e`clientSecretScope`\u003c/span\u003e - (Required) (String) This is the secret scope in which your service principal/enterprise app client secret will be stored.\n* \u003cspan pulumi-lang-nodejs=\"`containerName`\" pulumi-lang-dotnet=\"`ContainerName`\" pulumi-lang-go=\"`containerName`\" pulumi-lang-python=\"`container_name`\" pulumi-lang-yaml=\"`containerName`\" pulumi-lang-java=\"`containerName`\" pulumi-lang-hcl=\"`container_name`\"\u003e`containerName`\u003c/span\u003e - (Required) (String) ADLS gen2 container name. (Could be omitted if \u003cspan pulumi-lang-nodejs=\"`resourceId`\" pulumi-lang-dotnet=\"`ResourceId`\" pulumi-lang-go=\"`resourceId`\" pulumi-lang-python=\"`resource_id`\" pulumi-lang-yaml=\"`resourceId`\" pulumi-lang-java=\"`resourceId`\" pulumi-lang-hcl=\"`resource_id`\"\u003e`resourceId`\u003c/span\u003e is provided)\n* \u003cspan pulumi-lang-nodejs=\"`storageAccountName`\" pulumi-lang-dotnet=\"`StorageAccountName`\" pulumi-lang-go=\"`storageAccountName`\" pulumi-lang-python=\"`storage_account_name`\" pulumi-lang-yaml=\"`storageAccountName`\" pulumi-lang-java=\"`storageAccountName`\" pulumi-lang-hcl=\"`storage_account_name`\"\u003e`storageAccountName`\u003c/span\u003e - (Required) (String) The name of the storage resource in which the data is. (Could be omitted if \u003cspan pulumi-lang-nodejs=\"`resourceId`\" pulumi-lang-dotnet=\"`ResourceId`\" pulumi-lang-go=\"`resourceId`\" pulumi-lang-python=\"`resource_id`\" pulumi-lang-yaml=\"`resourceId`\" pulumi-lang-java=\"`resourceId`\" pulumi-lang-hcl=\"`resource_id`\"\u003e`resourceId`\u003c/span\u003e is provided)\n* \u003cspan pulumi-lang-nodejs=\"`directory`\" pulumi-lang-dotnet=\"`Directory`\" pulumi-lang-go=\"`directory`\" pulumi-lang-python=\"`directory`\" pulumi-lang-yaml=\"`directory`\" pulumi-lang-java=\"`directory`\" pulumi-lang-hcl=\"`directory`\"\u003e`directory`\u003c/span\u003e - (Computed) (String) This is optional if you don't want to add an additional directory that you wish to mount. This must start with a \"/\".\n* \u003cspan pulumi-lang-nodejs=\"`initializeFileSystem`\" pulumi-lang-dotnet=\"`InitializeFileSystem`\" pulumi-lang-go=\"`initializeFileSystem`\" pulumi-lang-python=\"`initialize_file_system`\" pulumi-lang-yaml=\"`initializeFileSystem`\" pulumi-lang-java=\"`initializeFileSystem`\" pulumi-lang-hcl=\"`initialize_file_system`\"\u003e`initializeFileSystem`\u003c/span\u003e - (Required) (Bool) either or not initialize FS for the first use\n\n### Creating mount for ADLS Gen2 using abfs block\n\nIn this example, we're using Azure authentication, so we can omit some parameters (\u003cspan pulumi-lang-nodejs=\"`tenantId`\" pulumi-lang-dotnet=\"`TenantId`\" pulumi-lang-go=\"`tenantId`\" pulumi-lang-python=\"`tenant_id`\" pulumi-lang-yaml=\"`tenantId`\" pulumi-lang-java=\"`tenantId`\" pulumi-lang-hcl=\"`tenant_id`\"\u003e`tenantId`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`storageAccountName`\" pulumi-lang-dotnet=\"`StorageAccountName`\" pulumi-lang-go=\"`storageAccountName`\" pulumi-lang-python=\"`storage_account_name`\" pulumi-lang-yaml=\"`storageAccountName`\" pulumi-lang-java=\"`storageAccountName`\" pulumi-lang-hcl=\"`storage_account_name`\"\u003e`storageAccountName`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`containerName`\" pulumi-lang-dotnet=\"`ContainerName`\" pulumi-lang-go=\"`containerName`\" pulumi-lang-python=\"`container_name`\" pulumi-lang-yaml=\"`containerName`\" pulumi-lang-java=\"`containerName`\" pulumi-lang-hcl=\"`container_name`\"\u003e`containerName`\u003c/span\u003e) that will be detected automatically.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as azurerm from \"@pulumi/azurerm\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst terraform = new databricks.SecretScope(\"terraform\", {\n name: \"application\",\n initialManagePrincipal: \"users\",\n});\nconst servicePrincipalKey = new databricks.Secret(\"service_principal_key\", {\n key: \"service_principal_key\",\n stringValue: ARM_CLIENT_SECRET,\n scope: terraform.name,\n});\nconst _this = new azurerm.index.StorageAccount(\"this\", {\n name: `${prefix}datalake`,\n resourceGroupName: resourceGroupName,\n location: resourceGroupLocation,\n accountTier: \"Standard\",\n accountReplicationType: \"GRS\",\n accountKind: \"StorageV2\",\n isHnsEnabled: true,\n});\nconst thisRoleAssignment = new azurerm.index.RoleAssignment(\"this\", {\n scope: _this.id,\n roleDefinitionName: \"Storage Blob Data Contributor\",\n principalId: current.objectId,\n});\nconst thisStorageContainer = new azurerm.index.StorageContainer(\"this\", {\n name: \"marketing\",\n storageAccountName: _this.name,\n containerAccessType: \"private\",\n});\nconst marketing = new databricks.Mount(\"marketing\", {\n name: \"marketing\",\n resourceId: thisStorageContainer.resourceManagerId,\n abfs: {\n clientId: current.clientId,\n clientSecretScope: terraform.name,\n clientSecretKey: servicePrincipalKey.key,\n initializeFileSystem: true,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_azurerm as azurerm\nimport pulumi_databricks as databricks\n\nterraform = databricks.SecretScope(\"terraform\",\n name=\"application\",\n initial_manage_principal=\"users\")\nservice_principal_key = databricks.Secret(\"service_principal_key\",\n key=\"service_principal_key\",\n string_value=ar_m__clien_t__secret,\n scope=terraform.name)\nthis = azurerm.StorageAccount(\"this\",\n name=f{prefix}datalake,\n resource_group_name=resource_group_name,\n location=resource_group_location,\n account_tier=Standard,\n account_replication_type=GRS,\n account_kind=StorageV2,\n is_hns_enabled=True)\nthis_role_assignment = azurerm.RoleAssignment(\"this\",\n scope=this.id,\n role_definition_name=Storage Blob Data Contributor,\n principal_id=current.object_id)\nthis_storage_container = azurerm.StorageContainer(\"this\",\n name=marketing,\n storage_account_name=this.name,\n container_access_type=private)\nmarketing = databricks.Mount(\"marketing\",\n name=\"marketing\",\n resource_id=this_storage_container[\"resourceManagerId\"],\n abfs={\n \"client_id\": current[\"clientId\"],\n \"client_secret_scope\": terraform.name,\n \"client_secret_key\": service_principal_key.key,\n \"initialize_file_system\": True,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Azurerm = Pulumi.Azurerm;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var terraform = new Databricks.SecretScope(\"terraform\", new()\n {\n Name = \"application\",\n InitialManagePrincipal = \"users\",\n });\n\n var servicePrincipalKey = new Databricks.Secret(\"service_principal_key\", new()\n {\n Key = \"service_principal_key\",\n StringValue = ARM_CLIENT_SECRET,\n Scope = terraform.Name,\n });\n\n var @this = new Azurerm.StorageAccount(\"this\", new()\n {\n Name = $\"{prefix}datalake\",\n ResourceGroupName = resourceGroupName,\n Location = resourceGroupLocation,\n AccountTier = \"Standard\",\n AccountReplicationType = \"GRS\",\n AccountKind = \"StorageV2\",\n IsHnsEnabled = true,\n });\n\n var thisRoleAssignment = new Azurerm.RoleAssignment(\"this\", new()\n {\n Scope = @this.Id,\n RoleDefinitionName = \"Storage Blob Data Contributor\",\n PrincipalId = current.ObjectId,\n });\n\n var thisStorageContainer = new Azurerm.StorageContainer(\"this\", new()\n {\n Name = \"marketing\",\n StorageAccountName = @this.Name,\n ContainerAccessType = \"private\",\n });\n\n var marketing = new Databricks.Mount(\"marketing\", new()\n {\n Name = \"marketing\",\n ResourceId = thisStorageContainer.ResourceManagerId,\n Abfs = new Databricks.Inputs.MountAbfsArgs\n {\n ClientId = current.ClientId,\n ClientSecretScope = terraform.Name,\n ClientSecretKey = servicePrincipalKey.Key,\n InitializeFileSystem = true,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-azurerm/sdk/go/azurerm\"\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tterraform, err := databricks.NewSecretScope(ctx, \"terraform\", \u0026databricks.SecretScopeArgs{\n\t\t\tName: pulumi.String(\"application\"),\n\t\t\tInitialManagePrincipal: pulumi.String(\"users\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tservicePrincipalKey, err := databricks.NewSecret(ctx, \"service_principal_key\", \u0026databricks.SecretArgs{\n\t\t\tKey: pulumi.String(\"service_principal_key\"),\n\t\t\tStringValue: pulumi.Any(ARM_CLIENT_SECRET),\n\t\t\tScope: terraform.Name,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthis, err := azurerm.NewStorageAccount(ctx, \"this\", \u0026azurerm.StorageAccountArgs{\n\t\t\tName: fmt.Sprintf(\"%vdatalake\", prefix),\n\t\t\tResourceGroupName: resourceGroupName,\n\t\t\tLocation: resourceGroupLocation,\n\t\t\tAccountTier: \"Standard\",\n\t\t\tAccountReplicationType: \"GRS\",\n\t\t\tAccountKind: \"StorageV2\",\n\t\t\tIsHnsEnabled: true,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = azurerm.NewRoleAssignment(ctx, \"this\", \u0026azurerm.RoleAssignmentArgs{\n\t\t\tScope: this.Id,\n\t\t\tRoleDefinitionName: \"Storage Blob Data Contributor\",\n\t\t\tPrincipalId: current.ObjectId,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthisStorageContainer, err := azurerm.NewStorageContainer(ctx, \"this\", \u0026azurerm.StorageContainerArgs{\n\t\t\tName: \"marketing\",\n\t\t\tStorageAccountName: this.Name,\n\t\t\tContainerAccessType: \"private\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMount(ctx, \"marketing\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"marketing\"),\n\t\t\tResourceId: thisStorageContainer.ResourceManagerId,\n\t\t\tAbfs: \u0026databricks.MountAbfsArgs{\n\t\t\t\tClientId: pulumi.Any(current.ClientId),\n\t\t\t\tClientSecretScope: terraform.Name,\n\t\t\t\tClientSecretKey: servicePrincipalKey.Key,\n\t\t\t\tInitializeFileSystem: pulumi.Bool(true),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_secretscope\" \"terraform\" {\n name = \"application\"\n initial_manage_principal = \"users\"\n}\nresource \"databricks_secret\" \"service_principal_key\" {\n key = \"service_principal_key\"\n string_value = ARM_CLIENT_SECRET\n scope = databricks_secretscope.terraform.name\n}\nresource \"azurerm_storageaccount\" \"this\" {\n name =\"${prefix}datalake\"\n resource_group_name = resourceGroupName\n location = resourceGroupLocation\n account_tier = \"Standard\"\n account_replication_type = \"GRS\"\n account_kind = \"StorageV2\"\n is_hns_enabled = true\n}\nresource \"azurerm_roleassignment\" \"this\" {\n scope = azurerm_storageaccount.this.id\n role_definition_name = \"Storage Blob Data Contributor\"\n principal_id = current.objectId\n}\nresource \"azurerm_storagecontainer\" \"this\" {\n name = \"marketing\"\n storage_account_name = azurerm_storageaccount.this.name\n container_access_type = \"private\"\n}\nresource \"databricks_mount\" \"marketing\" {\n name = \"marketing\"\n resource_id = azurerm_storagecontainer.this.resourceManagerId\n abfs = {\n client_id = current.clientId\n client_secret_scope = databricks_secretscope.terraform.name\n client_secret_key = databricks_secret.service_principal_key.key\n initialize_file_system = true\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.SecretScope;\nimport com.pulumi.databricks.SecretScopeArgs;\nimport com.pulumi.databricks.Secret;\nimport com.pulumi.databricks.SecretArgs;\nimport com.pulumi.azurerm.StorageAccount;\nimport com.pulumi.azurerm.StorageAccountArgs;\nimport com.pulumi.azurerm.RoleAssignment;\nimport com.pulumi.azurerm.RoleAssignmentArgs;\nimport com.pulumi.azurerm.StorageContainer;\nimport com.pulumi.azurerm.StorageContainerArgs;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport com.pulumi.databricks.inputs.MountAbfsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var terraform = new SecretScope(\"terraform\", SecretScopeArgs.builder()\n .name(\"application\")\n .initialManagePrincipal(\"users\")\n .build());\n\n var servicePrincipalKey = new Secret(\"servicePrincipalKey\", SecretArgs.builder()\n .key(\"service_principal_key\")\n .stringValue(ARM_CLIENT_SECRET)\n .scope(terraform.name())\n .build());\n\n var this_ = new StorageAccount(\"this\", StorageAccountArgs.builder()\n .name(String.format(\"%sdatalake\", prefix))\n .resourceGroupName(resourceGroupName)\n .location(resourceGroupLocation)\n .accountTier(\"Standard\")\n .accountReplicationType(\"GRS\")\n .accountKind(\"StorageV2\")\n .isHnsEnabled(true)\n .build());\n\n var thisRoleAssignment = new RoleAssignment(\"thisRoleAssignment\", RoleAssignmentArgs.builder()\n .scope(this_.id())\n .roleDefinitionName(\"Storage Blob Data Contributor\")\n .principalId(current.objectId())\n .build());\n\n var thisStorageContainer = new StorageContainer(\"thisStorageContainer\", StorageContainerArgs.builder()\n .name(\"marketing\")\n .storageAccountName(this_.name())\n .containerAccessType(\"private\")\n .build());\n\n var marketing = new Mount(\"marketing\", MountArgs.builder()\n .name(\"marketing\")\n .resourceId(thisStorageContainer.resourceManagerId())\n .abfs(MountAbfsArgs.builder()\n .clientId(current.clientId())\n .clientSecretScope(terraform.name())\n .clientSecretKey(servicePrincipalKey.key())\n .initializeFileSystem(true)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n terraform:\n type: databricks:SecretScope\n properties:\n name: application\n initialManagePrincipal: users\n servicePrincipalKey:\n type: databricks:Secret\n name: service_principal_key\n properties:\n key: service_principal_key\n stringValue: ${ARM_CLIENT_SECRET}\n scope: ${terraform.name}\n this:\n type: azurerm:StorageAccount\n properties:\n name: ${prefix}datalake\n resourceGroupName: ${resourceGroupName}\n location: ${resourceGroupLocation}\n accountTier: Standard\n accountReplicationType: GRS\n accountKind: StorageV2\n isHnsEnabled: true\n thisRoleAssignment:\n type: azurerm:RoleAssignment\n name: this\n properties:\n scope: ${this.id}\n roleDefinitionName: Storage Blob Data Contributor\n principalId: ${current.objectId}\n thisStorageContainer:\n type: azurerm:StorageContainer\n name: this\n properties:\n name: marketing\n storageAccountName: ${this.name}\n containerAccessType: private\n marketing:\n type: databricks:Mount\n properties:\n name: marketing\n resourceId: ${thisStorageContainer.resourceManagerId}\n abfs:\n clientId: ${current.clientId}\n clientSecretScope: ${terraform.name}\n clientSecretKey: ${servicePrincipalKey.key}\n initializeFileSystem: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## gs block\n\nThis block allows specifying parameters for mounting of the Google Cloud Storage. The following arguments are required inside the \u003cspan pulumi-lang-nodejs=\"`gs`\" pulumi-lang-dotnet=\"`Gs`\" pulumi-lang-go=\"`gs`\" pulumi-lang-python=\"`gs`\" pulumi-lang-yaml=\"`gs`\" pulumi-lang-java=\"`gs`\" pulumi-lang-hcl=\"`gs`\"\u003e`gs`\u003c/span\u003e block:\n\n* \u003cspan pulumi-lang-nodejs=\"`serviceAccount`\" pulumi-lang-dotnet=\"`ServiceAccount`\" pulumi-lang-go=\"`serviceAccount`\" pulumi-lang-python=\"`service_account`\" pulumi-lang-yaml=\"`serviceAccount`\" pulumi-lang-java=\"`serviceAccount`\" pulumi-lang-hcl=\"`service_account`\"\u003e`serviceAccount`\u003c/span\u003e - (Optional) (String) email of registered [Google Service Account](https://docs.gcp.databricks.com/data/data-sources/google/gcs.html#step-1-set-up-google-cloud-service-account-using-google-cloud-console) for data access. If it's not specified, then the \u003cspan pulumi-lang-nodejs=\"`clusterId`\" pulumi-lang-dotnet=\"`ClusterId`\" pulumi-lang-go=\"`clusterId`\" pulumi-lang-python=\"`cluster_id`\" pulumi-lang-yaml=\"`clusterId`\" pulumi-lang-java=\"`clusterId`\" pulumi-lang-hcl=\"`cluster_id`\"\u003e`clusterId`\u003c/span\u003e should be provided, and the cluster should have a Google service account attached to it.\n* \u003cspan pulumi-lang-nodejs=\"`bucketName`\" pulumi-lang-dotnet=\"`BucketName`\" pulumi-lang-go=\"`bucketName`\" pulumi-lang-python=\"`bucket_name`\" pulumi-lang-yaml=\"`bucketName`\" pulumi-lang-java=\"`bucketName`\" pulumi-lang-hcl=\"`bucket_name`\"\u003e`bucketName`\u003c/span\u003e - (Required) (String) GCS bucket name to be mounted.\n\n### Example mounting Google Cloud Storage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst thisGs = new databricks.Mount(\"this_gs\", {\n name: \"gs-mount\",\n gs: {\n serviceAccount: \"acc@company.iam.gserviceaccount.com\",\n bucketName: \"mybucket\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis_gs = databricks.Mount(\"this_gs\",\n name=\"gs-mount\",\n gs={\n \"service_account\": \"acc@company.iam.gserviceaccount.com\",\n \"bucket_name\": \"mybucket\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var thisGs = new Databricks.Mount(\"this_gs\", new()\n {\n Name = \"gs-mount\",\n Gs = new Databricks.Inputs.MountGsArgs\n {\n ServiceAccount = \"acc@company.iam.gserviceaccount.com\",\n BucketName = \"mybucket\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMount(ctx, \"this_gs\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"gs-mount\"),\n\t\t\tGs: \u0026databricks.MountGsArgs{\n\t\t\t\tServiceAccount: pulumi.String(\"acc@company.iam.gserviceaccount.com\"),\n\t\t\t\tBucketName: pulumi.String(\"mybucket\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mount\" \"this_gs\" {\n name = \"gs-mount\"\n gs = {\n service_account = \"acc@company.iam.gserviceaccount.com\"\n bucket_name = \"mybucket\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport com.pulumi.databricks.inputs.MountGsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var thisGs = new Mount(\"thisGs\", MountArgs.builder()\n .name(\"gs-mount\")\n .gs(MountGsArgs.builder()\n .serviceAccount(\"acc@company.iam.gserviceaccount.com\")\n .bucketName(\"mybucket\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n thisGs:\n type: databricks:Mount\n name: this_gs\n properties:\n name: gs-mount\n gs:\n serviceAccount: acc@company.iam.gserviceaccount.com\n bucketName: mybucket\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## adl block\n\nThis block allows specifying parameters for mounting of the ADLS Gen1. The following arguments are required inside the \u003cspan pulumi-lang-nodejs=\"`adl`\" pulumi-lang-dotnet=\"`Adl`\" pulumi-lang-go=\"`adl`\" pulumi-lang-python=\"`adl`\" pulumi-lang-yaml=\"`adl`\" pulumi-lang-java=\"`adl`\" pulumi-lang-hcl=\"`adl`\"\u003e`adl`\u003c/span\u003e block:\n\n* \u003cspan pulumi-lang-nodejs=\"`clientId`\" pulumi-lang-dotnet=\"`ClientId`\" pulumi-lang-go=\"`clientId`\" pulumi-lang-python=\"`client_id`\" pulumi-lang-yaml=\"`clientId`\" pulumi-lang-java=\"`clientId`\" pulumi-lang-hcl=\"`client_id`\"\u003e`clientId`\u003c/span\u003e - (Required) (String) This is the\u003cspan pulumi-lang-nodejs=\" clientId \" pulumi-lang-dotnet=\" ClientId \" pulumi-lang-go=\" clientId \" pulumi-lang-python=\" client_id \" pulumi-lang-yaml=\" clientId \" pulumi-lang-java=\" clientId \" pulumi-lang-hcl=\" client_id \"\u003e clientId \u003c/span\u003efor the enterprise application for the service principal.\n* \u003cspan pulumi-lang-nodejs=\"`tenantId`\" pulumi-lang-dotnet=\"`TenantId`\" pulumi-lang-go=\"`tenantId`\" pulumi-lang-python=\"`tenant_id`\" pulumi-lang-yaml=\"`tenantId`\" pulumi-lang-java=\"`tenantId`\" pulumi-lang-hcl=\"`tenant_id`\"\u003e`tenantId`\u003c/span\u003e - (Optional) (String) This is your azure directory tenant id. It is required for creating the mount. (Could be omitted if Azure authentication is used, and we can extract \u003cspan pulumi-lang-nodejs=\"`tenantId`\" pulumi-lang-dotnet=\"`TenantId`\" pulumi-lang-go=\"`tenantId`\" pulumi-lang-python=\"`tenant_id`\" pulumi-lang-yaml=\"`tenantId`\" pulumi-lang-java=\"`tenantId`\" pulumi-lang-hcl=\"`tenant_id`\"\u003e`tenantId`\u003c/span\u003e from it)\n* \u003cspan pulumi-lang-nodejs=\"`clientSecretKey`\" pulumi-lang-dotnet=\"`ClientSecretKey`\" pulumi-lang-go=\"`clientSecretKey`\" pulumi-lang-python=\"`client_secret_key`\" pulumi-lang-yaml=\"`clientSecretKey`\" pulumi-lang-java=\"`clientSecretKey`\" pulumi-lang-hcl=\"`client_secret_key`\"\u003e`clientSecretKey`\u003c/span\u003e - (Required) (String) This is the secret key in which your service principal/enterprise app client secret will be stored.\n* \u003cspan pulumi-lang-nodejs=\"`clientSecretScope`\" pulumi-lang-dotnet=\"`ClientSecretScope`\" pulumi-lang-go=\"`clientSecretScope`\" pulumi-lang-python=\"`client_secret_scope`\" pulumi-lang-yaml=\"`clientSecretScope`\" pulumi-lang-java=\"`clientSecretScope`\" pulumi-lang-hcl=\"`client_secret_scope`\"\u003e`clientSecretScope`\u003c/span\u003e - (Required) (String) This is the secret scope in which your service principal/enterprise app client secret will be stored.\n\n* \u003cspan pulumi-lang-nodejs=\"`storageResourceName`\" pulumi-lang-dotnet=\"`StorageResourceName`\" pulumi-lang-go=\"`storageResourceName`\" pulumi-lang-python=\"`storage_resource_name`\" pulumi-lang-yaml=\"`storageResourceName`\" pulumi-lang-java=\"`storageResourceName`\" pulumi-lang-hcl=\"`storage_resource_name`\"\u003e`storageResourceName`\u003c/span\u003e - (Required) (String) The name of the storage resource in which the data is for ADLS gen 1. This is what you are trying to mount. (Could be omitted if \u003cspan pulumi-lang-nodejs=\"`resourceId`\" pulumi-lang-dotnet=\"`ResourceId`\" pulumi-lang-go=\"`resourceId`\" pulumi-lang-python=\"`resource_id`\" pulumi-lang-yaml=\"`resourceId`\" pulumi-lang-java=\"`resourceId`\" pulumi-lang-hcl=\"`resource_id`\"\u003e`resourceId`\u003c/span\u003e is provided)\n* \u003cspan pulumi-lang-nodejs=\"`sparkConfPrefix`\" pulumi-lang-dotnet=\"`SparkConfPrefix`\" pulumi-lang-go=\"`sparkConfPrefix`\" pulumi-lang-python=\"`spark_conf_prefix`\" pulumi-lang-yaml=\"`sparkConfPrefix`\" pulumi-lang-java=\"`sparkConfPrefix`\" pulumi-lang-hcl=\"`spark_conf_prefix`\"\u003e`sparkConfPrefix`\u003c/span\u003e - (Optional) (String) This is the spark configuration prefix for adls gen 1 mount. The options are `fs.adl`, `dfs.adls`. Use `fs.adl` for runtime 6.0 and above for the clusters. Otherwise use `dfs.adls`. The default value is: `fs.adl`.\n* \u003cspan pulumi-lang-nodejs=\"`directory`\" pulumi-lang-dotnet=\"`Directory`\" pulumi-lang-go=\"`directory`\" pulumi-lang-python=\"`directory`\" pulumi-lang-yaml=\"`directory`\" pulumi-lang-java=\"`directory`\" pulumi-lang-hcl=\"`directory`\"\u003e`directory`\u003c/span\u003e - (Computed) (String) This is optional if you don't want to add an additional directory that you wish to mount. This must start with a \"/\".\n\n### Example mounting ADLS Gen1\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst mount = new databricks.Mount(\"mount\", {\n name: \"{var.RANDOM}\",\n adl: {\n storageResourceName: \"{env.TEST_STORAGE_ACCOUNT_NAME}\",\n tenantId: current.tenantId,\n clientId: current.clientId,\n clientSecretScope: terraform.name,\n clientSecretKey: servicePrincipalKey.key,\n sparkConfPrefix: \"fs.adl\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nmount = databricks.Mount(\"mount\",\n name=\"{var.RANDOM}\",\n adl={\n \"storage_resource_name\": \"{env.TEST_STORAGE_ACCOUNT_NAME}\",\n \"tenant_id\": current[\"tenantId\"],\n \"client_id\": current[\"clientId\"],\n \"client_secret_scope\": terraform[\"name\"],\n \"client_secret_key\": service_principal_key[\"key\"],\n \"spark_conf_prefix\": \"fs.adl\",\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var mount = new Databricks.Mount(\"mount\", new()\n {\n Name = \"{var.RANDOM}\",\n Adl = new Databricks.Inputs.MountAdlArgs\n {\n StorageResourceName = \"{env.TEST_STORAGE_ACCOUNT_NAME}\",\n TenantId = current.TenantId,\n ClientId = current.ClientId,\n ClientSecretScope = terraform.Name,\n ClientSecretKey = servicePrincipalKey.Key,\n SparkConfPrefix = \"fs.adl\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMount(ctx, \"mount\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"{var.RANDOM}\"),\n\t\t\tAdl: \u0026databricks.MountAdlArgs{\n\t\t\t\tStorageResourceName: pulumi.String(\"{env.TEST_STORAGE_ACCOUNT_NAME}\"),\n\t\t\t\tTenantId: pulumi.Any(current.TenantId),\n\t\t\t\tClientId: pulumi.Any(current.ClientId),\n\t\t\t\tClientSecretScope: pulumi.Any(terraform.Name),\n\t\t\t\tClientSecretKey: pulumi.Any(servicePrincipalKey.Key),\n\t\t\t\tSparkConfPrefix: pulumi.String(\"fs.adl\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mount\" \"mount\" {\n name = \"{var.RANDOM}\"\n adl = {\n storage_resource_name = \"{env.TEST_STORAGE_ACCOUNT_NAME}\"\n tenant_id = current.tenantId\n client_id = current.clientId\n client_secret_scope = terraform.name\n client_secret_key = servicePrincipalKey.key\n spark_conf_prefix = \"fs.adl\"\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport com.pulumi.databricks.inputs.MountAdlArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var mount = new Mount(\"mount\", MountArgs.builder()\n .name(\"{var.RANDOM}\")\n .adl(MountAdlArgs.builder()\n .storageResourceName(\"{env.TEST_STORAGE_ACCOUNT_NAME}\")\n .tenantId(current.tenantId())\n .clientId(current.clientId())\n .clientSecretScope(terraform.name())\n .clientSecretKey(servicePrincipalKey.key())\n .sparkConfPrefix(\"fs.adl\")\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n mount:\n type: databricks:Mount\n properties:\n name: '{var.RANDOM}'\n adl:\n storageResourceName: '{env.TEST_STORAGE_ACCOUNT_NAME}'\n tenantId: ${current.tenantId}\n clientId: ${current.clientId}\n clientSecretScope: ${terraform.name}\n clientSecretKey: ${servicePrincipalKey.key}\n sparkConfPrefix: fs.adl\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## wasb block\n\nThis block allows specifying parameters for mounting of the Azure Blob Storage. The following arguments are required inside the \u003cspan pulumi-lang-nodejs=\"`wasb`\" pulumi-lang-dotnet=\"`Wasb`\" pulumi-lang-go=\"`wasb`\" pulumi-lang-python=\"`wasb`\" pulumi-lang-yaml=\"`wasb`\" pulumi-lang-java=\"`wasb`\" pulumi-lang-hcl=\"`wasb`\"\u003e`wasb`\u003c/span\u003e block:\n\n* \u003cspan pulumi-lang-nodejs=\"`authType`\" pulumi-lang-dotnet=\"`AuthType`\" pulumi-lang-go=\"`authType`\" pulumi-lang-python=\"`auth_type`\" pulumi-lang-yaml=\"`authType`\" pulumi-lang-java=\"`authType`\" pulumi-lang-hcl=\"`auth_type`\"\u003e`authType`\u003c/span\u003e - (Required) (String) This is the auth type for blob storage. This can either be SAS tokens (`SAS`) or account access keys (`ACCESS_KEY`).\n* \u003cspan pulumi-lang-nodejs=\"`tokenSecretScope`\" pulumi-lang-dotnet=\"`TokenSecretScope`\" pulumi-lang-go=\"`tokenSecretScope`\" pulumi-lang-python=\"`token_secret_scope`\" pulumi-lang-yaml=\"`tokenSecretScope`\" pulumi-lang-java=\"`tokenSecretScope`\" pulumi-lang-hcl=\"`token_secret_scope`\"\u003e`tokenSecretScope`\u003c/span\u003e - (Required) (String) This is the secret scope in which your auth type token is stored.\n* \u003cspan pulumi-lang-nodejs=\"`tokenSecretKey`\" pulumi-lang-dotnet=\"`TokenSecretKey`\" pulumi-lang-go=\"`tokenSecretKey`\" pulumi-lang-python=\"`token_secret_key`\" pulumi-lang-yaml=\"`tokenSecretKey`\" pulumi-lang-java=\"`tokenSecretKey`\" pulumi-lang-hcl=\"`token_secret_key`\"\u003e`tokenSecretKey`\u003c/span\u003e - (Required) (String) This is the secret key in which your auth type token is stored.\n* \u003cspan pulumi-lang-nodejs=\"`containerName`\" pulumi-lang-dotnet=\"`ContainerName`\" pulumi-lang-go=\"`containerName`\" pulumi-lang-python=\"`container_name`\" pulumi-lang-yaml=\"`containerName`\" pulumi-lang-java=\"`containerName`\" pulumi-lang-hcl=\"`container_name`\"\u003e`containerName`\u003c/span\u003e - (Required) (String) The container in which the data is. This is what you are trying to mount. (Could be omitted if \u003cspan pulumi-lang-nodejs=\"`resourceId`\" pulumi-lang-dotnet=\"`ResourceId`\" pulumi-lang-go=\"`resourceId`\" pulumi-lang-python=\"`resource_id`\" pulumi-lang-yaml=\"`resourceId`\" pulumi-lang-java=\"`resourceId`\" pulumi-lang-hcl=\"`resource_id`\"\u003e`resourceId`\u003c/span\u003e is provided)\n* \u003cspan pulumi-lang-nodejs=\"`storageAccountName`\" pulumi-lang-dotnet=\"`StorageAccountName`\" pulumi-lang-go=\"`storageAccountName`\" pulumi-lang-python=\"`storage_account_name`\" pulumi-lang-yaml=\"`storageAccountName`\" pulumi-lang-java=\"`storageAccountName`\" pulumi-lang-hcl=\"`storage_account_name`\"\u003e`storageAccountName`\u003c/span\u003e - (Required) (String) The name of the storage resource in which the data is. (Could be omitted if \u003cspan pulumi-lang-nodejs=\"`resourceId`\" pulumi-lang-dotnet=\"`ResourceId`\" pulumi-lang-go=\"`resourceId`\" pulumi-lang-python=\"`resource_id`\" pulumi-lang-yaml=\"`resourceId`\" pulumi-lang-java=\"`resourceId`\" pulumi-lang-hcl=\"`resource_id`\"\u003e`resourceId`\u003c/span\u003e is provided)\n* \u003cspan pulumi-lang-nodejs=\"`directory`\" pulumi-lang-dotnet=\"`Directory`\" pulumi-lang-go=\"`directory`\" pulumi-lang-python=\"`directory`\" pulumi-lang-yaml=\"`directory`\" pulumi-lang-java=\"`directory`\" pulumi-lang-hcl=\"`directory`\"\u003e`directory`\u003c/span\u003e - (Computed) (String) This is optional if you don't want to add an additional directory that you wish to mount. This must start with a \"/\".\n\n### Example mounting Azure Blob Storage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as azurerm from \"@pulumi/azurerm\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst blobaccount = new azurerm.index.StorageAccount(\"blobaccount\", {\n name: `${prefix}blob`,\n resourceGroupName: resourceGroupName,\n location: resourceGroupLocation,\n accountTier: \"Standard\",\n accountReplicationType: \"LRS\",\n accountKind: \"StorageV2\",\n});\nconst marketing = new azurerm.index.StorageContainer(\"marketing\", {\n name: \"marketing\",\n storageAccountName: blobaccount.name,\n containerAccessType: \"private\",\n});\nconst terraform = new databricks.SecretScope(\"terraform\", {\n name: \"application\",\n initialManagePrincipal: \"users\",\n});\nconst storageKey = new databricks.Secret(\"storage_key\", {\n key: \"blob_storage_key\",\n stringValue: blobaccount.primaryAccessKey,\n scope: terraform.name,\n});\nconst marketingMount = new databricks.Mount(\"marketing\", {\n name: \"marketing\",\n wasb: {\n containerName: marketing.name,\n storageAccountName: blobaccount.name,\n authType: \"ACCESS_KEY\",\n tokenSecretScope: terraform.name,\n tokenSecretKey: storageKey.key,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_azurerm as azurerm\nimport pulumi_databricks as databricks\n\nblobaccount = azurerm.StorageAccount(\"blobaccount\",\n name=f{prefix}blob,\n resource_group_name=resource_group_name,\n location=resource_group_location,\n account_tier=Standard,\n account_replication_type=LRS,\n account_kind=StorageV2)\nmarketing = azurerm.StorageContainer(\"marketing\",\n name=marketing,\n storage_account_name=blobaccount.name,\n container_access_type=private)\nterraform = databricks.SecretScope(\"terraform\",\n name=\"application\",\n initial_manage_principal=\"users\")\nstorage_key = databricks.Secret(\"storage_key\",\n key=\"blob_storage_key\",\n string_value=blobaccount[\"primaryAccessKey\"],\n scope=terraform.name)\nmarketing_mount = databricks.Mount(\"marketing\",\n name=\"marketing\",\n wasb={\n \"container_name\": marketing[\"name\"],\n \"storage_account_name\": blobaccount[\"name\"],\n \"auth_type\": \"ACCESS_KEY\",\n \"token_secret_scope\": terraform.name,\n \"token_secret_key\": storage_key.key,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Azurerm = Pulumi.Azurerm;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var blobaccount = new Azurerm.StorageAccount(\"blobaccount\", new()\n {\n Name = $\"{prefix}blob\",\n ResourceGroupName = resourceGroupName,\n Location = resourceGroupLocation,\n AccountTier = \"Standard\",\n AccountReplicationType = \"LRS\",\n AccountKind = \"StorageV2\",\n });\n\n var marketing = new Azurerm.StorageContainer(\"marketing\", new()\n {\n Name = \"marketing\",\n StorageAccountName = blobaccount.Name,\n ContainerAccessType = \"private\",\n });\n\n var terraform = new Databricks.SecretScope(\"terraform\", new()\n {\n Name = \"application\",\n InitialManagePrincipal = \"users\",\n });\n\n var storageKey = new Databricks.Secret(\"storage_key\", new()\n {\n Key = \"blob_storage_key\",\n StringValue = blobaccount.PrimaryAccessKey,\n Scope = terraform.Name,\n });\n\n var marketingMount = new Databricks.Mount(\"marketing\", new()\n {\n Name = \"marketing\",\n Wasb = new Databricks.Inputs.MountWasbArgs\n {\n ContainerName = marketing.Name,\n StorageAccountName = blobaccount.Name,\n AuthType = \"ACCESS_KEY\",\n TokenSecretScope = terraform.Name,\n TokenSecretKey = storageKey.Key,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-azurerm/sdk/go/azurerm\"\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tblobaccount, err := azurerm.NewStorageAccount(ctx, \"blobaccount\", \u0026azurerm.StorageAccountArgs{\n\t\t\tName: fmt.Sprintf(\"%vblob\", prefix),\n\t\t\tResourceGroupName: resourceGroupName,\n\t\t\tLocation: resourceGroupLocation,\n\t\t\tAccountTier: \"Standard\",\n\t\t\tAccountReplicationType: \"LRS\",\n\t\t\tAccountKind: \"StorageV2\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tmarketing, err := azurerm.NewStorageContainer(ctx, \"marketing\", \u0026azurerm.StorageContainerArgs{\n\t\t\tName: \"marketing\",\n\t\t\tStorageAccountName: blobaccount.Name,\n\t\t\tContainerAccessType: \"private\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tterraform, err := databricks.NewSecretScope(ctx, \"terraform\", \u0026databricks.SecretScopeArgs{\n\t\t\tName: pulumi.String(\"application\"),\n\t\t\tInitialManagePrincipal: pulumi.String(\"users\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tstorageKey, err := databricks.NewSecret(ctx, \"storage_key\", \u0026databricks.SecretArgs{\n\t\t\tKey: pulumi.String(\"blob_storage_key\"),\n\t\t\tStringValue: blobaccount.PrimaryAccessKey,\n\t\t\tScope: terraform.Name,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMount(ctx, \"marketing\", \u0026databricks.MountArgs{\n\t\t\tName: pulumi.String(\"marketing\"),\n\t\t\tWasb: \u0026databricks.MountWasbArgs{\n\t\t\t\tContainerName: marketing.Name,\n\t\t\t\tStorageAccountName: blobaccount.Name,\n\t\t\t\tAuthType: pulumi.String(\"ACCESS_KEY\"),\n\t\t\t\tTokenSecretScope: terraform.Name,\n\t\t\t\tTokenSecretKey: storageKey.Key,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"azurerm_storageaccount\" \"blobaccount\" {\n name =\"${prefix}blob\"\n resource_group_name = resourceGroupName\n location = resourceGroupLocation\n account_tier = \"Standard\"\n account_replication_type = \"LRS\"\n account_kind = \"StorageV2\"\n}\nresource \"azurerm_storagecontainer\" \"marketing\" {\n name = \"marketing\"\n storage_account_name = azurerm_storageaccount.blobaccount.name\n container_access_type = \"private\"\n}\nresource \"databricks_secretscope\" \"terraform\" {\n name = \"application\"\n initial_manage_principal = \"users\"\n}\nresource \"databricks_secret\" \"storage_key\" {\n key = \"blob_storage_key\"\n string_value = azurerm_storageaccount.blobaccount.primaryAccessKey\n scope = databricks_secretscope.terraform.name\n}\nresource \"databricks_mount\" \"marketing\" {\n name = \"marketing\"\n wasb = {\n container_name = azurerm_storagecontainer.marketing.name\n storage_account_name = azurerm_storageaccount.blobaccount.name\n auth_type = \"ACCESS_KEY\"\n token_secret_scope = databricks_secretscope.terraform.name\n token_secret_key = databricks_secret.storage_key.key\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.azurerm.StorageAccount;\nimport com.pulumi.azurerm.StorageAccountArgs;\nimport com.pulumi.azurerm.StorageContainer;\nimport com.pulumi.azurerm.StorageContainerArgs;\nimport com.pulumi.databricks.SecretScope;\nimport com.pulumi.databricks.SecretScopeArgs;\nimport com.pulumi.databricks.Secret;\nimport com.pulumi.databricks.SecretArgs;\nimport com.pulumi.databricks.Mount;\nimport com.pulumi.databricks.MountArgs;\nimport com.pulumi.databricks.inputs.MountWasbArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var blobaccount = new StorageAccount(\"blobaccount\", StorageAccountArgs.builder()\n .name(String.format(\"%sblob\", prefix))\n .resourceGroupName(resourceGroupName)\n .location(resourceGroupLocation)\n .accountTier(\"Standard\")\n .accountReplicationType(\"LRS\")\n .accountKind(\"StorageV2\")\n .build());\n\n var marketing = new StorageContainer(\"marketing\", StorageContainerArgs.builder()\n .name(\"marketing\")\n .storageAccountName(blobaccount.name())\n .containerAccessType(\"private\")\n .build());\n\n var terraform = new SecretScope(\"terraform\", SecretScopeArgs.builder()\n .name(\"application\")\n .initialManagePrincipal(\"users\")\n .build());\n\n var storageKey = new Secret(\"storageKey\", SecretArgs.builder()\n .key(\"blob_storage_key\")\n .stringValue(blobaccount.primaryAccessKey())\n .scope(terraform.name())\n .build());\n\n var marketingMount = new Mount(\"marketingMount\", MountArgs.builder()\n .name(\"marketing\")\n .wasb(MountWasbArgs.builder()\n .containerName(marketing.name())\n .storageAccountName(blobaccount.name())\n .authType(\"ACCESS_KEY\")\n .tokenSecretScope(terraform.name())\n .tokenSecretKey(storageKey.key())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n blobaccount:\n type: azurerm:StorageAccount\n properties:\n name: ${prefix}blob\n resourceGroupName: ${resourceGroupName}\n location: ${resourceGroupLocation}\n accountTier: Standard\n accountReplicationType: LRS\n accountKind: StorageV2\n marketing:\n type: azurerm:StorageContainer\n properties:\n name: marketing\n storageAccountName: ${blobaccount.name}\n containerAccessType: private\n terraform:\n type: databricks:SecretScope\n properties:\n name: application\n initialManagePrincipal: users\n storageKey:\n type: databricks:Secret\n name: storage_key\n properties:\n key: blob_storage_key\n stringValue: ${blobaccount.primaryAccessKey}\n scope: ${terraform.name}\n marketingMount:\n type: databricks:Mount\n name: marketing\n properties:\n name: marketing\n wasb:\n containerName: ${marketing.name}\n storageAccountName: ${blobaccount.name}\n authType: ACCESS_KEY\n tokenSecretScope: ${terraform.name}\n tokenSecretKey: ${storageKey.key}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n* \u003cspan pulumi-lang-nodejs=\"`providerConfig`\" pulumi-lang-dotnet=\"`ProviderConfig`\" pulumi-lang-go=\"`providerConfig`\" pulumi-lang-python=\"`provider_config`\" pulumi-lang-yaml=\"`providerConfig`\" pulumi-lang-java=\"`providerConfig`\" pulumi-lang-hcl=\"`provider_config`\"\u003e`providerConfig`\u003c/span\u003e - (Optional) Configure the provider for management through account provider. This block consists of the following fields:\n * \u003cspan pulumi-lang-nodejs=\"`workspaceId`\" pulumi-lang-dotnet=\"`WorkspaceId`\" pulumi-lang-go=\"`workspaceId`\" pulumi-lang-python=\"`workspace_id`\" pulumi-lang-yaml=\"`workspaceId`\" pulumi-lang-java=\"`workspaceId`\" pulumi-lang-hcl=\"`workspace_id`\"\u003e`workspaceId`\u003c/span\u003e - (Required) Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.\n\n## Migration from other mount resources\n\nMigration from the specific mount resource is straightforward:\n\n* rename \u003cspan pulumi-lang-nodejs=\"`mountName`\" pulumi-lang-dotnet=\"`MountName`\" pulumi-lang-go=\"`mountName`\" pulumi-lang-python=\"`mount_name`\" pulumi-lang-yaml=\"`mountName`\" pulumi-lang-java=\"`mountName`\" pulumi-lang-hcl=\"`mount_name`\"\u003e`mountName`\u003c/span\u003e to \u003cspan pulumi-lang-nodejs=\"`name`\" pulumi-lang-dotnet=\"`Name`\" pulumi-lang-go=\"`name`\" pulumi-lang-python=\"`name`\" pulumi-lang-yaml=\"`name`\" pulumi-lang-java=\"`name`\" pulumi-lang-hcl=\"`name`\"\u003e`name`\u003c/span\u003e\n* wrap storage-specific settings (\u003cspan pulumi-lang-nodejs=\"`containerName`\" pulumi-lang-dotnet=\"`ContainerName`\" pulumi-lang-go=\"`containerName`\" pulumi-lang-python=\"`container_name`\" pulumi-lang-yaml=\"`containerName`\" pulumi-lang-java=\"`containerName`\" pulumi-lang-hcl=\"`container_name`\"\u003e`containerName`\u003c/span\u003e, ...) into corresponding block (\u003cspan pulumi-lang-nodejs=\"`adl`\" pulumi-lang-dotnet=\"`Adl`\" pulumi-lang-go=\"`adl`\" pulumi-lang-python=\"`adl`\" pulumi-lang-yaml=\"`adl`\" pulumi-lang-java=\"`adl`\" pulumi-lang-hcl=\"`adl`\"\u003e`adl`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`abfs`\" pulumi-lang-dotnet=\"`Abfs`\" pulumi-lang-go=\"`abfs`\" pulumi-lang-python=\"`abfs`\" pulumi-lang-yaml=\"`abfs`\" pulumi-lang-java=\"`abfs`\" pulumi-lang-hcl=\"`abfs`\"\u003e`abfs`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`s3`\" pulumi-lang-dotnet=\"`S3`\" pulumi-lang-go=\"`s3`\" pulumi-lang-python=\"`s3`\" pulumi-lang-yaml=\"`s3`\" pulumi-lang-java=\"`s3`\" pulumi-lang-hcl=\"`s3`\"\u003e`s3`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`wasbs`\" pulumi-lang-dotnet=\"`Wasbs`\" pulumi-lang-go=\"`wasbs`\" pulumi-lang-python=\"`wasbs`\" pulumi-lang-yaml=\"`wasbs`\" pulumi-lang-java=\"`wasbs`\" pulumi-lang-hcl=\"`wasbs`\"\u003e`wasbs`\u003c/span\u003e)\n* for S3 mounts, rename \u003cspan pulumi-lang-nodejs=\"`s3BucketName`\" pulumi-lang-dotnet=\"`S3BucketName`\" pulumi-lang-go=\"`s3BucketName`\" pulumi-lang-python=\"`s3_bucket_name`\" pulumi-lang-yaml=\"`s3BucketName`\" pulumi-lang-java=\"`s3BucketName`\" pulumi-lang-hcl=\"`s3_bucket_name`\"\u003e`s3BucketName`\u003c/span\u003e to \u003cspan pulumi-lang-nodejs=\"`bucketName`\" pulumi-lang-dotnet=\"`BucketName`\" pulumi-lang-go=\"`bucketName`\" pulumi-lang-python=\"`bucket_name`\" pulumi-lang-yaml=\"`bucketName`\" pulumi-lang-java=\"`bucketName`\" pulumi-lang-hcl=\"`bucket_name`\"\u003e`bucketName`\u003c/span\u003e\n\n## Related Resources\n\nThe following resources are often used in the same context:\n\n* End to end workspace management guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.getAwsBucketPolicy \" pulumi-lang-dotnet=\" databricks.getAwsBucketPolicy \" pulumi-lang-go=\" getAwsBucketPolicy \" pulumi-lang-python=\" get_aws_bucket_policy \" pulumi-lang-yaml=\" databricks.getAwsBucketPolicy \" pulumi-lang-java=\" databricks.getAwsBucketPolicy \" pulumi-lang-hcl=\" data.databricks_aws_bucket_policy \"\u003e databricks.getAwsBucketPolicy \u003c/span\u003edata to configure a simple access policy for AWS S3 buckets, so that Databricks can access data in it.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eto create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.DbfsFile \" pulumi-lang-dotnet=\" databricks.DbfsFile \" pulumi-lang-go=\" DbfsFile \" pulumi-lang-python=\" DbfsFile \" pulumi-lang-yaml=\" databricks.DbfsFile \" pulumi-lang-java=\" databricks.DbfsFile \" pulumi-lang-hcl=\" databricks_dbfs_file \"\u003e databricks.DbfsFile \u003c/span\u003edata to get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.getDbfsFilePaths \" pulumi-lang-dotnet=\" databricks.getDbfsFilePaths \" pulumi-lang-go=\" getDbfsFilePaths \" pulumi-lang-python=\" get_dbfs_file_paths \" pulumi-lang-yaml=\" databricks.getDbfsFilePaths \" pulumi-lang-java=\" databricks.getDbfsFilePaths \" pulumi-lang-hcl=\" data.databricks_dbfs_file_paths \"\u003e databricks.getDbfsFilePaths \u003c/span\u003edata to get list of file names from get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.DbfsFile \" pulumi-lang-dotnet=\" databricks.DbfsFile \" pulumi-lang-go=\" DbfsFile \" pulumi-lang-python=\" DbfsFile \" pulumi-lang-yaml=\" databricks.DbfsFile \" pulumi-lang-java=\" databricks.DbfsFile \" pulumi-lang-hcl=\" databricks_dbfs_file \"\u003e databricks.DbfsFile \u003c/span\u003eto manage relatively small files on [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.InstanceProfile \" pulumi-lang-dotnet=\" databricks.InstanceProfile \" pulumi-lang-go=\" InstanceProfile \" pulumi-lang-python=\" InstanceProfile \" pulumi-lang-yaml=\" databricks.InstanceProfile \" pulumi-lang-java=\" databricks.InstanceProfile \" pulumi-lang-hcl=\" databricks_instance_profile \"\u003e databricks.InstanceProfile \u003c/span\u003eto manage AWS EC2 instance profiles that users can launch\u003cspan pulumi-lang-nodejs=\" databricks.Cluster \" pulumi-lang-dotnet=\" databricks.Cluster \" pulumi-lang-go=\" Cluster \" pulumi-lang-python=\" Cluster \" pulumi-lang-yaml=\" databricks.Cluster \" pulumi-lang-java=\" databricks.Cluster \" pulumi-lang-hcl=\" databricks_cluster \"\u003e databricks.Cluster \u003c/span\u003eand access data, like databricks_mount.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Library \" pulumi-lang-dotnet=\" databricks.Library \" pulumi-lang-go=\" Library \" pulumi-lang-python=\" Library \" pulumi-lang-yaml=\" databricks.Library \" pulumi-lang-java=\" databricks.Library \" pulumi-lang-hcl=\" databricks_library \"\u003e databricks.Library \u003c/span\u003eto install a [library](https://docs.databricks.com/libraries/index.html) on databricks_cluster.\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "abfs": { "$ref": "#/types/databricks:index/MountAbfs:MountAbfs" }, "adl": { "$ref": "#/types/databricks:index/MountAdl:MountAdl" }, "clusterId": { "type": "string" }, "encryptionType": { "type": "string" }, "extraConfigs": { "type": "object", "additionalProperties": { "type": "string" } }, "gs": { "$ref": "#/types/databricks:index/MountGs:MountGs" }, "name": { "type": "string" }, "providerConfig": { "$ref": "#/types/databricks:index/MountProviderConfig:MountProviderConfig" }, "resourceId": { "type": "string" }, "s3": { "$ref": "#/types/databricks:index/MountS3:MountS3" }, "source": { "type": "string", "description": "(String) HDFS-compatible url\n" }, "uri": { "type": "string" }, "wasb": { "$ref": "#/types/databricks:index/MountWasb:MountWasb" } }, "required": [ "clusterId", "name", "providerConfig", "source" ], "inputProperties": { "abfs": { "$ref": "#/types/databricks:index/MountAbfs:MountAbfs", "willReplaceOnChanges": true }, "adl": { "$ref": "#/types/databricks:index/MountAdl:MountAdl", "willReplaceOnChanges": true }, "clusterId": { "type": "string", "willReplaceOnChanges": true }, "encryptionType": { "type": "string", "willReplaceOnChanges": true }, "extraConfigs": { "type": "object", "additionalProperties": { "type": "string" }, "willReplaceOnChanges": true }, "gs": { "$ref": "#/types/databricks:index/MountGs:MountGs", "willReplaceOnChanges": true }, "name": { "type": "string", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MountProviderConfig:MountProviderConfig" }, "resourceId": { "type": "string", "willReplaceOnChanges": true }, "s3": { "$ref": "#/types/databricks:index/MountS3:MountS3", "willReplaceOnChanges": true }, "uri": { "type": "string", "willReplaceOnChanges": true }, "wasb": { "$ref": "#/types/databricks:index/MountWasb:MountWasb", "willReplaceOnChanges": true } }, "stateInputs": { "description": "Input properties used for looking up and filtering Mount resources.\n", "properties": { "abfs": { "$ref": "#/types/databricks:index/MountAbfs:MountAbfs", "willReplaceOnChanges": true }, "adl": { "$ref": "#/types/databricks:index/MountAdl:MountAdl", "willReplaceOnChanges": true }, "clusterId": { "type": "string", "willReplaceOnChanges": true }, "encryptionType": { "type": "string", "willReplaceOnChanges": true }, "extraConfigs": { "type": "object", "additionalProperties": { "type": "string" }, "willReplaceOnChanges": true }, "gs": { "$ref": "#/types/databricks:index/MountGs:MountGs", "willReplaceOnChanges": true }, "name": { "type": "string", "willReplaceOnChanges": true }, "providerConfig": { "$ref": "#/types/databricks:index/MountProviderConfig:MountProviderConfig" }, "resourceId": { "type": "string", "willReplaceOnChanges": true }, "s3": { "$ref": "#/types/databricks:index/MountS3:MountS3", "willReplaceOnChanges": true }, "source": { "type": "string", "description": "(String) HDFS-compatible url\n" }, "uri": { "type": "string", "willReplaceOnChanges": true }, "wasb": { "$ref": "#/types/databricks:index/MountWasb:MountWasb", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsCredentials:MwsCredentials": { "description": "This resource to configure the cross-account role for creation of new workspaces within AWS.\n\n\u003e This resource can only be used with an account-level provider!\n\nPlease follow this complete runnable example with new VPC and new workspace setup. Please pay special attention to the fact that there you have two different instances of a databricks provider - one for deploying workspaces (with `host=\"https://accounts.cloud.databricks.com/\"`) and another for the workspace you've created with \u003cspan pulumi-lang-nodejs=\"`databricks.MwsWorkspaces`\" pulumi-lang-dotnet=\"`databricks.MwsWorkspaces`\" pulumi-lang-go=\"`MwsWorkspaces`\" pulumi-lang-python=\"`MwsWorkspaces`\" pulumi-lang-yaml=\"`databricks.MwsWorkspaces`\" pulumi-lang-java=\"`databricks.MwsWorkspaces`\" pulumi-lang-hcl=\"`databricks_mws_workspaces`\"\u003e`databricks.MwsWorkspaces`\u003c/span\u003e resource. If you want both creation of workspaces \u0026 clusters within workspace within the same terraform module (essentially same directory), you should use the provider aliasing feature of Pulumi. We strongly recommend having one terraform module for creation of workspace + PAT token and the rest in different modules.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\n// Names of created resources will be prefixed with this value\nconst prefix = config.requireObject\u003cany\u003e(\"prefix\");\nconst _this = databricks.getAwsAssumeRolePolicy({\n externalId: databricksAccountId,\n});\nconst crossAccountRole = new aws.index.IamRole(\"cross_account_role\", {\n name: `${prefix}-crossaccount`,\n assumeRolePolicy: _this.json,\n tags: tags,\n});\nconst thisGetAwsCrossAccountPolicy = databricks.getAwsCrossAccountPolicy({});\nconst thisIamRolePolicy = new aws.index.IamRolePolicy(\"this\", {\n name: `${prefix}-policy`,\n role: crossAccountRole.id,\n policy: thisGetAwsCrossAccountPolicy.json,\n});\nconst thisMwsCredentials = new databricks.MwsCredentials(\"this\", {\n credentialsName: `${prefix}-creds`,\n roleArn: crossAccountRole.arn,\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\n# Names of created resources will be prefixed with this value\nprefix = config.require_object(\"prefix\")\nthis = databricks.get_aws_assume_role_policy(external_id=databricks_account_id)\ncross_account_role = aws.IamRole(\"cross_account_role\",\n name=f{prefix}-crossaccount,\n assume_role_policy=this.json,\n tags=tags)\nthis_get_aws_cross_account_policy = databricks.get_aws_cross_account_policy()\nthis_iam_role_policy = aws.IamRolePolicy(\"this\",\n name=f{prefix}-policy,\n role=cross_account_role.id,\n policy=this_get_aws_cross_account_policy.json)\nthis_mws_credentials = databricks.MwsCredentials(\"this\",\n credentials_name=f\"{prefix}-creds\",\n role_arn=cross_account_role[\"arn\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n // Names of created resources will be prefixed with this value\n var prefix = config.RequireObject\u003cdynamic\u003e(\"prefix\");\n var @this = Databricks.GetAwsAssumeRolePolicy.Invoke(new()\n {\n ExternalId = databricksAccountId,\n });\n\n var crossAccountRole = new Aws.IamRole(\"cross_account_role\", new()\n {\n Name = $\"{prefix}-crossaccount\",\n AssumeRolePolicy = @this.Apply(getAwsAssumeRolePolicyResult =\u003e getAwsAssumeRolePolicyResult.Json),\n Tags = tags,\n });\n\n var thisGetAwsCrossAccountPolicy = Databricks.GetAwsCrossAccountPolicy.Invoke();\n\n var thisIamRolePolicy = new Aws.IamRolePolicy(\"this\", new()\n {\n Name = $\"{prefix}-policy\",\n Role = crossAccountRole.Id,\n Policy = thisGetAwsCrossAccountPolicy.Apply(getAwsCrossAccountPolicyResult =\u003e getAwsCrossAccountPolicyResult.Json),\n });\n\n var thisMwsCredentials = new Databricks.MwsCredentials(\"this\", new()\n {\n CredentialsName = $\"{prefix}-creds\",\n RoleArn = crossAccountRole.Arn,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-aws/sdk/v7/go/aws\"\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\t// Names of created resources will be prefixed with this value\n\t\tvar prefix interface{}\n\t\tcfg.RequireObject(\"prefix\", \u0026prefix)\n\t\tthis, err := databricks.GetAwsAssumeRolePolicy(ctx, \u0026databricks.GetAwsAssumeRolePolicyArgs{\n\t\t\tExternalId: databricksAccountId,\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tcrossAccountRole, err := aws.NewIamRole(ctx, \"cross_account_role\", \u0026aws.IamRoleArgs{\n\t\t\tName: fmt.Sprintf(\"%v-crossaccount\", prefix),\n\t\t\tAssumeRolePolicy: this.Json,\n\t\t\tTags: tags,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tthisGetAwsCrossAccountPolicy, err := databricks.GetAwsCrossAccountPolicy(ctx, \u0026databricks.GetAwsCrossAccountPolicyArgs{}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewIamRolePolicy(ctx, \"this\", \u0026aws.IamRolePolicyArgs{\n\t\t\tName: fmt.Sprintf(\"%v-policy\", prefix),\n\t\t\tRole: crossAccountRole.Id,\n\t\t\tPolicy: thisGetAwsCrossAccountPolicy.Json,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsCredentials(ctx, \"this\", \u0026databricks.MwsCredentialsArgs{\n\t\t\tCredentialsName: pulumi.Sprintf(\"%v-creds\", prefix),\n\t\t\tRoleArn: crossAccountRole.Arn,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n aws = {\n source = \"pulumi/aws\"\n }\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\ndata \"databricks_getawsassumerolepolicy\" \"this\" {\n external_id = var.databricksAccountId\n}\ndata \"databricks_getawscrossaccountpolicy\" \"thisGetAwsCrossAccountPolicy\" {\n}\n\nresource \"aws_iamrole\" \"cross_account_role\" {\n name =\"${var.prefix}-crossaccount\"\n assume_role_policy = data.databricks_getawsassumerolepolicy.this.json\n tags = tags\n}\nresource \"aws_iamrolepolicy\" \"this\" {\n name =\"${var.prefix}-policy\"\n role = aws_iamrole.cross_account_role.id\n policy = data.databricks_getawscrossaccountpolicy.thisGetAwsCrossAccountPolicy.json\n}\nresource \"databricks_mwscredentials\" \"this\" {\n credentials_name =\"${var.prefix}-creds\"\n role_arn = aws_iamrole.cross_account_role.arn\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\"\n}\nvariable \"prefix\" {\n description = \"Names of created resources will be prefixed with this value\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetAwsAssumeRolePolicyArgs;\nimport com.pulumi.aws.IamRole;\nimport com.pulumi.aws.IamRoleArgs;\nimport com.pulumi.databricks.inputs.GetAwsCrossAccountPolicyArgs;\nimport com.pulumi.aws.IamRolePolicy;\nimport com.pulumi.aws.IamRolePolicyArgs;\nimport com.pulumi.databricks.MwsCredentials;\nimport com.pulumi.databricks.MwsCredentialsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n final var prefix = config.require(\"prefix\");\n final var this = DatabricksFunctions.getAwsAssumeRolePolicy(GetAwsAssumeRolePolicyArgs.builder()\n .externalId(databricksAccountId)\n .build());\n\n var crossAccountRole = new IamRole(\"crossAccountRole\", IamRoleArgs.builder()\n .name(String.format(\"%s-crossaccount\", prefix))\n .assumeRolePolicy(this_.json())\n .tags(tags)\n .build());\n\n final var thisGetAwsCrossAccountPolicy = DatabricksFunctions.getAwsCrossAccountPolicy(GetAwsCrossAccountPolicyArgs.builder()\n .build());\n\n var thisIamRolePolicy = new IamRolePolicy(\"thisIamRolePolicy\", IamRolePolicyArgs.builder()\n .name(String.format(\"%s-policy\", prefix))\n .role(crossAccountRole.id())\n .policy(thisGetAwsCrossAccountPolicy.json())\n .build());\n\n var thisMwsCredentials = new MwsCredentials(\"thisMwsCredentials\", MwsCredentialsArgs.builder()\n .credentialsName(String.format(\"%s-creds\", prefix))\n .roleArn(crossAccountRole.arn())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\n prefix:\n type: object\nresources:\n crossAccountRole:\n type: aws:IamRole\n name: cross_account_role\n properties:\n name: ${prefix}-crossaccount\n assumeRolePolicy: ${this.json}\n tags: ${tags}\n thisIamRolePolicy:\n type: aws:IamRolePolicy\n name: this\n properties:\n name: ${prefix}-policy\n role: ${crossAccountRole.id}\n policy: ${thisGetAwsCrossAccountPolicy.json}\n thisMwsCredentials:\n type: databricks:MwsCredentials\n name: this\n properties:\n credentialsName: ${prefix}-creds\n roleArn: ${crossAccountRole.arn}\nvariables:\n this:\n fn::invoke:\n function: databricks:getAwsAssumeRolePolicy\n arguments:\n externalId: ${databricksAccountId}\n thisGetAwsCrossAccountPolicy:\n fn::invoke:\n function: databricks:getAwsCrossAccountPolicy\n arguments: {}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-dotnet=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-go=\" MwsCustomerManagedKeys \" pulumi-lang-python=\" MwsCustomerManagedKeys \" pulumi-lang-yaml=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-java=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-hcl=\" databricks_mws_customer_managed_keys \"\u003e databricks.MwsCustomerManagedKeys \u003c/span\u003eto configure KMS keys for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsLogDelivery \" pulumi-lang-dotnet=\" databricks.MwsLogDelivery \" pulumi-lang-go=\" MwsLogDelivery \" pulumi-lang-python=\" MwsLogDelivery \" pulumi-lang-yaml=\" databricks.MwsLogDelivery \" pulumi-lang-java=\" databricks.MwsLogDelivery \" pulumi-lang-hcl=\" databricks_mws_log_delivery \"\u003e databricks.MwsLogDelivery \u003c/span\u003eto configure delivery of [billable usage logs](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html) and [audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsStorageConfigurations \" pulumi-lang-dotnet=\" databricks.MwsStorageConfigurations \" pulumi-lang-go=\" MwsStorageConfigurations \" pulumi-lang-python=\" MwsStorageConfigurations \" pulumi-lang-yaml=\" databricks.MwsStorageConfigurations \" pulumi-lang-java=\" databricks.MwsStorageConfigurations \" pulumi-lang-hcl=\" databricks_mws_storage_configurations \"\u003e databricks.MwsStorageConfigurations \u003c/span\u003eto configure root bucket new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n", "properties": { "accountId": { "type": "string", "description": "**(Deprecated)** Maintained for backwards compatibility and will be removed in a later version. It should now be specified under a provider instance where `host = \"https://accounts.cloud.databricks.com\"`\n", "deprecationMessage": "\u003cspan pulumi-lang-nodejs=\"`accountId`\" pulumi-lang-dotnet=\"`AccountId`\" pulumi-lang-go=\"`accountId`\" pulumi-lang-python=\"`account_id`\" pulumi-lang-yaml=\"`accountId`\" pulumi-lang-java=\"`accountId`\" pulumi-lang-hcl=\"`account_id`\"\u003e`accountId`\u003c/span\u003e should be set as part of the Databricks Config, not in the resource." }, "creationTime": { "type": "integer", "description": "(Integer) time of credentials registration\n" }, "credentialsId": { "type": "string", "description": "(String) identifier of credentials\n" }, "credentialsName": { "type": "string", "description": "name of credentials to register\n" }, "externalId": { "type": "string" }, "roleArn": { "type": "string", "description": "ARN of cross-account role\n" } }, "required": [ "creationTime", "credentialsId", "credentialsName", "externalId", "roleArn" ], "inputProperties": { "accountId": { "type": "string", "description": "**(Deprecated)** Maintained for backwards compatibility and will be removed in a later version. It should now be specified under a provider instance where `host = \"https://accounts.cloud.databricks.com\"`\n", "deprecationMessage": "\u003cspan pulumi-lang-nodejs=\"`accountId`\" pulumi-lang-dotnet=\"`AccountId`\" pulumi-lang-go=\"`accountId`\" pulumi-lang-python=\"`account_id`\" pulumi-lang-yaml=\"`accountId`\" pulumi-lang-java=\"`accountId`\" pulumi-lang-hcl=\"`account_id`\"\u003e`accountId`\u003c/span\u003e should be set as part of the Databricks Config, not in the resource.", "willReplaceOnChanges": true }, "creationTime": { "type": "integer", "description": "(Integer) time of credentials registration\n" }, "credentialsId": { "type": "string", "description": "(String) identifier of credentials\n" }, "credentialsName": { "type": "string", "description": "name of credentials to register\n", "willReplaceOnChanges": true }, "externalId": { "type": "string" }, "roleArn": { "type": "string", "description": "ARN of cross-account role\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "credentialsName", "roleArn" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsCredentials resources.\n", "properties": { "accountId": { "type": "string", "description": "**(Deprecated)** Maintained for backwards compatibility and will be removed in a later version. It should now be specified under a provider instance where `host = \"https://accounts.cloud.databricks.com\"`\n", "deprecationMessage": "\u003cspan pulumi-lang-nodejs=\"`accountId`\" pulumi-lang-dotnet=\"`AccountId`\" pulumi-lang-go=\"`accountId`\" pulumi-lang-python=\"`account_id`\" pulumi-lang-yaml=\"`accountId`\" pulumi-lang-java=\"`accountId`\" pulumi-lang-hcl=\"`account_id`\"\u003e`accountId`\u003c/span\u003e should be set as part of the Databricks Config, not in the resource.", "willReplaceOnChanges": true }, "creationTime": { "type": "integer", "description": "(Integer) time of credentials registration\n" }, "credentialsId": { "type": "string", "description": "(String) identifier of credentials\n" }, "credentialsName": { "type": "string", "description": "name of credentials to register\n", "willReplaceOnChanges": true }, "externalId": { "type": "string" }, "roleArn": { "type": "string", "description": "ARN of cross-account role\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsCustomerManagedKeys:MwsCustomerManagedKeys": { "description": "This resource to configure KMS keys for new workspaces within AWS or GCP. This is to support the following features:\n\n* [Customer-managed keys for managed services](https://docs.databricks.com/security/keys/customer-managed-keys-managed-services-aws.html): Encrypt the workspace's managed services data in the control plane, including notebooks, secrets, Databricks SQL queries, and Databricks SQL query history with a CMK.\n* [Customer-managed keys for workspace storage](https://docs.databricks.com/security/keys/customer-managed-keys-storage-aws.html): Encrypt the workspace's root S3 bucket and clusters' EBS volumes with a CMK.\n\n\u003e This resource can only be used with an account-level provider!\n\n\u003e On GCP, the provider must be authenticated with a Google-issued OIDC token (not a Databricks OAuth token), because creating or updating this resource triggers operations against your GCP project (such as validating the KMS key). See Authenticate with Databricks account API for setup instructions.\n\nPlease follow this complete runnable example with new VPC and new workspace setup. Please pay special attention to the fact that there you have two different instances of a databricks provider - one for deploying workspaces (with `host=\"https://accounts.cloud.databricks.com/\"`) and another for the workspace you've created with\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource. If you want both creation of workspaces \u0026 clusters within workspace within the same terraform module (essentially same directory), you should use the provider aliasing feature of Pulumi. We strongly recommend having one Pulumi module for creation of workspace + PAT token and the rest in different modules.\n\n## Example Usage\n\n\u003e If you've used the resource before, please add \u003cspan pulumi-lang-nodejs=\"`useCases \" pulumi-lang-dotnet=\"`UseCases \" pulumi-lang-go=\"`useCases \" pulumi-lang-python=\"`use_cases \" pulumi-lang-yaml=\"`useCases \" pulumi-lang-java=\"`useCases \" pulumi-lang-hcl=\"`use_cases \"\u003e`useCases \u003c/span\u003e= [\"MANAGED_SERVICES\"]` to keep the previous behaviour.\n\n### Customer-managed key for managed services\n\nYou must configure this during workspace creation\n\n### For GCP\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\n// Id of a google_kms_crypto_key\nconst cmekResourceId = config.requireObject\u003cany\u003e(\"cmekResourceId\");\nconst managedServices = new databricks.MwsCustomerManagedKeys(\"managed_services\", {\n accountId: databricksAccountId,\n gcpKeyInfo: {\n kmsKeyId: cmekResourceId,\n },\n useCases: [\"MANAGED_SERVICES\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\n# Id of a google_kms_crypto_key\ncmek_resource_id = config.require_object(\"cmekResourceId\")\nmanaged_services = databricks.MwsCustomerManagedKeys(\"managed_services\",\n account_id=databricks_account_id,\n gcp_key_info={\n \"kms_key_id\": cmek_resource_id,\n },\n use_cases=[\"MANAGED_SERVICES\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n // Id of a google_kms_crypto_key\n var cmekResourceId = config.RequireObject\u003cdynamic\u003e(\"cmekResourceId\");\n var managedServices = new Databricks.MwsCustomerManagedKeys(\"managed_services\", new()\n {\n AccountId = databricksAccountId,\n GcpKeyInfo = new Databricks.Inputs.MwsCustomerManagedKeysGcpKeyInfoArgs\n {\n KmsKeyId = cmekResourceId,\n },\n UseCases = new[]\n {\n \"MANAGED_SERVICES\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\t// Id of a google_kms_crypto_key\n\t\tvar cmekResourceId interface{}\n\t\tcfg.RequireObject(\"cmekResourceId\", \u0026cmekResourceId)\n\t\t_, err := databricks.NewMwsCustomerManagedKeys(ctx, \"managed_services\", \u0026databricks.MwsCustomerManagedKeysArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tGcpKeyInfo: \u0026databricks.MwsCustomerManagedKeysGcpKeyInfoArgs{\n\t\t\t\tKmsKeyId: pulumi.Any(cmekResourceId),\n\t\t\t},\n\t\t\tUseCases: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"MANAGED_SERVICES\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwscustomermanagedkeys\" \"managed_services\" {\n account_id = var.databricksAccountId\n gcp_key_info = {\n kms_key_id = var.cmekResourceId\n }\n use_cases = [\"MANAGED_SERVICES\"]\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\"\n}\nvariable \"cmekResourceId\" {\n description = \"Id of a google_kms_crypto_key\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsCustomerManagedKeys;\nimport com.pulumi.databricks.MwsCustomerManagedKeysArgs;\nimport com.pulumi.databricks.inputs.MwsCustomerManagedKeysGcpKeyInfoArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n final var cmekResourceId = config.require(\"cmekResourceId\");\n var managedServices = new MwsCustomerManagedKeys(\"managedServices\", MwsCustomerManagedKeysArgs.builder()\n .accountId(databricksAccountId)\n .gcpKeyInfo(MwsCustomerManagedKeysGcpKeyInfoArgs.builder()\n .kmsKeyId(cmekResourceId)\n .build())\n .useCases(\"MANAGED_SERVICES\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\n cmekResourceId:\n type: object\nresources:\n managedServices:\n type: databricks:MwsCustomerManagedKeys\n name: managed_services\n properties:\n accountId: ${databricksAccountId}\n gcpKeyInfo:\n kmsKeyId: ${cmekResourceId}\n useCases:\n - MANAGED_SERVICES\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Customer-managed key for workspace storage\n\n### For GCP\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\n// Id of a google_kms_crypto_key\nconst cmekResourceId = config.requireObject\u003cany\u003e(\"cmekResourceId\");\nconst storage = new databricks.MwsCustomerManagedKeys(\"storage\", {\n accountId: databricksAccountId,\n gcpKeyInfo: {\n kmsKeyId: cmekResourceId,\n },\n useCases: [\"STORAGE\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\n# Id of a google_kms_crypto_key\ncmek_resource_id = config.require_object(\"cmekResourceId\")\nstorage = databricks.MwsCustomerManagedKeys(\"storage\",\n account_id=databricks_account_id,\n gcp_key_info={\n \"kms_key_id\": cmek_resource_id,\n },\n use_cases=[\"STORAGE\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n // Id of a google_kms_crypto_key\n var cmekResourceId = config.RequireObject\u003cdynamic\u003e(\"cmekResourceId\");\n var storage = new Databricks.MwsCustomerManagedKeys(\"storage\", new()\n {\n AccountId = databricksAccountId,\n GcpKeyInfo = new Databricks.Inputs.MwsCustomerManagedKeysGcpKeyInfoArgs\n {\n KmsKeyId = cmekResourceId,\n },\n UseCases = new[]\n {\n \"STORAGE\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\t// Id of a google_kms_crypto_key\n\t\tvar cmekResourceId interface{}\n\t\tcfg.RequireObject(\"cmekResourceId\", \u0026cmekResourceId)\n\t\t_, err := databricks.NewMwsCustomerManagedKeys(ctx, \"storage\", \u0026databricks.MwsCustomerManagedKeysArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tGcpKeyInfo: \u0026databricks.MwsCustomerManagedKeysGcpKeyInfoArgs{\n\t\t\t\tKmsKeyId: pulumi.Any(cmekResourceId),\n\t\t\t},\n\t\t\tUseCases: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"STORAGE\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwscustomermanagedkeys\" \"storage\" {\n account_id = var.databricksAccountId\n gcp_key_info = {\n kms_key_id = var.cmekResourceId\n }\n use_cases = [\"STORAGE\"]\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in the top right corner of https://accounts.gcp.databricks.com/\"\n}\nvariable \"cmekResourceId\" {\n description = \"Id of a google_kms_crypto_key\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsCustomerManagedKeys;\nimport com.pulumi.databricks.MwsCustomerManagedKeysArgs;\nimport com.pulumi.databricks.inputs.MwsCustomerManagedKeysGcpKeyInfoArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n final var cmekResourceId = config.require(\"cmekResourceId\");\n var storage = new MwsCustomerManagedKeys(\"storage\", MwsCustomerManagedKeysArgs.builder()\n .accountId(databricksAccountId)\n .gcpKeyInfo(MwsCustomerManagedKeysGcpKeyInfoArgs.builder()\n .kmsKeyId(cmekResourceId)\n .build())\n .useCases(\"STORAGE\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\n cmekResourceId:\n type: object\nresources:\n storage:\n type: databricks:MwsCustomerManagedKeys\n properties:\n accountId: ${databricksAccountId}\n gcpKeyInfo:\n kmsKeyId: ${cmekResourceId}\n useCases:\n - STORAGE\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCredentials \" pulumi-lang-dotnet=\" databricks.MwsCredentials \" pulumi-lang-go=\" MwsCredentials \" pulumi-lang-python=\" MwsCredentials \" pulumi-lang-yaml=\" databricks.MwsCredentials \" pulumi-lang-java=\" databricks.MwsCredentials \" pulumi-lang-hcl=\" databricks_mws_credentials \"\u003e databricks.MwsCredentials \u003c/span\u003eto configure the cross-account role for creation of new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsLogDelivery \" pulumi-lang-dotnet=\" databricks.MwsLogDelivery \" pulumi-lang-go=\" MwsLogDelivery \" pulumi-lang-python=\" MwsLogDelivery \" pulumi-lang-yaml=\" databricks.MwsLogDelivery \" pulumi-lang-java=\" databricks.MwsLogDelivery \" pulumi-lang-hcl=\" databricks_mws_log_delivery \"\u003e databricks.MwsLogDelivery \u003c/span\u003eto configure delivery of [billable usage logs](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html) and [audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsStorageConfigurations \" pulumi-lang-dotnet=\" databricks.MwsStorageConfigurations \" pulumi-lang-go=\" MwsStorageConfigurations \" pulumi-lang-python=\" MwsStorageConfigurations \" pulumi-lang-yaml=\" databricks.MwsStorageConfigurations \" pulumi-lang-java=\" databricks.MwsStorageConfigurations \" pulumi-lang-hcl=\" databricks_mws_storage_configurations \"\u003e databricks.MwsStorageConfigurations \u003c/span\u003eto configure root bucket new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n" }, "awsKeyInfo": { "$ref": "#/types/databricks:index/MwsCustomerManagedKeysAwsKeyInfo:MwsCustomerManagedKeysAwsKeyInfo", "description": "This field is a block and is documented below. This conflicts with \u003cspan pulumi-lang-nodejs=\"`gcpKeyInfo`\" pulumi-lang-dotnet=\"`GcpKeyInfo`\" pulumi-lang-go=\"`gcpKeyInfo`\" pulumi-lang-python=\"`gcp_key_info`\" pulumi-lang-yaml=\"`gcpKeyInfo`\" pulumi-lang-java=\"`gcpKeyInfo`\" pulumi-lang-hcl=\"`gcp_key_info`\"\u003e`gcpKeyInfo`\u003c/span\u003e\n" }, "creationTime": { "type": "integer", "description": "(Integer) Time in epoch milliseconds when the customer key was created.\n" }, "customerManagedKeyId": { "type": "string", "description": "(String) ID of the encryption key configuration object.\n" }, "gcpKeyInfo": { "$ref": "#/types/databricks:index/MwsCustomerManagedKeysGcpKeyInfo:MwsCustomerManagedKeysGcpKeyInfo", "description": "This field is a block and is documented below. This conflicts with \u003cspan pulumi-lang-nodejs=\"`awsKeyInfo`\" pulumi-lang-dotnet=\"`AwsKeyInfo`\" pulumi-lang-go=\"`awsKeyInfo`\" pulumi-lang-python=\"`aws_key_info`\" pulumi-lang-yaml=\"`awsKeyInfo`\" pulumi-lang-java=\"`awsKeyInfo`\" pulumi-lang-hcl=\"`aws_key_info`\"\u003e`awsKeyInfo`\u003c/span\u003e\n" }, "useCases": { "type": "array", "items": { "type": "string" }, "description": "*(since v0.3.4)* List of use cases for which this key will be used. *If you've used the resource before, please add \u003cspan pulumi-lang-nodejs=\"`useCases \" pulumi-lang-dotnet=\"`UseCases \" pulumi-lang-go=\"`useCases \" pulumi-lang-python=\"`use_cases \" pulumi-lang-yaml=\"`useCases \" pulumi-lang-java=\"`useCases \" pulumi-lang-hcl=\"`use_cases \"\u003e`useCases \u003c/span\u003e= [\"MANAGED_SERVICES\"]` to keep the previous behaviour.* Possible values are:\n* `MANAGED_SERVICES` - for encryption of the workspace objects (notebooks, secrets) that are stored in the control plane\n* `STORAGE` - for encryption of the DBFS Storage \u0026 Cluster EBS Volumes\n" } }, "required": [ "accountId", "creationTime", "customerManagedKeyId", "useCases" ], "inputProperties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "willReplaceOnChanges": true }, "awsKeyInfo": { "$ref": "#/types/databricks:index/MwsCustomerManagedKeysAwsKeyInfo:MwsCustomerManagedKeysAwsKeyInfo", "description": "This field is a block and is documented below. This conflicts with \u003cspan pulumi-lang-nodejs=\"`gcpKeyInfo`\" pulumi-lang-dotnet=\"`GcpKeyInfo`\" pulumi-lang-go=\"`gcpKeyInfo`\" pulumi-lang-python=\"`gcp_key_info`\" pulumi-lang-yaml=\"`gcpKeyInfo`\" pulumi-lang-java=\"`gcpKeyInfo`\" pulumi-lang-hcl=\"`gcp_key_info`\"\u003e`gcpKeyInfo`\u003c/span\u003e\n", "willReplaceOnChanges": true }, "creationTime": { "type": "integer", "description": "(Integer) Time in epoch milliseconds when the customer key was created.\n" }, "customerManagedKeyId": { "type": "string", "description": "(String) ID of the encryption key configuration object.\n" }, "gcpKeyInfo": { "$ref": "#/types/databricks:index/MwsCustomerManagedKeysGcpKeyInfo:MwsCustomerManagedKeysGcpKeyInfo", "description": "This field is a block and is documented below. This conflicts with \u003cspan pulumi-lang-nodejs=\"`awsKeyInfo`\" pulumi-lang-dotnet=\"`AwsKeyInfo`\" pulumi-lang-go=\"`awsKeyInfo`\" pulumi-lang-python=\"`aws_key_info`\" pulumi-lang-yaml=\"`awsKeyInfo`\" pulumi-lang-java=\"`awsKeyInfo`\" pulumi-lang-hcl=\"`aws_key_info`\"\u003e`awsKeyInfo`\u003c/span\u003e\n", "willReplaceOnChanges": true }, "useCases": { "type": "array", "items": { "type": "string" }, "description": "*(since v0.3.4)* List of use cases for which this key will be used. *If you've used the resource before, please add \u003cspan pulumi-lang-nodejs=\"`useCases \" pulumi-lang-dotnet=\"`UseCases \" pulumi-lang-go=\"`useCases \" pulumi-lang-python=\"`use_cases \" pulumi-lang-yaml=\"`useCases \" pulumi-lang-java=\"`useCases \" pulumi-lang-hcl=\"`use_cases \"\u003e`useCases \u003c/span\u003e= [\"MANAGED_SERVICES\"]` to keep the previous behaviour.* Possible values are:\n* `MANAGED_SERVICES` - for encryption of the workspace objects (notebooks, secrets) that are stored in the control plane\n* `STORAGE` - for encryption of the DBFS Storage \u0026 Cluster EBS Volumes\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "accountId", "useCases" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsCustomerManagedKeys resources.\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "willReplaceOnChanges": true }, "awsKeyInfo": { "$ref": "#/types/databricks:index/MwsCustomerManagedKeysAwsKeyInfo:MwsCustomerManagedKeysAwsKeyInfo", "description": "This field is a block and is documented below. This conflicts with \u003cspan pulumi-lang-nodejs=\"`gcpKeyInfo`\" pulumi-lang-dotnet=\"`GcpKeyInfo`\" pulumi-lang-go=\"`gcpKeyInfo`\" pulumi-lang-python=\"`gcp_key_info`\" pulumi-lang-yaml=\"`gcpKeyInfo`\" pulumi-lang-java=\"`gcpKeyInfo`\" pulumi-lang-hcl=\"`gcp_key_info`\"\u003e`gcpKeyInfo`\u003c/span\u003e\n", "willReplaceOnChanges": true }, "creationTime": { "type": "integer", "description": "(Integer) Time in epoch milliseconds when the customer key was created.\n" }, "customerManagedKeyId": { "type": "string", "description": "(String) ID of the encryption key configuration object.\n" }, "gcpKeyInfo": { "$ref": "#/types/databricks:index/MwsCustomerManagedKeysGcpKeyInfo:MwsCustomerManagedKeysGcpKeyInfo", "description": "This field is a block and is documented below. This conflicts with \u003cspan pulumi-lang-nodejs=\"`awsKeyInfo`\" pulumi-lang-dotnet=\"`AwsKeyInfo`\" pulumi-lang-go=\"`awsKeyInfo`\" pulumi-lang-python=\"`aws_key_info`\" pulumi-lang-yaml=\"`awsKeyInfo`\" pulumi-lang-java=\"`awsKeyInfo`\" pulumi-lang-hcl=\"`aws_key_info`\"\u003e`awsKeyInfo`\u003c/span\u003e\n", "willReplaceOnChanges": true }, "useCases": { "type": "array", "items": { "type": "string" }, "description": "*(since v0.3.4)* List of use cases for which this key will be used. *If you've used the resource before, please add \u003cspan pulumi-lang-nodejs=\"`useCases \" pulumi-lang-dotnet=\"`UseCases \" pulumi-lang-go=\"`useCases \" pulumi-lang-python=\"`use_cases \" pulumi-lang-yaml=\"`useCases \" pulumi-lang-java=\"`useCases \" pulumi-lang-hcl=\"`use_cases \"\u003e`useCases \u003c/span\u003e= [\"MANAGED_SERVICES\"]` to keep the previous behaviour.* Possible values are:\n* `MANAGED_SERVICES` - for encryption of the workspace objects (notebooks, secrets) that are stored in the control plane\n* `STORAGE` - for encryption of the DBFS Storage \u0026 Cluster EBS Volumes\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsLogDelivery:MwsLogDelivery": { "description": "This resource configures the delivery of the two supported log types from Databricks workspaces: [billable usage logs](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html) and [audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).\n\n\u003e This resource can only be used with an account-level provider!\n\nYou cannot delete a log delivery configuration, but you can disable it when you no longer need it. This fact is important because there is a limit to the number of enabled log delivery configurations that you can create for an account. You can create a maximum of two enabled configurations that use the account level (no workspace filter) and two enabled configurations for every specific workspace (a workspaceId can occur in the workspace filter for two configurations). You can re-enable a disabled configuration, but the request fails if it violates the limits previously described.\n\n## Example Usage\n\nEnd-to-end example of usage and audit log delivery:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as std from \"@pulumi/std\";\nimport * as time from \"@pulumiverse/time\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\nconst logdeliveryS3Bucket = new aws.index.S3Bucket(\"logdelivery\", {\n bucket: `${prefix}-logdelivery`,\n acl: \"private\",\n forceDestroy: true,\n tags: std.merge({\n input: [\n tags,\n {\n name: `${prefix}-logdelivery`,\n },\n ],\n }).result,\n});\nconst logdeliveryS3BucketPublicAccessBlock = new aws.index.S3BucketPublicAccessBlock(\"logdelivery\", {\n bucket: logdeliveryS3Bucket.id,\n ignorePublicAcls: true,\n});\nconst logdelivery = databricks.getAwsAssumeRolePolicy({\n externalId: databricksAccountId,\n forLogDelivery: true,\n});\nconst logdeliveryVersioning = new aws.index.S3BucketVersioning(\"logdelivery_versioning\", {\n bucket: logdeliveryS3Bucket.id,\n versioningConfiguration: [{\n status: \"Disabled\",\n }],\n});\nconst logdeliveryIamRole = new aws.index.IamRole(\"logdelivery\", {\n name: `${prefix}-logdelivery`,\n description: `(${prefix}) UsageDelivery role`,\n assumeRolePolicy: logdelivery.json,\n tags: tags,\n});\nconst logdeliveryGetAwsBucketPolicy = databricks.getAwsBucketPolicy({\n fullAccessRole: logdeliveryIamRole.arn,\n bucket: logdeliveryS3Bucket.bucket,\n});\nconst logdeliveryS3BucketPolicy = new aws.index.S3BucketPolicy(\"logdelivery\", {\n bucket: logdeliveryS3Bucket.id,\n policy: logdeliveryGetAwsBucketPolicy.json,\n});\nconst wait = new time.Sleep(\"wait\", {createDuration: \"10s\"}, {\n dependsOn: [logdeliveryIamRole],\n});\nconst logWriter = new databricks.MwsCredentials(\"log_writer\", {\n accountId: databricksAccountId,\n credentialsName: \"Usage Delivery\",\n roleArn: logdeliveryIamRole.arn,\n}, {\n dependsOn: [wait],\n});\nconst logBucket = new databricks.MwsStorageConfigurations(\"log_bucket\", {\n accountId: databricksAccountId,\n storageConfigurationName: \"Usage Logs\",\n bucketName: logdeliveryS3Bucket.bucket,\n});\nconst usageLogs = new databricks.MwsLogDelivery(\"usage_logs\", {\n accountId: databricksAccountId,\n credentialsId: logWriter.credentialsId,\n storageConfigurationId: logBucket.storageConfigurationId,\n deliveryPathPrefix: \"billable-usage\",\n configName: \"Usage Logs\",\n logType: \"BILLABLE_USAGE\",\n outputFormat: \"CSV\",\n});\nconst auditLogs = new databricks.MwsLogDelivery(\"audit_logs\", {\n accountId: databricksAccountId,\n credentialsId: logWriter.credentialsId,\n storageConfigurationId: logBucket.storageConfigurationId,\n deliveryPathPrefix: \"audit-logs\",\n configName: \"Audit Logs\",\n logType: \"AUDIT_LOGS\",\n outputFormat: \"JSON\",\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\nimport pulumi_databricks as databricks\nimport pulumi_std as std\nimport pulumiverse_time as time\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\nlogdelivery_s3_bucket = aws.S3Bucket(\"logdelivery\",\n bucket=f{prefix}-logdelivery,\n acl=private,\n force_destroy=True,\n tags=std.merge(input=[\n tags,\n {\n name: f{prefix}-logdelivery,\n },\n ]).result)\nlogdelivery_s3_bucket_public_access_block = aws.S3BucketPublicAccessBlock(\"logdelivery\",\n bucket=logdelivery_s3_bucket.id,\n ignore_public_acls=True)\nlogdelivery = databricks.get_aws_assume_role_policy(external_id=databricks_account_id,\n for_log_delivery=True)\nlogdelivery_versioning = aws.S3BucketVersioning(\"logdelivery_versioning\",\n bucket=logdelivery_s3_bucket.id,\n versioning_configuration=[{\n status: Disabled,\n }])\nlogdelivery_iam_role = aws.IamRole(\"logdelivery\",\n name=f{prefix}-logdelivery,\n description=f({prefix}) UsageDelivery role,\n assume_role_policy=logdelivery.json,\n tags=tags)\nlogdelivery_get_aws_bucket_policy = databricks.get_aws_bucket_policy(full_access_role=logdelivery_iam_role[\"arn\"],\n bucket=logdelivery_s3_bucket[\"bucket\"])\nlogdelivery_s3_bucket_policy = aws.S3BucketPolicy(\"logdelivery\",\n bucket=logdelivery_s3_bucket.id,\n policy=logdelivery_get_aws_bucket_policy.json)\nwait = time.Sleep(\"wait\", create_duration=\"10s\",\nopts = pulumi.ResourceOptions(depends_on=[logdelivery_iam_role]))\nlog_writer = databricks.MwsCredentials(\"log_writer\",\n account_id=databricks_account_id,\n credentials_name=\"Usage Delivery\",\n role_arn=logdelivery_iam_role[\"arn\"],\n opts = pulumi.ResourceOptions(depends_on=[wait]))\nlog_bucket = databricks.MwsStorageConfigurations(\"log_bucket\",\n account_id=databricks_account_id,\n storage_configuration_name=\"Usage Logs\",\n bucket_name=logdelivery_s3_bucket[\"bucket\"])\nusage_logs = databricks.MwsLogDelivery(\"usage_logs\",\n account_id=databricks_account_id,\n credentials_id=log_writer.credentials_id,\n storage_configuration_id=log_bucket.storage_configuration_id,\n delivery_path_prefix=\"billable-usage\",\n config_name=\"Usage Logs\",\n log_type=\"BILLABLE_USAGE\",\n output_format=\"CSV\")\naudit_logs = databricks.MwsLogDelivery(\"audit_logs\",\n account_id=databricks_account_id,\n credentials_id=log_writer.credentials_id,\n storage_configuration_id=log_bucket.storage_configuration_id,\n delivery_path_prefix=\"audit-logs\",\n config_name=\"Audit Logs\",\n log_type=\"AUDIT_LOGS\",\n output_format=\"JSON\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\nusing Databricks = Pulumi.Databricks;\nusing Std = Pulumi.Std;\nusing Time = Pulumiverse.Time;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n var logdeliveryS3Bucket = new Aws.S3Bucket(\"logdelivery\", new()\n {\n Bucket = $\"{prefix}-logdelivery\",\n Acl = \"private\",\n ForceDestroy = true,\n Tags = Std.Merge.Invoke(new()\n {\n Input = new[]\n {\n tags,\n \n {\n { \"name\", $\"{prefix}-logdelivery\" },\n },\n },\n }).Result,\n });\n\n var logdeliveryS3BucketPublicAccessBlock = new Aws.S3BucketPublicAccessBlock(\"logdelivery\", new()\n {\n Bucket = logdeliveryS3Bucket.Id,\n IgnorePublicAcls = true,\n });\n\n var logdelivery = Databricks.GetAwsAssumeRolePolicy.Invoke(new()\n {\n ExternalId = databricksAccountId,\n ForLogDelivery = true,\n });\n\n var logdeliveryVersioning = new Aws.S3BucketVersioning(\"logdelivery_versioning\", new()\n {\n Bucket = logdeliveryS3Bucket.Id,\n VersioningConfiguration = new[]\n {\n \n {\n { \"status\", \"Disabled\" },\n },\n },\n });\n\n var logdeliveryIamRole = new Aws.IamRole(\"logdelivery\", new()\n {\n Name = $\"{prefix}-logdelivery\",\n Description = $\"({prefix}) UsageDelivery role\",\n AssumeRolePolicy = logdelivery.Apply(getAwsAssumeRolePolicyResult =\u003e getAwsAssumeRolePolicyResult.Json),\n Tags = tags,\n });\n\n var logdeliveryGetAwsBucketPolicy = Databricks.GetAwsBucketPolicy.Invoke(new()\n {\n FullAccessRole = logdeliveryIamRole.Arn,\n Bucket = logdeliveryS3Bucket.Bucket,\n });\n\n var logdeliveryS3BucketPolicy = new Aws.S3BucketPolicy(\"logdelivery\", new()\n {\n Bucket = logdeliveryS3Bucket.Id,\n Policy = logdeliveryGetAwsBucketPolicy.Apply(getAwsBucketPolicyResult =\u003e getAwsBucketPolicyResult.Json),\n });\n\n var wait = new Time.Sleep(\"wait\", new()\n {\n CreateDuration = \"10s\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n logdeliveryIamRole,\n },\n });\n\n var logWriter = new Databricks.MwsCredentials(\"log_writer\", new()\n {\n AccountId = databricksAccountId,\n CredentialsName = \"Usage Delivery\",\n RoleArn = logdeliveryIamRole.Arn,\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n wait,\n },\n });\n\n var logBucket = new Databricks.MwsStorageConfigurations(\"log_bucket\", new()\n {\n AccountId = databricksAccountId,\n StorageConfigurationName = \"Usage Logs\",\n BucketName = logdeliveryS3Bucket.Bucket,\n });\n\n var usageLogs = new Databricks.MwsLogDelivery(\"usage_logs\", new()\n {\n AccountId = databricksAccountId,\n CredentialsId = logWriter.CredentialsId,\n StorageConfigurationId = logBucket.StorageConfigurationId,\n DeliveryPathPrefix = \"billable-usage\",\n ConfigName = \"Usage Logs\",\n LogType = \"BILLABLE_USAGE\",\n OutputFormat = \"CSV\",\n });\n\n var auditLogs = new Databricks.MwsLogDelivery(\"audit_logs\", new()\n {\n AccountId = databricksAccountId,\n CredentialsId = logWriter.CredentialsId,\n StorageConfigurationId = logBucket.StorageConfigurationId,\n DeliveryPathPrefix = \"audit-logs\",\n ConfigName = \"Audit Logs\",\n LogType = \"AUDIT_LOGS\",\n OutputFormat = \"JSON\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-aws/sdk/v7/go/aws\"\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-std/sdk/go/std\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n\t\"github.com/pulumiverse/pulumi-time/sdk/go/time\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\tlogdeliveryS3Bucket, err := aws.NewS3Bucket(ctx, \"logdelivery\", \u0026aws.S3BucketArgs{\n\t\t\tBucket: fmt.Sprintf(\"%v-logdelivery\", prefix),\n\t\t\tAcl: \"private\",\n\t\t\tForceDestroy: true,\n\t\t\tTags: std.Merge(ctx, \u0026std.MergeArgs{\n\t\t\t\tInput: []interface{}{\n\t\t\t\t\ttags,\n\t\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\t\"name\": fmt.Sprintf(\"%v-logdelivery\", prefix),\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t}, nil).Result,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewS3BucketPublicAccessBlock(ctx, \"logdelivery\", \u0026aws.S3BucketPublicAccessBlockArgs{\n\t\t\tBucket: logdeliveryS3Bucket.Id,\n\t\t\tIgnorePublicAcls: true,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlogdelivery, err := databricks.GetAwsAssumeRolePolicy(ctx, \u0026databricks.GetAwsAssumeRolePolicyArgs{\n\t\t\tExternalId: databricksAccountId,\n\t\t\tForLogDelivery: pulumi.BoolRef(true),\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewS3BucketVersioning(ctx, \"logdelivery_versioning\", \u0026aws.S3BucketVersioningArgs{\n\t\t\tBucket: logdeliveryS3Bucket.Id,\n\t\t\tVersioningConfiguration: []map[string]interface{}{\n\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\"status\": \"Disabled\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlogdeliveryIamRole, err := aws.NewIamRole(ctx, \"logdelivery\", \u0026aws.IamRoleArgs{\n\t\t\tName: fmt.Sprintf(\"%v-logdelivery\", prefix),\n\t\t\tDescription: fmt.Sprintf(\"(%v) UsageDelivery role\", prefix),\n\t\t\tAssumeRolePolicy: logdelivery.Json,\n\t\t\tTags: tags,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlogdeliveryGetAwsBucketPolicy, err := databricks.GetAwsBucketPolicy(ctx, \u0026databricks.GetAwsBucketPolicyArgs{\n\t\t\tFullAccessRole: pulumi.StringRef(logdeliveryIamRole.Arn),\n\t\t\tBucket: logdeliveryS3Bucket.Bucket,\n\t\t}, nil)\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewS3BucketPolicy(ctx, \"logdelivery\", \u0026aws.S3BucketPolicyArgs{\n\t\t\tBucket: logdeliveryS3Bucket.Id,\n\t\t\tPolicy: logdeliveryGetAwsBucketPolicy.Json,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\twait, err := time.NewSleep(ctx, \"wait\", \u0026time.SleepArgs{\n\t\t\tCreateDuration: pulumi.String(\"10s\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tlogdeliveryIamRole,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlogWriter, err := databricks.NewMwsCredentials(ctx, \"log_writer\", \u0026databricks.MwsCredentialsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tCredentialsName: pulumi.String(\"Usage Delivery\"),\n\t\t\tRoleArn: logdeliveryIamRole.Arn,\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\twait,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tlogBucket, err := databricks.NewMwsStorageConfigurations(ctx, \"log_bucket\", \u0026databricks.MwsStorageConfigurationsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tStorageConfigurationName: pulumi.String(\"Usage Logs\"),\n\t\t\tBucketName: logdeliveryS3Bucket.Bucket,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsLogDelivery(ctx, \"usage_logs\", \u0026databricks.MwsLogDeliveryArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tCredentialsId: logWriter.CredentialsId,\n\t\t\tStorageConfigurationId: logBucket.StorageConfigurationId,\n\t\t\tDeliveryPathPrefix: pulumi.String(\"billable-usage\"),\n\t\t\tConfigName: pulumi.String(\"Usage Logs\"),\n\t\t\tLogType: pulumi.String(\"BILLABLE_USAGE\"),\n\t\t\tOutputFormat: pulumi.String(\"CSV\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsLogDelivery(ctx, \"audit_logs\", \u0026databricks.MwsLogDeliveryArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tCredentialsId: logWriter.CredentialsId,\n\t\t\tStorageConfigurationId: logBucket.StorageConfigurationId,\n\t\t\tDeliveryPathPrefix: pulumi.String(\"audit-logs\"),\n\t\t\tConfigName: pulumi.String(\"Audit Logs\"),\n\t\t\tLogType: pulumi.String(\"AUDIT_LOGS\"),\n\t\t\tOutputFormat: pulumi.String(\"JSON\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n aws = {\n source = \"pulumi/aws\"\n }\n databricks = {\n source = \"pulumi/databricks\"\n }\n std = {\n source = \"pulumi/std\"\n }\n time = {\n source = \"pulumi/time\"\n }\n }\n}\n\ndata \"std_merge\" \"invoke_0\" {\n input = [tags, {\n \"name\" =\"${prefix}-logdelivery\"\n }]\n}\ndata \"databricks_getawsassumerolepolicy\" \"logdelivery\" {\n external_id = var.databricksAccountId\n for_log_delivery = true\n}\ndata \"databricks_getawsbucketpolicy\" \"logdeliveryGetAwsBucketPolicy\" {\n full_access_role = aws_iamrole.logdelivery.arn\n bucket = aws_s3bucket.logdelivery.bucket\n}\n\nresource \"aws_s3bucket\" \"logdelivery\" {\n bucket =\"${prefix}-logdelivery\"\n acl = \"private\"\n force_destroy = true\n tags = data.std_merge.invoke_0.result\n}\nresource \"aws_s3bucketpublicaccessblock\" \"logdelivery\" {\n bucket = aws_s3bucket.logdelivery.id\n ignore_public_acls = true\n}\nresource \"aws_s3bucketversioning\" \"logdelivery_versioning\" {\n bucket = aws_s3bucket.logdelivery.id\n versioning_configuration = [{\n \"status\" = \"Disabled\"\n }]\n}\nresource \"aws_iamrole\" \"logdelivery\" {\n name =\"${prefix}-logdelivery\"\n description =\"(${prefix}) UsageDelivery role\"\n assume_role_policy = data.databricks_getawsassumerolepolicy.logdelivery.json\n tags = tags\n}\nresource \"aws_s3bucketpolicy\" \"logdelivery\" {\n bucket = aws_s3bucket.logdelivery.id\n policy = data.databricks_getawsbucketpolicy.logdeliveryGetAwsBucketPolicy.json\n}\nresource \"time_sleep\" \"wait\" {\n depends_on = [aws_iamrole.logdelivery]\n create_duration = \"10s\"\n}\nresource \"databricks_mwscredentials\" \"log_writer\" {\n depends_on = [time_sleep.wait]\n account_id = var.databricksAccountId\n credentials_name = \"Usage Delivery\"\n role_arn = aws_iamrole.logdelivery.arn\n}\nresource \"databricks_mwsstorageconfigurations\" \"log_bucket\" {\n account_id = var.databricksAccountId\n storage_configuration_name = \"Usage Logs\"\n bucket_name = aws_s3bucket.logdelivery.bucket\n}\nresource \"databricks_mwslogdelivery\" \"usage_logs\" {\n account_id = var.databricksAccountId\n credentials_id = databricks_mwscredentials.log_writer.credentials_id\n storage_configuration_id = databricks_mwsstorageconfigurations.log_bucket.storage_configuration_id\n delivery_path_prefix = \"billable-usage\"\n config_name = \"Usage Logs\"\n log_type = \"BILLABLE_USAGE\"\n output_format = \"CSV\"\n}\nresource \"databricks_mwslogdelivery\" \"audit_logs\" {\n account_id = var.databricksAccountId\n credentials_id = databricks_mwscredentials.log_writer.credentials_id\n storage_configuration_id = databricks_mwsstorageconfigurations.log_bucket.storage_configuration_id\n delivery_path_prefix = \"audit-logs\"\n config_name = \"Audit Logs\"\n log_type = \"AUDIT_LOGS\"\n output_format = \"JSON\"\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.S3Bucket;\nimport com.pulumi.aws.S3BucketArgs;\nimport com.pulumi.std.StdFunctions;\nimport com.pulumi.std.inputs.MergeArgs;\nimport com.pulumi.aws.S3BucketPublicAccessBlock;\nimport com.pulumi.aws.S3BucketPublicAccessBlockArgs;\nimport com.pulumi.databricks.DatabricksFunctions;\nimport com.pulumi.databricks.inputs.GetAwsAssumeRolePolicyArgs;\nimport com.pulumi.aws.S3BucketVersioning;\nimport com.pulumi.aws.S3BucketVersioningArgs;\nimport com.pulumi.aws.IamRole;\nimport com.pulumi.aws.IamRoleArgs;\nimport com.pulumi.databricks.inputs.GetAwsBucketPolicyArgs;\nimport com.pulumi.aws.S3BucketPolicy;\nimport com.pulumi.aws.S3BucketPolicyArgs;\nimport com.pulumiverse.time.Sleep;\nimport com.pulumiverse.time.SleepArgs;\nimport com.pulumi.databricks.MwsCredentials;\nimport com.pulumi.databricks.MwsCredentialsArgs;\nimport com.pulumi.databricks.MwsStorageConfigurations;\nimport com.pulumi.databricks.MwsStorageConfigurationsArgs;\nimport com.pulumi.databricks.MwsLogDelivery;\nimport com.pulumi.databricks.MwsLogDeliveryArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n var logdeliveryS3Bucket = new S3Bucket(\"logdeliveryS3Bucket\", S3BucketArgs.builder()\n .bucket(String.format(\"%s-logdelivery\", prefix))\n .acl(\"private\")\n .forceDestroy(true)\n .tags(StdFunctions.merge(MergeArgs.builder()\n .input( \n tags,\n Map.of(\"name\", String.format(\"%s-logdelivery\", prefix)))\n .build()).result())\n .build());\n\n var logdeliveryS3BucketPublicAccessBlock = new S3BucketPublicAccessBlock(\"logdeliveryS3BucketPublicAccessBlock\", S3BucketPublicAccessBlockArgs.builder()\n .bucket(logdeliveryS3Bucket.id())\n .ignorePublicAcls(true)\n .build());\n\n final var logdelivery = DatabricksFunctions.getAwsAssumeRolePolicy(GetAwsAssumeRolePolicyArgs.builder()\n .externalId(databricksAccountId)\n .forLogDelivery(true)\n .build());\n\n var logdeliveryVersioning = new S3BucketVersioning(\"logdeliveryVersioning\", S3BucketVersioningArgs.builder()\n .bucket(logdeliveryS3Bucket.id())\n .versioningConfiguration(Arrays.asList(Map.of(\"status\", \"Disabled\")))\n .build());\n\n var logdeliveryIamRole = new IamRole(\"logdeliveryIamRole\", IamRoleArgs.builder()\n .name(String.format(\"%s-logdelivery\", prefix))\n .description(String.format(\"(%s) UsageDelivery role\", prefix))\n .assumeRolePolicy(logdelivery.json())\n .tags(tags)\n .build());\n\n final var logdeliveryGetAwsBucketPolicy = DatabricksFunctions.getAwsBucketPolicy(GetAwsBucketPolicyArgs.builder()\n .fullAccessRole(logdeliveryIamRole.arn())\n .bucket(logdeliveryS3Bucket.bucket())\n .build());\n\n var logdeliveryS3BucketPolicy = new S3BucketPolicy(\"logdeliveryS3BucketPolicy\", S3BucketPolicyArgs.builder()\n .bucket(logdeliveryS3Bucket.id())\n .policy(logdeliveryGetAwsBucketPolicy.json())\n .build());\n\n var wait = new Sleep(\"wait\", SleepArgs.builder()\n .createDuration(\"10s\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(logdeliveryIamRole)\n .build());\n\n var logWriter = new MwsCredentials(\"logWriter\", MwsCredentialsArgs.builder()\n .accountId(databricksAccountId)\n .credentialsName(\"Usage Delivery\")\n .roleArn(logdeliveryIamRole.arn())\n .build(), CustomResourceOptions.builder()\n .dependsOn(wait)\n .build());\n\n var logBucket = new MwsStorageConfigurations(\"logBucket\", MwsStorageConfigurationsArgs.builder()\n .accountId(databricksAccountId)\n .storageConfigurationName(\"Usage Logs\")\n .bucketName(logdeliveryS3Bucket.bucket())\n .build());\n\n var usageLogs = new MwsLogDelivery(\"usageLogs\", MwsLogDeliveryArgs.builder()\n .accountId(databricksAccountId)\n .credentialsId(logWriter.credentialsId())\n .storageConfigurationId(logBucket.storageConfigurationId())\n .deliveryPathPrefix(\"billable-usage\")\n .configName(\"Usage Logs\")\n .logType(\"BILLABLE_USAGE\")\n .outputFormat(\"CSV\")\n .build());\n\n var auditLogs = new MwsLogDelivery(\"auditLogs\", MwsLogDeliveryArgs.builder()\n .accountId(databricksAccountId)\n .credentialsId(logWriter.credentialsId())\n .storageConfigurationId(logBucket.storageConfigurationId())\n .deliveryPathPrefix(\"audit-logs\")\n .configName(\"Audit Logs\")\n .logType(\"AUDIT_LOGS\")\n .outputFormat(\"JSON\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\nresources:\n logdeliveryS3Bucket:\n type: aws:S3Bucket\n name: logdelivery\n properties:\n bucket: ${prefix}-logdelivery\n acl: private\n forceDestroy: true\n tags:\n fn::invoke:\n function: std:merge\n arguments:\n input:\n - ${tags}\n - name: ${prefix}-logdelivery\n return: result\n logdeliveryS3BucketPublicAccessBlock:\n type: aws:S3BucketPublicAccessBlock\n name: logdelivery\n properties:\n bucket: ${logdeliveryS3Bucket.id}\n ignorePublicAcls: true\n logdeliveryVersioning:\n type: aws:S3BucketVersioning\n name: logdelivery_versioning\n properties:\n bucket: ${logdeliveryS3Bucket.id}\n versioningConfiguration:\n - status: Disabled\n logdeliveryIamRole:\n type: aws:IamRole\n name: logdelivery\n properties:\n name: ${prefix}-logdelivery\n description: (${prefix}) UsageDelivery role\n assumeRolePolicy: ${logdelivery.json}\n tags: ${tags}\n logdeliveryS3BucketPolicy:\n type: aws:S3BucketPolicy\n name: logdelivery\n properties:\n bucket: ${logdeliveryS3Bucket.id}\n policy: ${logdeliveryGetAwsBucketPolicy.json}\n wait:\n type: time:Sleep\n properties:\n createDuration: 10s\n options:\n dependsOn:\n - ${logdeliveryIamRole}\n logWriter:\n type: databricks:MwsCredentials\n name: log_writer\n properties:\n accountId: ${databricksAccountId}\n credentialsName: Usage Delivery\n roleArn: ${logdeliveryIamRole.arn}\n options:\n dependsOn:\n - ${wait}\n logBucket:\n type: databricks:MwsStorageConfigurations\n name: log_bucket\n properties:\n accountId: ${databricksAccountId}\n storageConfigurationName: Usage Logs\n bucketName: ${logdeliveryS3Bucket.bucket}\n usageLogs:\n type: databricks:MwsLogDelivery\n name: usage_logs\n properties:\n accountId: ${databricksAccountId}\n credentialsId: ${logWriter.credentialsId}\n storageConfigurationId: ${logBucket.storageConfigurationId}\n deliveryPathPrefix: billable-usage\n configName: Usage Logs\n logType: BILLABLE_USAGE\n outputFormat: CSV\n auditLogs:\n type: databricks:MwsLogDelivery\n name: audit_logs\n properties:\n accountId: ${databricksAccountId}\n credentialsId: ${logWriter.credentialsId}\n storageConfigurationId: ${logBucket.storageConfigurationId}\n deliveryPathPrefix: audit-logs\n configName: Audit Logs\n logType: AUDIT_LOGS\n outputFormat: JSON\nvariables:\n logdelivery:\n fn::invoke:\n function: databricks:getAwsAssumeRolePolicy\n arguments:\n externalId: ${databricksAccountId}\n forLogDelivery: true\n logdeliveryGetAwsBucketPolicy:\n fn::invoke:\n function: databricks:getAwsBucketPolicy\n arguments:\n fullAccessRole: ${logdeliveryIamRole.arn}\n bucket: ${logdeliveryS3Bucket.bucket}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Billable Usage\n\nCSV files are delivered to `\u003cdelivery_path_prefix\u003e/billable-usage/csv/` and are named `workspaceId=\u003cworkspace-id\u003e-usageMonth=\u003cmonth\u003e.csv`, which are delivered daily by overwriting the month's CSV file for each workspace. Format of CSV file, as well as some usage examples, can be found [here](https://docs.databricks.com/administration-guide/account-settings/usage.html#download-usage-as-a-csv-file).\n\nCommon processing scenario is to apply [cost allocation tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html), that could be enforced by setting\u003cspan pulumi-lang-nodejs=\" customTags \" pulumi-lang-dotnet=\" CustomTags \" pulumi-lang-go=\" customTags \" pulumi-lang-python=\" custom_tags \" pulumi-lang-yaml=\" customTags \" pulumi-lang-java=\" customTags \" pulumi-lang-hcl=\" custom_tags \"\u003e customTags \u003c/span\u003eon a cluster or through cluster policy. Report contains `clusterId` field, that could be joined with data from AWS [cost and usage reports](https://docs.aws.amazon.com/cur/latest/userguide/cur-create.html), that can be joined with `user:ClusterId` tag from AWS usage report.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst usageLogs = new databricks.MwsLogDelivery(\"usage_logs\", {\n accountId: databricksAccountId,\n credentialsId: logWriter.credentialsId,\n storageConfigurationId: logBucket.storageConfigurationId,\n deliveryPathPrefix: \"billable-usage\",\n configName: \"Usage Logs\",\n logType: \"BILLABLE_USAGE\",\n outputFormat: \"CSV\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nusage_logs = databricks.MwsLogDelivery(\"usage_logs\",\n account_id=databricks_account_id,\n credentials_id=log_writer[\"credentialsId\"],\n storage_configuration_id=log_bucket[\"storageConfigurationId\"],\n delivery_path_prefix=\"billable-usage\",\n config_name=\"Usage Logs\",\n log_type=\"BILLABLE_USAGE\",\n output_format=\"CSV\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var usageLogs = new Databricks.MwsLogDelivery(\"usage_logs\", new()\n {\n AccountId = databricksAccountId,\n CredentialsId = logWriter.CredentialsId,\n StorageConfigurationId = logBucket.StorageConfigurationId,\n DeliveryPathPrefix = \"billable-usage\",\n ConfigName = \"Usage Logs\",\n LogType = \"BILLABLE_USAGE\",\n OutputFormat = \"CSV\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsLogDelivery(ctx, \"usage_logs\", \u0026databricks.MwsLogDeliveryArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tCredentialsId: pulumi.Any(logWriter.CredentialsId),\n\t\t\tStorageConfigurationId: pulumi.Any(logBucket.StorageConfigurationId),\n\t\t\tDeliveryPathPrefix: pulumi.String(\"billable-usage\"),\n\t\t\tConfigName: pulumi.String(\"Usage Logs\"),\n\t\t\tLogType: pulumi.String(\"BILLABLE_USAGE\"),\n\t\t\tOutputFormat: pulumi.String(\"CSV\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwslogdelivery\" \"usage_logs\" {\n account_id = databricksAccountId\n credentials_id = logWriter.credentialsId\n storage_configuration_id = logBucket.storageConfigurationId\n delivery_path_prefix = \"billable-usage\"\n config_name = \"Usage Logs\"\n log_type = \"BILLABLE_USAGE\"\n output_format = \"CSV\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsLogDelivery;\nimport com.pulumi.databricks.MwsLogDeliveryArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var usageLogs = new MwsLogDelivery(\"usageLogs\", MwsLogDeliveryArgs.builder()\n .accountId(databricksAccountId)\n .credentialsId(logWriter.credentialsId())\n .storageConfigurationId(logBucket.storageConfigurationId())\n .deliveryPathPrefix(\"billable-usage\")\n .configName(\"Usage Logs\")\n .logType(\"BILLABLE_USAGE\")\n .outputFormat(\"CSV\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n usageLogs:\n type: databricks:MwsLogDelivery\n name: usage_logs\n properties:\n accountId: ${databricksAccountId}\n credentialsId: ${logWriter.credentialsId}\n storageConfigurationId: ${logBucket.storageConfigurationId}\n deliveryPathPrefix: billable-usage\n configName: Usage Logs\n logType: BILLABLE_USAGE\n outputFormat: CSV\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Audit Logs\n\nJSON files with [static schema](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html#audit-log-schema) are delivered to `\u003cdelivery_path_prefix\u003e/workspaceId=\u003cworkspaceId\u003e/date=\u003cyyyy-mm-dd\u003e/auditlogs_\u003cinternal-id\u003e.json`. Logs are available within 15 minutes of activation for audit logs. New JSON files are delivered every few minutes, potentially overwriting existing files for each workspace. Sometimes data may arrive later than 15 minutes. Databricks can overwrite the delivered log files in your bucket at any time. If a file is overwritten, the existing content remains, but there may be additional lines for more auditable events. Overwriting ensures exactly-once semantics without requiring read or delete access to your account.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst auditLogs = new databricks.MwsLogDelivery(\"audit_logs\", {\n accountId: databricksAccountId,\n credentialsId: logWriter.credentialsId,\n storageConfigurationId: logBucket.storageConfigurationId,\n deliveryPathPrefix: \"audit-logs\",\n configName: \"Audit Logs\",\n logType: \"AUDIT_LOGS\",\n outputFormat: \"JSON\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\naudit_logs = databricks.MwsLogDelivery(\"audit_logs\",\n account_id=databricks_account_id,\n credentials_id=log_writer[\"credentialsId\"],\n storage_configuration_id=log_bucket[\"storageConfigurationId\"],\n delivery_path_prefix=\"audit-logs\",\n config_name=\"Audit Logs\",\n log_type=\"AUDIT_LOGS\",\n output_format=\"JSON\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var auditLogs = new Databricks.MwsLogDelivery(\"audit_logs\", new()\n {\n AccountId = databricksAccountId,\n CredentialsId = logWriter.CredentialsId,\n StorageConfigurationId = logBucket.StorageConfigurationId,\n DeliveryPathPrefix = \"audit-logs\",\n ConfigName = \"Audit Logs\",\n LogType = \"AUDIT_LOGS\",\n OutputFormat = \"JSON\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsLogDelivery(ctx, \"audit_logs\", \u0026databricks.MwsLogDeliveryArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tCredentialsId: pulumi.Any(logWriter.CredentialsId),\n\t\t\tStorageConfigurationId: pulumi.Any(logBucket.StorageConfigurationId),\n\t\t\tDeliveryPathPrefix: pulumi.String(\"audit-logs\"),\n\t\t\tConfigName: pulumi.String(\"Audit Logs\"),\n\t\t\tLogType: pulumi.String(\"AUDIT_LOGS\"),\n\t\t\tOutputFormat: pulumi.String(\"JSON\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwslogdelivery\" \"audit_logs\" {\n account_id = databricksAccountId\n credentials_id = logWriter.credentialsId\n storage_configuration_id = logBucket.storageConfigurationId\n delivery_path_prefix = \"audit-logs\"\n config_name = \"Audit Logs\"\n log_type = \"AUDIT_LOGS\"\n output_format = \"JSON\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsLogDelivery;\nimport com.pulumi.databricks.MwsLogDeliveryArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var auditLogs = new MwsLogDelivery(\"auditLogs\", MwsLogDeliveryArgs.builder()\n .accountId(databricksAccountId)\n .credentialsId(logWriter.credentialsId())\n .storageConfigurationId(logBucket.storageConfigurationId())\n .deliveryPathPrefix(\"audit-logs\")\n .configName(\"Audit Logs\")\n .logType(\"AUDIT_LOGS\")\n .outputFormat(\"JSON\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n auditLogs:\n type: databricks:MwsLogDelivery\n name: audit_logs\n properties:\n accountId: ${databricksAccountId}\n credentialsId: ${logWriter.credentialsId}\n storageConfigurationId: ${logBucket.storageConfigurationId}\n deliveryPathPrefix: audit-logs\n configName: Audit Logs\n logType: AUDIT_LOGS\n outputFormat: JSON\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCredentials \" pulumi-lang-dotnet=\" databricks.MwsCredentials \" pulumi-lang-go=\" MwsCredentials \" pulumi-lang-python=\" MwsCredentials \" pulumi-lang-yaml=\" databricks.MwsCredentials \" pulumi-lang-java=\" databricks.MwsCredentials \" pulumi-lang-hcl=\" databricks_mws_credentials \"\u003e databricks.MwsCredentials \u003c/span\u003eto configure the cross-account role for creation of new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-dotnet=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-go=\" MwsCustomerManagedKeys \" pulumi-lang-python=\" MwsCustomerManagedKeys \" pulumi-lang-yaml=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-java=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-hcl=\" databricks_mws_customer_managed_keys \"\u003e databricks.MwsCustomerManagedKeys \u003c/span\u003eto configure KMS keys for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsStorageConfigurations \" pulumi-lang-dotnet=\" databricks.MwsStorageConfigurations \" pulumi-lang-go=\" MwsStorageConfigurations \" pulumi-lang-python=\" MwsStorageConfigurations \" pulumi-lang-yaml=\" databricks.MwsStorageConfigurations \" pulumi-lang-java=\" databricks.MwsStorageConfigurations \" pulumi-lang-hcl=\" databricks_mws_storage_configurations \"\u003e databricks.MwsStorageConfigurations \u003c/span\u003eto configure root bucket new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/).\n" }, "configId": { "type": "string", "description": "Databricks log delivery configuration ID.\n" }, "configName": { "type": "string", "description": "The optional human-readable name of the log delivery configuration. Defaults to empty.\n" }, "credentialsId": { "type": "string", "description": "The ID for a Databricks credential configuration that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page.\n" }, "deliveryPathPrefix": { "type": "string", "description": "Defaults to empty, which means that logs are delivered to the root of the bucket. The value must be a valid S3 object key. It must not start or end with a slash character.\n" }, "deliveryStartTime": { "type": "string", "description": "The optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. Usage is not available before 2019-03.\n" }, "logType": { "type": "string", "description": "The type of log delivery. `BILLABLE_USAGE` and `AUDIT_LOGS` are supported.\n" }, "outputFormat": { "type": "string", "description": "The file type of log delivery. Currently `CSV` (for `BILLABLE_USAGE`) and `JSON` (for `AUDIT_LOGS`) are supported.\n" }, "status": { "type": "string", "description": "Status of log delivery configuration. Set to ENABLED or DISABLED. Defaults to ENABLED. This is the only field you can update.\n" }, "storageConfigurationId": { "type": "string", "description": "The ID for a Databricks storage configuration that represents the S3 bucket with bucket policy as described in the main billable usage documentation page.\n" }, "workspaceIdsFilters": { "type": "array", "items": { "type": "integer" }, "description": "By default, this log configuration applies to all workspaces associated with your account ID. If your account is on the multitenant version of the platform or on a select custom plan that allows multiple workspaces per account, you may have multiple workspaces associated with your account ID. You can optionally set the field as mentioned earlier to an array of workspace IDs. If you plan to use different log delivery configurations for several workspaces, set this explicitly rather than leaving it blank. If you leave this blank and your account ID gets additional workspaces in the future, this configuration will also apply to the new workspaces.\n" } }, "required": [ "accountId", "configId", "credentialsId", "deliveryStartTime", "logType", "outputFormat", "status", "storageConfigurationId" ], "inputProperties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/).\n", "willReplaceOnChanges": true }, "configId": { "type": "string", "description": "Databricks log delivery configuration ID.\n", "willReplaceOnChanges": true }, "configName": { "type": "string", "description": "The optional human-readable name of the log delivery configuration. Defaults to empty.\n", "willReplaceOnChanges": true }, "credentialsId": { "type": "string", "description": "The ID for a Databricks credential configuration that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page.\n", "willReplaceOnChanges": true }, "deliveryPathPrefix": { "type": "string", "description": "Defaults to empty, which means that logs are delivered to the root of the bucket. The value must be a valid S3 object key. It must not start or end with a slash character.\n", "willReplaceOnChanges": true }, "deliveryStartTime": { "type": "string", "description": "The optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. Usage is not available before 2019-03.\n", "willReplaceOnChanges": true }, "logType": { "type": "string", "description": "The type of log delivery. `BILLABLE_USAGE` and `AUDIT_LOGS` are supported.\n", "willReplaceOnChanges": true }, "outputFormat": { "type": "string", "description": "The file type of log delivery. Currently `CSV` (for `BILLABLE_USAGE`) and `JSON` (for `AUDIT_LOGS`) are supported.\n", "willReplaceOnChanges": true }, "status": { "type": "string", "description": "Status of log delivery configuration. Set to ENABLED or DISABLED. Defaults to ENABLED. This is the only field you can update.\n" }, "storageConfigurationId": { "type": "string", "description": "The ID for a Databricks storage configuration that represents the S3 bucket with bucket policy as described in the main billable usage documentation page.\n", "willReplaceOnChanges": true }, "workspaceIdsFilters": { "type": "array", "items": { "type": "integer" }, "description": "By default, this log configuration applies to all workspaces associated with your account ID. If your account is on the multitenant version of the platform or on a select custom plan that allows multiple workspaces per account, you may have multiple workspaces associated with your account ID. You can optionally set the field as mentioned earlier to an array of workspace IDs. If you plan to use different log delivery configurations for several workspaces, set this explicitly rather than leaving it blank. If you leave this blank and your account ID gets additional workspaces in the future, this configuration will also apply to the new workspaces.\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "accountId", "credentialsId", "logType", "outputFormat", "storageConfigurationId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsLogDelivery resources.\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/).\n", "willReplaceOnChanges": true }, "configId": { "type": "string", "description": "Databricks log delivery configuration ID.\n", "willReplaceOnChanges": true }, "configName": { "type": "string", "description": "The optional human-readable name of the log delivery configuration. Defaults to empty.\n", "willReplaceOnChanges": true }, "credentialsId": { "type": "string", "description": "The ID for a Databricks credential configuration that represents the AWS IAM role with policy and trust relationship as described in the main billable usage documentation page.\n", "willReplaceOnChanges": true }, "deliveryPathPrefix": { "type": "string", "description": "Defaults to empty, which means that logs are delivered to the root of the bucket. The value must be a valid S3 object key. It must not start or end with a slash character.\n", "willReplaceOnChanges": true }, "deliveryStartTime": { "type": "string", "description": "The optional start month and year for delivery, specified in YYYY-MM format. Defaults to current year and month. Usage is not available before 2019-03.\n", "willReplaceOnChanges": true }, "logType": { "type": "string", "description": "The type of log delivery. `BILLABLE_USAGE` and `AUDIT_LOGS` are supported.\n", "willReplaceOnChanges": true }, "outputFormat": { "type": "string", "description": "The file type of log delivery. Currently `CSV` (for `BILLABLE_USAGE`) and `JSON` (for `AUDIT_LOGS`) are supported.\n", "willReplaceOnChanges": true }, "status": { "type": "string", "description": "Status of log delivery configuration. Set to ENABLED or DISABLED. Defaults to ENABLED. This is the only field you can update.\n" }, "storageConfigurationId": { "type": "string", "description": "The ID for a Databricks storage configuration that represents the S3 bucket with bucket policy as described in the main billable usage documentation page.\n", "willReplaceOnChanges": true }, "workspaceIdsFilters": { "type": "array", "items": { "type": "integer" }, "description": "By default, this log configuration applies to all workspaces associated with your account ID. If your account is on the multitenant version of the platform or on a select custom plan that allows multiple workspaces per account, you may have multiple workspaces associated with your account ID. You can optionally set the field as mentioned earlier to an array of workspace IDs. If you plan to use different log delivery configurations for several workspaces, set this explicitly rather than leaving it blank. If you leave this blank and your account ID gets additional workspaces in the future, this configuration will also apply to the new workspaces.\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsNccBinding:MwsNccBinding": { "description": "Allows you to attach a Network Connectivity Config object to a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource to create a [Databricks Workspace that leverages serverless network connectivity configs](https://learn.microsoft.com/en-us/azure/databricks/sql/admin/serverless-firewall).\n\n\u003e This resource can only be used with an account-level provider!\n\n\u003e This feature is available for AWS \u0026 Azure only, and is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html) in AWS.\n\nThe NCC and workspace must be in the same region.\n\n\u003e A workspace can only be bound to a single NCC. Binding a different NCC to the same workspace will overwrite the previous one. If you need multiple private endpoint rules, add them to a single NCC using \u003cspan pulumi-lang-nodejs=\"`databricks.MwsNccPrivateEndpointRule`\" pulumi-lang-dotnet=\"`databricks.MwsNccPrivateEndpointRule`\" pulumi-lang-go=\"`MwsNccPrivateEndpointRule`\" pulumi-lang-python=\"`MwsNccPrivateEndpointRule`\" pulumi-lang-yaml=\"`databricks.MwsNccPrivateEndpointRule`\" pulumi-lang-java=\"`databricks.MwsNccPrivateEndpointRule`\" pulumi-lang-hcl=\"`databricks_mws_ncc_private_endpoint_rule`\"\u003e`databricks.MwsNccPrivateEndpointRule`\u003c/span\u003e.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\nconst region = config.requireObject\u003cany\u003e(\"region\");\nconst prefix = config.requireObject\u003cany\u003e(\"prefix\");\nconst ncc = new databricks.MwsNetworkConnectivityConfig(\"ncc\", {\n name: `ncc-for-${prefix}`,\n region: region,\n});\nconst nccBinding = new databricks.MwsNccBinding(\"ncc_binding\", {\n networkConnectivityConfigId: ncc.networkConnectivityConfigId,\n workspaceId: databricksWorkspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\nregion = config.require_object(\"region\")\nprefix = config.require_object(\"prefix\")\nncc = databricks.MwsNetworkConnectivityConfig(\"ncc\",\n name=f\"ncc-for-{prefix}\",\n region=region)\nncc_binding = databricks.MwsNccBinding(\"ncc_binding\",\n network_connectivity_config_id=ncc.network_connectivity_config_id,\n workspace_id=databricks_workspace_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n var region = config.RequireObject\u003cdynamic\u003e(\"region\");\n var prefix = config.RequireObject\u003cdynamic\u003e(\"prefix\");\n var ncc = new Databricks.MwsNetworkConnectivityConfig(\"ncc\", new()\n {\n Name = $\"ncc-for-{prefix}\",\n Region = region,\n });\n\n var nccBinding = new Databricks.MwsNccBinding(\"ncc_binding\", new()\n {\n NetworkConnectivityConfigId = ncc.NetworkConnectivityConfigId,\n WorkspaceId = databricksWorkspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvar region interface{}\n\t\tcfg.RequireObject(\"region\", \u0026region)\n\t\tvar prefix interface{}\n\t\tcfg.RequireObject(\"prefix\", \u0026prefix)\n\t\tncc, err := databricks.NewMwsNetworkConnectivityConfig(ctx, \"ncc\", \u0026databricks.MwsNetworkConnectivityConfigArgs{\n\t\t\tName: pulumi.Sprintf(\"ncc-for-%v\", prefix),\n\t\t\tRegion: pulumi.Any(region),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNccBinding(ctx, \"ncc_binding\", \u0026databricks.MwsNccBindingArgs{\n\t\t\tNetworkConnectivityConfigId: ncc.NetworkConnectivityConfigId,\n\t\t\tWorkspaceId: pulumi.Any(databricksWorkspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsnetworkconnectivityconfig\" \"ncc\" {\n name =\"ncc-for-${var.prefix}\"\n region = var.region\n}\nresource \"databricks_mwsnccbinding\" \"ncc_binding\" {\n network_connectivity_config_id = databricks_mwsnetworkconnectivityconfig.ncc.network_connectivity_config_id\n workspace_id = databricksWorkspaceId\n}\nvariable \"region\" {\n}\nvariable \"prefix\" {\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfig;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfigArgs;\nimport com.pulumi.databricks.MwsNccBinding;\nimport com.pulumi.databricks.MwsNccBindingArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var region = config.require(\"region\");\n final var prefix = config.require(\"prefix\");\n var ncc = new MwsNetworkConnectivityConfig(\"ncc\", MwsNetworkConnectivityConfigArgs.builder()\n .name(String.format(\"ncc-for-%s\", prefix))\n .region(region)\n .build());\n\n var nccBinding = new MwsNccBinding(\"nccBinding\", MwsNccBindingArgs.builder()\n .networkConnectivityConfigId(ncc.networkConnectivityConfigId())\n .workspaceId(databricksWorkspaceId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n region:\n type: object\n prefix:\n type: object\nresources:\n ncc:\n type: databricks:MwsNetworkConnectivityConfig\n properties:\n name: ncc-for-${prefix}\n region: ${region}\n nccBinding:\n type: databricks:MwsNccBinding\n name: ncc_binding\n properties:\n networkConnectivityConfigId: ${ncc.networkConnectivityConfigId}\n workspaceId: ${databricksWorkspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up Databricks workspaces.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-dotnet=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-go=\" MwsNetworkConnectivityConfig \" pulumi-lang-python=\" MwsNetworkConnectivityConfig \" pulumi-lang-yaml=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-java=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-hcl=\" databricks_mws_network_connectivity_config \"\u003e databricks.MwsNetworkConnectivityConfig \u003c/span\u003eto create Network Connectivity Config objects.\n", "properties": { "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account.\n" }, "workspaceId": { "type": "string", "description": "Identifier of the workspace to attach the NCC to. Change forces creation of a new resource.\n" } }, "required": [ "networkConnectivityConfigId", "workspaceId" ], "inputProperties": { "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account.\n" }, "workspaceId": { "type": "string", "description": "Identifier of the workspace to attach the NCC to. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "networkConnectivityConfigId", "workspaceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsNccBinding resources.\n", "properties": { "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account.\n" }, "workspaceId": { "type": "string", "description": "Identifier of the workspace to attach the NCC to. Change forces creation of a new resource.\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsNccPrivateEndpointRule:MwsNccPrivateEndpointRule": { "description": "Allows you to create a private endpoint in a Network Connectivity Config that can be used to [configure private connectivity from serverless compute](https://learn.microsoft.com/en-us/azure/databricks/security/network/serverless-network-security/serverless-private-link).\n\n\u003e This resource can only be used with an account-level provider!\n\n\u003e This feature is available on Azure, and in Public Preview on AWS.\n\n## Example Usage\n\nCreate private endpoints to an Azure storage account and an Azure standard load balancer.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\nconst region = config.requireObject\u003cany\u003e(\"region\");\nconst prefix = config.requireObject\u003cany\u003e(\"prefix\");\nconst ncc = new databricks.MwsNetworkConnectivityConfig(\"ncc\", {\n name: `ncc-for-${prefix}`,\n region: region,\n});\nconst storage = new databricks.MwsNccPrivateEndpointRule(\"storage\", {\n networkConnectivityConfigId: ncc.networkConnectivityConfigId,\n resourceId: \"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\",\n groupId: \"blob\",\n});\nconst slb = new databricks.MwsNccPrivateEndpointRule(\"slb\", {\n networkConnectivityConfigId: ncc.networkConnectivityConfigId,\n resourceId: \"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\",\n domainNames: [\"my-example.exampledomain.com\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\nregion = config.require_object(\"region\")\nprefix = config.require_object(\"prefix\")\nncc = databricks.MwsNetworkConnectivityConfig(\"ncc\",\n name=f\"ncc-for-{prefix}\",\n region=region)\nstorage = databricks.MwsNccPrivateEndpointRule(\"storage\",\n network_connectivity_config_id=ncc.network_connectivity_config_id,\n resource_id=\"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\",\n group_id=\"blob\")\nslb = databricks.MwsNccPrivateEndpointRule(\"slb\",\n network_connectivity_config_id=ncc.network_connectivity_config_id,\n resource_id=\"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\",\n domain_names=[\"my-example.exampledomain.com\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n var region = config.RequireObject\u003cdynamic\u003e(\"region\");\n var prefix = config.RequireObject\u003cdynamic\u003e(\"prefix\");\n var ncc = new Databricks.MwsNetworkConnectivityConfig(\"ncc\", new()\n {\n Name = $\"ncc-for-{prefix}\",\n Region = region,\n });\n\n var storage = new Databricks.MwsNccPrivateEndpointRule(\"storage\", new()\n {\n NetworkConnectivityConfigId = ncc.NetworkConnectivityConfigId,\n ResourceId = \"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\",\n GroupId = \"blob\",\n });\n\n var slb = new Databricks.MwsNccPrivateEndpointRule(\"slb\", new()\n {\n NetworkConnectivityConfigId = ncc.NetworkConnectivityConfigId,\n ResourceId = \"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\",\n DomainNames = new[]\n {\n \"my-example.exampledomain.com\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvar region interface{}\n\t\tcfg.RequireObject(\"region\", \u0026region)\n\t\tvar prefix interface{}\n\t\tcfg.RequireObject(\"prefix\", \u0026prefix)\n\t\tncc, err := databricks.NewMwsNetworkConnectivityConfig(ctx, \"ncc\", \u0026databricks.MwsNetworkConnectivityConfigArgs{\n\t\t\tName: pulumi.Sprintf(\"ncc-for-%v\", prefix),\n\t\t\tRegion: pulumi.Any(region),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNccPrivateEndpointRule(ctx, \"storage\", \u0026databricks.MwsNccPrivateEndpointRuleArgs{\n\t\t\tNetworkConnectivityConfigId: ncc.NetworkConnectivityConfigId,\n\t\t\tResourceId: pulumi.String(\"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\"),\n\t\t\tGroupId: pulumi.String(\"blob\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNccPrivateEndpointRule(ctx, \"slb\", \u0026databricks.MwsNccPrivateEndpointRuleArgs{\n\t\t\tNetworkConnectivityConfigId: ncc.NetworkConnectivityConfigId,\n\t\t\tResourceId: pulumi.String(\"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\"),\n\t\t\tDomainNames: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"my-example.exampledomain.com\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsnetworkconnectivityconfig\" \"ncc\" {\n name =\"ncc-for-${var.prefix}\"\n region = var.region\n}\nresource \"databricks_mwsnccprivateendpointrule\" \"storage\" {\n network_connectivity_config_id = databricks_mwsnetworkconnectivityconfig.ncc.network_connectivity_config_id\n resource_id = \"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\"\n group_id = \"blob\"\n}\nresource \"databricks_mwsnccprivateendpointrule\" \"slb\" {\n network_connectivity_config_id = databricks_mwsnetworkconnectivityconfig.ncc.network_connectivity_config_id\n resource_id = \"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\"\n domain_names = [\"my-example.exampledomain.com\"]\n}\nvariable \"region\" {\n}\nvariable \"prefix\" {\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfig;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfigArgs;\nimport com.pulumi.databricks.MwsNccPrivateEndpointRule;\nimport com.pulumi.databricks.MwsNccPrivateEndpointRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var region = config.require(\"region\");\n final var prefix = config.require(\"prefix\");\n var ncc = new MwsNetworkConnectivityConfig(\"ncc\", MwsNetworkConnectivityConfigArgs.builder()\n .name(String.format(\"ncc-for-%s\", prefix))\n .region(region)\n .build());\n\n var storage = new MwsNccPrivateEndpointRule(\"storage\", MwsNccPrivateEndpointRuleArgs.builder()\n .networkConnectivityConfigId(ncc.networkConnectivityConfigId())\n .resourceId(\"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\")\n .groupId(\"blob\")\n .build());\n\n var slb = new MwsNccPrivateEndpointRule(\"slb\", MwsNccPrivateEndpointRuleArgs.builder()\n .networkConnectivityConfigId(ncc.networkConnectivityConfigId())\n .resourceId(\"/subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\")\n .domainNames(\"my-example.exampledomain.com\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n region:\n type: object\n prefix:\n type: object\nresources:\n ncc:\n type: databricks:MwsNetworkConnectivityConfig\n properties:\n name: ncc-for-${prefix}\n region: ${region}\n storage:\n type: databricks:MwsNccPrivateEndpointRule\n properties:\n networkConnectivityConfigId: ${ncc.networkConnectivityConfigId}\n resourceId: /subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Storage/storageAccounts/examplesa\n groupId: blob\n slb:\n type: databricks:MwsNccPrivateEndpointRule\n properties:\n networkConnectivityConfigId: ${ncc.networkConnectivityConfigId}\n resourceId: /subscriptions/653bb673-1234-abcd-a90b-d064d5d53ca4/resourcegroups/example-resource-group/providers/Microsoft.Network/privatelinkServices/example-private-link-service\n domainNames:\n - my-example.exampledomain.com\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nCreate a private endpoint rule to an AWS VPC endpoint and to an S3 bucket.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\nconst region = config.requireObject\u003cany\u003e(\"region\");\nconst prefix = config.requireObject\u003cany\u003e(\"prefix\");\nconst ncc = new databricks.MwsNetworkConnectivityConfig(\"ncc\", {\n name: `ncc-for-${prefix}`,\n region: region,\n});\nconst storage = new databricks.MwsNccPrivateEndpointRule(\"storage\", {\n networkConnectivityConfigId: ncc.networkConnectivityConfigId,\n endpointService: \"com.amazonaws.us-east-1.s3\",\n resourceNames: [\"bucket\"],\n});\nconst vpce = new databricks.MwsNccPrivateEndpointRule(\"vpce\", {\n networkConnectivityConfigId: ncc.networkConnectivityConfigId,\n endpointService: \"com.amazonaws.vpce.us-west-2.vpce-svc-xyz\",\n domainNames: [\"subdomain.internal.net\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\nregion = config.require_object(\"region\")\nprefix = config.require_object(\"prefix\")\nncc = databricks.MwsNetworkConnectivityConfig(\"ncc\",\n name=f\"ncc-for-{prefix}\",\n region=region)\nstorage = databricks.MwsNccPrivateEndpointRule(\"storage\",\n network_connectivity_config_id=ncc.network_connectivity_config_id,\n endpoint_service=\"com.amazonaws.us-east-1.s3\",\n resource_names=[\"bucket\"])\nvpce = databricks.MwsNccPrivateEndpointRule(\"vpce\",\n network_connectivity_config_id=ncc.network_connectivity_config_id,\n endpoint_service=\"com.amazonaws.vpce.us-west-2.vpce-svc-xyz\",\n domain_names=[\"subdomain.internal.net\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n var region = config.RequireObject\u003cdynamic\u003e(\"region\");\n var prefix = config.RequireObject\u003cdynamic\u003e(\"prefix\");\n var ncc = new Databricks.MwsNetworkConnectivityConfig(\"ncc\", new()\n {\n Name = $\"ncc-for-{prefix}\",\n Region = region,\n });\n\n var storage = new Databricks.MwsNccPrivateEndpointRule(\"storage\", new()\n {\n NetworkConnectivityConfigId = ncc.NetworkConnectivityConfigId,\n EndpointService = \"com.amazonaws.us-east-1.s3\",\n ResourceNames = new[]\n {\n \"bucket\",\n },\n });\n\n var vpce = new Databricks.MwsNccPrivateEndpointRule(\"vpce\", new()\n {\n NetworkConnectivityConfigId = ncc.NetworkConnectivityConfigId,\n EndpointService = \"com.amazonaws.vpce.us-west-2.vpce-svc-xyz\",\n DomainNames = new[]\n {\n \"subdomain.internal.net\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvar region interface{}\n\t\tcfg.RequireObject(\"region\", \u0026region)\n\t\tvar prefix interface{}\n\t\tcfg.RequireObject(\"prefix\", \u0026prefix)\n\t\tncc, err := databricks.NewMwsNetworkConnectivityConfig(ctx, \"ncc\", \u0026databricks.MwsNetworkConnectivityConfigArgs{\n\t\t\tName: pulumi.Sprintf(\"ncc-for-%v\", prefix),\n\t\t\tRegion: pulumi.Any(region),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNccPrivateEndpointRule(ctx, \"storage\", \u0026databricks.MwsNccPrivateEndpointRuleArgs{\n\t\t\tNetworkConnectivityConfigId: ncc.NetworkConnectivityConfigId,\n\t\t\tEndpointService: pulumi.String(\"com.amazonaws.us-east-1.s3\"),\n\t\t\tResourceNames: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"bucket\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNccPrivateEndpointRule(ctx, \"vpce\", \u0026databricks.MwsNccPrivateEndpointRuleArgs{\n\t\t\tNetworkConnectivityConfigId: ncc.NetworkConnectivityConfigId,\n\t\t\tEndpointService: pulumi.String(\"com.amazonaws.vpce.us-west-2.vpce-svc-xyz\"),\n\t\t\tDomainNames: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"subdomain.internal.net\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsnetworkconnectivityconfig\" \"ncc\" {\n name =\"ncc-for-${var.prefix}\"\n region = var.region\n}\nresource \"databricks_mwsnccprivateendpointrule\" \"storage\" {\n network_connectivity_config_id = databricks_mwsnetworkconnectivityconfig.ncc.network_connectivity_config_id\n endpoint_service = \"com.amazonaws.us-east-1.s3\"\n resource_names = [\"bucket\"]\n}\nresource \"databricks_mwsnccprivateendpointrule\" \"vpce\" {\n network_connectivity_config_id = databricks_mwsnetworkconnectivityconfig.ncc.network_connectivity_config_id\n endpoint_service = \"com.amazonaws.vpce.us-west-2.vpce-svc-xyz\"\n domain_names = [\"subdomain.internal.net\"]\n}\nvariable \"region\" {\n}\nvariable \"prefix\" {\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfig;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfigArgs;\nimport com.pulumi.databricks.MwsNccPrivateEndpointRule;\nimport com.pulumi.databricks.MwsNccPrivateEndpointRuleArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var region = config.require(\"region\");\n final var prefix = config.require(\"prefix\");\n var ncc = new MwsNetworkConnectivityConfig(\"ncc\", MwsNetworkConnectivityConfigArgs.builder()\n .name(String.format(\"ncc-for-%s\", prefix))\n .region(region)\n .build());\n\n var storage = new MwsNccPrivateEndpointRule(\"storage\", MwsNccPrivateEndpointRuleArgs.builder()\n .networkConnectivityConfigId(ncc.networkConnectivityConfigId())\n .endpointService(\"com.amazonaws.us-east-1.s3\")\n .resourceNames(\"bucket\")\n .build());\n\n var vpce = new MwsNccPrivateEndpointRule(\"vpce\", MwsNccPrivateEndpointRuleArgs.builder()\n .networkConnectivityConfigId(ncc.networkConnectivityConfigId())\n .endpointService(\"com.amazonaws.vpce.us-west-2.vpce-svc-xyz\")\n .domainNames(\"subdomain.internal.net\")\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n region:\n type: object\n prefix:\n type: object\nresources:\n ncc:\n type: databricks:MwsNetworkConnectivityConfig\n properties:\n name: ncc-for-${prefix}\n region: ${region}\n storage:\n type: databricks:MwsNccPrivateEndpointRule\n properties:\n networkConnectivityConfigId: ${ncc.networkConnectivityConfigId}\n endpointService: com.amazonaws.us-east-1.s3\n resourceNames:\n - bucket\n vpce:\n type: databricks:MwsNccPrivateEndpointRule\n properties:\n networkConnectivityConfigId: ${ncc.networkConnectivityConfigId}\n endpointService: com.amazonaws.vpce.us-west-2.vpce-svc-xyz\n domainNames:\n - subdomain.internal.net\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-dotnet=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-go=\" MwsNetworkConnectivityConfig \" pulumi-lang-python=\" MwsNetworkConnectivityConfig \" pulumi-lang-yaml=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-java=\" databricks.MwsNetworkConnectivityConfig \" pulumi-lang-hcl=\" databricks_mws_network_connectivity_config \"\u003e databricks.MwsNetworkConnectivityConfig \u003c/span\u003eto create Network Connectivity Config objects.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNccBinding \" pulumi-lang-dotnet=\" databricks.MwsNccBinding \" pulumi-lang-go=\" MwsNccBinding \" pulumi-lang-python=\" MwsNccBinding \" pulumi-lang-yaml=\" databricks.MwsNccBinding \" pulumi-lang-java=\" databricks.MwsNccBinding \" pulumi-lang-hcl=\" databricks_mws_ncc_binding \"\u003e databricks.MwsNccBinding \u003c/span\u003eto attach an NCC to a workspace.\n\n", "properties": { "accountId": { "type": "string" }, "connectionState": { "type": "string", "description": "The current status of this private endpoint. The private endpoint rules are effective only if the connection state is `ESTABLISHED`. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect.\nThe possible values are:\n* `PENDING`: The endpoint has been created and pending approval.\n* `ESTABLISHED`: The endpoint has been approved and is ready to be used in your serverless compute resources.\n* `REJECTED`: Connection was rejected by the private link resource owner.\n* `DISCONNECTED`: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.\n* `EXPIRED`: If the endpoint was created but not approved in 14 days, it will be EXPIRED.\n" }, "creationTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean", "description": "Whether this private endpoint is deactivated.\n" }, "deactivatedAt": { "type": "integer", "description": "Time in epoch milliseconds when this object was deactivated.\n" }, "domainNames": { "type": "array", "items": { "type": "string" }, "description": "* On Azure: List of domain names of target private link service. Only used by private endpoints to customer-managed private endpoint services. Conflicts with \u003cspan pulumi-lang-nodejs=\"`groupId`\" pulumi-lang-dotnet=\"`GroupId`\" pulumi-lang-go=\"`groupId`\" pulumi-lang-python=\"`group_id`\" pulumi-lang-yaml=\"`groupId`\" pulumi-lang-java=\"`groupId`\" pulumi-lang-hcl=\"`group_id`\"\u003e`groupId`\u003c/span\u003e.\n* On AWS: List of target resource FQDNs accessible via the VPC endpoint service. Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service. Conflicts with \u003cspan pulumi-lang-nodejs=\"`resourceNames`\" pulumi-lang-dotnet=\"`ResourceNames`\" pulumi-lang-go=\"`resourceNames`\" pulumi-lang-python=\"`resource_names`\" pulumi-lang-yaml=\"`resourceNames`\" pulumi-lang-java=\"`resourceNames`\" pulumi-lang-hcl=\"`resource_names`\"\u003e`resourceNames`\u003c/span\u003e.\n" }, "enabled": { "type": "boolean", "description": "Activation status. Only used by private endpoints towards an AWS S3 service. Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Can only be updated after a private endpoint rule towards an AWS S3 service is successfully created.\n" }, "endpointName": { "type": "string", "description": "The name of the Azure private endpoint resource, e.g. \"databricks-088781b3-77fa-4132-b429-1af0d91bc593-pe-3cb31234\"\n" }, "endpointService": { "type": "string", "description": "Example `com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123`. The full target AWS endpoint service name that connects to the destination resources of the private endpoint. Change forces creation of a new resource.\n" }, "errorMessage": { "type": "string" }, "gcpEndpoint": { "$ref": "#/types/databricks:index/MwsNccPrivateEndpointRuleGcpEndpoint:MwsNccPrivateEndpointRuleGcpEndpoint" }, "groupId": { "type": "string", "description": "Not used by customer-managed private endpoint services. The sub-resource type (group ID) of the target resource. Must be one of supported resource types (i.e., \u003cspan pulumi-lang-nodejs=\"`blob`\" pulumi-lang-dotnet=\"`Blob`\" pulumi-lang-go=\"`blob`\" pulumi-lang-python=\"`blob`\" pulumi-lang-yaml=\"`blob`\" pulumi-lang-java=\"`blob`\" pulumi-lang-hcl=\"`blob`\"\u003e`blob`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`dfs`\" pulumi-lang-dotnet=\"`Dfs`\" pulumi-lang-go=\"`dfs`\" pulumi-lang-python=\"`dfs`\" pulumi-lang-yaml=\"`dfs`\" pulumi-lang-java=\"`dfs`\" pulumi-lang-hcl=\"`dfs`\"\u003e`dfs`\u003c/span\u003e, `sqlServer` , etc. Consult the [Azure documentation](https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource) for full list of supported resources). Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for \u003cspan pulumi-lang-nodejs=\"`blob`\" pulumi-lang-dotnet=\"`Blob`\" pulumi-lang-go=\"`blob`\" pulumi-lang-python=\"`blob`\" pulumi-lang-yaml=\"`blob`\" pulumi-lang-java=\"`blob`\" pulumi-lang-hcl=\"`blob`\"\u003e`blob`\u003c/span\u003e and one for \u003cspan pulumi-lang-nodejs=\"`dfs`\" pulumi-lang-dotnet=\"`Dfs`\" pulumi-lang-go=\"`dfs`\" pulumi-lang-python=\"`dfs`\" pulumi-lang-yaml=\"`dfs`\" pulumi-lang-java=\"`dfs`\" pulumi-lang-hcl=\"`dfs`\"\u003e`dfs`\u003c/span\u003e. Change forces creation of a new resource. Conflicts with \u003cspan pulumi-lang-nodejs=\"`domainNames`\" pulumi-lang-dotnet=\"`DomainNames`\" pulumi-lang-go=\"`domainNames`\" pulumi-lang-python=\"`domain_names`\" pulumi-lang-yaml=\"`domainNames`\" pulumi-lang-java=\"`domainNames`\" pulumi-lang-hcl=\"`domain_names`\"\u003e`domainNames`\u003c/span\u003e.\n" }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.\n" }, "resourceId": { "type": "string", "description": "The Azure resource ID of the target resource. Change forces creation of a new resource.\n" }, "resourceNames": { "type": "array", "items": { "type": "string" }, "description": "Only used by private endpoints towards AWS S3 service. List of globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. Conflict with \u003cspan pulumi-lang-nodejs=\"`domainNames`\" pulumi-lang-dotnet=\"`DomainNames`\" pulumi-lang-go=\"`domainNames`\" pulumi-lang-python=\"`domain_names`\" pulumi-lang-yaml=\"`domainNames`\" pulumi-lang-java=\"`domainNames`\" pulumi-lang-hcl=\"`domain_names`\"\u003e`domainNames`\u003c/span\u003e.\n" }, "ruleId": { "type": "string", "description": "the ID of a private endpoint rule.\n" }, "updatedTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was updated.\n" }, "vpcEndpointId": { "type": "string", "description": "The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint created by Databricks.\n" } }, "required": [ "connectionState", "creationTime", "enabled", "endpointName", "networkConnectivityConfigId", "ruleId", "updatedTime", "vpcEndpointId" ], "inputProperties": { "accountId": { "type": "string" }, "connectionState": { "type": "string", "description": "The current status of this private endpoint. The private endpoint rules are effective only if the connection state is `ESTABLISHED`. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect.\nThe possible values are:\n* `PENDING`: The endpoint has been created and pending approval.\n* `ESTABLISHED`: The endpoint has been approved and is ready to be used in your serverless compute resources.\n* `REJECTED`: Connection was rejected by the private link resource owner.\n* `DISCONNECTED`: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.\n* `EXPIRED`: If the endpoint was created but not approved in 14 days, it will be EXPIRED.\n" }, "creationTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean", "description": "Whether this private endpoint is deactivated.\n" }, "deactivatedAt": { "type": "integer", "description": "Time in epoch milliseconds when this object was deactivated.\n" }, "domainNames": { "type": "array", "items": { "type": "string" }, "description": "* On Azure: List of domain names of target private link service. Only used by private endpoints to customer-managed private endpoint services. Conflicts with \u003cspan pulumi-lang-nodejs=\"`groupId`\" pulumi-lang-dotnet=\"`GroupId`\" pulumi-lang-go=\"`groupId`\" pulumi-lang-python=\"`group_id`\" pulumi-lang-yaml=\"`groupId`\" pulumi-lang-java=\"`groupId`\" pulumi-lang-hcl=\"`group_id`\"\u003e`groupId`\u003c/span\u003e.\n* On AWS: List of target resource FQDNs accessible via the VPC endpoint service. Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service. Conflicts with \u003cspan pulumi-lang-nodejs=\"`resourceNames`\" pulumi-lang-dotnet=\"`ResourceNames`\" pulumi-lang-go=\"`resourceNames`\" pulumi-lang-python=\"`resource_names`\" pulumi-lang-yaml=\"`resourceNames`\" pulumi-lang-java=\"`resourceNames`\" pulumi-lang-hcl=\"`resource_names`\"\u003e`resourceNames`\u003c/span\u003e.\n" }, "enabled": { "type": "boolean", "description": "Activation status. Only used by private endpoints towards an AWS S3 service. Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Can only be updated after a private endpoint rule towards an AWS S3 service is successfully created.\n" }, "endpointName": { "type": "string", "description": "The name of the Azure private endpoint resource, e.g. \"databricks-088781b3-77fa-4132-b429-1af0d91bc593-pe-3cb31234\"\n" }, "endpointService": { "type": "string", "description": "Example `com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123`. The full target AWS endpoint service name that connects to the destination resources of the private endpoint. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "errorMessage": { "type": "string" }, "gcpEndpoint": { "$ref": "#/types/databricks:index/MwsNccPrivateEndpointRuleGcpEndpoint:MwsNccPrivateEndpointRuleGcpEndpoint" }, "groupId": { "type": "string", "description": "Not used by customer-managed private endpoint services. The sub-resource type (group ID) of the target resource. Must be one of supported resource types (i.e., \u003cspan pulumi-lang-nodejs=\"`blob`\" pulumi-lang-dotnet=\"`Blob`\" pulumi-lang-go=\"`blob`\" pulumi-lang-python=\"`blob`\" pulumi-lang-yaml=\"`blob`\" pulumi-lang-java=\"`blob`\" pulumi-lang-hcl=\"`blob`\"\u003e`blob`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`dfs`\" pulumi-lang-dotnet=\"`Dfs`\" pulumi-lang-go=\"`dfs`\" pulumi-lang-python=\"`dfs`\" pulumi-lang-yaml=\"`dfs`\" pulumi-lang-java=\"`dfs`\" pulumi-lang-hcl=\"`dfs`\"\u003e`dfs`\u003c/span\u003e, `sqlServer` , etc. Consult the [Azure documentation](https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource) for full list of supported resources). Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for \u003cspan pulumi-lang-nodejs=\"`blob`\" pulumi-lang-dotnet=\"`Blob`\" pulumi-lang-go=\"`blob`\" pulumi-lang-python=\"`blob`\" pulumi-lang-yaml=\"`blob`\" pulumi-lang-java=\"`blob`\" pulumi-lang-hcl=\"`blob`\"\u003e`blob`\u003c/span\u003e and one for \u003cspan pulumi-lang-nodejs=\"`dfs`\" pulumi-lang-dotnet=\"`Dfs`\" pulumi-lang-go=\"`dfs`\" pulumi-lang-python=\"`dfs`\" pulumi-lang-yaml=\"`dfs`\" pulumi-lang-java=\"`dfs`\" pulumi-lang-hcl=\"`dfs`\"\u003e`dfs`\u003c/span\u003e. Change forces creation of a new resource. Conflicts with \u003cspan pulumi-lang-nodejs=\"`domainNames`\" pulumi-lang-dotnet=\"`DomainNames`\" pulumi-lang-go=\"`domainNames`\" pulumi-lang-python=\"`domain_names`\" pulumi-lang-yaml=\"`domainNames`\" pulumi-lang-java=\"`domainNames`\" pulumi-lang-hcl=\"`domain_names`\"\u003e`domainNames`\u003c/span\u003e.\n", "willReplaceOnChanges": true }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "resourceId": { "type": "string", "description": "The Azure resource ID of the target resource. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "resourceNames": { "type": "array", "items": { "type": "string" }, "description": "Only used by private endpoints towards AWS S3 service. List of globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. Conflict with \u003cspan pulumi-lang-nodejs=\"`domainNames`\" pulumi-lang-dotnet=\"`DomainNames`\" pulumi-lang-go=\"`domainNames`\" pulumi-lang-python=\"`domain_names`\" pulumi-lang-yaml=\"`domainNames`\" pulumi-lang-java=\"`domainNames`\" pulumi-lang-hcl=\"`domain_names`\"\u003e`domainNames`\u003c/span\u003e.\n" }, "ruleId": { "type": "string", "description": "the ID of a private endpoint rule.\n" }, "updatedTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was updated.\n" }, "vpcEndpointId": { "type": "string", "description": "The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint created by Databricks.\n" } }, "requiredInputs": [ "networkConnectivityConfigId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsNccPrivateEndpointRule resources.\n", "properties": { "accountId": { "type": "string" }, "connectionState": { "type": "string", "description": "The current status of this private endpoint. The private endpoint rules are effective only if the connection state is `ESTABLISHED`. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect.\nThe possible values are:\n* `PENDING`: The endpoint has been created and pending approval.\n* `ESTABLISHED`: The endpoint has been approved and is ready to be used in your serverless compute resources.\n* `REJECTED`: Connection was rejected by the private link resource owner.\n* `DISCONNECTED`: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.\n* `EXPIRED`: If the endpoint was created but not approved in 14 days, it will be EXPIRED.\n" }, "creationTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was created.\n" }, "deactivated": { "type": "boolean", "description": "Whether this private endpoint is deactivated.\n" }, "deactivatedAt": { "type": "integer", "description": "Time in epoch milliseconds when this object was deactivated.\n" }, "domainNames": { "type": "array", "items": { "type": "string" }, "description": "* On Azure: List of domain names of target private link service. Only used by private endpoints to customer-managed private endpoint services. Conflicts with \u003cspan pulumi-lang-nodejs=\"`groupId`\" pulumi-lang-dotnet=\"`GroupId`\" pulumi-lang-go=\"`groupId`\" pulumi-lang-python=\"`group_id`\" pulumi-lang-yaml=\"`groupId`\" pulumi-lang-java=\"`groupId`\" pulumi-lang-hcl=\"`group_id`\"\u003e`groupId`\u003c/span\u003e.\n* On AWS: List of target resource FQDNs accessible via the VPC endpoint service. Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service. Conflicts with \u003cspan pulumi-lang-nodejs=\"`resourceNames`\" pulumi-lang-dotnet=\"`ResourceNames`\" pulumi-lang-go=\"`resourceNames`\" pulumi-lang-python=\"`resource_names`\" pulumi-lang-yaml=\"`resourceNames`\" pulumi-lang-java=\"`resourceNames`\" pulumi-lang-hcl=\"`resource_names`\"\u003e`resourceNames`\u003c/span\u003e.\n" }, "enabled": { "type": "boolean", "description": "Activation status. Only used by private endpoints towards an AWS S3 service. Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Can only be updated after a private endpoint rule towards an AWS S3 service is successfully created.\n" }, "endpointName": { "type": "string", "description": "The name of the Azure private endpoint resource, e.g. \"databricks-088781b3-77fa-4132-b429-1af0d91bc593-pe-3cb31234\"\n" }, "endpointService": { "type": "string", "description": "Example `com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123`. The full target AWS endpoint service name that connects to the destination resources of the private endpoint. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "errorMessage": { "type": "string" }, "gcpEndpoint": { "$ref": "#/types/databricks:index/MwsNccPrivateEndpointRuleGcpEndpoint:MwsNccPrivateEndpointRuleGcpEndpoint" }, "groupId": { "type": "string", "description": "Not used by customer-managed private endpoint services. The sub-resource type (group ID) of the target resource. Must be one of supported resource types (i.e., \u003cspan pulumi-lang-nodejs=\"`blob`\" pulumi-lang-dotnet=\"`Blob`\" pulumi-lang-go=\"`blob`\" pulumi-lang-python=\"`blob`\" pulumi-lang-yaml=\"`blob`\" pulumi-lang-java=\"`blob`\" pulumi-lang-hcl=\"`blob`\"\u003e`blob`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`dfs`\" pulumi-lang-dotnet=\"`Dfs`\" pulumi-lang-go=\"`dfs`\" pulumi-lang-python=\"`dfs`\" pulumi-lang-yaml=\"`dfs`\" pulumi-lang-java=\"`dfs`\" pulumi-lang-hcl=\"`dfs`\"\u003e`dfs`\u003c/span\u003e, `sqlServer` , etc. Consult the [Azure documentation](https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource) for full list of supported resources). Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for \u003cspan pulumi-lang-nodejs=\"`blob`\" pulumi-lang-dotnet=\"`Blob`\" pulumi-lang-go=\"`blob`\" pulumi-lang-python=\"`blob`\" pulumi-lang-yaml=\"`blob`\" pulumi-lang-java=\"`blob`\" pulumi-lang-hcl=\"`blob`\"\u003e`blob`\u003c/span\u003e and one for \u003cspan pulumi-lang-nodejs=\"`dfs`\" pulumi-lang-dotnet=\"`Dfs`\" pulumi-lang-go=\"`dfs`\" pulumi-lang-python=\"`dfs`\" pulumi-lang-yaml=\"`dfs`\" pulumi-lang-java=\"`dfs`\" pulumi-lang-hcl=\"`dfs`\"\u003e`dfs`\u003c/span\u003e. Change forces creation of a new resource. Conflicts with \u003cspan pulumi-lang-nodejs=\"`domainNames`\" pulumi-lang-dotnet=\"`DomainNames`\" pulumi-lang-go=\"`domainNames`\" pulumi-lang-python=\"`domain_names`\" pulumi-lang-yaml=\"`domainNames`\" pulumi-lang-java=\"`domainNames`\" pulumi-lang-hcl=\"`domain_names`\"\u003e`domainNames`\u003c/span\u003e.\n", "willReplaceOnChanges": true }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "resourceId": { "type": "string", "description": "The Azure resource ID of the target resource. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "resourceNames": { "type": "array", "items": { "type": "string" }, "description": "Only used by private endpoints towards AWS S3 service. List of globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. Conflict with \u003cspan pulumi-lang-nodejs=\"`domainNames`\" pulumi-lang-dotnet=\"`DomainNames`\" pulumi-lang-go=\"`domainNames`\" pulumi-lang-python=\"`domain_names`\" pulumi-lang-yaml=\"`domainNames`\" pulumi-lang-java=\"`domainNames`\" pulumi-lang-hcl=\"`domain_names`\"\u003e`domainNames`\u003c/span\u003e.\n" }, "ruleId": { "type": "string", "description": "the ID of a private endpoint rule.\n" }, "updatedTime": { "type": "integer", "description": "Time in epoch milliseconds when this object was updated.\n" }, "vpcEndpointId": { "type": "string", "description": "The AWS VPC endpoint ID. You can use this ID to identify the VPC endpoint created by Databricks.\n" } }, "type": "object" } }, "databricks:index/mwsNetworkConnectivityConfig:MwsNetworkConnectivityConfig": { "description": "Allows you to create a Network Connectivity Config that can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource to create a [Databricks Workspace that leverages serverless network connectivity configs](https://learn.microsoft.com/en-us/azure/databricks/security/network/serverless-network-security/serverless-firewall).\n\n\u003e This resource can only be used with an account-level provider!\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\nconst region = config.requireObject\u003cany\u003e(\"region\");\nconst prefix = config.requireObject\u003cany\u003e(\"prefix\");\nconst ncc = new databricks.MwsNetworkConnectivityConfig(\"ncc\", {\n name: `ncc-for-${prefix}`,\n region: region,\n});\nconst nccBinding = new databricks.MwsNccBinding(\"ncc_binding\", {\n networkConnectivityConfigId: ncc.networkConnectivityConfigId,\n workspaceId: databricksWorkspaceId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\nregion = config.require_object(\"region\")\nprefix = config.require_object(\"prefix\")\nncc = databricks.MwsNetworkConnectivityConfig(\"ncc\",\n name=f\"ncc-for-{prefix}\",\n region=region)\nncc_binding = databricks.MwsNccBinding(\"ncc_binding\",\n network_connectivity_config_id=ncc.network_connectivity_config_id,\n workspace_id=databricks_workspace_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n var region = config.RequireObject\u003cdynamic\u003e(\"region\");\n var prefix = config.RequireObject\u003cdynamic\u003e(\"prefix\");\n var ncc = new Databricks.MwsNetworkConnectivityConfig(\"ncc\", new()\n {\n Name = $\"ncc-for-{prefix}\",\n Region = region,\n });\n\n var nccBinding = new Databricks.MwsNccBinding(\"ncc_binding\", new()\n {\n NetworkConnectivityConfigId = ncc.NetworkConnectivityConfigId,\n WorkspaceId = databricksWorkspaceId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\tvar region interface{}\n\t\tcfg.RequireObject(\"region\", \u0026region)\n\t\tvar prefix interface{}\n\t\tcfg.RequireObject(\"prefix\", \u0026prefix)\n\t\tncc, err := databricks.NewMwsNetworkConnectivityConfig(ctx, \"ncc\", \u0026databricks.MwsNetworkConnectivityConfigArgs{\n\t\t\tName: pulumi.Sprintf(\"ncc-for-%v\", prefix),\n\t\t\tRegion: pulumi.Any(region),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNccBinding(ctx, \"ncc_binding\", \u0026databricks.MwsNccBindingArgs{\n\t\t\tNetworkConnectivityConfigId: ncc.NetworkConnectivityConfigId,\n\t\t\tWorkspaceId: pulumi.Any(databricksWorkspaceId),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsnetworkconnectivityconfig\" \"ncc\" {\n name =\"ncc-for-${var.prefix}\"\n region = var.region\n}\nresource \"databricks_mwsnccbinding\" \"ncc_binding\" {\n network_connectivity_config_id = databricks_mwsnetworkconnectivityconfig.ncc.network_connectivity_config_id\n workspace_id = databricksWorkspaceId\n}\nvariable \"region\" {\n}\nvariable \"prefix\" {\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfig;\nimport com.pulumi.databricks.MwsNetworkConnectivityConfigArgs;\nimport com.pulumi.databricks.MwsNccBinding;\nimport com.pulumi.databricks.MwsNccBindingArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var region = config.require(\"region\");\n final var prefix = config.require(\"prefix\");\n var ncc = new MwsNetworkConnectivityConfig(\"ncc\", MwsNetworkConnectivityConfigArgs.builder()\n .name(String.format(\"ncc-for-%s\", prefix))\n .region(region)\n .build());\n\n var nccBinding = new MwsNccBinding(\"nccBinding\", MwsNccBindingArgs.builder()\n .networkConnectivityConfigId(ncc.networkConnectivityConfigId())\n .workspaceId(databricksWorkspaceId)\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n region:\n type: object\n prefix:\n type: object\nresources:\n ncc:\n type: databricks:MwsNetworkConnectivityConfig\n properties:\n name: ncc-for-${prefix}\n region: ${region}\n nccBinding:\n type: databricks:MwsNccBinding\n name: ncc_binding\n properties:\n networkConnectivityConfigId: ${ncc.networkConnectivityConfigId}\n workspaceId: ${databricksWorkspaceId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up Databricks workspaces.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNccBinding \" pulumi-lang-dotnet=\" databricks.MwsNccBinding \" pulumi-lang-go=\" MwsNccBinding \" pulumi-lang-python=\" MwsNccBinding \" pulumi-lang-yaml=\" databricks.MwsNccBinding \" pulumi-lang-java=\" databricks.MwsNccBinding \" pulumi-lang-hcl=\" databricks_mws_ncc_binding \"\u003e databricks.MwsNccBinding \u003c/span\u003eto attach an NCC to a workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNccPrivateEndpointRule \" pulumi-lang-dotnet=\" databricks.MwsNccPrivateEndpointRule \" pulumi-lang-go=\" MwsNccPrivateEndpointRule \" pulumi-lang-python=\" MwsNccPrivateEndpointRule \" pulumi-lang-yaml=\" databricks.MwsNccPrivateEndpointRule \" pulumi-lang-java=\" databricks.MwsNccPrivateEndpointRule \" pulumi-lang-hcl=\" databricks_mws_ncc_private_endpoint_rule \"\u003e databricks.MwsNccPrivateEndpointRule \u003c/span\u003eto create a private endpoint rule.\n\n", "properties": { "accountId": { "type": "string" }, "creationTime": { "type": "integer", "description": "time in epoch milliseconds when this object was created.\n" }, "egressConfig": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfig:MwsNetworkConnectivityConfigEgressConfig", "description": "block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:\n" }, "name": { "type": "string", "description": "Name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression `^[0-9a-zA-Z-_]{3,30}$`. Change forces creation of a new resource.\n" }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account\n" }, "region": { "type": "string", "description": "Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.\n" }, "updatedTime": { "type": "integer", "description": "time in epoch milliseconds when this object was updated.\n" } }, "required": [ "accountId", "creationTime", "egressConfig", "name", "networkConnectivityConfigId", "region", "updatedTime" ], "inputProperties": { "accountId": { "type": "string" }, "creationTime": { "type": "integer", "description": "time in epoch milliseconds when this object was created.\n" }, "egressConfig": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfig:MwsNetworkConnectivityConfigEgressConfig", "description": "block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:\n" }, "name": { "type": "string", "description": "Name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression `^[0-9a-zA-Z-_]{3,30}$`. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account\n" }, "region": { "type": "string", "description": "Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "updatedTime": { "type": "integer", "description": "time in epoch milliseconds when this object was updated.\n" } }, "requiredInputs": [ "region" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsNetworkConnectivityConfig resources.\n", "properties": { "accountId": { "type": "string" }, "creationTime": { "type": "integer", "description": "time in epoch milliseconds when this object was created.\n" }, "egressConfig": { "$ref": "#/types/databricks:index/MwsNetworkConnectivityConfigEgressConfig:MwsNetworkConnectivityConfigEgressConfig", "description": "block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:\n" }, "name": { "type": "string", "description": "Name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression `^[0-9a-zA-Z-_]{3,30}$`. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "networkConnectivityConfigId": { "type": "string", "description": "Canonical unique identifier of Network Connectivity Config in Databricks Account\n" }, "region": { "type": "string", "description": "Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.\n", "willReplaceOnChanges": true }, "updatedTime": { "type": "integer", "description": "time in epoch milliseconds when this object was updated.\n" } }, "type": "object" } }, "databricks:index/mwsNetworks:MwsNetworks": { "description": "## Databricks on AWS usage\n\nUse this resource to configure VPC \u0026 subnets for new workspaces within AWS and GCP.\n\n\u003e This resource can only be used with an account-level provider!\n\n\u003e The \u003cspan pulumi-lang-nodejs=\"`gkeClusterServiceIpRange`\" pulumi-lang-dotnet=\"`GkeClusterServiceIpRange`\" pulumi-lang-go=\"`gkeClusterServiceIpRange`\" pulumi-lang-python=\"`gke_cluster_service_ip_range`\" pulumi-lang-yaml=\"`gkeClusterServiceIpRange`\" pulumi-lang-java=\"`gkeClusterServiceIpRange`\" pulumi-lang-hcl=\"`gke_cluster_service_ip_range`\"\u003e`gkeClusterServiceIpRange`\u003c/span\u003e and \u003cspan pulumi-lang-nodejs=\"`gkePodServiceIpRange`\" pulumi-lang-dotnet=\"`GkePodServiceIpRange`\" pulumi-lang-go=\"`gkePodServiceIpRange`\" pulumi-lang-python=\"`gke_pod_service_ip_range`\" pulumi-lang-yaml=\"`gkePodServiceIpRange`\" pulumi-lang-java=\"`gkePodServiceIpRange`\" pulumi-lang-hcl=\"`gke_pod_service_ip_range`\"\u003e`gkePodServiceIpRange`\u003c/span\u003e arguments in \u003cspan pulumi-lang-nodejs=\"`gcpManagedNetworkConfig`\" pulumi-lang-dotnet=\"`GcpManagedNetworkConfig`\" pulumi-lang-go=\"`gcpManagedNetworkConfig`\" pulumi-lang-python=\"`gcp_managed_network_config`\" pulumi-lang-yaml=\"`gcpManagedNetworkConfig`\" pulumi-lang-java=\"`gcpManagedNetworkConfig`\" pulumi-lang-hcl=\"`gcp_managed_network_config`\"\u003e`gcpManagedNetworkConfig`\u003c/span\u003e are now deprecated and no longer supported. If you have already created a workspace using these fields, it is safe to remove them from your Pulumi template.\n\n* Databricks must have access to at least two subnets for each workspace, with each subnet in a different Availability Zone. You cannot specify more than one Databricks workspace subnet per Availability Zone in the Create network configuration API call. You can have more than one subnet per Availability Zone as part of your network setup, but you can choose only one subnet per Availability Zone for the Databricks workspace.\n* Databricks assigns two IP addresses per node, one for management traffic and one for Spark applications. The total number of instances for each subnet is equal to half of the available IP addresses.\n* Each subnet must have a netmask between /17 and /25.\n* Subnets must be private.\n* Subnets must have outbound access to the public network using a\u003cspan pulumi-lang-nodejs=\" awsNatGateway \" pulumi-lang-dotnet=\" AwsNatGateway \" pulumi-lang-go=\" awsNatGateway \" pulumi-lang-python=\" aws_nat_gateway \" pulumi-lang-yaml=\" awsNatGateway \" pulumi-lang-java=\" awsNatGateway \" pulumi-lang-hcl=\" aws_nat_gateway \"\u003e awsNatGateway \u003c/span\u003eand aws_internet_gateway, or other similar customer-managed appliance infrastructure.\n* The NAT gateway must be set up in its subnet (public_subnets in the example below) that routes quad-zero (0.0.0.0/0) traffic to an internet gateway or other customer-managed appliance infrastructure.\n\n\u003e The NAT gateway needs only one IP address per AZ. Hence, the public subnet only needs two IP addresses. In order to limit the number of IP addresses in the public subnet, you can specify a secondary CIDR block (cidr_block_public) using the argument\u003cspan pulumi-lang-nodejs=\" secondaryCidrBlocks \" pulumi-lang-dotnet=\" SecondaryCidrBlocks \" pulumi-lang-go=\" secondaryCidrBlocks \" pulumi-lang-python=\" secondary_cidr_blocks \" pulumi-lang-yaml=\" secondaryCidrBlocks \" pulumi-lang-java=\" secondaryCidrBlocks \" pulumi-lang-hcl=\" secondary_cidr_blocks \"\u003e secondaryCidrBlocks \u003c/span\u003ethen pass it to the\u003cspan pulumi-lang-nodejs=\" publicSubnets \" pulumi-lang-dotnet=\" PublicSubnets \" pulumi-lang-go=\" publicSubnets \" pulumi-lang-python=\" public_subnets \" pulumi-lang-yaml=\" publicSubnets \" pulumi-lang-java=\" publicSubnets \" pulumi-lang-hcl=\" public_subnets \"\u003e publicSubnets \u003c/span\u003eargument. Please review the [IPv4 CIDR block association restrictions](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) when choosing the secondary cidr block.\n\nPlease follow this complete runnable example with new VPC and new workspace setup. Please pay special attention to the fact that there you have two different instances of a databricks provider - one for deploying workspaces (with `host=\"https://accounts.cloud.databricks.com/\"`) and another for the workspace you've created with \u003cspan pulumi-lang-nodejs=\"`databricks.MwsWorkspaces`\" pulumi-lang-dotnet=\"`databricks.MwsWorkspaces`\" pulumi-lang-go=\"`MwsWorkspaces`\" pulumi-lang-python=\"`MwsWorkspaces`\" pulumi-lang-yaml=\"`databricks.MwsWorkspaces`\" pulumi-lang-java=\"`databricks.MwsWorkspaces`\" pulumi-lang-hcl=\"`databricks_mws_workspaces`\"\u003e`databricks.MwsWorkspaces`\u003c/span\u003e resource. If you want both creations of workspaces \u0026 clusters within the same Pulumi module (essentially the same directory), you should use the provider aliasing feature of Pulumi. We strongly recommend having one terraform module to create workspace + PAT token and the rest in different modules.\n\n## Databricks on GCP usage\n\n\u003e Initialize provider with `alias = \"mws\"`, `host = \"https://accounts.gcp.databricks.com\"` and use `provider = databricks.mws`\n\n\u003e On GCP, the provider must be authenticated with a Google-issued OIDC token (not a Databricks OAuth token), because creating or updating this resource triggers operations against your GCP project. See Authenticate with Databricks account API for setup instructions.\n\nUse this resource to [configure VPC](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/customer-managed-vpc.html) \u0026 subnet for new workspaces within GCP. It is essential to understand that this will require you to configure your provider separately for the multiple workspaces resources.\n\n* Databricks must have access to a subnet in the same region as the workspace, of which IP range will be used to allocate your workspace's GCE cluster nodes.\n* The subnet must have a netmask between /29 and /9.\n* Subnet must have outbound access to the public network using a\u003cspan pulumi-lang-nodejs=\" gcpComputeRouterNat \" pulumi-lang-dotnet=\" GcpComputeRouterNat \" pulumi-lang-go=\" gcpComputeRouterNat \" pulumi-lang-python=\" gcp_compute_router_nat \" pulumi-lang-yaml=\" gcpComputeRouterNat \" pulumi-lang-java=\" gcpComputeRouterNat \" pulumi-lang-hcl=\" gcp_compute_router_nat \"\u003e gcpComputeRouterNat \u003c/span\u003eor other similar customer-managed appliance infrastructure.\n\nPlease follow this complete runnable example with new VPC and new workspace setup. Please pay special attention to the fact that there you have two different instances of a databricks provider - one for deploying workspaces (with `host=\"https://accounts.gcp.databricks.com/\"`) and another for the workspace you've created with \u003cspan pulumi-lang-nodejs=\"`databricks.MwsWorkspaces`\" pulumi-lang-dotnet=\"`databricks.MwsWorkspaces`\" pulumi-lang-go=\"`MwsWorkspaces`\" pulumi-lang-python=\"`MwsWorkspaces`\" pulumi-lang-yaml=\"`databricks.MwsWorkspaces`\" pulumi-lang-java=\"`databricks.MwsWorkspaces`\" pulumi-lang-hcl=\"`databricks_mws_workspaces`\"\u003e`databricks.MwsWorkspaces`\u003c/span\u003e resource. If you want both creations of workspaces \u0026 clusters within the same Pulumi module (essentially the same directory), you should use the provider aliasing feature of Pulumi. We strongly recommend having one terraform module to create workspace + PAT token and the rest in different modules.\n\n## Example Usage\n\n### Creating a Databricks on GCP workspace\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as google from \"@pulumi/google\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\nconst dbxPrivateVpc = new google.index.ComputeNetwork(\"dbx_private_vpc\", {\n project: googleProject,\n name: `tf-network-${suffix.result}`,\n autoCreateSubnetworks: false,\n});\nconst network_with_private_secondary_ip_ranges = new google.index.ComputeSubnetwork(\"network-with-private-secondary-ip-ranges\", {\n name: `test-dbx-${suffix.result}`,\n ipCidrRange: \"10.0.0.0/16\",\n region: \"us-central1\",\n network: dbxPrivateVpc.id,\n privateIpGoogleAccess: true,\n});\nconst router = new google.index.ComputeRouter(\"router\", {\n name: `my-router-${suffix.result}`,\n region: network_with_private_secondary_ip_ranges.region,\n network: dbxPrivateVpc.id,\n});\nconst nat = new google.index.ComputeRouterNat(\"nat\", {\n name: `my-router-nat-${suffix.result}`,\n router: router.name,\n region: router.region,\n natIpAllocateOption: \"AUTO_ONLY\",\n sourceSubnetworkIpRangesToNat: \"ALL_SUBNETWORKS_ALL_IP_RANGES\",\n});\nconst _this = new databricks.MwsNetworks(\"this\", {\n accountId: databricksAccountId,\n networkName: `test-demo-${suffix.result}`,\n gcpNetworkInfo: {\n networkProjectId: googleProject,\n vpcId: dbxPrivateVpc.name,\n subnetId: networkWithPrivateSecondaryIpRanges.name,\n subnetRegion: networkWithPrivateSecondaryIpRanges.region,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\nimport pulumi_google as google\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\ndbx_private_vpc = google.ComputeNetwork(\"dbx_private_vpc\",\n project=google_project,\n name=ftf-network-{suffix.result},\n auto_create_subnetworks=False)\nnetwork_with_private_secondary_ip_ranges = google.ComputeSubnetwork(\"network-with-private-secondary-ip-ranges\",\n name=ftest-dbx-{suffix.result},\n ip_cidr_range=10.0.0.0/16,\n region=us-central1,\n network=dbx_private_vpc.id,\n private_ip_google_access=True)\nrouter = google.ComputeRouter(\"router\",\n name=fmy-router-{suffix.result},\n region=network_with_private_secondary_ip_ranges.region,\n network=dbx_private_vpc.id)\nnat = google.ComputeRouterNat(\"nat\",\n name=fmy-router-nat-{suffix.result},\n router=router.name,\n region=router.region,\n nat_ip_allocate_option=AUTO_ONLY,\n source_subnetwork_ip_ranges_to_nat=ALL_SUBNETWORKS_ALL_IP_RANGES)\nthis = databricks.MwsNetworks(\"this\",\n account_id=databricks_account_id,\n network_name=f\"test-demo-{suffix['result']}\",\n gcp_network_info={\n \"network_project_id\": google_project,\n \"vpc_id\": dbx_private_vpc[\"name\"],\n \"subnet_id\": network_with_private_secondary_ip_ranges[\"name\"],\n \"subnet_region\": network_with_private_secondary_ip_ranges[\"region\"],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\nusing Google = Pulumi.Google;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n var dbxPrivateVpc = new Google.ComputeNetwork(\"dbx_private_vpc\", new()\n {\n Project = googleProject,\n Name = $\"tf-network-{suffix.Result}\",\n AutoCreateSubnetworks = false,\n });\n\n var network_with_private_secondary_ip_ranges = new Google.ComputeSubnetwork(\"network-with-private-secondary-ip-ranges\", new()\n {\n Name = $\"test-dbx-{suffix.Result}\",\n IpCidrRange = \"10.0.0.0/16\",\n Region = \"us-central1\",\n Network = dbxPrivateVpc.Id,\n PrivateIpGoogleAccess = true,\n });\n\n var router = new Google.ComputeRouter(\"router\", new()\n {\n Name = $\"my-router-{suffix.Result}\",\n Region = network_with_private_secondary_ip_ranges.Region,\n Network = dbxPrivateVpc.Id,\n });\n\n var nat = new Google.ComputeRouterNat(\"nat\", new()\n {\n Name = $\"my-router-nat-{suffix.Result}\",\n Router = router.Name,\n Region = router.Region,\n NatIpAllocateOption = \"AUTO_ONLY\",\n SourceSubnetworkIpRangesToNat = \"ALL_SUBNETWORKS_ALL_IP_RANGES\",\n });\n\n var @this = new Databricks.MwsNetworks(\"this\", new()\n {\n AccountId = databricksAccountId,\n NetworkName = $\"test-demo-{suffix.Result}\",\n GcpNetworkInfo = new Databricks.Inputs.MwsNetworksGcpNetworkInfoArgs\n {\n NetworkProjectId = googleProject,\n VpcId = dbxPrivateVpc.Name,\n SubnetId = networkWithPrivateSecondaryIpRanges.Name,\n SubnetRegion = networkWithPrivateSecondaryIpRanges.Region,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi-google/sdk/go/google\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\tdbxPrivateVpc, err := google.NewComputeNetwork(ctx, \"dbx_private_vpc\", \u0026google.ComputeNetworkArgs{\n\t\t\tProject: googleProject,\n\t\t\tName: fmt.Sprintf(\"tf-network-%v\", suffix.Result),\n\t\t\tAutoCreateSubnetworks: false,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\tnetwork_with_private_secondary_ip_ranges, err := google.NewComputeSubnetwork(ctx, \"network-with-private-secondary-ip-ranges\", \u0026google.ComputeSubnetworkArgs{\n\t\t\tName: fmt.Sprintf(\"test-dbx-%v\", suffix.Result),\n\t\t\tIpCidrRange: \"10.0.0.0/16\",\n\t\t\tRegion: \"us-central1\",\n\t\t\tNetwork: dbxPrivateVpc.Id,\n\t\t\tPrivateIpGoogleAccess: true,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\trouter, err := google.NewComputeRouter(ctx, \"router\", \u0026google.ComputeRouterArgs{\n\t\t\tName: fmt.Sprintf(\"my-router-%v\", suffix.Result),\n\t\t\tRegion: network_with_private_secondary_ip_ranges.Region,\n\t\t\tNetwork: dbxPrivateVpc.Id,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = google.NewComputeRouterNat(ctx, \"nat\", \u0026google.ComputeRouterNatArgs{\n\t\t\tName: fmt.Sprintf(\"my-router-nat-%v\", suffix.Result),\n\t\t\tRouter: router.Name,\n\t\t\tRegion: router.Region,\n\t\t\tNatIpAllocateOption: \"AUTO_ONLY\",\n\t\t\tSourceSubnetworkIpRangesToNat: \"ALL_SUBNETWORKS_ALL_IP_RANGES\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsNetworks(ctx, \"this\", \u0026databricks.MwsNetworksArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tNetworkName: pulumi.Sprintf(\"test-demo-%v\", suffix.Result),\n\t\t\tGcpNetworkInfo: \u0026databricks.MwsNetworksGcpNetworkInfoArgs{\n\t\t\t\tNetworkProjectId: pulumi.Any(googleProject),\n\t\t\t\tVpcId: dbxPrivateVpc.Name,\n\t\t\t\tSubnetId: pulumi.Any(networkWithPrivateSecondaryIpRanges.Name),\n\t\t\t\tSubnetRegion: pulumi.Any(networkWithPrivateSecondaryIpRanges.Region),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"google_computenetwork\" \"dbx_private_vpc\" {\n project = googleProject\n name =\"tf-network-${suffix.result}\"\n auto_create_subnetworks = false\n}\nresource \"google_computesubnetwork\" \"network-with-private-secondary-ip-ranges\" {\n name =\"test-dbx-${suffix.result}\"\n ip_cidr_range = \"10.0.0.0/16\"\n region = \"us-central1\"\n network = google_computenetwork.dbx_private_vpc.id\n private_ip_google_access = true\n}\nresource \"google_computerouter\" \"router\" {\n name =\"my-router-${suffix.result}\"\n region = google_computesubnetwork.network-with-private-secondary-ip-ranges.region\n network = google_computenetwork.dbx_private_vpc.id\n}\nresource \"google_computerouternat\" \"nat\" {\n name =\"my-router-nat-${suffix.result}\"\n router = google_computerouter.router.name\n region = google_computerouter.router.region\n nat_ip_allocate_option = \"AUTO_ONLY\"\n source_subnetwork_ip_ranges_to_nat = \"ALL_SUBNETWORKS_ALL_IP_RANGES\"\n}\nresource \"databricks_mwsnetworks\" \"this\" {\n account_id = var.databricksAccountId\n network_name =\"test-demo-${suffix.result}\"\n gcp_network_info = {\n network_project_id = googleProject\n vpc_id = google_computenetwork.dbx_private_vpc.name\n subnet_id = networkWithPrivateSecondaryIpRanges.name\n subnet_region = networkWithPrivateSecondaryIpRanges.region\n }\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.google.ComputeNetwork;\nimport com.pulumi.google.ComputeNetworkArgs;\nimport com.pulumi.google.ComputeSubnetwork;\nimport com.pulumi.google.ComputeSubnetworkArgs;\nimport com.pulumi.google.ComputeRouter;\nimport com.pulumi.google.ComputeRouterArgs;\nimport com.pulumi.google.ComputeRouterNat;\nimport com.pulumi.google.ComputeRouterNatArgs;\nimport com.pulumi.databricks.MwsNetworks;\nimport com.pulumi.databricks.MwsNetworksArgs;\nimport com.pulumi.databricks.inputs.MwsNetworksGcpNetworkInfoArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n var dbxPrivateVpc = new ComputeNetwork(\"dbxPrivateVpc\", ComputeNetworkArgs.builder()\n .project(googleProject)\n .name(String.format(\"tf-network-%s\", suffix.result()))\n .autoCreateSubnetworks(false)\n .build());\n\n var network_with_private_secondary_ip_ranges = new ComputeSubnetwork(\"network-with-private-secondary-ip-ranges\", ComputeSubnetworkArgs.builder()\n .name(String.format(\"test-dbx-%s\", suffix.result()))\n .ipCidrRange(\"10.0.0.0/16\")\n .region(\"us-central1\")\n .network(dbxPrivateVpc.id())\n .privateIpGoogleAccess(true)\n .build());\n\n var router = new ComputeRouter(\"router\", ComputeRouterArgs.builder()\n .name(String.format(\"my-router-%s\", suffix.result()))\n .region(network_with_private_secondary_ip_ranges.region())\n .network(dbxPrivateVpc.id())\n .build());\n\n var nat = new ComputeRouterNat(\"nat\", ComputeRouterNatArgs.builder()\n .name(String.format(\"my-router-nat-%s\", suffix.result()))\n .router(router.name())\n .region(router.region())\n .natIpAllocateOption(\"AUTO_ONLY\")\n .sourceSubnetworkIpRangesToNat(\"ALL_SUBNETWORKS_ALL_IP_RANGES\")\n .build());\n\n var this_ = new MwsNetworks(\"this\", MwsNetworksArgs.builder()\n .accountId(databricksAccountId)\n .networkName(String.format(\"test-demo-%s\", suffix.result()))\n .gcpNetworkInfo(MwsNetworksGcpNetworkInfoArgs.builder()\n .networkProjectId(googleProject)\n .vpcId(dbxPrivateVpc.name())\n .subnetId(networkWithPrivateSecondaryIpRanges.name())\n .subnetRegion(networkWithPrivateSecondaryIpRanges.region())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\nresources:\n dbxPrivateVpc:\n type: google:ComputeNetwork\n name: dbx_private_vpc\n properties:\n project: ${googleProject}\n name: tf-network-${suffix.result}\n autoCreateSubnetworks: false\n network-with-private-secondary-ip-ranges:\n type: google:ComputeSubnetwork\n properties:\n name: test-dbx-${suffix.result}\n ipCidrRange: 10.0.0.0/16\n region: us-central1\n network: ${dbxPrivateVpc.id}\n privateIpGoogleAccess: true\n router:\n type: google:ComputeRouter\n properties:\n name: my-router-${suffix.result}\n region: ${[\"network-with-private-secondary-ip-ranges\"].region}\n network: ${dbxPrivateVpc.id}\n nat:\n type: google:ComputeRouterNat\n properties:\n name: my-router-nat-${suffix.result}\n router: ${router.name}\n region: ${router.region}\n natIpAllocateOption: AUTO_ONLY\n sourceSubnetworkIpRangesToNat: ALL_SUBNETWORKS_ALL_IP_RANGES\n this:\n type: databricks:MwsNetworks\n properties:\n accountId: ${databricksAccountId}\n networkName: test-demo-${suffix.result}\n gcpNetworkInfo:\n networkProjectId: ${googleProject}\n vpcId: ${dbxPrivateVpc.name}\n subnetId: ${networkWithPrivateSecondaryIpRanges.name}\n subnetRegion: ${networkWithPrivateSecondaryIpRanges.region}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nIn order to create a VPC [that leverages GCP Private Service Connect](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html) you would need to add the \u003cspan pulumi-lang-nodejs=\"`vpcEndpointId`\" pulumi-lang-dotnet=\"`VpcEndpointId`\" pulumi-lang-go=\"`vpcEndpointId`\" pulumi-lang-python=\"`vpc_endpoint_id`\" pulumi-lang-yaml=\"`vpcEndpointId`\" pulumi-lang-java=\"`vpcEndpointId`\" pulumi-lang-hcl=\"`vpc_endpoint_id`\"\u003e`vpcEndpointId`\u003c/span\u003e Attributes from\u003cspan pulumi-lang-nodejs=\" mwsVpcEndpoint \" pulumi-lang-dotnet=\" MwsVpcEndpoint \" pulumi-lang-go=\" mwsVpcEndpoint \" pulumi-lang-python=\" mws_vpc_endpoint \" pulumi-lang-yaml=\" mwsVpcEndpoint \" pulumi-lang-java=\" mwsVpcEndpoint \" pulumi-lang-hcl=\" mws_vpc_endpoint \"\u003e mwsVpcEndpoint \u003c/span\u003eresources into the\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eresource. For example:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.MwsNetworks(\"this\", {\n accountId: databricksAccountId,\n networkName: `test-demo-${suffix.result}`,\n gcpNetworkInfo: {\n networkProjectId: googleProject,\n vpcId: dbxPrivateVpc.name,\n subnetId: networkWithPrivateSecondaryIpRanges.name,\n subnetRegion: networkWithPrivateSecondaryIpRanges.region,\n },\n vpcEndpoints: {\n dataplaneRelays: [relay.vpcEndpointId],\n restApis: [workspace.vpcEndpointId],\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.MwsNetworks(\"this\",\n account_id=databricks_account_id,\n network_name=f\"test-demo-{suffix['result']}\",\n gcp_network_info={\n \"network_project_id\": google_project,\n \"vpc_id\": dbx_private_vpc[\"name\"],\n \"subnet_id\": network_with_private_secondary_ip_ranges[\"name\"],\n \"subnet_region\": network_with_private_secondary_ip_ranges[\"region\"],\n },\n vpc_endpoints={\n \"dataplane_relays\": [relay[\"vpcEndpointId\"]],\n \"rest_apis\": [workspace[\"vpcEndpointId\"]],\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.MwsNetworks(\"this\", new()\n {\n AccountId = databricksAccountId,\n NetworkName = $\"test-demo-{suffix.Result}\",\n GcpNetworkInfo = new Databricks.Inputs.MwsNetworksGcpNetworkInfoArgs\n {\n NetworkProjectId = googleProject,\n VpcId = dbxPrivateVpc.Name,\n SubnetId = networkWithPrivateSecondaryIpRanges.Name,\n SubnetRegion = networkWithPrivateSecondaryIpRanges.Region,\n },\n VpcEndpoints = new Databricks.Inputs.MwsNetworksVpcEndpointsArgs\n {\n DataplaneRelays = new[]\n {\n relay.VpcEndpointId,\n },\n RestApis = new[]\n {\n workspace.VpcEndpointId,\n },\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsNetworks(ctx, \"this\", \u0026databricks.MwsNetworksArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tNetworkName: pulumi.Sprintf(\"test-demo-%v\", suffix.Result),\n\t\t\tGcpNetworkInfo: \u0026databricks.MwsNetworksGcpNetworkInfoArgs{\n\t\t\t\tNetworkProjectId: pulumi.Any(googleProject),\n\t\t\t\tVpcId: pulumi.Any(dbxPrivateVpc.Name),\n\t\t\t\tSubnetId: pulumi.Any(networkWithPrivateSecondaryIpRanges.Name),\n\t\t\t\tSubnetRegion: pulumi.Any(networkWithPrivateSecondaryIpRanges.Region),\n\t\t\t},\n\t\t\tVpcEndpoints: \u0026databricks.MwsNetworksVpcEndpointsArgs{\n\t\t\t\tDataplaneRelays: pulumi.StringArray{\n\t\t\t\t\trelay.VpcEndpointId,\n\t\t\t\t},\n\t\t\t\tRestApis: pulumi.StringArray{\n\t\t\t\t\tworkspace.VpcEndpointId,\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsnetworks\" \"this\" {\n account_id = databricksAccountId\n network_name =\"test-demo-${suffix.result}\"\n gcp_network_info = {\n network_project_id = googleProject\n vpc_id = dbxPrivateVpc.name\n subnet_id = networkWithPrivateSecondaryIpRanges.name\n subnet_region = networkWithPrivateSecondaryIpRanges.region\n }\n vpc_endpoints = {\n dataplane_relays = [relay.vpcEndpointId]\n rest_apis = [workspace.vpcEndpointId]\n }\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsNetworks;\nimport com.pulumi.databricks.MwsNetworksArgs;\nimport com.pulumi.databricks.inputs.MwsNetworksGcpNetworkInfoArgs;\nimport com.pulumi.databricks.inputs.MwsNetworksVpcEndpointsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new MwsNetworks(\"this\", MwsNetworksArgs.builder()\n .accountId(databricksAccountId)\n .networkName(String.format(\"test-demo-%s\", suffix.result()))\n .gcpNetworkInfo(MwsNetworksGcpNetworkInfoArgs.builder()\n .networkProjectId(googleProject)\n .vpcId(dbxPrivateVpc.name())\n .subnetId(networkWithPrivateSecondaryIpRanges.name())\n .subnetRegion(networkWithPrivateSecondaryIpRanges.region())\n .build())\n .vpcEndpoints(MwsNetworksVpcEndpointsArgs.builder()\n .dataplaneRelays(relay.vpcEndpointId())\n .restApis(workspace.vpcEndpointId())\n .build())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MwsNetworks\n properties:\n accountId: ${databricksAccountId}\n networkName: test-demo-${suffix.result}\n gcpNetworkInfo:\n networkProjectId: ${googleProject}\n vpcId: ${dbxPrivateVpc.name}\n subnetId: ${networkWithPrivateSecondaryIpRanges.name}\n subnetRegion: ${networkWithPrivateSecondaryIpRanges.region}\n vpcEndpoints:\n dataplaneRelays:\n - ${relay.vpcEndpointId}\n restApis:\n - ${workspace.vpcEndpointId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Modifying networks on running workspaces (AWS only)\n\nDue to specifics of platform APIs, changing any attribute of network configuration would cause \u003cspan pulumi-lang-nodejs=\"`databricks.MwsNetworks`\" pulumi-lang-dotnet=\"`databricks.MwsNetworks`\" pulumi-lang-go=\"`MwsNetworks`\" pulumi-lang-python=\"`MwsNetworks`\" pulumi-lang-yaml=\"`databricks.MwsNetworks`\" pulumi-lang-java=\"`databricks.MwsNetworks`\" pulumi-lang-hcl=\"`databricks_mws_networks`\"\u003e`databricks.MwsNetworks`\u003c/span\u003e to be re-created - deleted \u0026 added again with special case for running workspaces. Once network configuration is attached to a running databricks_mws_workspaces, you cannot delete it and `pulumi up` would result in `INVALID_STATE: Unable to delete, Network is being used by active workspace X` error. In order to modify any attributes of a network, you have to perform three different `pulumi up` steps:\n\n1. Create a new \u003cspan pulumi-lang-nodejs=\"`databricks.MwsNetworks`\" pulumi-lang-dotnet=\"`databricks.MwsNetworks`\" pulumi-lang-go=\"`MwsNetworks`\" pulumi-lang-python=\"`MwsNetworks`\" pulumi-lang-yaml=\"`databricks.MwsNetworks`\" pulumi-lang-java=\"`databricks.MwsNetworks`\" pulumi-lang-hcl=\"`databricks_mws_networks`\"\u003e`databricks.MwsNetworks`\u003c/span\u003e resource.\n2. Update the \u003cspan pulumi-lang-nodejs=\"`databricks.MwsWorkspaces`\" pulumi-lang-dotnet=\"`databricks.MwsWorkspaces`\" pulumi-lang-go=\"`MwsWorkspaces`\" pulumi-lang-python=\"`MwsWorkspaces`\" pulumi-lang-yaml=\"`databricks.MwsWorkspaces`\" pulumi-lang-java=\"`databricks.MwsWorkspaces`\" pulumi-lang-hcl=\"`databricks_mws_workspaces`\"\u003e`databricks.MwsWorkspaces`\u003c/span\u003e to point to the new \u003cspan pulumi-lang-nodejs=\"`networkId`\" pulumi-lang-dotnet=\"`NetworkId`\" pulumi-lang-go=\"`networkId`\" pulumi-lang-python=\"`network_id`\" pulumi-lang-yaml=\"`networkId`\" pulumi-lang-java=\"`networkId`\" pulumi-lang-hcl=\"`network_id`\"\u003e`networkId`\u003c/span\u003e.\n3. Delete the old \u003cspan pulumi-lang-nodejs=\"`databricks.MwsNetworks`\" pulumi-lang-dotnet=\"`databricks.MwsNetworks`\" pulumi-lang-go=\"`MwsNetworks`\" pulumi-lang-python=\"`MwsNetworks`\" pulumi-lang-yaml=\"`databricks.MwsNetworks`\" pulumi-lang-java=\"`databricks.MwsNetworks`\" pulumi-lang-hcl=\"`databricks_mws_networks`\"\u003e`databricks.MwsNetworks`\u003c/span\u003e resource.\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n* Provisioning Databricks on AWS with Private Link guide.\n* Provisioning AWS Databricks workspaces with a Hub \u0026 Spoke firewall for data exfiltration protection guide.\n* Provisioning Databricks on GCP guide.\n* Provisioning Databricks workspaces on GCP with Private Service Connect guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003eto register\u003cspan pulumi-lang-nodejs=\" awsVpcEndpoint \" pulumi-lang-dotnet=\" AwsVpcEndpoint \" pulumi-lang-go=\" awsVpcEndpoint \" pulumi-lang-python=\" aws_vpc_endpoint \" pulumi-lang-yaml=\" awsVpcEndpoint \" pulumi-lang-java=\" awsVpcEndpoint \" pulumi-lang-hcl=\" aws_vpc_endpoint \"\u003e awsVpcEndpoint \u003c/span\u003eresources with Databricks such that they can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003econfiguration.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-dotnet=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-go=\" MwsPrivateAccessSettings \" pulumi-lang-python=\" MwsPrivateAccessSettings \" pulumi-lang-yaml=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-java=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-hcl=\" databricks_mws_private_access_settings \"\u003e databricks.MwsPrivateAccessSettings \u003c/span\u003eto create a Private Access Setting that can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource to create a [Databricks Workspace that leverages AWS PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html) or [GCP Private Service Connect](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "secret": true }, "creationTime": { "type": "integer" }, "errorMessages": { "type": "array", "items": { "$ref": "#/types/databricks:index/MwsNetworksErrorMessage:MwsNetworksErrorMessage" } }, "gcpNetworkInfo": { "$ref": "#/types/databricks:index/MwsNetworksGcpNetworkInfo:MwsNetworksGcpNetworkInfo", "description": "a block consists of Google Cloud specific information for this network, for example the VPC ID, subnet ID, and secondary IP ranges. It has the following fields:\n" }, "networkId": { "type": "string", "description": "(String) id of network to be used for\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource.\n" }, "networkName": { "type": "string", "description": "name under which this network is registered\n" }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ids of aws_security_group\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "ids of aws_subnet\n" }, "vpcEndpoints": { "$ref": "#/types/databricks:index/MwsNetworksVpcEndpoints:MwsNetworksVpcEndpoints", "description": "mapping of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003efor PrivateLink or Private Service Connect connections\n" }, "vpcId": { "type": "string", "description": "aws_vpc id\n" }, "vpcStatus": { "type": "string", "description": "(String) VPC attachment status\n" }, "workspaceId": { "type": "string", "description": "(Integer) id of associated workspace\n" } }, "required": [ "accountId", "creationTime", "errorMessages", "networkId", "networkName", "vpcEndpoints", "vpcStatus", "workspaceId" ], "inputProperties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "secret": true, "willReplaceOnChanges": true }, "creationTime": { "type": "integer" }, "errorMessages": { "type": "array", "items": { "$ref": "#/types/databricks:index/MwsNetworksErrorMessage:MwsNetworksErrorMessage" } }, "gcpNetworkInfo": { "$ref": "#/types/databricks:index/MwsNetworksGcpNetworkInfo:MwsNetworksGcpNetworkInfo", "description": "a block consists of Google Cloud specific information for this network, for example the VPC ID, subnet ID, and secondary IP ranges. It has the following fields:\n" }, "networkId": { "type": "string", "description": "(String) id of network to be used for\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource.\n" }, "networkName": { "type": "string", "description": "name under which this network is registered\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ids of aws_security_group\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "ids of aws_subnet\n", "willReplaceOnChanges": true }, "vpcEndpoints": { "$ref": "#/types/databricks:index/MwsNetworksVpcEndpoints:MwsNetworksVpcEndpoints", "description": "mapping of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003efor PrivateLink or Private Service Connect connections\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "aws_vpc id\n", "willReplaceOnChanges": true }, "vpcStatus": { "type": "string", "description": "(String) VPC attachment status\n" }, "workspaceId": { "type": "string", "description": "(Integer) id of associated workspace\n" } }, "requiredInputs": [ "accountId", "networkName" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsNetworks resources.\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "secret": true, "willReplaceOnChanges": true }, "creationTime": { "type": "integer" }, "errorMessages": { "type": "array", "items": { "$ref": "#/types/databricks:index/MwsNetworksErrorMessage:MwsNetworksErrorMessage" } }, "gcpNetworkInfo": { "$ref": "#/types/databricks:index/MwsNetworksGcpNetworkInfo:MwsNetworksGcpNetworkInfo", "description": "a block consists of Google Cloud specific information for this network, for example the VPC ID, subnet ID, and secondary IP ranges. It has the following fields:\n" }, "networkId": { "type": "string", "description": "(String) id of network to be used for\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource.\n" }, "networkName": { "type": "string", "description": "name under which this network is registered\n", "willReplaceOnChanges": true }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "ids of aws_security_group\n", "willReplaceOnChanges": true }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "ids of aws_subnet\n", "willReplaceOnChanges": true }, "vpcEndpoints": { "$ref": "#/types/databricks:index/MwsNetworksVpcEndpoints:MwsNetworksVpcEndpoints", "description": "mapping of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003efor PrivateLink or Private Service Connect connections\n", "willReplaceOnChanges": true }, "vpcId": { "type": "string", "description": "aws_vpc id\n", "willReplaceOnChanges": true }, "vpcStatus": { "type": "string", "description": "(String) VPC attachment status\n" }, "workspaceId": { "type": "string", "description": "(Integer) id of associated workspace\n" } }, "type": "object" } }, "databricks:index/mwsPermissionAssignment:MwsPermissionAssignment": { "description": "This resource is used to assign account-level users, service principals and groups to a Databricks workspace. To configure additional entitlements such as cluster creation, please use databricks_entitlements.\n\n\u003e This resource can only be used with an account-level provider!\n\n## Example Usage\n\nIn account context, adding account-level group to a workspace:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst dataEng = new databricks.Group(\"data_eng\", {displayName: \"Data Engineering\"});\nconst addAdminGroup = new databricks.MwsPermissionAssignment(\"add_admin_group\", {\n workspaceId: _this.workspaceId,\n principalId: dataEng.id,\n permissions: [\"ADMIN\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\ndata_eng = databricks.Group(\"data_eng\", display_name=\"Data Engineering\")\nadd_admin_group = databricks.MwsPermissionAssignment(\"add_admin_group\",\n workspace_id=this[\"workspaceId\"],\n principal_id=data_eng.id,\n permissions=[\"ADMIN\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var dataEng = new Databricks.Group(\"data_eng\", new()\n {\n DisplayName = \"Data Engineering\",\n });\n\n var addAdminGroup = new Databricks.MwsPermissionAssignment(\"add_admin_group\", new()\n {\n WorkspaceId = @this.WorkspaceId,\n PrincipalId = dataEng.Id,\n Permissions = new[]\n {\n \"ADMIN\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tdataEng, err := databricks.NewGroup(ctx, \"data_eng\", \u0026databricks.GroupArgs{\n\t\t\tDisplayName: pulumi.String(\"Data Engineering\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsPermissionAssignment(ctx, \"add_admin_group\", \u0026databricks.MwsPermissionAssignmentArgs{\n\t\t\tWorkspaceId: pulumi.Any(this.WorkspaceId),\n\t\t\tPrincipalId: dataEng.ID(),\n\t\t\tPermissions: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"ADMIN\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_group\" \"data_eng\" {\n display_name = \"Data Engineering\"\n}\nresource \"databricks_mwspermissionassignment\" \"add_admin_group\" {\n workspace_id = this.workspaceId\n principal_id = databricks_group.data_eng.id\n permissions = [\"ADMIN\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.Group;\nimport com.pulumi.databricks.GroupArgs;\nimport com.pulumi.databricks.MwsPermissionAssignment;\nimport com.pulumi.databricks.MwsPermissionAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var dataEng = new Group(\"dataEng\", GroupArgs.builder()\n .displayName(\"Data Engineering\")\n .build());\n\n var addAdminGroup = new MwsPermissionAssignment(\"addAdminGroup\", MwsPermissionAssignmentArgs.builder()\n .workspaceId(this_.workspaceId())\n .principalId(dataEng.id())\n .permissions(\"ADMIN\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n dataEng:\n type: databricks:Group\n name: data_eng\n properties:\n displayName: Data Engineering\n addAdminGroup:\n type: databricks:MwsPermissionAssignment\n name: add_admin_group\n properties:\n workspaceId: ${this.workspaceId}\n principalId: ${dataEng.id}\n permissions:\n - ADMIN\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nIn account context, adding account-level user to a workspace:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst me = new databricks.User(\"me\", {userName: \"me@example.com\"});\nconst addUser = new databricks.MwsPermissionAssignment(\"add_user\", {\n workspaceId: _this.workspaceId,\n principalId: me.id,\n permissions: [\"USER\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nme = databricks.User(\"me\", user_name=\"me@example.com\")\nadd_user = databricks.MwsPermissionAssignment(\"add_user\",\n workspace_id=this[\"workspaceId\"],\n principal_id=me.id,\n permissions=[\"USER\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var me = new Databricks.User(\"me\", new()\n {\n UserName = \"me@example.com\",\n });\n\n var addUser = new Databricks.MwsPermissionAssignment(\"add_user\", new()\n {\n WorkspaceId = @this.WorkspaceId,\n PrincipalId = me.Id,\n Permissions = new[]\n {\n \"USER\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tme, err := databricks.NewUser(ctx, \"me\", \u0026databricks.UserArgs{\n\t\t\tUserName: pulumi.String(\"me@example.com\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsPermissionAssignment(ctx, \"add_user\", \u0026databricks.MwsPermissionAssignmentArgs{\n\t\t\tWorkspaceId: pulumi.Any(this.WorkspaceId),\n\t\t\tPrincipalId: me.ID(),\n\t\t\tPermissions: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"USER\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_user\" \"me\" {\n user_name = \"me@example.com\"\n}\nresource \"databricks_mwspermissionassignment\" \"add_user\" {\n workspace_id = this.workspaceId\n principal_id = databricks_user.me.id\n permissions = [\"USER\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.User;\nimport com.pulumi.databricks.UserArgs;\nimport com.pulumi.databricks.MwsPermissionAssignment;\nimport com.pulumi.databricks.MwsPermissionAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var me = new User(\"me\", UserArgs.builder()\n .userName(\"me@example.com\")\n .build());\n\n var addUser = new MwsPermissionAssignment(\"addUser\", MwsPermissionAssignmentArgs.builder()\n .workspaceId(this_.workspaceId())\n .principalId(me.id())\n .permissions(\"USER\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n me:\n type: databricks:User\n properties:\n userName: me@example.com\n addUser:\n type: databricks:MwsPermissionAssignment\n name: add_user\n properties:\n workspaceId: ${this.workspaceId}\n principalId: ${me.id}\n permissions:\n - USER\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nIn account context, adding account-level service principal to a workspace:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst sp = new databricks.ServicePrincipal(\"sp\", {displayName: \"Automation-only SP\"});\nconst addAdminSpn = new databricks.MwsPermissionAssignment(\"add_admin_spn\", {\n workspaceId: _this.workspaceId,\n principalId: sp.id,\n permissions: [\"ADMIN\"],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nsp = databricks.ServicePrincipal(\"sp\", display_name=\"Automation-only SP\")\nadd_admin_spn = databricks.MwsPermissionAssignment(\"add_admin_spn\",\n workspace_id=this[\"workspaceId\"],\n principal_id=sp.id,\n permissions=[\"ADMIN\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var sp = new Databricks.ServicePrincipal(\"sp\", new()\n {\n DisplayName = \"Automation-only SP\",\n });\n\n var addAdminSpn = new Databricks.MwsPermissionAssignment(\"add_admin_spn\", new()\n {\n WorkspaceId = @this.WorkspaceId,\n PrincipalId = sp.Id,\n Permissions = new[]\n {\n \"ADMIN\",\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tsp, err := databricks.NewServicePrincipal(ctx, \"sp\", \u0026databricks.ServicePrincipalArgs{\n\t\t\tDisplayName: pulumi.String(\"Automation-only SP\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsPermissionAssignment(ctx, \"add_admin_spn\", \u0026databricks.MwsPermissionAssignmentArgs{\n\t\t\tWorkspaceId: pulumi.Any(this.WorkspaceId),\n\t\t\tPrincipalId: sp.ID(),\n\t\t\tPermissions: pulumi.StringArray{\n\t\t\t\tpulumi.String(\"ADMIN\"),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_serviceprincipal\" \"sp\" {\n display_name = \"Automation-only SP\"\n}\nresource \"databricks_mwspermissionassignment\" \"add_admin_spn\" {\n workspace_id = this.workspaceId\n principal_id = databricks_serviceprincipal.sp.id\n permissions = [\"ADMIN\"]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.ServicePrincipal;\nimport com.pulumi.databricks.ServicePrincipalArgs;\nimport com.pulumi.databricks.MwsPermissionAssignment;\nimport com.pulumi.databricks.MwsPermissionAssignmentArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var sp = new ServicePrincipal(\"sp\", ServicePrincipalArgs.builder()\n .displayName(\"Automation-only SP\")\n .build());\n\n var addAdminSpn = new MwsPermissionAssignment(\"addAdminSpn\", MwsPermissionAssignmentArgs.builder()\n .workspaceId(this_.workspaceId())\n .principalId(sp.id())\n .permissions(\"ADMIN\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n sp:\n type: databricks:ServicePrincipal\n properties:\n displayName: Automation-only SP\n addAdminSpn:\n type: databricks:MwsPermissionAssignment\n name: add_admin_spn\n properties:\n workspaceId: ${this.workspaceId}\n principalId: ${sp.id}\n permissions:\n - ADMIN\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003eto manage [Account-level](https://docs.databricks.com/aws/en/admin/users-groups/groups) or [Workspace-level](https://docs.databricks.com/aws/en/admin/users-groups/workspace-local-groups) groups.\n*\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata to retrieve information about\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003emembers, entitlements and instance profiles.\n*\u003cspan pulumi-lang-nodejs=\" databricks.GroupMember \" pulumi-lang-dotnet=\" databricks.GroupMember \" pulumi-lang-go=\" GroupMember \" pulumi-lang-python=\" GroupMember \" pulumi-lang-yaml=\" databricks.GroupMember \" pulumi-lang-java=\" databricks.GroupMember \" pulumi-lang-hcl=\" databricks_group_member \"\u003e databricks.GroupMember \u003c/span\u003eto attach users and groups as group members.\n*\u003cspan pulumi-lang-nodejs=\" databricks.PermissionAssignment \" pulumi-lang-dotnet=\" databricks.PermissionAssignment \" pulumi-lang-go=\" PermissionAssignment \" pulumi-lang-python=\" PermissionAssignment \" pulumi-lang-yaml=\" databricks.PermissionAssignment \" pulumi-lang-java=\" databricks.PermissionAssignment \" pulumi-lang-hcl=\" databricks_permission_assignment \"\u003e databricks.PermissionAssignment \u003c/span\u003eto manage permission assignment from a workspace context\n\n", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "The list of workspace permissions to assign to the principal:\n* `\"USER\"` - Adds principal to the workspace \u003cspan pulumi-lang-nodejs=\"`users`\" pulumi-lang-dotnet=\"`Users`\" pulumi-lang-go=\"`users`\" pulumi-lang-python=\"`users`\" pulumi-lang-yaml=\"`users`\" pulumi-lang-java=\"`users`\" pulumi-lang-hcl=\"`users`\"\u003e`users`\u003c/span\u003e group. This gives basic workspace access.\n* `\"ADMIN\"` - Adds principal to the workspace \u003cspan pulumi-lang-nodejs=\"`admins`\" pulumi-lang-dotnet=\"`Admins`\" pulumi-lang-go=\"`admins`\" pulumi-lang-python=\"`admins`\" pulumi-lang-yaml=\"`admins`\" pulumi-lang-java=\"`admins`\" pulumi-lang-hcl=\"`admins`\"\u003e`admins`\u003c/span\u003e group. This gives workspace admin privileges to manage users and groups, workspace configurations, and more.\n" }, "principalId": { "type": "string", "description": "Databricks ID of the user, service principal, or group. The principal ID can be retrieved using the SCIM API, or using databricks_user,\u003cspan pulumi-lang-nodejs=\" databricks.ServicePrincipal \" pulumi-lang-dotnet=\" databricks.ServicePrincipal \" pulumi-lang-go=\" ServicePrincipal \" pulumi-lang-python=\" ServicePrincipal \" pulumi-lang-yaml=\" databricks.ServicePrincipal \" pulumi-lang-java=\" databricks.ServicePrincipal \" pulumi-lang-hcl=\" databricks_service_principal \"\u003e databricks.ServicePrincipal \u003c/span\u003eor\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata sources.\n" }, "workspaceId": { "type": "string", "description": "Databricks workspace ID.\n" } }, "required": [ "permissions", "principalId", "workspaceId" ], "inputProperties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "The list of workspace permissions to assign to the principal:\n* `\"USER\"` - Adds principal to the workspace \u003cspan pulumi-lang-nodejs=\"`users`\" pulumi-lang-dotnet=\"`Users`\" pulumi-lang-go=\"`users`\" pulumi-lang-python=\"`users`\" pulumi-lang-yaml=\"`users`\" pulumi-lang-java=\"`users`\" pulumi-lang-hcl=\"`users`\"\u003e`users`\u003c/span\u003e group. This gives basic workspace access.\n* `\"ADMIN\"` - Adds principal to the workspace \u003cspan pulumi-lang-nodejs=\"`admins`\" pulumi-lang-dotnet=\"`Admins`\" pulumi-lang-go=\"`admins`\" pulumi-lang-python=\"`admins`\" pulumi-lang-yaml=\"`admins`\" pulumi-lang-java=\"`admins`\" pulumi-lang-hcl=\"`admins`\"\u003e`admins`\u003c/span\u003e group. This gives workspace admin privileges to manage users and groups, workspace configurations, and more.\n", "willReplaceOnChanges": true }, "principalId": { "type": "string", "description": "Databricks ID of the user, service principal, or group. The principal ID can be retrieved using the SCIM API, or using databricks_user,\u003cspan pulumi-lang-nodejs=\" databricks.ServicePrincipal \" pulumi-lang-dotnet=\" databricks.ServicePrincipal \" pulumi-lang-go=\" ServicePrincipal \" pulumi-lang-python=\" ServicePrincipal \" pulumi-lang-yaml=\" databricks.ServicePrincipal \" pulumi-lang-java=\" databricks.ServicePrincipal \" pulumi-lang-hcl=\" databricks_service_principal \"\u003e databricks.ServicePrincipal \u003c/span\u003eor\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata sources.\n", "willReplaceOnChanges": true }, "workspaceId": { "type": "string", "description": "Databricks workspace ID.\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "permissions", "principalId", "workspaceId" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsPermissionAssignment resources.\n", "properties": { "permissions": { "type": "array", "items": { "type": "string" }, "description": "The list of workspace permissions to assign to the principal:\n* `\"USER\"` - Adds principal to the workspace \u003cspan pulumi-lang-nodejs=\"`users`\" pulumi-lang-dotnet=\"`Users`\" pulumi-lang-go=\"`users`\" pulumi-lang-python=\"`users`\" pulumi-lang-yaml=\"`users`\" pulumi-lang-java=\"`users`\" pulumi-lang-hcl=\"`users`\"\u003e`users`\u003c/span\u003e group. This gives basic workspace access.\n* `\"ADMIN\"` - Adds principal to the workspace \u003cspan pulumi-lang-nodejs=\"`admins`\" pulumi-lang-dotnet=\"`Admins`\" pulumi-lang-go=\"`admins`\" pulumi-lang-python=\"`admins`\" pulumi-lang-yaml=\"`admins`\" pulumi-lang-java=\"`admins`\" pulumi-lang-hcl=\"`admins`\"\u003e`admins`\u003c/span\u003e group. This gives workspace admin privileges to manage users and groups, workspace configurations, and more.\n", "willReplaceOnChanges": true }, "principalId": { "type": "string", "description": "Databricks ID of the user, service principal, or group. The principal ID can be retrieved using the SCIM API, or using databricks_user,\u003cspan pulumi-lang-nodejs=\" databricks.ServicePrincipal \" pulumi-lang-dotnet=\" databricks.ServicePrincipal \" pulumi-lang-go=\" ServicePrincipal \" pulumi-lang-python=\" ServicePrincipal \" pulumi-lang-yaml=\" databricks.ServicePrincipal \" pulumi-lang-java=\" databricks.ServicePrincipal \" pulumi-lang-hcl=\" databricks_service_principal \"\u003e databricks.ServicePrincipal \u003c/span\u003eor\u003cspan pulumi-lang-nodejs=\" databricks.Group \" pulumi-lang-dotnet=\" databricks.Group \" pulumi-lang-go=\" Group \" pulumi-lang-python=\" Group \" pulumi-lang-yaml=\" databricks.Group \" pulumi-lang-java=\" databricks.Group \" pulumi-lang-hcl=\" databricks_group \"\u003e databricks.Group \u003c/span\u003edata sources.\n", "willReplaceOnChanges": true }, "workspaceId": { "type": "string", "description": "Databricks workspace ID.\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsPrivateAccessSettings:MwsPrivateAccessSettings": { "description": "Allows you to create a Private Access Setting resource that can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource to create a [Databricks Workspace that leverages AWS PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html) or [GCP Private Service Connect](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html)\n\n\u003e This resource can only be used with an account-level provider!\n\nIt is strongly recommended that customers read the [Enable AWS Private Link](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html) [Enable GCP Private Service Connect](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html) documentation before trying to leverage this resource.\n\n## Databricks on AWS usage\n\n\u003e Initialize provider with `alias = \"mws\"`, `host = \"https://accounts.cloud.databricks.com\"` and use `provider = databricks.mws`\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst pas = new databricks.MwsPrivateAccessSettings(\"pas\", {\n accountId: databricksAccountId,\n privateAccessSettingsName: `Private Access Settings for ${prefix}`,\n region: region,\n publicAccessEnabled: true,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\npas = databricks.MwsPrivateAccessSettings(\"pas\",\n account_id=databricks_account_id,\n private_access_settings_name=f\"Private Access Settings for {prefix}\",\n region=region,\n public_access_enabled=True)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var pas = new Databricks.MwsPrivateAccessSettings(\"pas\", new()\n {\n AccountId = databricksAccountId,\n PrivateAccessSettingsName = $\"Private Access Settings for {prefix}\",\n Region = region,\n PublicAccessEnabled = true,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsPrivateAccessSettings(ctx, \"pas\", \u0026databricks.MwsPrivateAccessSettingsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tPrivateAccessSettingsName: pulumi.Sprintf(\"Private Access Settings for %v\", prefix),\n\t\t\tRegion: pulumi.Any(region),\n\t\t\tPublicAccessEnabled: pulumi.Bool(true),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsprivateaccesssettings\" \"pas\" {\n account_id = databricksAccountId\n private_access_settings_name =\"Private Access Settings for ${prefix}\"\n region = region\n public_access_enabled = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsPrivateAccessSettings;\nimport com.pulumi.databricks.MwsPrivateAccessSettingsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var pas = new MwsPrivateAccessSettings(\"pas\", MwsPrivateAccessSettingsArgs.builder()\n .accountId(databricksAccountId)\n .privateAccessSettingsName(String.format(\"Private Access Settings for %s\", prefix))\n .region(region)\n .publicAccessEnabled(true)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n pas:\n type: databricks:MwsPrivateAccessSettings\n properties:\n accountId: ${databricksAccountId}\n privateAccessSettingsName: Private Access Settings for ${prefix}\n region: ${region}\n publicAccessEnabled: true\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nThe `databricks_mws_private_access_settings.pas.private_access_settings_id` can then be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.MwsWorkspaces(\"this\", {\n awsRegion: region,\n workspaceName: prefix,\n credentialsId: thisDatabricksMwsCredentials.credentialsId,\n storageConfigurationId: thisDatabricksMwsStorageConfigurations.storageConfigurationId,\n networkId: thisDatabricksMwsNetworks.networkId,\n privateAccessSettingsId: pas.privateAccessSettingsId,\n pricingTier: \"ENTERPRISE\",\n}, {\n dependsOn: [thisDatabricksMwsNetworks],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.MwsWorkspaces(\"this\",\n aws_region=region,\n workspace_name=prefix,\n credentials_id=this_databricks_mws_credentials[\"credentialsId\"],\n storage_configuration_id=this_databricks_mws_storage_configurations[\"storageConfigurationId\"],\n network_id=this_databricks_mws_networks[\"networkId\"],\n private_access_settings_id=pas[\"privateAccessSettingsId\"],\n pricing_tier=\"ENTERPRISE\",\n opts = pulumi.ResourceOptions(depends_on=[this_databricks_mws_networks]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.MwsWorkspaces(\"this\", new()\n {\n AwsRegion = region,\n WorkspaceName = prefix,\n CredentialsId = thisDatabricksMwsCredentials.CredentialsId,\n StorageConfigurationId = thisDatabricksMwsStorageConfigurations.StorageConfigurationId,\n NetworkId = thisDatabricksMwsNetworks.NetworkId,\n PrivateAccessSettingsId = pas.PrivateAccessSettingsId,\n PricingTier = \"ENTERPRISE\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n thisDatabricksMwsNetworks,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsWorkspaces(ctx, \"this\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tAwsRegion: pulumi.Any(region),\n\t\t\tWorkspaceName: pulumi.Any(prefix),\n\t\t\tCredentialsId: pulumi.Any(thisDatabricksMwsCredentials.CredentialsId),\n\t\t\tStorageConfigurationId: pulumi.Any(thisDatabricksMwsStorageConfigurations.StorageConfigurationId),\n\t\t\tNetworkId: pulumi.Any(thisDatabricksMwsNetworks.NetworkId),\n\t\t\tPrivateAccessSettingsId: pulumi.Any(pas.PrivateAccessSettingsId),\n\t\t\tPricingTier: pulumi.String(\"ENTERPRISE\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthisDatabricksMwsNetworks,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsworkspaces\" \"this\" {\n depends_on = [thisDatabricksMwsNetworks]\n aws_region = region\n workspace_name = prefix\n credentials_id = thisDatabricksMwsCredentials.credentialsId\n storage_configuration_id = thisDatabricksMwsStorageConfigurations.storageConfigurationId\n network_id = thisDatabricksMwsNetworks.networkId\n private_access_settings_id = pas.privateAccessSettingsId\n pricing_tier = \"ENTERPRISE\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new MwsWorkspaces(\"this\", MwsWorkspacesArgs.builder()\n .awsRegion(region)\n .workspaceName(prefix)\n .credentialsId(thisDatabricksMwsCredentials.credentialsId())\n .storageConfigurationId(thisDatabricksMwsStorageConfigurations.storageConfigurationId())\n .networkId(thisDatabricksMwsNetworks.networkId())\n .privateAccessSettingsId(pas.privateAccessSettingsId())\n .pricingTier(\"ENTERPRISE\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(thisDatabricksMwsNetworks)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MwsWorkspaces\n properties:\n awsRegion: ${region}\n workspaceName: ${prefix}\n credentialsId: ${thisDatabricksMwsCredentials.credentialsId}\n storageConfigurationId: ${thisDatabricksMwsStorageConfigurations.storageConfigurationId}\n networkId: ${thisDatabricksMwsNetworks.networkId}\n privateAccessSettingsId: ${pas.privateAccessSettingsId}\n pricingTier: ENTERPRISE\n options:\n dependsOn:\n - ${thisDatabricksMwsNetworks}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Databricks on GCP usage\n\n\u003e Initialize provider with `alias = \"mws\"`, `host = \"https://accounts.gcp.databricks.com\"` and use `provider = databricks.mws`\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.MwsWorkspaces(\"this\", {\n workspaceName: \"gcp-workspace\",\n location: subnetRegion,\n cloudResourceContainer: {\n gcp: {\n projectId: googleProject,\n },\n },\n networkId: thisDatabricksMwsNetworks.networkId,\n privateAccessSettingsId: pas.privateAccessSettingsId,\n pricingTier: \"PREMIUM\",\n}, {\n dependsOn: [thisDatabricksMwsNetworks],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.MwsWorkspaces(\"this\",\n workspace_name=\"gcp-workspace\",\n location=subnet_region,\n cloud_resource_container={\n \"gcp\": {\n \"project_id\": google_project,\n },\n },\n network_id=this_databricks_mws_networks[\"networkId\"],\n private_access_settings_id=pas[\"privateAccessSettingsId\"],\n pricing_tier=\"PREMIUM\",\n opts = pulumi.ResourceOptions(depends_on=[this_databricks_mws_networks]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.MwsWorkspaces(\"this\", new()\n {\n WorkspaceName = \"gcp-workspace\",\n Location = subnetRegion,\n CloudResourceContainer = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerArgs\n {\n Gcp = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerGcpArgs\n {\n ProjectId = googleProject,\n },\n },\n NetworkId = thisDatabricksMwsNetworks.NetworkId,\n PrivateAccessSettingsId = pas.PrivateAccessSettingsId,\n PricingTier = \"PREMIUM\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n thisDatabricksMwsNetworks,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsWorkspaces(ctx, \"this\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tWorkspaceName: pulumi.String(\"gcp-workspace\"),\n\t\t\tLocation: pulumi.Any(subnetRegion),\n\t\t\tCloudResourceContainer: \u0026databricks.MwsWorkspacesCloudResourceContainerArgs{\n\t\t\t\tGcp: \u0026databricks.MwsWorkspacesCloudResourceContainerGcpArgs{\n\t\t\t\t\tProjectId: pulumi.Any(googleProject),\n\t\t\t\t},\n\t\t\t},\n\t\t\tNetworkId: pulumi.Any(thisDatabricksMwsNetworks.NetworkId),\n\t\t\tPrivateAccessSettingsId: pulumi.Any(pas.PrivateAccessSettingsId),\n\t\t\tPricingTier: pulumi.String(\"PREMIUM\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthisDatabricksMwsNetworks,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsworkspaces\" \"this\" {\n depends_on = [thisDatabricksMwsNetworks]\n workspace_name = \"gcp-workspace\"\n location = subnetRegion\n cloud_resource_container = {\n gcp = {\n project_id = googleProject\n }\n }\n network_id = thisDatabricksMwsNetworks.networkId\n private_access_settings_id = pas.privateAccessSettingsId\n pricing_tier = \"PREMIUM\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport com.pulumi.databricks.inputs.MwsWorkspacesCloudResourceContainerArgs;\nimport com.pulumi.databricks.inputs.MwsWorkspacesCloudResourceContainerGcpArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new MwsWorkspaces(\"this\", MwsWorkspacesArgs.builder()\n .workspaceName(\"gcp-workspace\")\n .location(subnetRegion)\n .cloudResourceContainer(MwsWorkspacesCloudResourceContainerArgs.builder()\n .gcp(MwsWorkspacesCloudResourceContainerGcpArgs.builder()\n .projectId(googleProject)\n .build())\n .build())\n .networkId(thisDatabricksMwsNetworks.networkId())\n .privateAccessSettingsId(pas.privateAccessSettingsId())\n .pricingTier(\"PREMIUM\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(thisDatabricksMwsNetworks)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MwsWorkspaces\n properties:\n workspaceName: gcp-workspace\n location: ${subnetRegion}\n cloudResourceContainer:\n gcp:\n projectId: ${googleProject}\n networkId: ${thisDatabricksMwsNetworks.networkId}\n privateAccessSettingsId: ${pas.privateAccessSettingsId}\n pricingTier: PREMIUM\n options:\n dependsOn:\n - ${thisDatabricksMwsNetworks}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n* Provisioning Databricks on AWS with Private Link guide.\n* Provisioning AWS Databricks workspaces with a Hub \u0026 Spoke firewall for data exfiltration protection guide.\n* Provisioning Databricks workspaces on GCP with Private Service Connect guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003eto register\u003cspan pulumi-lang-nodejs=\" awsVpcEndpoint \" pulumi-lang-dotnet=\" AwsVpcEndpoint \" pulumi-lang-go=\" awsVpcEndpoint \" pulumi-lang-python=\" aws_vpc_endpoint \" pulumi-lang-yaml=\" awsVpcEndpoint \" pulumi-lang-java=\" awsVpcEndpoint \" pulumi-lang-hcl=\" aws_vpc_endpoint \"\u003e awsVpcEndpoint \u003c/span\u003eresources with Databricks such that they can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003econfiguration.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n", "properties": { "accountId": { "type": "string", "deprecationMessage": "Configuring \u003cspan pulumi-lang-nodejs=\"`accountId`\" pulumi-lang-dotnet=\"`AccountId`\" pulumi-lang-go=\"`accountId`\" pulumi-lang-python=\"`account_id`\" pulumi-lang-yaml=\"`accountId`\" pulumi-lang-java=\"`accountId`\" pulumi-lang-hcl=\"`account_id`\"\u003e`accountId`\u003c/span\u003e at the resource-level is deprecated; please specify it in the `provider {}` configuration block instead" }, "allowedVpcEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "An array of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003e\u003cspan pulumi-lang-nodejs=\"`vpcEndpointId`\" pulumi-lang-dotnet=\"`VpcEndpointId`\" pulumi-lang-go=\"`vpcEndpointId`\" pulumi-lang-python=\"`vpc_endpoint_id`\" pulumi-lang-yaml=\"`vpcEndpointId`\" pulumi-lang-java=\"`vpcEndpointId`\" pulumi-lang-hcl=\"`vpc_endpoint_id`\"\u003e`vpcEndpointId`\u003c/span\u003e (not \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e). Only used when \u003cspan pulumi-lang-nodejs=\"`privateAccessLevel`\" pulumi-lang-dotnet=\"`PrivateAccessLevel`\" pulumi-lang-go=\"`privateAccessLevel`\" pulumi-lang-python=\"`private_access_level`\" pulumi-lang-yaml=\"`privateAccessLevel`\" pulumi-lang-java=\"`privateAccessLevel`\" pulumi-lang-hcl=\"`private_access_level`\"\u003e`privateAccessLevel`\u003c/span\u003e is set to `ENDPOINT`. This is an allow list of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003ethat in your account that can connect to your\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eover AWS PrivateLink. If hybrid access to your workspace is enabled by setting \u003cspan pulumi-lang-nodejs=\"`publicAccessEnabled`\" pulumi-lang-dotnet=\"`PublicAccessEnabled`\" pulumi-lang-go=\"`publicAccessEnabled`\" pulumi-lang-python=\"`public_access_enabled`\" pulumi-lang-yaml=\"`publicAccessEnabled`\" pulumi-lang-java=\"`publicAccessEnabled`\" pulumi-lang-hcl=\"`public_access_enabled`\"\u003e`publicAccessEnabled`\u003c/span\u003e to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.\n" }, "privateAccessLevel": { "type": "string", "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. `ACCOUNT` level access _(default)_ lets only\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003ethat are registered in your Databricks account connect to your databricks_mws_workspaces. `ENDPOINT` level access lets only specified\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003econnect to your workspace. Please see the \u003cspan pulumi-lang-nodejs=\"`allowedVpcEndpointIds`\" pulumi-lang-dotnet=\"`AllowedVpcEndpointIds`\" pulumi-lang-go=\"`allowedVpcEndpointIds`\" pulumi-lang-python=\"`allowed_vpc_endpoint_ids`\" pulumi-lang-yaml=\"`allowedVpcEndpointIds`\" pulumi-lang-java=\"`allowedVpcEndpointIds`\" pulumi-lang-hcl=\"`allowed_vpc_endpoint_ids`\"\u003e`allowedVpcEndpointIds`\u003c/span\u003e documentation for more details.\n" }, "privateAccessSettingsId": { "type": "string", "description": "Canonical unique identifier of Private Access Settings in Databricks Account\n" }, "privateAccessSettingsName": { "type": "string", "description": "Name of Private Access Settings in Databricks Account\n" }, "publicAccessEnabled": { "type": "boolean", "description": "If \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003ecan be accessed over the\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003eas well as over the public network. In such a case, you could also configure an\u003cspan pulumi-lang-nodejs=\" databricks.IpAccessList \" pulumi-lang-dotnet=\" databricks.IpAccessList \" pulumi-lang-go=\" IpAccessList \" pulumi-lang-python=\" IpAccessList \" pulumi-lang-yaml=\" databricks.IpAccessList \" pulumi-lang-java=\" databricks.IpAccessList \" pulumi-lang-hcl=\" databricks_ip_access_list \"\u003e databricks.IpAccessList \u003c/span\u003efor the workspace, to restrict the source networks that could be used to access it over the public network. If \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, the workspace can be accessed only over VPC endpoints, and not over the public network. Once explicitly set, this field becomes mandatory.\n" }, "region": { "type": "string", "description": "Region of AWS VPC or the Google Cloud VPC network\n" } }, "required": [ "accountId", "privateAccessSettingsId", "privateAccessSettingsName", "region" ], "inputProperties": { "accountId": { "type": "string", "deprecationMessage": "Configuring \u003cspan pulumi-lang-nodejs=\"`accountId`\" pulumi-lang-dotnet=\"`AccountId`\" pulumi-lang-go=\"`accountId`\" pulumi-lang-python=\"`account_id`\" pulumi-lang-yaml=\"`accountId`\" pulumi-lang-java=\"`accountId`\" pulumi-lang-hcl=\"`account_id`\"\u003e`accountId`\u003c/span\u003e at the resource-level is deprecated; please specify it in the `provider {}` configuration block instead" }, "allowedVpcEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "An array of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003e\u003cspan pulumi-lang-nodejs=\"`vpcEndpointId`\" pulumi-lang-dotnet=\"`VpcEndpointId`\" pulumi-lang-go=\"`vpcEndpointId`\" pulumi-lang-python=\"`vpc_endpoint_id`\" pulumi-lang-yaml=\"`vpcEndpointId`\" pulumi-lang-java=\"`vpcEndpointId`\" pulumi-lang-hcl=\"`vpc_endpoint_id`\"\u003e`vpcEndpointId`\u003c/span\u003e (not \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e). Only used when \u003cspan pulumi-lang-nodejs=\"`privateAccessLevel`\" pulumi-lang-dotnet=\"`PrivateAccessLevel`\" pulumi-lang-go=\"`privateAccessLevel`\" pulumi-lang-python=\"`private_access_level`\" pulumi-lang-yaml=\"`privateAccessLevel`\" pulumi-lang-java=\"`privateAccessLevel`\" pulumi-lang-hcl=\"`private_access_level`\"\u003e`privateAccessLevel`\u003c/span\u003e is set to `ENDPOINT`. This is an allow list of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003ethat in your account that can connect to your\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eover AWS PrivateLink. If hybrid access to your workspace is enabled by setting \u003cspan pulumi-lang-nodejs=\"`publicAccessEnabled`\" pulumi-lang-dotnet=\"`PublicAccessEnabled`\" pulumi-lang-go=\"`publicAccessEnabled`\" pulumi-lang-python=\"`public_access_enabled`\" pulumi-lang-yaml=\"`publicAccessEnabled`\" pulumi-lang-java=\"`publicAccessEnabled`\" pulumi-lang-hcl=\"`public_access_enabled`\"\u003e`publicAccessEnabled`\u003c/span\u003e to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.\n" }, "privateAccessLevel": { "type": "string", "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. `ACCOUNT` level access _(default)_ lets only\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003ethat are registered in your Databricks account connect to your databricks_mws_workspaces. `ENDPOINT` level access lets only specified\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003econnect to your workspace. Please see the \u003cspan pulumi-lang-nodejs=\"`allowedVpcEndpointIds`\" pulumi-lang-dotnet=\"`AllowedVpcEndpointIds`\" pulumi-lang-go=\"`allowedVpcEndpointIds`\" pulumi-lang-python=\"`allowed_vpc_endpoint_ids`\" pulumi-lang-yaml=\"`allowedVpcEndpointIds`\" pulumi-lang-java=\"`allowedVpcEndpointIds`\" pulumi-lang-hcl=\"`allowed_vpc_endpoint_ids`\"\u003e`allowedVpcEndpointIds`\u003c/span\u003e documentation for more details.\n" }, "privateAccessSettingsId": { "type": "string", "description": "Canonical unique identifier of Private Access Settings in Databricks Account\n" }, "privateAccessSettingsName": { "type": "string", "description": "Name of Private Access Settings in Databricks Account\n" }, "publicAccessEnabled": { "type": "boolean", "description": "If \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003ecan be accessed over the\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003eas well as over the public network. In such a case, you could also configure an\u003cspan pulumi-lang-nodejs=\" databricks.IpAccessList \" pulumi-lang-dotnet=\" databricks.IpAccessList \" pulumi-lang-go=\" IpAccessList \" pulumi-lang-python=\" IpAccessList \" pulumi-lang-yaml=\" databricks.IpAccessList \" pulumi-lang-java=\" databricks.IpAccessList \" pulumi-lang-hcl=\" databricks_ip_access_list \"\u003e databricks.IpAccessList \u003c/span\u003efor the workspace, to restrict the source networks that could be used to access it over the public network. If \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, the workspace can be accessed only over VPC endpoints, and not over the public network. Once explicitly set, this field becomes mandatory.\n" }, "region": { "type": "string", "description": "Region of AWS VPC or the Google Cloud VPC network\n" } }, "requiredInputs": [ "privateAccessSettingsName", "region" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsPrivateAccessSettings resources.\n", "properties": { "accountId": { "type": "string", "deprecationMessage": "Configuring \u003cspan pulumi-lang-nodejs=\"`accountId`\" pulumi-lang-dotnet=\"`AccountId`\" pulumi-lang-go=\"`accountId`\" pulumi-lang-python=\"`account_id`\" pulumi-lang-yaml=\"`accountId`\" pulumi-lang-java=\"`accountId`\" pulumi-lang-hcl=\"`account_id`\"\u003e`accountId`\u003c/span\u003e at the resource-level is deprecated; please specify it in the `provider {}` configuration block instead" }, "allowedVpcEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "An array of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003e\u003cspan pulumi-lang-nodejs=\"`vpcEndpointId`\" pulumi-lang-dotnet=\"`VpcEndpointId`\" pulumi-lang-go=\"`vpcEndpointId`\" pulumi-lang-python=\"`vpc_endpoint_id`\" pulumi-lang-yaml=\"`vpcEndpointId`\" pulumi-lang-java=\"`vpcEndpointId`\" pulumi-lang-hcl=\"`vpc_endpoint_id`\"\u003e`vpcEndpointId`\u003c/span\u003e (not \u003cspan pulumi-lang-nodejs=\"`id`\" pulumi-lang-dotnet=\"`Id`\" pulumi-lang-go=\"`id`\" pulumi-lang-python=\"`id`\" pulumi-lang-yaml=\"`id`\" pulumi-lang-java=\"`id`\" pulumi-lang-hcl=\"`id`\"\u003e`id`\u003c/span\u003e). Only used when \u003cspan pulumi-lang-nodejs=\"`privateAccessLevel`\" pulumi-lang-dotnet=\"`PrivateAccessLevel`\" pulumi-lang-go=\"`privateAccessLevel`\" pulumi-lang-python=\"`private_access_level`\" pulumi-lang-yaml=\"`privateAccessLevel`\" pulumi-lang-java=\"`privateAccessLevel`\" pulumi-lang-hcl=\"`private_access_level`\"\u003e`privateAccessLevel`\u003c/span\u003e is set to `ENDPOINT`. This is an allow list of\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003ethat in your account that can connect to your\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eover AWS PrivateLink. If hybrid access to your workspace is enabled by setting \u003cspan pulumi-lang-nodejs=\"`publicAccessEnabled`\" pulumi-lang-dotnet=\"`PublicAccessEnabled`\" pulumi-lang-go=\"`publicAccessEnabled`\" pulumi-lang-python=\"`public_access_enabled`\" pulumi-lang-yaml=\"`publicAccessEnabled`\" pulumi-lang-java=\"`publicAccessEnabled`\" pulumi-lang-hcl=\"`public_access_enabled`\"\u003e`publicAccessEnabled`\u003c/span\u003e to true, then this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see the article for databricks_ip_access_list.\n" }, "privateAccessLevel": { "type": "string", "description": "The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. `ACCOUNT` level access _(default)_ lets only\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003ethat are registered in your Databricks account connect to your databricks_mws_workspaces. `ENDPOINT` level access lets only specified\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003econnect to your workspace. Please see the \u003cspan pulumi-lang-nodejs=\"`allowedVpcEndpointIds`\" pulumi-lang-dotnet=\"`AllowedVpcEndpointIds`\" pulumi-lang-go=\"`allowedVpcEndpointIds`\" pulumi-lang-python=\"`allowed_vpc_endpoint_ids`\" pulumi-lang-yaml=\"`allowedVpcEndpointIds`\" pulumi-lang-java=\"`allowedVpcEndpointIds`\" pulumi-lang-hcl=\"`allowed_vpc_endpoint_ids`\"\u003e`allowedVpcEndpointIds`\u003c/span\u003e documentation for more details.\n" }, "privateAccessSettingsId": { "type": "string", "description": "Canonical unique identifier of Private Access Settings in Databricks Account\n" }, "privateAccessSettingsName": { "type": "string", "description": "Name of Private Access Settings in Databricks Account\n" }, "publicAccessEnabled": { "type": "boolean", "description": "If \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003ecan be accessed over the\u003cspan pulumi-lang-nodejs=\" databricks.MwsVpcEndpoint \" pulumi-lang-dotnet=\" databricks.MwsVpcEndpoint \" pulumi-lang-go=\" MwsVpcEndpoint \" pulumi-lang-python=\" MwsVpcEndpoint \" pulumi-lang-yaml=\" databricks.MwsVpcEndpoint \" pulumi-lang-java=\" databricks.MwsVpcEndpoint \" pulumi-lang-hcl=\" databricks_mws_vpc_endpoint \"\u003e databricks.MwsVpcEndpoint \u003c/span\u003eas well as over the public network. In such a case, you could also configure an\u003cspan pulumi-lang-nodejs=\" databricks.IpAccessList \" pulumi-lang-dotnet=\" databricks.IpAccessList \" pulumi-lang-go=\" IpAccessList \" pulumi-lang-python=\" IpAccessList \" pulumi-lang-yaml=\" databricks.IpAccessList \" pulumi-lang-java=\" databricks.IpAccessList \" pulumi-lang-hcl=\" databricks_ip_access_list \"\u003e databricks.IpAccessList \u003c/span\u003efor the workspace, to restrict the source networks that could be used to access it over the public network. If \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, the workspace can be accessed only over VPC endpoints, and not over the public network. Once explicitly set, this field becomes mandatory.\n" }, "region": { "type": "string", "description": "Region of AWS VPC or the Google Cloud VPC network\n" } }, "type": "object" } }, "databricks:index/mwsStorageConfigurations:MwsStorageConfigurations": { "description": "This resource to configure root bucket new workspaces within AWS.\n\n\u003e This resource can only be used with an account-level provider!\n\nIt is important to understand that this will require you to configure your provider separately for the multiple workspaces resources. This will point to \u003chttps://accounts.cloud.databricks.com\u003e for the HOST and it will use basic auth as that is the only authentication method available for multiple workspaces api.\n\nPlease follow this complete runnable example with new VPC and new workspace setup. Please pay special attention to the fact that there you have two different instances of a databricks provider - one for deploying workspaces (with `host=\"https://accounts.cloud.databricks.com/\"`) and another for the workspace you've created with\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource. If you want both creation of workspaces \u0026 clusters within workspace within the same terraform module (essentially same directory), you should use the provider aliasing feature of Pulumi. We strongly recommend having one terraform module for creation of workspace + PAT token and the rest in different modules.\n\n## Example Usage\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\nconst rootStorageBucket = new aws.index.S3Bucket(\"root_storage_bucket\", {\n bucket: `${prefix}-rootbucket`,\n acl: \"private\",\n});\nconst rootVersioning = new aws.index.S3BucketVersioning(\"root_versioning\", {\n bucket: rootStorageBucket.id,\n versioningConfiguration: [{\n status: \"Disabled\",\n }],\n});\nconst _this = new databricks.MwsStorageConfigurations(\"this\", {\n accountId: databricksAccountId,\n storageConfigurationName: `${prefix}-storage`,\n bucketName: rootStorageBucket.bucket,\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\nroot_storage_bucket = aws.S3Bucket(\"root_storage_bucket\",\n bucket=f{prefix}-rootbucket,\n acl=private)\nroot_versioning = aws.S3BucketVersioning(\"root_versioning\",\n bucket=root_storage_bucket.id,\n versioning_configuration=[{\n status: Disabled,\n }])\nthis = databricks.MwsStorageConfigurations(\"this\",\n account_id=databricks_account_id,\n storage_configuration_name=f\"{prefix}-storage\",\n bucket_name=root_storage_bucket[\"bucket\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n var rootStorageBucket = new Aws.S3Bucket(\"root_storage_bucket\", new()\n {\n Bucket = $\"{prefix}-rootbucket\",\n Acl = \"private\",\n });\n\n var rootVersioning = new Aws.S3BucketVersioning(\"root_versioning\", new()\n {\n Bucket = rootStorageBucket.Id,\n VersioningConfiguration = new[]\n {\n \n {\n { \"status\", \"Disabled\" },\n },\n },\n });\n\n var @this = new Databricks.MwsStorageConfigurations(\"this\", new()\n {\n AccountId = databricksAccountId,\n StorageConfigurationName = $\"{prefix}-storage\",\n BucketName = rootStorageBucket.Bucket,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-aws/sdk/v7/go/aws\"\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\trootStorageBucket, err := aws.NewS3Bucket(ctx, \"root_storage_bucket\", \u0026aws.S3BucketArgs{\n\t\t\tBucket: fmt.Sprintf(\"%v-rootbucket\", prefix),\n\t\t\tAcl: \"private\",\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewS3BucketVersioning(ctx, \"root_versioning\", \u0026aws.S3BucketVersioningArgs{\n\t\t\tBucket: rootStorageBucket.Id,\n\t\t\tVersioningConfiguration: []map[string]interface{}{\n\t\t\t\tmap[string]interface{}{\n\t\t\t\t\t\"status\": \"Disabled\",\n\t\t\t\t},\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsStorageConfigurations(ctx, \"this\", \u0026databricks.MwsStorageConfigurationsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tStorageConfigurationName: pulumi.Sprintf(\"%v-storage\", prefix),\n\t\t\tBucketName: rootStorageBucket.Bucket,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n aws = {\n source = \"pulumi/aws\"\n }\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"aws_s3bucket\" \"root_storage_bucket\" {\n bucket =\"${prefix}-rootbucket\"\n acl = \"private\"\n}\nresource \"aws_s3bucketversioning\" \"root_versioning\" {\n bucket = aws_s3bucket.root_storage_bucket.id\n versioning_configuration = [{\n \"status\" = \"Disabled\"\n }]\n}\nresource \"databricks_mwsstorageconfigurations\" \"this\" {\n account_id = var.databricksAccountId\n storage_configuration_name =\"${prefix}-storage\"\n bucket_name = aws_s3bucket.root_storage_bucket.bucket\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.S3Bucket;\nimport com.pulumi.aws.S3BucketArgs;\nimport com.pulumi.aws.S3BucketVersioning;\nimport com.pulumi.aws.S3BucketVersioningArgs;\nimport com.pulumi.databricks.MwsStorageConfigurations;\nimport com.pulumi.databricks.MwsStorageConfigurationsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n var rootStorageBucket = new S3Bucket(\"rootStorageBucket\", S3BucketArgs.builder()\n .bucket(String.format(\"%s-rootbucket\", prefix))\n .acl(\"private\")\n .build());\n\n var rootVersioning = new S3BucketVersioning(\"rootVersioning\", S3BucketVersioningArgs.builder()\n .bucket(rootStorageBucket.id())\n .versioningConfiguration(Arrays.asList(Map.of(\"status\", \"Disabled\")))\n .build());\n\n var this_ = new MwsStorageConfigurations(\"this\", MwsStorageConfigurationsArgs.builder()\n .accountId(databricksAccountId)\n .storageConfigurationName(String.format(\"%s-storage\", prefix))\n .bucketName(rootStorageBucket.bucket())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\nresources:\n rootStorageBucket:\n type: aws:S3Bucket\n name: root_storage_bucket\n properties:\n bucket: ${prefix}-rootbucket\n acl: private\n rootVersioning:\n type: aws:S3BucketVersioning\n name: root_versioning\n properties:\n bucket: ${rootStorageBucket.id}\n versioningConfiguration:\n - status: Disabled\n this:\n type: databricks:MwsStorageConfigurations\n properties:\n accountId: ${databricksAccountId}\n storageConfigurationName: ${prefix}-storage\n bucketName: ${rootStorageBucket.bucket}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Example Usage with Role ARN\n\nWhen sharing an S3 bucket between root storage and a Unity Catalog metastore, you can specify a role ARN:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.MwsStorageConfigurations(\"this\", {\n accountId: databricksAccountId,\n storageConfigurationName: `${prefix}-storage`,\n bucketName: rootStorageBucket.bucket,\n roleArn: unityCatalogRole.arn,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.MwsStorageConfigurations(\"this\",\n account_id=databricks_account_id,\n storage_configuration_name=f\"{prefix}-storage\",\n bucket_name=root_storage_bucket[\"bucket\"],\n role_arn=unity_catalog_role[\"arn\"])\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.MwsStorageConfigurations(\"this\", new()\n {\n AccountId = databricksAccountId,\n StorageConfigurationName = $\"{prefix}-storage\",\n BucketName = rootStorageBucket.Bucket,\n RoleArn = unityCatalogRole.Arn,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsStorageConfigurations(ctx, \"this\", \u0026databricks.MwsStorageConfigurationsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tStorageConfigurationName: pulumi.Sprintf(\"%v-storage\", prefix),\n\t\t\tBucketName: pulumi.Any(rootStorageBucket.Bucket),\n\t\t\tRoleArn: pulumi.Any(unityCatalogRole.Arn),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsstorageconfigurations\" \"this\" {\n account_id = databricksAccountId\n storage_configuration_name =\"${prefix}-storage\"\n bucket_name = rootStorageBucket.bucket\n role_arn = unityCatalogRole.arn\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsStorageConfigurations;\nimport com.pulumi.databricks.MwsStorageConfigurationsArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new MwsStorageConfigurations(\"this\", MwsStorageConfigurationsArgs.builder()\n .accountId(databricksAccountId)\n .storageConfigurationName(String.format(\"%s-storage\", prefix))\n .bucketName(rootStorageBucket.bucket())\n .roleArn(unityCatalogRole.arn())\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MwsStorageConfigurations\n properties:\n accountId: ${databricksAccountId}\n storageConfigurationName: ${prefix}-storage\n bucketName: ${rootStorageBucket.bucket}\n roleArn: ${unityCatalogRole.arn}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n* Provisioning Databricks on AWS with Private Link guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCredentials \" pulumi-lang-dotnet=\" databricks.MwsCredentials \" pulumi-lang-go=\" MwsCredentials \" pulumi-lang-python=\" MwsCredentials \" pulumi-lang-yaml=\" databricks.MwsCredentials \" pulumi-lang-java=\" databricks.MwsCredentials \" pulumi-lang-hcl=\" databricks_mws_credentials \"\u003e databricks.MwsCredentials \u003c/span\u003eto configure the cross-account role for creation of new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-dotnet=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-go=\" MwsCustomerManagedKeys \" pulumi-lang-python=\" MwsCustomerManagedKeys \" pulumi-lang-yaml=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-java=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-hcl=\" databricks_mws_customer_managed_keys \"\u003e databricks.MwsCustomerManagedKeys \u003c/span\u003eto configure KMS keys for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsLogDelivery \" pulumi-lang-dotnet=\" databricks.MwsLogDelivery \" pulumi-lang-go=\" MwsLogDelivery \" pulumi-lang-python=\" MwsLogDelivery \" pulumi-lang-yaml=\" databricks.MwsLogDelivery \" pulumi-lang-java=\" databricks.MwsLogDelivery \" pulumi-lang-hcl=\" databricks_mws_log_delivery \"\u003e databricks.MwsLogDelivery \u003c/span\u003eto configure delivery of [billable usage logs](https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html) and [audit logs](https://docs.databricks.com/administration-guide/account-settings/audit-logs.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "secret": true }, "bucketName": { "type": "string", "description": "name of AWS S3 bucket\n" }, "creationTime": { "type": "integer" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that Databricks will assume to access the S3 bucket. This allows sharing an S3 bucket between root storage and the default catalog for a workspace. See the [Databricks API documentation](https://docs.databricks.com/api/account/storage/create) for more details.\n" }, "storageConfigurationId": { "type": "string", "description": "(String) id of storage config to be used for \u003cspan pulumi-lang-nodejs=\"`databricksMwsWorkspace`\" pulumi-lang-dotnet=\"`DatabricksMwsWorkspace`\" pulumi-lang-go=\"`databricksMwsWorkspace`\" pulumi-lang-python=\"`databricks_mws_workspace`\" pulumi-lang-yaml=\"`databricksMwsWorkspace`\" pulumi-lang-java=\"`databricksMwsWorkspace`\" pulumi-lang-hcl=\"`databricks_mws_workspace`\"\u003e`databricksMwsWorkspace`\u003c/span\u003e resource.\n" }, "storageConfigurationName": { "type": "string", "description": "name under which this storage configuration is stored\n\nThe following arguments are optional:\n" } }, "required": [ "accountId", "bucketName", "creationTime", "storageConfigurationId", "storageConfigurationName" ], "inputProperties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "secret": true, "willReplaceOnChanges": true }, "bucketName": { "type": "string", "description": "name of AWS S3 bucket\n", "willReplaceOnChanges": true }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that Databricks will assume to access the S3 bucket. This allows sharing an S3 bucket between root storage and the default catalog for a workspace. See the [Databricks API documentation](https://docs.databricks.com/api/account/storage/create) for more details.\n", "willReplaceOnChanges": true }, "storageConfigurationName": { "type": "string", "description": "name under which this storage configuration is stored\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "accountId", "bucketName", "storageConfigurationName" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsStorageConfigurations resources.\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the top right corner of [Accounts Console](https://accounts.cloud.databricks.com/)\n", "secret": true, "willReplaceOnChanges": true }, "bucketName": { "type": "string", "description": "name of AWS S3 bucket\n", "willReplaceOnChanges": true }, "creationTime": { "type": "integer" }, "roleArn": { "type": "string", "description": "The ARN of the IAM role that Databricks will assume to access the S3 bucket. This allows sharing an S3 bucket between root storage and the default catalog for a workspace. See the [Databricks API documentation](https://docs.databricks.com/api/account/storage/create) for more details.\n", "willReplaceOnChanges": true }, "storageConfigurationId": { "type": "string", "description": "(String) id of storage config to be used for \u003cspan pulumi-lang-nodejs=\"`databricksMwsWorkspace`\" pulumi-lang-dotnet=\"`DatabricksMwsWorkspace`\" pulumi-lang-go=\"`databricksMwsWorkspace`\" pulumi-lang-python=\"`databricks_mws_workspace`\" pulumi-lang-yaml=\"`databricksMwsWorkspace`\" pulumi-lang-java=\"`databricksMwsWorkspace`\" pulumi-lang-hcl=\"`databricks_mws_workspace`\"\u003e`databricksMwsWorkspace`\u003c/span\u003e resource.\n" }, "storageConfigurationName": { "type": "string", "description": "name under which this storage configuration is stored\n\nThe following arguments are optional:\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsVpcEndpoint:MwsVpcEndpoint": { "description": "Enables you to register\u003cspan pulumi-lang-nodejs=\" awsVpcEndpoint \" pulumi-lang-dotnet=\" AwsVpcEndpoint \" pulumi-lang-go=\" awsVpcEndpoint \" pulumi-lang-python=\" aws_vpc_endpoint \" pulumi-lang-yaml=\" awsVpcEndpoint \" pulumi-lang-java=\" awsVpcEndpoint \" pulumi-lang-hcl=\" aws_vpc_endpoint \"\u003e awsVpcEndpoint \u003c/span\u003eresources or gcp\u003cspan pulumi-lang-nodejs=\" vpcEndpoint \" pulumi-lang-dotnet=\" VpcEndpoint \" pulumi-lang-go=\" vpcEndpoint \" pulumi-lang-python=\" vpc_endpoint \" pulumi-lang-yaml=\" vpcEndpoint \" pulumi-lang-java=\" vpcEndpoint \" pulumi-lang-hcl=\" vpc_endpoint \"\u003e vpcEndpoint \u003c/span\u003eresources with Databricks such that they can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003econfiguration.\n\n\u003e This resource can only be used with an account-level provider!\n\nIt is strongly recommended that customers read the [Enable AWS Private Link](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html) or the [Enable GCP Private Service Connect](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html) documentation before trying to leverage this resource.\n\n## Example Usage\n\n### Databricks on AWS usage\n\nBefore using this resource, you will need to create the necessary VPC Endpoints as per your [VPC endpoint requirements](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#vpc-endpoint-requirements). You can use the\u003cspan pulumi-lang-nodejs=\" awsVpcEndpoint \" pulumi-lang-dotnet=\" AwsVpcEndpoint \" pulumi-lang-go=\" awsVpcEndpoint \" pulumi-lang-python=\" aws_vpc_endpoint \" pulumi-lang-yaml=\" awsVpcEndpoint \" pulumi-lang-java=\" awsVpcEndpoint \" pulumi-lang-hcl=\" aws_vpc_endpoint \"\u003e awsVpcEndpoint \u003c/span\u003eresource for this, for example:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst workspace = new aws.index.VpcEndpoint(\"workspace\", {\n vpcId: vpc.vpcId,\n serviceName: privateLink.workspaceService,\n vpcEndpointType: \"Interface\",\n securityGroupIds: [vpc.defaultSecurityGroupId],\n subnetIds: [plSubnet.id],\n privateDnsEnabled: true,\n}, {\n dependsOn: [plSubnet],\n});\nconst relay = new aws.index.VpcEndpoint(\"relay\", {\n vpcId: vpc.vpcId,\n serviceName: privateLink.relayService,\n vpcEndpointType: \"Interface\",\n securityGroupIds: [vpc.defaultSecurityGroupId],\n subnetIds: [plSubnet.id],\n privateDnsEnabled: true,\n}, {\n dependsOn: [plSubnet],\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\nworkspace = aws.VpcEndpoint(\"workspace\",\n vpc_id=vpc.vpc_id,\n service_name=private_link.workspace_service,\n vpc_endpoint_type=Interface,\n security_group_ids=[vpc.default_security_group_id],\n subnet_ids=[pl_subnet.id],\n private_dns_enabled=True,\n opts = pulumi.ResourceOptions(depends_on=[pl_subnet]))\nrelay = aws.VpcEndpoint(\"relay\",\n vpc_id=vpc.vpc_id,\n service_name=private_link.relay_service,\n vpc_endpoint_type=Interface,\n security_group_ids=[vpc.default_security_group_id],\n subnet_ids=[pl_subnet.id],\n private_dns_enabled=True,\n opts = pulumi.ResourceOptions(depends_on=[pl_subnet]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var workspace = new Aws.VpcEndpoint(\"workspace\", new()\n {\n VpcId = vpc.VpcId,\n ServiceName = privateLink.WorkspaceService,\n VpcEndpointType = \"Interface\",\n SecurityGroupIds = new[]\n {\n vpc.DefaultSecurityGroupId,\n },\n SubnetIds = new[]\n {\n plSubnet.Id,\n },\n PrivateDnsEnabled = true,\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n plSubnet,\n },\n });\n\n var relay = new Aws.VpcEndpoint(\"relay\", new()\n {\n VpcId = vpc.VpcId,\n ServiceName = privateLink.RelayService,\n VpcEndpointType = \"Interface\",\n SecurityGroupIds = new[]\n {\n vpc.DefaultSecurityGroupId,\n },\n SubnetIds = new[]\n {\n plSubnet.Id,\n },\n PrivateDnsEnabled = true,\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n plSubnet,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-aws/sdk/v7/go/aws\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := aws.NewVpcEndpoint(ctx, \"workspace\", \u0026aws.VpcEndpointArgs{\n\t\t\tVpcId: vpc.VpcId,\n\t\t\tServiceName: privateLink.WorkspaceService,\n\t\t\tVpcEndpointType: \"Interface\",\n\t\t\tSecurityGroupIds: []interface{}{\n\t\t\t\tvpc.DefaultSecurityGroupId,\n\t\t\t},\n\t\t\tSubnetIds: []interface{}{\n\t\t\t\tplSubnet.Id,\n\t\t\t},\n\t\t\tPrivateDnsEnabled: true,\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tplSubnet,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewVpcEndpoint(ctx, \"relay\", \u0026aws.VpcEndpointArgs{\n\t\t\tVpcId: vpc.VpcId,\n\t\t\tServiceName: privateLink.RelayService,\n\t\t\tVpcEndpointType: \"Interface\",\n\t\t\tSecurityGroupIds: []interface{}{\n\t\t\t\tvpc.DefaultSecurityGroupId,\n\t\t\t},\n\t\t\tSubnetIds: []interface{}{\n\t\t\t\tplSubnet.Id,\n\t\t\t},\n\t\t\tPrivateDnsEnabled: true,\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tplSubnet,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n aws = {\n source = \"pulumi/aws\"\n }\n }\n}\n\nresource \"aws_vpcendpoint\" \"workspace\" {\n depends_on = [plSubnet]\n vpc_id = vpc.vpcId\n service_name = privateLink.workspaceService\n vpc_endpoint_type = \"Interface\"\n security_group_ids = [vpc.defaultSecurityGroupId]\n subnet_ids = [plSubnet.id]\n private_dns_enabled = true\n}\nresource \"aws_vpcendpoint\" \"relay\" {\n depends_on = [plSubnet]\n vpc_id = vpc.vpcId\n service_name = privateLink.relayService\n vpc_endpoint_type = \"Interface\"\n security_group_ids = [vpc.defaultSecurityGroupId]\n subnet_ids = [plSubnet.id]\n private_dns_enabled = true\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.VpcEndpoint;\nimport com.pulumi.aws.VpcEndpointArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var workspace = new VpcEndpoint(\"workspace\", VpcEndpointArgs.builder()\n .vpcId(vpc.vpcId())\n .serviceName(privateLink.workspaceService())\n .vpcEndpointType(\"Interface\")\n .securityGroupIds(Arrays.asList(vpc.defaultSecurityGroupId()))\n .subnetIds(Arrays.asList(plSubnet.id()))\n .privateDnsEnabled(true)\n .build(), CustomResourceOptions.builder()\n .dependsOn(Arrays.asList(plSubnet))\n .build());\n\n var relay = new VpcEndpoint(\"relay\", VpcEndpointArgs.builder()\n .vpcId(vpc.vpcId())\n .serviceName(privateLink.relayService())\n .vpcEndpointType(\"Interface\")\n .securityGroupIds(Arrays.asList(vpc.defaultSecurityGroupId()))\n .subnetIds(Arrays.asList(plSubnet.id()))\n .privateDnsEnabled(true)\n .build(), CustomResourceOptions.builder()\n .dependsOn(Arrays.asList(plSubnet))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n workspace:\n type: aws:VpcEndpoint\n properties:\n vpcId: ${vpc.vpcId}\n serviceName: ${privateLink.workspaceService}\n vpcEndpointType: Interface\n securityGroupIds:\n - ${vpc.defaultSecurityGroupId}\n subnetIds:\n - ${plSubnet.id}\n privateDnsEnabled: true\n options:\n dependsOn:\n - ${plSubnet}\n relay:\n type: aws:VpcEndpoint\n properties:\n vpcId: ${vpc.vpcId}\n serviceName: ${privateLink.relayService}\n vpcEndpointType: Interface\n securityGroupIds:\n - ${vpc.defaultSecurityGroupId}\n subnetIds:\n - ${plSubnet.id}\n privateDnsEnabled: true\n options:\n dependsOn:\n - ${plSubnet}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nDepending on your use case, you may need or choose to add VPC Endpoints for the AWS Services Databricks uses. See [Add VPC endpoints for other AWS services (recommended but optional)\n](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#step-9-add-vpc-endpoints-for-other-aws-services-recommended-but-optional) for more information. For example:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\n\nconst s3 = new aws.index.VpcEndpoint(\"s3\", {\n vpcId: vpc.vpcId,\n routeTableIds: vpc.privateRouteTableIds,\n serviceName: `com.amazonaws.${region}.s3`,\n}, {\n dependsOn: [vpc],\n});\nconst sts = new aws.index.VpcEndpoint(\"sts\", {\n vpcId: vpc.vpcId,\n serviceName: `com.amazonaws.${region}.sts`,\n vpcEndpointType: \"Interface\",\n subnetIds: vpc.privateSubnets,\n securityGroupIds: [vpc.defaultSecurityGroupId],\n privateDnsEnabled: true,\n}, {\n dependsOn: [vpc],\n});\nconst kinesis_streams = new aws.index.VpcEndpoint(\"kinesis-streams\", {\n vpcId: vpc.vpcId,\n serviceName: `com.amazonaws.${region}.kinesis-streams`,\n vpcEndpointType: \"Interface\",\n subnetIds: vpc.privateSubnets,\n securityGroupIds: [vpc.defaultSecurityGroupId],\n}, {\n dependsOn: [vpc],\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\n\ns3 = aws.VpcEndpoint(\"s3\",\n vpc_id=vpc.vpc_id,\n route_table_ids=vpc.private_route_table_ids,\n service_name=fcom.amazonaws.{region}.s3,\n opts = pulumi.ResourceOptions(depends_on=[vpc]))\nsts = aws.VpcEndpoint(\"sts\",\n vpc_id=vpc.vpc_id,\n service_name=fcom.amazonaws.{region}.sts,\n vpc_endpoint_type=Interface,\n subnet_ids=vpc.private_subnets,\n security_group_ids=[vpc.default_security_group_id],\n private_dns_enabled=True,\n opts = pulumi.ResourceOptions(depends_on=[vpc]))\nkinesis_streams = aws.VpcEndpoint(\"kinesis-streams\",\n vpc_id=vpc.vpc_id,\n service_name=fcom.amazonaws.{region}.kinesis-streams,\n vpc_endpoint_type=Interface,\n subnet_ids=vpc.private_subnets,\n security_group_ids=[vpc.default_security_group_id],\n opts = pulumi.ResourceOptions(depends_on=[vpc]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Aws = Pulumi.Aws;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var s3 = new Aws.VpcEndpoint(\"s3\", new()\n {\n VpcId = vpc.VpcId,\n RouteTableIds = vpc.PrivateRouteTableIds,\n ServiceName = $\"com.amazonaws.{region}.s3\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n vpc,\n },\n });\n\n var sts = new Aws.VpcEndpoint(\"sts\", new()\n {\n VpcId = vpc.VpcId,\n ServiceName = $\"com.amazonaws.{region}.sts\",\n VpcEndpointType = \"Interface\",\n SubnetIds = vpc.PrivateSubnets,\n SecurityGroupIds = new[]\n {\n vpc.DefaultSecurityGroupId,\n },\n PrivateDnsEnabled = true,\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n vpc,\n },\n });\n\n var kinesis_streams = new Aws.VpcEndpoint(\"kinesis-streams\", new()\n {\n VpcId = vpc.VpcId,\n ServiceName = $\"com.amazonaws.{region}.kinesis-streams\",\n VpcEndpointType = \"Interface\",\n SubnetIds = vpc.PrivateSubnets,\n SecurityGroupIds = new[]\n {\n vpc.DefaultSecurityGroupId,\n },\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n vpc,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\n\t\"github.com/pulumi/pulumi-aws/sdk/v7/go/aws\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := aws.NewVpcEndpoint(ctx, \"s3\", \u0026aws.VpcEndpointArgs{\n\t\t\tVpcId: vpc.VpcId,\n\t\t\tRouteTableIds: vpc.PrivateRouteTableIds,\n\t\t\tServiceName: fmt.Sprintf(\"com.amazonaws.%v.s3\", region),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tvpc,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewVpcEndpoint(ctx, \"sts\", \u0026aws.VpcEndpointArgs{\n\t\t\tVpcId: vpc.VpcId,\n\t\t\tServiceName: fmt.Sprintf(\"com.amazonaws.%v.sts\", region),\n\t\t\tVpcEndpointType: \"Interface\",\n\t\t\tSubnetIds: vpc.PrivateSubnets,\n\t\t\tSecurityGroupIds: []interface{}{\n\t\t\t\tvpc.DefaultSecurityGroupId,\n\t\t\t},\n\t\t\tPrivateDnsEnabled: true,\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tvpc,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = aws.NewVpcEndpoint(ctx, \"kinesis-streams\", \u0026aws.VpcEndpointArgs{\n\t\t\tVpcId: vpc.VpcId,\n\t\t\tServiceName: fmt.Sprintf(\"com.amazonaws.%v.kinesis-streams\", region),\n\t\t\tVpcEndpointType: \"Interface\",\n\t\t\tSubnetIds: vpc.PrivateSubnets,\n\t\t\tSecurityGroupIds: []interface{}{\n\t\t\t\tvpc.DefaultSecurityGroupId,\n\t\t\t},\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tvpc,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n aws = {\n source = \"pulumi/aws\"\n }\n }\n}\n\nresource \"aws_vpcendpoint\" \"s3\" {\n depends_on = [vpc]\n vpc_id = vpc.vpcId\n route_table_ids = vpc.privateRouteTableIds\n service_name =\"com.amazonaws.${region}.s3\"\n}\nresource \"aws_vpcendpoint\" \"sts\" {\n depends_on = [vpc]\n vpc_id = vpc.vpcId\n service_name =\"com.amazonaws.${region}.sts\"\n vpc_endpoint_type = \"Interface\"\n subnet_ids = vpc.privateSubnets\n security_group_ids = [vpc.defaultSecurityGroupId]\n private_dns_enabled = true\n}\nresource \"aws_vpcendpoint\" \"kinesis-streams\" {\n depends_on = [vpc]\n vpc_id = vpc.vpcId\n service_name =\"com.amazonaws.${region}.kinesis-streams\"\n vpc_endpoint_type = \"Interface\"\n subnet_ids = vpc.privateSubnets\n security_group_ids = [vpc.defaultSecurityGroupId]\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.aws.VpcEndpoint;\nimport com.pulumi.aws.VpcEndpointArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var s3 = new VpcEndpoint(\"s3\", VpcEndpointArgs.builder()\n .vpcId(vpc.vpcId())\n .routeTableIds(vpc.privateRouteTableIds())\n .serviceName(String.format(\"com.amazonaws.%s.s3\", region))\n .build(), CustomResourceOptions.builder()\n .dependsOn(Arrays.asList(vpc))\n .build());\n\n var sts = new VpcEndpoint(\"sts\", VpcEndpointArgs.builder()\n .vpcId(vpc.vpcId())\n .serviceName(String.format(\"com.amazonaws.%s.sts\", region))\n .vpcEndpointType(\"Interface\")\n .subnetIds(vpc.privateSubnets())\n .securityGroupIds(Arrays.asList(vpc.defaultSecurityGroupId()))\n .privateDnsEnabled(true)\n .build(), CustomResourceOptions.builder()\n .dependsOn(Arrays.asList(vpc))\n .build());\n\n var kinesis_streams = new VpcEndpoint(\"kinesis-streams\", VpcEndpointArgs.builder()\n .vpcId(vpc.vpcId())\n .serviceName(String.format(\"com.amazonaws.%s.kinesis-streams\", region))\n .vpcEndpointType(\"Interface\")\n .subnetIds(vpc.privateSubnets())\n .securityGroupIds(Arrays.asList(vpc.defaultSecurityGroupId()))\n .build(), CustomResourceOptions.builder()\n .dependsOn(Arrays.asList(vpc))\n .build());\n\n }\n}\n```\n```yaml\nresources:\n s3:\n type: aws:VpcEndpoint\n properties:\n vpcId: ${vpc.vpcId}\n routeTableIds: ${vpc.privateRouteTableIds}\n serviceName: com.amazonaws.${region}.s3\n options:\n dependsOn:\n - ${vpc}\n sts:\n type: aws:VpcEndpoint\n properties:\n vpcId: ${vpc.vpcId}\n serviceName: com.amazonaws.${region}.sts\n vpcEndpointType: Interface\n subnetIds: ${vpc.privateSubnets}\n securityGroupIds:\n - ${vpc.defaultSecurityGroupId}\n privateDnsEnabled: true\n options:\n dependsOn:\n - ${vpc}\n kinesis-streams:\n type: aws:VpcEndpoint\n properties:\n vpcId: ${vpc.vpcId}\n serviceName: com.amazonaws.${region}.kinesis-streams\n vpcEndpointType: Interface\n subnetIds: ${vpc.privateSubnets}\n securityGroupIds:\n - ${vpc.defaultSecurityGroupId}\n options:\n dependsOn:\n - ${vpc}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nOnce you have created the necessary endpoints, you need to register each of them via *this* Pulumi resource, which calls out to the [Databricks Account API](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#step-3-register-your-vpc-endpoint-ids-with-the-account-api)):\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst workspace = new databricks.MwsVpcEndpoint(\"workspace\", {\n accountId: databricksAccountId,\n awsVpcEndpointId: workspaceAwsVpcEndpoint.id,\n vpcEndpointName: `VPC Relay for ${vpc.vpcId}`,\n region: region,\n}, {\n dependsOn: [workspaceAwsVpcEndpoint],\n});\nconst relay = new databricks.MwsVpcEndpoint(\"relay\", {\n accountId: databricksAccountId,\n awsVpcEndpointId: relayAwsVpcEndpoint.id,\n vpcEndpointName: `VPC Relay for ${vpc.vpcId}`,\n region: region,\n}, {\n dependsOn: [relayAwsVpcEndpoint],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nworkspace = databricks.MwsVpcEndpoint(\"workspace\",\n account_id=databricks_account_id,\n aws_vpc_endpoint_id=workspace_aws_vpc_endpoint[\"id\"],\n vpc_endpoint_name=f\"VPC Relay for {vpc['vpcId']}\",\n region=region,\n opts = pulumi.ResourceOptions(depends_on=[workspace_aws_vpc_endpoint]))\nrelay = databricks.MwsVpcEndpoint(\"relay\",\n account_id=databricks_account_id,\n aws_vpc_endpoint_id=relay_aws_vpc_endpoint[\"id\"],\n vpc_endpoint_name=f\"VPC Relay for {vpc['vpcId']}\",\n region=region,\n opts = pulumi.ResourceOptions(depends_on=[relay_aws_vpc_endpoint]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var workspace = new Databricks.MwsVpcEndpoint(\"workspace\", new()\n {\n AccountId = databricksAccountId,\n AwsVpcEndpointId = workspaceAwsVpcEndpoint.Id,\n VpcEndpointName = $\"VPC Relay for {vpc.VpcId}\",\n Region = region,\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n workspaceAwsVpcEndpoint,\n },\n });\n\n var relay = new Databricks.MwsVpcEndpoint(\"relay\", new()\n {\n AccountId = databricksAccountId,\n AwsVpcEndpointId = relayAwsVpcEndpoint.Id,\n VpcEndpointName = $\"VPC Relay for {vpc.VpcId}\",\n Region = region,\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n relayAwsVpcEndpoint,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsVpcEndpoint(ctx, \"workspace\", \u0026databricks.MwsVpcEndpointArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tAwsVpcEndpointId: pulumi.Any(workspaceAwsVpcEndpoint.Id),\n\t\t\tVpcEndpointName: pulumi.Sprintf(\"VPC Relay for %v\", vpc.VpcId),\n\t\t\tRegion: pulumi.Any(region),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tworkspaceAwsVpcEndpoint,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsVpcEndpoint(ctx, \"relay\", \u0026databricks.MwsVpcEndpointArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tAwsVpcEndpointId: pulumi.Any(relayAwsVpcEndpoint.Id),\n\t\t\tVpcEndpointName: pulumi.Sprintf(\"VPC Relay for %v\", vpc.VpcId),\n\t\t\tRegion: pulumi.Any(region),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\trelayAwsVpcEndpoint,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsvpcendpoint\" \"workspace\" {\n depends_on = [workspaceAwsVpcEndpoint]\n account_id = databricksAccountId\n aws_vpc_endpoint_id = workspaceAwsVpcEndpoint.id\n vpc_endpoint_name =\"VPC Relay for ${vpc.vpcId}\"\n region = region\n}\nresource \"databricks_mwsvpcendpoint\" \"relay\" {\n depends_on = [relayAwsVpcEndpoint]\n account_id = databricksAccountId\n aws_vpc_endpoint_id = relayAwsVpcEndpoint.id\n vpc_endpoint_name =\"VPC Relay for ${vpc.vpcId}\"\n region = region\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsVpcEndpoint;\nimport com.pulumi.databricks.MwsVpcEndpointArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var workspace = new MwsVpcEndpoint(\"workspace\", MwsVpcEndpointArgs.builder()\n .accountId(databricksAccountId)\n .awsVpcEndpointId(workspaceAwsVpcEndpoint.id())\n .vpcEndpointName(String.format(\"VPC Relay for %s\", vpc.vpcId()))\n .region(region)\n .build(), CustomResourceOptions.builder()\n .dependsOn(workspaceAwsVpcEndpoint)\n .build());\n\n var relay = new MwsVpcEndpoint(\"relay\", MwsVpcEndpointArgs.builder()\n .accountId(databricksAccountId)\n .awsVpcEndpointId(relayAwsVpcEndpoint.id())\n .vpcEndpointName(String.format(\"VPC Relay for %s\", vpc.vpcId()))\n .region(region)\n .build(), CustomResourceOptions.builder()\n .dependsOn(relayAwsVpcEndpoint)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n workspace:\n type: databricks:MwsVpcEndpoint\n properties:\n accountId: ${databricksAccountId}\n awsVpcEndpointId: ${workspaceAwsVpcEndpoint.id}\n vpcEndpointName: VPC Relay for ${vpc.vpcId}\n region: ${region}\n options:\n dependsOn:\n - ${workspaceAwsVpcEndpoint}\n relay:\n type: databricks:MwsVpcEndpoint\n properties:\n accountId: ${databricksAccountId}\n awsVpcEndpointId: ${relayAwsVpcEndpoint.id}\n vpcEndpointName: VPC Relay for ${vpc.vpcId}\n region: ${region}\n options:\n dependsOn:\n - ${relayAwsVpcEndpoint}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nTypically the next steps after this would be to create a\u003cspan pulumi-lang-nodejs=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-dotnet=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-go=\" MwsPrivateAccessSettings \" pulumi-lang-python=\" MwsPrivateAccessSettings \" pulumi-lang-yaml=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-java=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-hcl=\" databricks_mws_private_access_settings \"\u003e databricks.MwsPrivateAccessSettings \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003econfiguration, before passing the `databricks_mws_private_access_settings.pas.private_access_settings_id` and `databricks_mws_networks.this.network_id` into a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.MwsWorkspaces(\"this\", {\n accountId: databricksAccountId,\n awsRegion: region,\n workspaceName: prefix,\n credentialsId: thisDatabricksMwsCredentials.credentialsId,\n storageConfigurationId: thisDatabricksMwsStorageConfigurations.storageConfigurationId,\n networkId: thisDatabricksMwsNetworks.networkId,\n privateAccessSettingsId: pas.privateAccessSettingsId,\n pricingTier: \"ENTERPRISE\",\n}, {\n dependsOn: [thisDatabricksMwsNetworks],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.MwsWorkspaces(\"this\",\n account_id=databricks_account_id,\n aws_region=region,\n workspace_name=prefix,\n credentials_id=this_databricks_mws_credentials[\"credentialsId\"],\n storage_configuration_id=this_databricks_mws_storage_configurations[\"storageConfigurationId\"],\n network_id=this_databricks_mws_networks[\"networkId\"],\n private_access_settings_id=pas[\"privateAccessSettingsId\"],\n pricing_tier=\"ENTERPRISE\",\n opts = pulumi.ResourceOptions(depends_on=[this_databricks_mws_networks]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.MwsWorkspaces(\"this\", new()\n {\n AccountId = databricksAccountId,\n AwsRegion = region,\n WorkspaceName = prefix,\n CredentialsId = thisDatabricksMwsCredentials.CredentialsId,\n StorageConfigurationId = thisDatabricksMwsStorageConfigurations.StorageConfigurationId,\n NetworkId = thisDatabricksMwsNetworks.NetworkId,\n PrivateAccessSettingsId = pas.PrivateAccessSettingsId,\n PricingTier = \"ENTERPRISE\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n thisDatabricksMwsNetworks,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsWorkspaces(ctx, \"this\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tAwsRegion: pulumi.Any(region),\n\t\t\tWorkspaceName: pulumi.Any(prefix),\n\t\t\tCredentialsId: pulumi.Any(thisDatabricksMwsCredentials.CredentialsId),\n\t\t\tStorageConfigurationId: pulumi.Any(thisDatabricksMwsStorageConfigurations.StorageConfigurationId),\n\t\t\tNetworkId: pulumi.Any(thisDatabricksMwsNetworks.NetworkId),\n\t\t\tPrivateAccessSettingsId: pulumi.Any(pas.PrivateAccessSettingsId),\n\t\t\tPricingTier: pulumi.String(\"ENTERPRISE\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthisDatabricksMwsNetworks,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsworkspaces\" \"this\" {\n depends_on = [thisDatabricksMwsNetworks]\n account_id = databricksAccountId\n aws_region = region\n workspace_name = prefix\n credentials_id = thisDatabricksMwsCredentials.credentialsId\n storage_configuration_id = thisDatabricksMwsStorageConfigurations.storageConfigurationId\n network_id = thisDatabricksMwsNetworks.networkId\n private_access_settings_id = pas.privateAccessSettingsId\n pricing_tier = \"ENTERPRISE\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new MwsWorkspaces(\"this\", MwsWorkspacesArgs.builder()\n .accountId(databricksAccountId)\n .awsRegion(region)\n .workspaceName(prefix)\n .credentialsId(thisDatabricksMwsCredentials.credentialsId())\n .storageConfigurationId(thisDatabricksMwsStorageConfigurations.storageConfigurationId())\n .networkId(thisDatabricksMwsNetworks.networkId())\n .privateAccessSettingsId(pas.privateAccessSettingsId())\n .pricingTier(\"ENTERPRISE\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(thisDatabricksMwsNetworks)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MwsWorkspaces\n properties:\n accountId: ${databricksAccountId}\n awsRegion: ${region}\n workspaceName: ${prefix}\n credentialsId: ${thisDatabricksMwsCredentials.credentialsId}\n storageConfigurationId: ${thisDatabricksMwsStorageConfigurations.storageConfigurationId}\n networkId: ${thisDatabricksMwsNetworks.networkId}\n privateAccessSettingsId: ${pas.privateAccessSettingsId}\n pricingTier: ENTERPRISE\n options:\n dependsOn:\n - ${thisDatabricksMwsNetworks}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Databricks on GCP usage\n\n\u003e On GCP, the provider must be authenticated with a Google-issued OIDC token (not a Databricks OAuth token), because creating or updating this resource triggers operations against your GCP project (such as validating the PSC endpoint). See Authenticate with Databricks account API for setup instructions.\n\nBefore using this resource, you will need to create the necessary Private Service Connect (PSC) connections on your Google Cloud VPC networks. You can see [Enable Private Service Connect for your workspace](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html) for more details.\n\nOnce you have created the necessary PSC connections, you need to register each of them via *this* Pulumi resource, which calls out to the Databricks Account API.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in https://accounts.gcp.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\nconst databricksGoogleServiceAccount = config.requireObject\u003cany\u003e(\"databricksGoogleServiceAccount\");\nconst googleProject = config.requireObject\u003cany\u003e(\"googleProject\");\nconst subnetRegion = config.requireObject\u003cany\u003e(\"subnetRegion\");\nconst workspace = new databricks.MwsVpcEndpoint(\"workspace\", {\n accountId: databricksAccountId,\n vpcEndpointName: \"PSC Rest API endpoint\",\n gcpVpcEndpointInfo: {\n projectId: googleProject,\n pscEndpointName: \"PSC Rest API endpoint\",\n endpointRegion: subnetRegion,\n },\n});\nconst relay = new databricks.MwsVpcEndpoint(\"relay\", {\n accountId: databricksAccountId,\n vpcEndpointName: \"PSC Relay endpoint\",\n gcpVpcEndpointInfo: {\n projectId: googleProject,\n pscEndpointName: \"PSC Relay endpoint\",\n endpointRegion: subnetRegion,\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Account Id that could be found in https://accounts.gcp.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\ndatabricks_google_service_account = config.require_object(\"databricksGoogleServiceAccount\")\ngoogle_project = config.require_object(\"googleProject\")\nsubnet_region = config.require_object(\"subnetRegion\")\nworkspace = databricks.MwsVpcEndpoint(\"workspace\",\n account_id=databricks_account_id,\n vpc_endpoint_name=\"PSC Rest API endpoint\",\n gcp_vpc_endpoint_info={\n \"project_id\": google_project,\n \"psc_endpoint_name\": \"PSC Rest API endpoint\",\n \"endpoint_region\": subnet_region,\n })\nrelay = databricks.MwsVpcEndpoint(\"relay\",\n account_id=databricks_account_id,\n vpc_endpoint_name=\"PSC Relay endpoint\",\n gcp_vpc_endpoint_info={\n \"project_id\": google_project,\n \"psc_endpoint_name\": \"PSC Relay endpoint\",\n \"endpoint_region\": subnet_region,\n })\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account Id that could be found in https://accounts.gcp.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n var databricksGoogleServiceAccount = config.RequireObject\u003cdynamic\u003e(\"databricksGoogleServiceAccount\");\n var googleProject = config.RequireObject\u003cdynamic\u003e(\"googleProject\");\n var subnetRegion = config.RequireObject\u003cdynamic\u003e(\"subnetRegion\");\n var workspace = new Databricks.MwsVpcEndpoint(\"workspace\", new()\n {\n AccountId = databricksAccountId,\n VpcEndpointName = \"PSC Rest API endpoint\",\n GcpVpcEndpointInfo = new Databricks.Inputs.MwsVpcEndpointGcpVpcEndpointInfoArgs\n {\n ProjectId = googleProject,\n PscEndpointName = \"PSC Rest API endpoint\",\n EndpointRegion = subnetRegion,\n },\n });\n\n var relay = new Databricks.MwsVpcEndpoint(\"relay\", new()\n {\n AccountId = databricksAccountId,\n VpcEndpointName = \"PSC Relay endpoint\",\n GcpVpcEndpointInfo = new Databricks.Inputs.MwsVpcEndpointGcpVpcEndpointInfoArgs\n {\n ProjectId = googleProject,\n PscEndpointName = \"PSC Relay endpoint\",\n EndpointRegion = subnetRegion,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account Id that could be found in https://accounts.gcp.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\tvar databricksGoogleServiceAccount interface{}\n\t\tcfg.RequireObject(\"databricksGoogleServiceAccount\", \u0026databricksGoogleServiceAccount)\n\t\tvar googleProject interface{}\n\t\tcfg.RequireObject(\"googleProject\", \u0026googleProject)\n\t\tvar subnetRegion interface{}\n\t\tcfg.RequireObject(\"subnetRegion\", \u0026subnetRegion)\n\t\t_, err := databricks.NewMwsVpcEndpoint(ctx, \"workspace\", \u0026databricks.MwsVpcEndpointArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tVpcEndpointName: pulumi.String(\"PSC Rest API endpoint\"),\n\t\t\tGcpVpcEndpointInfo: \u0026databricks.MwsVpcEndpointGcpVpcEndpointInfoArgs{\n\t\t\t\tProjectId: pulumi.Any(googleProject),\n\t\t\t\tPscEndpointName: pulumi.String(\"PSC Rest API endpoint\"),\n\t\t\t\tEndpointRegion: pulumi.Any(subnetRegion),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t_, err = databricks.NewMwsVpcEndpoint(ctx, \"relay\", \u0026databricks.MwsVpcEndpointArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tVpcEndpointName: pulumi.String(\"PSC Relay endpoint\"),\n\t\t\tGcpVpcEndpointInfo: \u0026databricks.MwsVpcEndpointGcpVpcEndpointInfoArgs{\n\t\t\t\tProjectId: pulumi.Any(googleProject),\n\t\t\t\tPscEndpointName: pulumi.String(\"PSC Relay endpoint\"),\n\t\t\t\tEndpointRegion: pulumi.Any(subnetRegion),\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsvpcendpoint\" \"workspace\" {\n account_id = var.databricksAccountId\n vpc_endpoint_name = \"PSC Rest API endpoint\"\n gcp_vpc_endpoint_info = {\n project_id = var.googleProject\n psc_endpoint_name = \"PSC Rest API endpoint\"\n endpoint_region = var.subnetRegion\n }\n}\nresource \"databricks_mwsvpcendpoint\" \"relay\" {\n account_id = var.databricksAccountId\n vpc_endpoint_name = \"PSC Relay endpoint\"\n gcp_vpc_endpoint_info = {\n project_id = var.googleProject\n psc_endpoint_name = \"PSC Relay endpoint\"\n endpoint_region = var.subnetRegion\n }\n}\nvariable \"databricksAccountId\" {\n description = \"Account Id that could be found in https://accounts.gcp.databricks.com/\"\n}\nvariable \"databricksGoogleServiceAccount\" {\n}\nvariable \"googleProject\" {\n}\nvariable \"subnetRegion\" {\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsVpcEndpoint;\nimport com.pulumi.databricks.MwsVpcEndpointArgs;\nimport com.pulumi.databricks.inputs.MwsVpcEndpointGcpVpcEndpointInfoArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n final var databricksGoogleServiceAccount = config.require(\"databricksGoogleServiceAccount\");\n final var googleProject = config.require(\"googleProject\");\n final var subnetRegion = config.require(\"subnetRegion\");\n var workspace = new MwsVpcEndpoint(\"workspace\", MwsVpcEndpointArgs.builder()\n .accountId(databricksAccountId)\n .vpcEndpointName(\"PSC Rest API endpoint\")\n .gcpVpcEndpointInfo(MwsVpcEndpointGcpVpcEndpointInfoArgs.builder()\n .projectId(googleProject)\n .pscEndpointName(\"PSC Rest API endpoint\")\n .endpointRegion(subnetRegion)\n .build())\n .build());\n\n var relay = new MwsVpcEndpoint(\"relay\", MwsVpcEndpointArgs.builder()\n .accountId(databricksAccountId)\n .vpcEndpointName(\"PSC Relay endpoint\")\n .gcpVpcEndpointInfo(MwsVpcEndpointGcpVpcEndpointInfoArgs.builder()\n .projectId(googleProject)\n .pscEndpointName(\"PSC Relay endpoint\")\n .endpointRegion(subnetRegion)\n .build())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\n databricksGoogleServiceAccount:\n type: object\n googleProject:\n type: object\n subnetRegion:\n type: object\nresources:\n workspace:\n type: databricks:MwsVpcEndpoint\n properties:\n accountId: ${databricksAccountId}\n vpcEndpointName: PSC Rest API endpoint\n gcpVpcEndpointInfo:\n projectId: ${googleProject}\n pscEndpointName: PSC Rest API endpoint\n endpointRegion: ${subnetRegion}\n relay:\n type: databricks:MwsVpcEndpoint\n properties:\n accountId: ${databricksAccountId}\n vpcEndpointName: PSC Relay endpoint\n gcpVpcEndpointInfo:\n projectId: ${googleProject}\n pscEndpointName: PSC Relay endpoint\n endpointRegion: ${subnetRegion}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nTypically the next steps after this would be to create a\u003cspan pulumi-lang-nodejs=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-dotnet=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-go=\" MwsPrivateAccessSettings \" pulumi-lang-python=\" MwsPrivateAccessSettings \" pulumi-lang-yaml=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-java=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-hcl=\" databricks_mws_private_access_settings \"\u003e databricks.MwsPrivateAccessSettings \u003c/span\u003eand\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003econfiguration, before passing the `databricks_mws_private_access_settings.pas.private_access_settings_id` and `databricks_mws_networks.this.network_id` into a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource:\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst _this = new databricks.MwsWorkspaces(\"this\", {\n accountId: databricksAccountId,\n workspaceName: \"gcp workspace\",\n location: subnetRegion,\n cloudResourceContainer: {\n gcp: {\n projectId: googleProject,\n },\n },\n gkeConfig: {\n connectivityType: \"PRIVATE_NODE_PUBLIC_MASTER\",\n masterIpRange: \"10.3.0.0/28\",\n },\n networkId: thisDatabricksMwsNetworks.networkId,\n privateAccessSettingsId: pas.privateAccessSettingsId,\n pricingTier: \"PREMIUM\",\n}, {\n dependsOn: [thisDatabricksMwsNetworks],\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nthis = databricks.MwsWorkspaces(\"this\",\n account_id=databricks_account_id,\n workspace_name=\"gcp workspace\",\n location=subnet_region,\n cloud_resource_container={\n \"gcp\": {\n \"project_id\": google_project,\n },\n },\n gke_config={\n \"connectivity_type\": \"PRIVATE_NODE_PUBLIC_MASTER\",\n \"master_ip_range\": \"10.3.0.0/28\",\n },\n network_id=this_databricks_mws_networks[\"networkId\"],\n private_access_settings_id=pas[\"privateAccessSettingsId\"],\n pricing_tier=\"PREMIUM\",\n opts = pulumi.ResourceOptions(depends_on=[this_databricks_mws_networks]))\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var @this = new Databricks.MwsWorkspaces(\"this\", new()\n {\n AccountId = databricksAccountId,\n WorkspaceName = \"gcp workspace\",\n Location = subnetRegion,\n CloudResourceContainer = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerArgs\n {\n Gcp = new Databricks.Inputs.MwsWorkspacesCloudResourceContainerGcpArgs\n {\n ProjectId = googleProject,\n },\n },\n GkeConfig = new Databricks.Inputs.MwsWorkspacesGkeConfigArgs\n {\n ConnectivityType = \"PRIVATE_NODE_PUBLIC_MASTER\",\n MasterIpRange = \"10.3.0.0/28\",\n },\n NetworkId = thisDatabricksMwsNetworks.NetworkId,\n PrivateAccessSettingsId = pas.PrivateAccessSettingsId,\n PricingTier = \"PREMIUM\",\n }, new CustomResourceOptions\n {\n DependsOn =\n {\n thisDatabricksMwsNetworks,\n },\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsWorkspaces(ctx, \"this\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tWorkspaceName: pulumi.String(\"gcp workspace\"),\n\t\t\tLocation: pulumi.Any(subnetRegion),\n\t\t\tCloudResourceContainer: \u0026databricks.MwsWorkspacesCloudResourceContainerArgs{\n\t\t\t\tGcp: \u0026databricks.MwsWorkspacesCloudResourceContainerGcpArgs{\n\t\t\t\t\tProjectId: pulumi.Any(googleProject),\n\t\t\t\t},\n\t\t\t},\n\t\t\tGkeConfig: \u0026databricks.MwsWorkspacesGkeConfigArgs{\n\t\t\t\tConnectivityType: pulumi.String(\"PRIVATE_NODE_PUBLIC_MASTER\"),\n\t\t\t\tMasterIpRange: pulumi.String(\"10.3.0.0/28\"),\n\t\t\t},\n\t\t\tNetworkId: pulumi.Any(thisDatabricksMwsNetworks.NetworkId),\n\t\t\tPrivateAccessSettingsId: pulumi.Any(pas.PrivateAccessSettingsId),\n\t\t\tPricingTier: pulumi.String(\"PREMIUM\"),\n\t\t}, pulumi.DependsOn([]pulumi.Resource{\n\t\t\tthisDatabricksMwsNetworks,\n\t\t}))\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsworkspaces\" \"this\" {\n depends_on = [thisDatabricksMwsNetworks]\n account_id = databricksAccountId\n workspace_name = \"gcp workspace\"\n location = subnetRegion\n cloud_resource_container = {\n gcp = {\n project_id = googleProject\n }\n }\n gke_config = {\n connectivity_type = \"PRIVATE_NODE_PUBLIC_MASTER\"\n master_ip_range = \"10.3.0.0/28\"\n }\n network_id = thisDatabricksMwsNetworks.networkId\n private_access_settings_id = pas.privateAccessSettingsId\n pricing_tier = \"PREMIUM\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport com.pulumi.databricks.inputs.MwsWorkspacesCloudResourceContainerArgs;\nimport com.pulumi.databricks.inputs.MwsWorkspacesCloudResourceContainerGcpArgs;\nimport com.pulumi.databricks.inputs.MwsWorkspacesGkeConfigArgs;\nimport com.pulumi.resources.CustomResourceOptions;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var this_ = new MwsWorkspaces(\"this\", MwsWorkspacesArgs.builder()\n .accountId(databricksAccountId)\n .workspaceName(\"gcp workspace\")\n .location(subnetRegion)\n .cloudResourceContainer(MwsWorkspacesCloudResourceContainerArgs.builder()\n .gcp(MwsWorkspacesCloudResourceContainerGcpArgs.builder()\n .projectId(googleProject)\n .build())\n .build())\n .gkeConfig(MwsWorkspacesGkeConfigArgs.builder()\n .connectivityType(\"PRIVATE_NODE_PUBLIC_MASTER\")\n .masterIpRange(\"10.3.0.0/28\")\n .build())\n .networkId(thisDatabricksMwsNetworks.networkId())\n .privateAccessSettingsId(pas.privateAccessSettingsId())\n .pricingTier(\"PREMIUM\")\n .build(), CustomResourceOptions.builder()\n .dependsOn(thisDatabricksMwsNetworks)\n .build());\n\n }\n}\n```\n```yaml\nresources:\n this:\n type: databricks:MwsWorkspaces\n properties:\n accountId: ${databricksAccountId}\n workspaceName: gcp workspace\n location: ${subnetRegion}\n cloudResourceContainer:\n gcp:\n projectId: ${googleProject}\n gkeConfig:\n connectivityType: PRIVATE_NODE_PUBLIC_MASTER\n masterIpRange: 10.3.0.0/28\n networkId: ${thisDatabricksMwsNetworks.networkId}\n privateAccessSettingsId: ${pas.privateAccessSettingsId}\n pricingTier: PREMIUM\n options:\n dependsOn:\n - ${thisDatabricksMwsNetworks}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n## Related Resources\n\nThe following resources are used in the same context:\n\n* Provisioning Databricks on AWS guide.\n* Provisioning Databricks on AWS with Private Link guide.\n* Provisioning AWS Databricks workspaces with a Hub \u0026 Spoke firewall for data exfiltration protection guide.\n* Provisioning Databricks workspaces on GCP with Private Service Connect guide.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eto [configure VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) \u0026 subnets for new workspaces within AWS.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-dotnet=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-go=\" MwsPrivateAccessSettings \" pulumi-lang-python=\" MwsPrivateAccessSettings \" pulumi-lang-yaml=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-java=\" databricks.MwsPrivateAccessSettings \" pulumi-lang-hcl=\" databricks_mws_private_access_settings \"\u003e databricks.MwsPrivateAccessSettings \u003c/span\u003eto create a [Private Access Setting](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html#step-5-create-a-private-access-settings-configuration-using-the-databricks-account-api) that can be used as part of a\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eresource to create a [Databricks Workspace that leverages AWS Private Link](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsWorkspaces \" pulumi-lang-dotnet=\" databricks.MwsWorkspaces \" pulumi-lang-go=\" MwsWorkspaces \" pulumi-lang-python=\" MwsWorkspaces \" pulumi-lang-yaml=\" databricks.MwsWorkspaces \" pulumi-lang-java=\" databricks.MwsWorkspaces \" pulumi-lang-hcl=\" databricks_mws_workspaces \"\u003e databricks.MwsWorkspaces \u003c/span\u003eto set up [AWS and GCP workspaces](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1).\n\n## Import\n\n\u003e Importing this resource is not currently supported.\n\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the Accounts Console for [AWS](https://accounts.cloud.databricks.com/) or [GCP](https://accounts.gcp.databricks.com/)\n" }, "awsAccountId": { "type": "string" }, "awsEndpointServiceId": { "type": "string", "description": "(AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the [Databricks PrivateLink documentation](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html)\n" }, "awsVpcEndpointId": { "type": "string", "description": "ID of configured aws_vpc_endpoint\n" }, "gcpVpcEndpointInfo": { "$ref": "#/types/databricks:index/MwsVpcEndpointGcpVpcEndpointInfo:MwsVpcEndpointGcpVpcEndpointInfo", "description": "a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:\n" }, "region": { "type": "string", "description": "Region of AWS VPC\n" }, "state": { "type": "string", "description": "(AWS Only) State of VPC Endpoint\n" }, "useCase": { "type": "string" }, "vpcEndpointId": { "type": "string", "description": "Canonical unique identifier of VPC Endpoint in Databricks Account\n" }, "vpcEndpointName": { "type": "string", "description": "Name of VPC Endpoint in Databricks Account\n" } }, "required": [ "awsAccountId", "awsEndpointServiceId", "state", "useCase", "vpcEndpointId", "vpcEndpointName" ], "inputProperties": { "accountId": { "type": "string", "description": "Account Id that could be found in the Accounts Console for [AWS](https://accounts.cloud.databricks.com/) or [GCP](https://accounts.gcp.databricks.com/)\n", "willReplaceOnChanges": true }, "awsAccountId": { "type": "string" }, "awsEndpointServiceId": { "type": "string", "description": "(AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the [Databricks PrivateLink documentation](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html)\n" }, "awsVpcEndpointId": { "type": "string", "description": "ID of configured aws_vpc_endpoint\n", "willReplaceOnChanges": true }, "gcpVpcEndpointInfo": { "$ref": "#/types/databricks:index/MwsVpcEndpointGcpVpcEndpointInfo:MwsVpcEndpointGcpVpcEndpointInfo", "description": "a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:\n", "willReplaceOnChanges": true }, "region": { "type": "string", "description": "Region of AWS VPC\n", "willReplaceOnChanges": true }, "state": { "type": "string", "description": "(AWS Only) State of VPC Endpoint\n" }, "useCase": { "type": "string" }, "vpcEndpointId": { "type": "string", "description": "Canonical unique identifier of VPC Endpoint in Databricks Account\n" }, "vpcEndpointName": { "type": "string", "description": "Name of VPC Endpoint in Databricks Account\n", "willReplaceOnChanges": true } }, "requiredInputs": [ "vpcEndpointName" ], "stateInputs": { "description": "Input properties used for looking up and filtering MwsVpcEndpoint resources.\n", "properties": { "accountId": { "type": "string", "description": "Account Id that could be found in the Accounts Console for [AWS](https://accounts.cloud.databricks.com/) or [GCP](https://accounts.gcp.databricks.com/)\n", "willReplaceOnChanges": true }, "awsAccountId": { "type": "string" }, "awsEndpointServiceId": { "type": "string", "description": "(AWS Only) The ID of the Databricks endpoint service that this VPC endpoint is connected to. Please find the list of endpoint service IDs for each supported region in the [Databricks PrivateLink documentation](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html)\n" }, "awsVpcEndpointId": { "type": "string", "description": "ID of configured aws_vpc_endpoint\n", "willReplaceOnChanges": true }, "gcpVpcEndpointInfo": { "$ref": "#/types/databricks:index/MwsVpcEndpointGcpVpcEndpointInfo:MwsVpcEndpointGcpVpcEndpointInfo", "description": "a block consists of Google Cloud specific information for this PSC endpoint. It has the following fields:\n", "willReplaceOnChanges": true }, "region": { "type": "string", "description": "Region of AWS VPC\n", "willReplaceOnChanges": true }, "state": { "type": "string", "description": "(AWS Only) State of VPC Endpoint\n" }, "useCase": { "type": "string" }, "vpcEndpointId": { "type": "string", "description": "Canonical unique identifier of VPC Endpoint in Databricks Account\n" }, "vpcEndpointName": { "type": "string", "description": "Name of VPC Endpoint in Databricks Account\n", "willReplaceOnChanges": true } }, "type": "object" } }, "databricks:index/mwsWorkspaces:MwsWorkspaces": { "description": "This resource allows you to set up [workspaces on AWS](https://docs.databricks.com/getting-started/overview.html#e2-architecture-1) or [workspaces on GCP](https://docs.gcp.databricks.com/administration-guide/account-settings-gcp/workspaces.html). Please follow this complete runnable example on AWS or GCP with new VPC and new workspace setup.\n\n\u003e This resource can only be used with an account-level provider!\n\n\u003e The \u003cspan pulumi-lang-nodejs=\"`gkeConfig`\" pulumi-lang-dotnet=\"`GkeConfig`\" pulumi-lang-go=\"`gkeConfig`\" pulumi-lang-python=\"`gke_config`\" pulumi-lang-yaml=\"`gkeConfig`\" pulumi-lang-java=\"`gkeConfig`\" pulumi-lang-hcl=\"`gke_config`\"\u003e`gkeConfig`\u003c/span\u003e argument is now deprecated and no longer supported. If you have already created a workspace using these fields, it is safe to remove them from your Pulumi template.\n\n\u003e On Azure you need to use\u003cspan pulumi-lang-nodejs=\" azurermDatabricksWorkspace \" pulumi-lang-dotnet=\" AzurermDatabricksWorkspace \" pulumi-lang-go=\" azurermDatabricksWorkspace \" pulumi-lang-python=\" azurerm_databricks_workspace \" pulumi-lang-yaml=\" azurermDatabricksWorkspace \" pulumi-lang-java=\" azurermDatabricksWorkspace \" pulumi-lang-hcl=\" azurerm_databricks_workspace \"\u003e azurermDatabricksWorkspace \u003c/span\u003eresource to create Azure Databricks workspaces.\n\n\u003e On GCP, the provider must be authenticated with a Google-issued OIDC token (not a Databricks OAuth token), because creating or updating this resource triggers operations against your GCP project. See Authenticate with Databricks account API for setup instructions.\n\n## Example Usage\n\n### Creating a serverless workspace in AWS and GCP\n\nCreating a serverless workspace does not require any prerequisite resources. Simply specify \u003cspan pulumi-lang-nodejs=\"`computeMode \" pulumi-lang-dotnet=\"`ComputeMode \" pulumi-lang-go=\"`computeMode \" pulumi-lang-python=\"`compute_mode \" pulumi-lang-yaml=\"`computeMode \" pulumi-lang-java=\"`computeMode \" pulumi-lang-hcl=\"`compute_mode \"\u003e`computeMode \u003c/span\u003e= \"SERVERLESS\"` when creating the workspace. Serverless workspaces must not include \u003cspan pulumi-lang-nodejs=\"`credentialsId`\" pulumi-lang-dotnet=\"`CredentialsId`\" pulumi-lang-go=\"`credentialsId`\" pulumi-lang-python=\"`credentials_id`\" pulumi-lang-yaml=\"`credentialsId`\" pulumi-lang-java=\"`credentialsId`\" pulumi-lang-hcl=\"`credentials_id`\"\u003e`credentialsId`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`storageConfigurationId`\" pulumi-lang-dotnet=\"`StorageConfigurationId`\" pulumi-lang-go=\"`storageConfigurationId`\" pulumi-lang-python=\"`storage_configuration_id`\" pulumi-lang-yaml=\"`storageConfigurationId`\" pulumi-lang-java=\"`storageConfigurationId`\" pulumi-lang-hcl=\"`storage_configuration_id`\"\u003e`storageConfigurationId`\u003c/span\u003e.\n\nOn [AWS](https://docs.databricks.com/aws/en/admin/workspace/serverless-workspaces):\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst serverlessWorkspace = new databricks.MwsWorkspaces(\"serverless_workspace\", {\n accountId: \"\",\n workspaceName: \"serverless-workspace\",\n awsRegion: \"us-east-1\",\n computeMode: \"SERVERLESS\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nserverless_workspace = databricks.MwsWorkspaces(\"serverless_workspace\",\n account_id=\"\",\n workspace_name=\"serverless-workspace\",\n aws_region=\"us-east-1\",\n compute_mode=\"SERVERLESS\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var serverlessWorkspace = new Databricks.MwsWorkspaces(\"serverless_workspace\", new()\n {\n AccountId = \"\",\n WorkspaceName = \"serverless-workspace\",\n AwsRegion = \"us-east-1\",\n ComputeMode = \"SERVERLESS\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsWorkspaces(ctx, \"serverless_workspace\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tAccountId: pulumi.String(\"\"),\n\t\t\tWorkspaceName: pulumi.String(\"serverless-workspace\"),\n\t\t\tAwsRegion: pulumi.String(\"us-east-1\"),\n\t\t\tComputeMode: pulumi.String(\"SERVERLESS\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsworkspaces\" \"serverless_workspace\" {\n account_id = \"\"\n workspace_name = \"serverless-workspace\"\n aws_region = \"us-east-1\"\n compute_mode = \"SERVERLESS\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var serverlessWorkspace = new MwsWorkspaces(\"serverlessWorkspace\", MwsWorkspacesArgs.builder()\n .accountId(\"\")\n .workspaceName(\"serverless-workspace\")\n .awsRegion(\"us-east-1\")\n .computeMode(\"SERVERLESS\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n serverlessWorkspace:\n type: databricks:MwsWorkspaces\n name: serverless_workspace\n properties:\n accountId: \"\"\n workspaceName: serverless-workspace\n awsRegion: us-east-1\n computeMode: SERVERLESS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\nOn [GCP](https://docs.databricks.com/gcp/en/admin/workspace/serverless-workspaces):\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst serverlessWorkspace = new databricks.MwsWorkspaces(\"serverless_workspace\", {\n accountId: \"\",\n workspaceName: \"serverless-workspace\",\n location: \"us-east4\",\n computeMode: \"SERVERLESS\",\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nserverless_workspace = databricks.MwsWorkspaces(\"serverless_workspace\",\n account_id=\"\",\n workspace_name=\"serverless-workspace\",\n location=\"us-east4\",\n compute_mode=\"SERVERLESS\")\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var serverlessWorkspace = new Databricks.MwsWorkspaces(\"serverless_workspace\", new()\n {\n AccountId = \"\",\n WorkspaceName = \"serverless-workspace\",\n Location = \"us-east4\",\n ComputeMode = \"SERVERLESS\",\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\t_, err := databricks.NewMwsWorkspaces(ctx, \"serverless_workspace\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tAccountId: pulumi.String(\"\"),\n\t\t\tWorkspaceName: pulumi.String(\"serverless-workspace\"),\n\t\t\tLocation: pulumi.String(\"us-east4\"),\n\t\t\tComputeMode: pulumi.String(\"SERVERLESS\"),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\nresource \"databricks_mwsworkspaces\" \"serverless_workspace\" {\n account_id = \"\"\n workspace_name = \"serverless-workspace\"\n location = \"us-east4\"\n compute_mode = \"SERVERLESS\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n var serverlessWorkspace = new MwsWorkspaces(\"serverlessWorkspace\", MwsWorkspacesArgs.builder()\n .accountId(\"\")\n .workspaceName(\"serverless-workspace\")\n .location(\"us-east4\")\n .computeMode(\"SERVERLESS\")\n .build());\n\n }\n}\n```\n```yaml\nresources:\n serverlessWorkspace:\n type: databricks:MwsWorkspaces\n name: serverless_workspace\n properties:\n accountId: \"\"\n workspaceName: serverless-workspace\n location: us-east4\n computeMode: SERVERLESS\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Creating a workspace on AWS\n\n!Simplest multiworkspace\n\nTo get workspace running, you have to configure a couple of things:\n\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCredentials \" pulumi-lang-dotnet=\" databricks.MwsCredentials \" pulumi-lang-go=\" MwsCredentials \" pulumi-lang-python=\" MwsCredentials \" pulumi-lang-yaml=\" databricks.MwsCredentials \" pulumi-lang-java=\" databricks.MwsCredentials \" pulumi-lang-hcl=\" databricks_mws_credentials \"\u003e databricks.MwsCredentials \u003c/span\u003e- You can share a credentials (cross-account IAM role) configuration ID with multiple workspaces. It is not required to create a new one for each workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsStorageConfigurations \" pulumi-lang-dotnet=\" databricks.MwsStorageConfigurations \" pulumi-lang-go=\" MwsStorageConfigurations \" pulumi-lang-python=\" MwsStorageConfigurations \" pulumi-lang-yaml=\" databricks.MwsStorageConfigurations \" pulumi-lang-java=\" databricks.MwsStorageConfigurations \" pulumi-lang-hcl=\" databricks_mws_storage_configurations \"\u003e databricks.MwsStorageConfigurations \u003c/span\u003e- You can share a root S3 bucket with multiple workspaces in a single account. You do not have to create new ones for each workspace. If you share a root S3 bucket for multiple workspaces in an account, data on the root S3 bucket is partitioned into separate directories by workspace.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003e- (optional, but recommended) You can share one [customer-managed VPC](https://docs.databricks.com/administration-guide/cloud-configurations/aws/customer-managed-vpc.html) with multiple workspaces in a single account. However, Databricks recommends using unique subnets and security groups for each workspace. If you plan to share one VPC with multiple workspaces, be sure to size your VPC and subnets accordingly. Because a Databricks\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eencapsulates this information, you cannot reuse it across workspaces.\n*\u003cspan pulumi-lang-nodejs=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-dotnet=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-go=\" MwsCustomerManagedKeys \" pulumi-lang-python=\" MwsCustomerManagedKeys \" pulumi-lang-yaml=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-java=\" databricks.MwsCustomerManagedKeys \" pulumi-lang-hcl=\" databricks_mws_customer_managed_keys \"\u003e databricks.MwsCustomerManagedKeys \u003c/span\u003e- You can share a customer-managed key across workspaces.\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as databricks from \"@pulumi/databricks\";\n\nconst config = new pulumi.Config();\n// Account ID that can be found in the dropdown under the email address in the upper-right corner of https://accounts.cloud.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\n// register cross-account ARN\nconst _this = new databricks.MwsCredentials(\"this\", {\n accountId: databricksAccountId,\n credentialsName: `${prefix}-creds`,\n roleArn: crossaccountArn,\n});\n// register root bucket\nconst thisMwsStorageConfigurations = new databricks.MwsStorageConfigurations(\"this\", {\n accountId: databricksAccountId,\n storageConfigurationName: `${prefix}-storage`,\n bucketName: rootBucket,\n});\n// register VPC\nconst thisMwsNetworks = new databricks.MwsNetworks(\"this\", {\n accountId: databricksAccountId,\n networkName: `${prefix}-network`,\n vpcId: vpcId,\n subnetIds: subnetsPrivate,\n securityGroupIds: [securityGroup],\n});\n// create workspace in given VPC with DBFS on root bucket\nconst thisMwsWorkspaces = new databricks.MwsWorkspaces(\"this\", {\n accountId: databricksAccountId,\n workspaceName: prefix,\n awsRegion: region,\n credentialsId: _this.credentialsId,\n storageConfigurationId: thisMwsStorageConfigurations.storageConfigurationId,\n networkId: thisMwsNetworks.networkId,\n});\n```\n```python\nimport pulumi\nimport pulumi_databricks as databricks\n\nconfig = pulumi.Config()\n# Account ID that can be found in the dropdown under the email address in the upper-right corner of https://accounts.cloud.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\n# register cross-account ARN\nthis = databricks.MwsCredentials(\"this\",\n account_id=databricks_account_id,\n credentials_name=f\"{prefix}-creds\",\n role_arn=crossaccount_arn)\n# register root bucket\nthis_mws_storage_configurations = databricks.MwsStorageConfigurations(\"this\",\n account_id=databricks_account_id,\n storage_configuration_name=f\"{prefix}-storage\",\n bucket_name=root_bucket)\n# register VPC\nthis_mws_networks = databricks.MwsNetworks(\"this\",\n account_id=databricks_account_id,\n network_name=f\"{prefix}-network\",\n vpc_id=vpc_id,\n subnet_ids=subnets_private,\n security_group_ids=[security_group])\n# create workspace in given VPC with DBFS on root bucket\nthis_mws_workspaces = databricks.MwsWorkspaces(\"this\",\n account_id=databricks_account_id,\n workspace_name=prefix,\n aws_region=region,\n credentials_id=this.credentials_id,\n storage_configuration_id=this_mws_storage_configurations.storage_configuration_id,\n network_id=this_mws_networks.network_id)\n```\n```csharp\nusing System.Collections.Generic;\nusing System.Linq;\nusing Pulumi;\nusing Databricks = Pulumi.Databricks;\n\nreturn await Deployment.RunAsync(() =\u003e \n{\n var config = new Config();\n // Account ID that can be found in the dropdown under the email address in the upper-right corner of https://accounts.cloud.databricks.com/\n var databricksAccountId = config.RequireObject\u003cdynamic\u003e(\"databricksAccountId\");\n // register cross-account ARN\n var @this = new Databricks.MwsCredentials(\"this\", new()\n {\n AccountId = databricksAccountId,\n CredentialsName = $\"{prefix}-creds\",\n RoleArn = crossaccountArn,\n });\n\n // register root bucket\n var thisMwsStorageConfigurations = new Databricks.MwsStorageConfigurations(\"this\", new()\n {\n AccountId = databricksAccountId,\n StorageConfigurationName = $\"{prefix}-storage\",\n BucketName = rootBucket,\n });\n\n // register VPC\n var thisMwsNetworks = new Databricks.MwsNetworks(\"this\", new()\n {\n AccountId = databricksAccountId,\n NetworkName = $\"{prefix}-network\",\n VpcId = vpcId,\n SubnetIds = subnetsPrivate,\n SecurityGroupIds = new[]\n {\n securityGroup,\n },\n });\n\n // create workspace in given VPC with DBFS on root bucket\n var thisMwsWorkspaces = new Databricks.MwsWorkspaces(\"this\", new()\n {\n AccountId = databricksAccountId,\n WorkspaceName = prefix,\n AwsRegion = region,\n CredentialsId = @this.CredentialsId,\n StorageConfigurationId = thisMwsStorageConfigurations.StorageConfigurationId,\n NetworkId = thisMwsNetworks.NetworkId,\n });\n\n});\n```\n```go\npackage main\n\nimport (\n\t\"github.com/pulumi/pulumi-databricks/sdk/go/databricks\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi\"\n\t\"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config\"\n)\n\nfunc main() {\n\tpulumi.Run(func(ctx *pulumi.Context) error {\n\t\tcfg := config.New(ctx, \"\")\n\t\t// Account ID that can be found in the dropdown under the email address in the upper-right corner of https://accounts.cloud.databricks.com/\n\t\tvar databricksAccountId interface{}\n\t\tcfg.RequireObject(\"databricksAccountId\", \u0026databricksAccountId)\n\t\t// register cross-account ARN\n\t\tthis, err := databricks.NewMwsCredentials(ctx, \"this\", \u0026databricks.MwsCredentialsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tCredentialsName: pulumi.Sprintf(\"%v-creds\", prefix),\n\t\t\tRoleArn: pulumi.Any(crossaccountArn),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// register root bucket\n\t\tthisMwsStorageConfigurations, err := databricks.NewMwsStorageConfigurations(ctx, \"this\", \u0026databricks.MwsStorageConfigurationsArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tStorageConfigurationName: pulumi.Sprintf(\"%v-storage\", prefix),\n\t\t\tBucketName: pulumi.Any(rootBucket),\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// register VPC\n\t\tthisMwsNetworks, err := databricks.NewMwsNetworks(ctx, \"this\", \u0026databricks.MwsNetworksArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tNetworkName: pulumi.Sprintf(\"%v-network\", prefix),\n\t\t\tVpcId: pulumi.Any(vpcId),\n\t\t\tSubnetIds: pulumi.Any(subnetsPrivate),\n\t\t\tSecurityGroupIds: pulumi.StringArray{\n\t\t\t\tsecurityGroup,\n\t\t\t},\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\t// create workspace in given VPC with DBFS on root bucket\n\t\t_, err = databricks.NewMwsWorkspaces(ctx, \"this\", \u0026databricks.MwsWorkspacesArgs{\n\t\t\tAccountId: pulumi.Any(databricksAccountId),\n\t\t\tWorkspaceName: pulumi.Any(prefix),\n\t\t\tAwsRegion: pulumi.Any(region),\n\t\t\tCredentialsId: this.CredentialsId,\n\t\t\tStorageConfigurationId: thisMwsStorageConfigurations.StorageConfigurationId,\n\t\t\tNetworkId: thisMwsNetworks.NetworkId,\n\t\t})\n\t\tif err != nil {\n\t\t\treturn err\n\t\t}\n\t\treturn nil\n\t})\n}\n```\n```hcl\npulumi {\n required_providers {\n databricks = {\n source = \"pulumi/databricks\"\n }\n }\n}\n\n// register cross-account ARN\nresource \"databricks_mwscredentials\" \"this\" {\n account_id = var.databricksAccountId\n credentials_name =\"${prefix}-creds\"\n role_arn = crossaccountArn\n}\n// register root bucket\nresource \"databricks_mwsstorageconfigurations\" \"this\" {\n account_id = var.databricksAccountId\n storage_configuration_name =\"${prefix}-storage\"\n bucket_name = rootBucket\n}\n// register VPC\nresource \"databricks_mwsnetworks\" \"this\" {\n account_id = var.databricksAccountId\n network_name =\"${prefix}-network\"\n vpc_id = vpcId\n subnet_ids = subnetsPrivate\n security_group_ids = [securityGroup]\n}\n// create workspace in given VPC with DBFS on root bucket\nresource \"databricks_mwsworkspaces\" \"this\" {\n account_id = var.databricksAccountId\n workspace_name = prefix\n aws_region = region\n credentials_id = databricks_mwscredentials.this.credentials_id\n storage_configuration_id = databricks_mwsstorageconfigurations.this.storage_configuration_id\n network_id = databricks_mwsnetworks.this.network_id\n}\nvariable \"databricksAccountId\" {\n description = \"Account ID that can be found in the dropdown under the email address in the upper-right corner of https://accounts.cloud.databricks.com/\"\n}\n```\n```java\npackage generated_program;\n\nimport com.pulumi.Context;\nimport com.pulumi.Pulumi;\nimport com.pulumi.core.Output;\nimport com.pulumi.databricks.MwsCredentials;\nimport com.pulumi.databricks.MwsCredentialsArgs;\nimport com.pulumi.databricks.MwsStorageConfigurations;\nimport com.pulumi.databricks.MwsStorageConfigurationsArgs;\nimport com.pulumi.databricks.MwsNetworks;\nimport com.pulumi.databricks.MwsNetworksArgs;\nimport com.pulumi.databricks.MwsWorkspaces;\nimport com.pulumi.databricks.MwsWorkspacesArgs;\nimport java.util.ArrayList;\nimport java.util.Arrays;\nimport java.util.Map;\nimport java.io.File;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\n\npublic class App {\n public static void main(String[] args) {\n Pulumi.run(App::stack);\n }\n\n public static void stack(Context ctx) {\n final var config = ctx.config();\n final var databricksAccountId = config.require(\"databricksAccountId\");\n // register cross-account ARN\n var this_ = new MwsCredentials(\"this\", MwsCredentialsArgs.builder()\n .accountId(databricksAccountId)\n .credentialsName(String.format(\"%s-creds\", prefix))\n .roleArn(crossaccountArn)\n .build());\n\n // register root bucket\n var thisMwsStorageConfigurations = new MwsStorageConfigurations(\"thisMwsStorageConfigurations\", MwsStorageConfigurationsArgs.builder()\n .accountId(databricksAccountId)\n .storageConfigurationName(String.format(\"%s-storage\", prefix))\n .bucketName(rootBucket)\n .build());\n\n // register VPC\n var thisMwsNetworks = new MwsNetworks(\"thisMwsNetworks\", MwsNetworksArgs.builder()\n .accountId(databricksAccountId)\n .networkName(String.format(\"%s-network\", prefix))\n .vpcId(vpcId)\n .subnetIds(subnetsPrivate)\n .securityGroupIds(securityGroup)\n .build());\n\n // create workspace in given VPC with DBFS on root bucket\n var thisMwsWorkspaces = new MwsWorkspaces(\"thisMwsWorkspaces\", MwsWorkspacesArgs.builder()\n .accountId(databricksAccountId)\n .workspaceName(prefix)\n .awsRegion(region)\n .credentialsId(this_.credentialsId())\n .storageConfigurationId(thisMwsStorageConfigurations.storageConfigurationId())\n .networkId(thisMwsNetworks.networkId())\n .build());\n\n }\n}\n```\n```yaml\nconfiguration:\n databricksAccountId:\n type: object\nresources:\n # register cross-account ARN\n this:\n type: databricks:MwsCredentials\n properties:\n accountId: ${databricksAccountId}\n credentialsName: ${prefix}-creds\n roleArn: ${crossaccountArn}\n # register root bucket\n thisMwsStorageConfigurations:\n type: databricks:MwsStorageConfigurations\n name: this\n properties:\n accountId: ${databricksAccountId}\n storageConfigurationName: ${prefix}-storage\n bucketName: ${rootBucket}\n # register VPC\n thisMwsNetworks:\n type: databricks:MwsNetworks\n name: this\n properties:\n accountId: ${databricksAccountId}\n networkName: ${prefix}-network\n vpcId: ${vpcId}\n subnetIds: ${subnetsPrivate}\n securityGroupIds:\n - ${securityGroup}\n # create workspace in given VPC with DBFS on root bucket\n thisMwsWorkspaces:\n type: databricks:MwsWorkspaces\n name: this\n properties:\n accountId: ${databricksAccountId}\n workspaceName: ${prefix}\n awsRegion: ${region}\n credentialsId: ${this.credentialsId}\n storageConfigurationId: ${thisMwsStorageConfigurations.storageConfigurationId}\n networkId: ${thisMwsNetworks.networkId}\n```\n\u003c!--End PulumiCodeChooser --\u003e\n\n### Creating a workspace on AWS with Databricks-Managed VPC\n\n![VPCs](https://docs.databricks.com/_images/customer-managed-vpc.png)\n\nBy default, Databricks creates a VPC in your AWS account for each workspace. Databricks uses it for running clusters in the workspace. Optionally, you can use your VPC for the workspace, using the feature customer-managed VPC. Databricks recommends that you provide your VPC with\u003cspan pulumi-lang-nodejs=\" databricks.MwsNetworks \" pulumi-lang-dotnet=\" databricks.MwsNetworks \" pulumi-lang-go=\" MwsNetworks \" pulumi-lang-python=\" MwsNetworks \" pulumi-lang-yaml=\" databricks.MwsNetworks \" pulumi-lang-java=\" databricks.MwsNetworks \" pulumi-lang-hcl=\" databricks_mws_networks \"\u003e databricks.MwsNetworks \u003c/span\u003eso that you can configure it according to your organization's enterprise cloud standards while still conforming to Databricks requirements. You cannot migrate an existing workspace to your VPC. Please see the difference described through IAM policy actions [on this page](https://docs.databricks.com/administration-guide/account-api/iam-role.html).\n\n\u003c!--Start PulumiCodeChooser --\u003e\n```typescript\nimport * as pulumi from \"@pulumi/pulumi\";\nimport * as aws from \"@pulumi/aws\";\nimport * as databricks from \"@pulumi/databricks\";\nimport * as random from \"@pulumi/random\";\n\nconst config = new pulumi.Config();\n// Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\nconst databricksAccountId = config.requireObject\u003cany\u003e(\"databricksAccountId\");\nconst naming = new random.index.String(\"naming\", {\n special: false,\n upper: false,\n length: 6,\n});\nconst prefix = `dltp${naming.result}`;\nconst _this = databricks.getAwsAssumeRolePolicy({\n externalId: databricksAccountId,\n});\nconst crossAccountRole = new aws.index.IamRole(\"cross_account_role\", {\n name: `${prefix}-crossaccount`,\n assumeRolePolicy: _this.json,\n tags: tags,\n});\nconst thisGetAwsCrossAccountPolicy = databricks.getAwsCrossAccountPolicy({});\nconst thisIamRolePolicy = new aws.index.IamRolePolicy(\"this\", {\n name: `${prefix}-policy`,\n role: crossAccountRole.id,\n policy: thisGetAwsCrossAccountPolicy.json,\n});\nconst thisMwsCredentials = new databricks.MwsCredentials(\"this\", {\n accountId: databricksAccountId,\n credentialsName: `${prefix}-creds`,\n roleArn: crossAccountRole.arn,\n});\nconst rootStorageBucket = new aws.index.S3Bucket(\"root_storage_bucket\", {\n bucket: `${prefix}-rootbucket`,\n acl: \"private\",\n forceDestroy: true,\n tags: tags,\n});\nconst rootVersioning = new aws.index.S3BucketVersioning(\"root_versioning\", {\n bucket: rootStorageBucket.id,\n versioningConfiguration: [{\n status: \"Disabled\",\n }],\n});\nconst rootStorageBucketS3BucketServerSideEncryptionConfiguration = new aws.index.S3BucketServerSideEncryptionConfiguration(\"root_storage_bucket\", {\n bucket: rootStorageBucket.bucket,\n rule: [{\n applyServerSideEncryptionByDefault: [{\n sseAlgorithm: \"AES256\",\n }],\n }],\n});\nconst rootStorageBucketS3BucketPublicAccessBlock = new aws.index.S3BucketPublicAccessBlock(\"root_storage_bucket\", {\n bucket: rootStorageBucket.id,\n blockPublicAcls: true,\n blockPublicPolicy: true,\n ignorePublicAcls: true,\n restrictPublicBuckets: true,\n}, {\n dependsOn: [rootStorageBucket],\n});\nconst thisGetAwsBucketPolicy = databricks.getAwsBucketPolicy({\n bucket: rootStorageBucket.bucket,\n});\nconst rootBucketPolicy = new aws.index.S3BucketPolicy(\"root_bucket_policy\", {\n bucket: rootStorageBucket.id,\n policy: thisGetAwsBucketPolicy.json,\n}, {\n dependsOn: [rootStorageBucketS3BucketPublicAccessBlock],\n});\nconst thisMwsStorageConfigurations = new databricks.MwsStorageConfigurations(\"this\", {\n accountId: databricksAccountId,\n storageConfigurationName: `${prefix}-storage`,\n bucketName: rootStorageBucket.bucket,\n});\nconst thisMwsWorkspaces = new databricks.MwsWorkspaces(\"this\", {\n accountId: databricksAccountId,\n workspaceName: prefix,\n awsRegion: \"us-east-1\",\n credentialsId: thisMwsCredentials.credentialsId,\n storageConfigurationId: thisMwsStorageConfigurations.storageConfigurationId,\n customTags: {\n SoldToCode: \"1234\",\n },\n});\n```\n```python\nimport pulumi\nimport pulumi_aws as aws\nimport pulumi_databricks as databricks\nimport pulumi_random as random\n\nconfig = pulumi.Config()\n# Account Id that could be found in the top right corner of https://accounts.cloud.databricks.com/\ndatabricks_account_id = config.require_object(\"databricksAccountId\")\nnaming = random.String(\"naming\",\n special=False,\n upper=False,\n length=6)\nprefix = f\"dltp{naming['result']}\"\nthis = databricks.get_aws_assume_role_policy(external_id=databricks_account_id)\ncross_account_role = aws.IamRole(\"cross_account_role\",\n name=f{prefix}-crossaccount,\n assume_role_policy=this.json,\n tags=tags)\nthis_get_aws_cross_account_policy = databricks.get_aws_cross_account_policy()\nthis_iam_role_policy = aws.IamRolePolicy(\"this\",\n name=f{prefix}-policy,\n role=cross_account_role.id,\n policy=this_get_aws_cross_account_policy.json)\nthis_mws_credentials = databricks.MwsCredentials(\"this\",\n account_id=databricks_account_id,\n credentials_name=f\"{prefix}-creds\",\n role_arn=cross_account_role[\"arn\"])\nroot_storage_bucket = aws.S3Bucket(\"root_storage_bucket\",\n bucket=f{prefix}-rootbucket,\n acl=private,\n force_destroy=True,\n tags=tags)\nroot_versioning = aws.S3BucketVersioning(\"root_versioning\",\n bucket=root_storage_bucket.id,\n versioning_configuration=[{\n status: Disabled,\n }])\nroot_storage_bucket_s3_bucket_server_side_encryption_configuration = aws.S3BucketServerSideEncryptionConfiguration(\"root_storage_bucket\",\n bucket=root_storage_bucket.bucket,\n rule=[{\n applyServerSideEncryptionByDefault: [{\n sseAlgorithm: AES256,\n }],\n }])\nroot_storage_bucket_s3_bucket_public_access_block = aws.S3BucketPublicAccessBlock(\"root_storage_bucket\",\n bucket=root_storage_bucket.id,\n block_public_acls=True,\n block_public_policy=True,\n ignore_public_acls=True,\n restrict_public_buckets=True,\n opts = pulumi.ResourceOptions(depends_on=[root_storage_bucket]))\nthis_get_aws_bucket_policy