1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresDataApi
Viewing docs for Databricks v1.99.0
published on Wednesday, Jul 8, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.99.0
published on Wednesday, Jul 8, 2026 by Pulumi

    Private Preview

    API Documentation

    This data source retrieves the Data API configuration for a single Lakebase database, including the public Data API URL.

    Example Usage

    Retrieve the Data API for a Database

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const app = databricks.getPostgresDataApi({
        name: "projects/my-project/branches/main/databases/app/data-api",
    });
    export const dataApiUrl = app.then(app => app.status?.url);
    export const availableSchemas = app.then(app => app.status?.availableSchemas);
    
    import pulumi
    import pulumi_databricks as databricks
    
    app = databricks.get_postgres_data_api(name="projects/my-project/branches/main/databases/app/data-api")
    pulumi.export("dataApiUrl", app.status.url)
    pulumi.export("availableSchemas", app.status.available_schemas)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		app, err := databricks.GetPostgresDataApi(ctx, &databricks.LookupPostgresDataApiArgs{
    			Name: "projects/my-project/branches/main/databases/app/data-api",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dataApiUrl", app.Status.Url)
    		ctx.Export("availableSchemas", app.Status.AvailableSchemas)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var app = Databricks.GetPostgresDataApi.Invoke(new()
        {
            Name = "projects/my-project/branches/main/databases/app/data-api",
        });
    
        return new Dictionary<string, object?>
        {
            ["dataApiUrl"] = app.Apply(getPostgresDataApiResult => getPostgresDataApiResult.Status?.Url),
            ["availableSchemas"] = app.Apply(getPostgresDataApiResult => getPostgresDataApiResult.Status?.AvailableSchemas),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.DatabricksFunctions;
    import com.pulumi.databricks.inputs.GetPostgresDataApiArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var app = DatabricksFunctions.getPostgresDataApi(GetPostgresDataApiArgs.builder()
                .name("projects/my-project/branches/main/databases/app/data-api")
                .build());
    
            ctx.export("dataApiUrl", app.status().url());
            ctx.export("availableSchemas", app.status().availableSchemas());
        }
    }
    
    variables:
      app:
        fn::invoke:
          function: databricks:getPostgresDataApi
          arguments:
            name: projects/my-project/branches/main/databases/app/data-api
    outputs:
      dataApiUrl: ${app.status.url}
      availableSchemas: ${app.status.availableSchemas}
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    data "databricks_getpostgresdataapi" "app" {
      name = "projects/my-project/branches/main/databases/app/data-api"
    }
    
    output "dataApiUrl" {
      value = data.databricks_getpostgresdataapi.app.status.url
    }
    output "availableSchemas" {
      value = data.databricks_getpostgresdataapi.app.status.available_schemas
    }
    

    Using getPostgresDataApi

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPostgresDataApi(args: GetPostgresDataApiArgs, opts?: InvokeOptions): Promise<GetPostgresDataApiResult>
    function getPostgresDataApiOutput(args: GetPostgresDataApiOutputArgs, opts?: InvokeOptions): Output<GetPostgresDataApiResult>
    def get_postgres_data_api(name: Optional[str] = None,
                              provider_config: Optional[GetPostgresDataApiProviderConfig] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPostgresDataApiResult
    def get_postgres_data_api_output(name: pulumi.Input[Optional[str]] = None,
                              provider_config: pulumi.Input[Optional[GetPostgresDataApiProviderConfigArgs]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPostgresDataApiResult]
    func LookupPostgresDataApi(ctx *Context, args *LookupPostgresDataApiArgs, opts ...InvokeOption) (*LookupPostgresDataApiResult, error)
    func LookupPostgresDataApiOutput(ctx *Context, args *LookupPostgresDataApiOutputArgs, opts ...InvokeOption) LookupPostgresDataApiResultOutput

    > Note: This function is named LookupPostgresDataApi in the Go SDK.

    public static class GetPostgresDataApi 
    {
        public static Task<GetPostgresDataApiResult> InvokeAsync(GetPostgresDataApiArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresDataApiResult> Invoke(GetPostgresDataApiInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPostgresDataApiResult> getPostgresDataApi(GetPostgresDataApiArgs args, InvokeOptions options)
    public static Output<GetPostgresDataApiResult> getPostgresDataApi(GetPostgresDataApiArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPostgresDataApi:getPostgresDataApi
      arguments:
        # arguments dictionary
    data "databricks_getpostgresdataapi" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    ProviderConfig GetPostgresDataApiProviderConfig
    Configure the provider for management through account provider.
    Name string
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    ProviderConfig GetPostgresDataApiProviderConfig
    Configure the provider for management through account provider.
    name string
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    provider_config object
    Configure the provider for management through account provider.
    name String
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    providerConfig GetPostgresDataApiProviderConfig
    Configure the provider for management through account provider.
    name string
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    providerConfig GetPostgresDataApiProviderConfig
    Configure the provider for management through account provider.
    name str
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    provider_config GetPostgresDataApiProviderConfig
    Configure the provider for management through account provider.
    name String
    Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresDataApi Result

    The following output properties are available:

    CreateTime string
    (string) - A timestamp indicating when the Data API was first enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    Parent string
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    Spec GetPostgresDataApiSpec
    (DataApiDataApiSpec) - The desired Data API configuration
    Status GetPostgresDataApiStatus
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    UpdateTime string
    (string) - A timestamp indicating when the Data API configuration was last updated
    ProviderConfig GetPostgresDataApiProviderConfig
    CreateTime string
    (string) - A timestamp indicating when the Data API was first enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    Parent string
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    Spec GetPostgresDataApiSpec
    (DataApiDataApiSpec) - The desired Data API configuration
    Status GetPostgresDataApiStatus
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    UpdateTime string
    (string) - A timestamp indicating when the Data API configuration was last updated
    ProviderConfig GetPostgresDataApiProviderConfig
    create_time string
    (string) - A timestamp indicating when the Data API was first enabled
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    parent string
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    spec object
    (DataApiDataApiSpec) - The desired Data API configuration
    status object
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    update_time string
    (string) - A timestamp indicating when the Data API configuration was last updated
    provider_config object
    createTime String
    (string) - A timestamp indicating when the Data API was first enabled
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    parent String
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    spec GetPostgresDataApiSpec
    (DataApiDataApiSpec) - The desired Data API configuration
    status GetPostgresDataApiStatus
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    updateTime String
    (string) - A timestamp indicating when the Data API configuration was last updated
    providerConfig GetPostgresDataApiProviderConfig
    createTime string
    (string) - A timestamp indicating when the Data API was first enabled
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    parent string
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    spec GetPostgresDataApiSpec
    (DataApiDataApiSpec) - The desired Data API configuration
    status GetPostgresDataApiStatus
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    updateTime string
    (string) - A timestamp indicating when the Data API configuration was last updated
    providerConfig GetPostgresDataApiProviderConfig
    create_time str
    (string) - A timestamp indicating when the Data API was first enabled
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    parent str
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    spec GetPostgresDataApiSpec
    (DataApiDataApiSpec) - The desired Data API configuration
    status GetPostgresDataApiStatus
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    update_time str
    (string) - A timestamp indicating when the Data API configuration was last updated
    provider_config GetPostgresDataApiProviderConfig
    createTime String
    (string) - A timestamp indicating when the Data API was first enabled
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
    parent String
    (string) - The database containing this Data API configuration. Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
    spec Property Map
    (DataApiDataApiSpec) - The desired Data API configuration
    status Property Map
    (DataApiDataApiStatus) - The observed Data API state (read-only)
    updateTime String
    (string) - A timestamp indicating when the Data API configuration was last updated
    providerConfig Property Map

    Supporting Types

    GetPostgresDataApiProviderConfig

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    GetPostgresDataApiSpec

    DbAggregatesEnabled bool
    (boolean) - Actual aggregate function setting read from the database
    DbExtraSearchPaths List<string>
    (list of string) - Actual extra search path schemas read from the database
    DbMaxRows int
    (integer) - Actual max rows setting read from the database
    DbSchemas List<string>
    (list of string) - Actual exposed schemas read from the database
    JwtCacheMaxLifetime string
    (string) - Actual JWT cache max lifetime read from the database
    JwtRoleClaimKey string
    (string) - Actual JWT role claim key read from the database
    OpenapiMode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    ServerCorsAllowedOrigins List<string>
    (list of string) - Actual CORS allowed origins read from the database
    ServerTimingEnabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    DbAggregatesEnabled bool
    (boolean) - Actual aggregate function setting read from the database
    DbExtraSearchPaths []string
    (list of string) - Actual extra search path schemas read from the database
    DbMaxRows int
    (integer) - Actual max rows setting read from the database
    DbSchemas []string
    (list of string) - Actual exposed schemas read from the database
    JwtCacheMaxLifetime string
    (string) - Actual JWT cache max lifetime read from the database
    JwtRoleClaimKey string
    (string) - Actual JWT role claim key read from the database
    OpenapiMode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    ServerCorsAllowedOrigins []string
    (list of string) - Actual CORS allowed origins read from the database
    ServerTimingEnabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    db_aggregates_enabled bool
    (boolean) - Actual aggregate function setting read from the database
    db_extra_search_paths list(string)
    (list of string) - Actual extra search path schemas read from the database
    db_max_rows number
    (integer) - Actual max rows setting read from the database
    db_schemas list(string)
    (list of string) - Actual exposed schemas read from the database
    jwt_cache_max_lifetime string
    (string) - Actual JWT cache max lifetime read from the database
    jwt_role_claim_key string
    (string) - Actual JWT role claim key read from the database
    openapi_mode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    server_cors_allowed_origins list(string)
    (list of string) - Actual CORS allowed origins read from the database
    server_timing_enabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    dbAggregatesEnabled Boolean
    (boolean) - Actual aggregate function setting read from the database
    dbExtraSearchPaths List<String>
    (list of string) - Actual extra search path schemas read from the database
    dbMaxRows Integer
    (integer) - Actual max rows setting read from the database
    dbSchemas List<String>
    (list of string) - Actual exposed schemas read from the database
    jwtCacheMaxLifetime String
    (string) - Actual JWT cache max lifetime read from the database
    jwtRoleClaimKey String
    (string) - Actual JWT role claim key read from the database
    openapiMode String
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    serverCorsAllowedOrigins List<String>
    (list of string) - Actual CORS allowed origins read from the database
    serverTimingEnabled Boolean
    (boolean) - Actual Server-Timing header setting read from the database
    dbAggregatesEnabled boolean
    (boolean) - Actual aggregate function setting read from the database
    dbExtraSearchPaths string[]
    (list of string) - Actual extra search path schemas read from the database
    dbMaxRows number
    (integer) - Actual max rows setting read from the database
    dbSchemas string[]
    (list of string) - Actual exposed schemas read from the database
    jwtCacheMaxLifetime string
    (string) - Actual JWT cache max lifetime read from the database
    jwtRoleClaimKey string
    (string) - Actual JWT role claim key read from the database
    openapiMode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    serverCorsAllowedOrigins string[]
    (list of string) - Actual CORS allowed origins read from the database
    serverTimingEnabled boolean
    (boolean) - Actual Server-Timing header setting read from the database
    db_aggregates_enabled bool
    (boolean) - Actual aggregate function setting read from the database
    db_extra_search_paths Sequence[str]
    (list of string) - Actual extra search path schemas read from the database
    db_max_rows int
    (integer) - Actual max rows setting read from the database
    db_schemas Sequence[str]
    (list of string) - Actual exposed schemas read from the database
    jwt_cache_max_lifetime str
    (string) - Actual JWT cache max lifetime read from the database
    jwt_role_claim_key str
    (string) - Actual JWT role claim key read from the database
    openapi_mode str
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    server_cors_allowed_origins Sequence[str]
    (list of string) - Actual CORS allowed origins read from the database
    server_timing_enabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    dbAggregatesEnabled Boolean
    (boolean) - Actual aggregate function setting read from the database
    dbExtraSearchPaths List<String>
    (list of string) - Actual extra search path schemas read from the database
    dbMaxRows Number
    (integer) - Actual max rows setting read from the database
    dbSchemas List<String>
    (list of string) - Actual exposed schemas read from the database
    jwtCacheMaxLifetime String
    (string) - Actual JWT cache max lifetime read from the database
    jwtRoleClaimKey String
    (string) - Actual JWT role claim key read from the database
    openapiMode String
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    serverCorsAllowedOrigins List<String>
    (list of string) - Actual CORS allowed origins read from the database
    serverTimingEnabled Boolean
    (boolean) - Actual Server-Timing header setting read from the database

    GetPostgresDataApiStatus

    AvailableSchemas List<string>
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    DbAggregatesEnabled bool
    (boolean) - Actual aggregate function setting read from the database
    DbExtraSearchPaths List<string>
    (list of string) - Actual extra search path schemas read from the database
    DbMaxRows int
    (integer) - Actual max rows setting read from the database
    DbSchemas List<string>
    (list of string) - Actual exposed schemas read from the database
    JwtCacheMaxLifetime string
    (string) - Actual JWT cache max lifetime read from the database
    JwtRoleClaimKey string
    (string) - Actual JWT role claim key read from the database
    OpenapiMode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    ServerCorsAllowedOrigins List<string>
    (list of string) - Actual CORS allowed origins read from the database
    ServerTimingEnabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    Url string
    (string) - Data API endpoint URL
    AvailableSchemas []string
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    DbAggregatesEnabled bool
    (boolean) - Actual aggregate function setting read from the database
    DbExtraSearchPaths []string
    (list of string) - Actual extra search path schemas read from the database
    DbMaxRows int
    (integer) - Actual max rows setting read from the database
    DbSchemas []string
    (list of string) - Actual exposed schemas read from the database
    JwtCacheMaxLifetime string
    (string) - Actual JWT cache max lifetime read from the database
    JwtRoleClaimKey string
    (string) - Actual JWT role claim key read from the database
    OpenapiMode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    ServerCorsAllowedOrigins []string
    (list of string) - Actual CORS allowed origins read from the database
    ServerTimingEnabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    Url string
    (string) - Data API endpoint URL
    available_schemas list(string)
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    db_aggregates_enabled bool
    (boolean) - Actual aggregate function setting read from the database
    db_extra_search_paths list(string)
    (list of string) - Actual extra search path schemas read from the database
    db_max_rows number
    (integer) - Actual max rows setting read from the database
    db_schemas list(string)
    (list of string) - Actual exposed schemas read from the database
    jwt_cache_max_lifetime string
    (string) - Actual JWT cache max lifetime read from the database
    jwt_role_claim_key string
    (string) - Actual JWT role claim key read from the database
    openapi_mode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    server_cors_allowed_origins list(string)
    (list of string) - Actual CORS allowed origins read from the database
    server_timing_enabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    url string
    (string) - Data API endpoint URL
    availableSchemas List<String>
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    dbAggregatesEnabled Boolean
    (boolean) - Actual aggregate function setting read from the database
    dbExtraSearchPaths List<String>
    (list of string) - Actual extra search path schemas read from the database
    dbMaxRows Integer
    (integer) - Actual max rows setting read from the database
    dbSchemas List<String>
    (list of string) - Actual exposed schemas read from the database
    jwtCacheMaxLifetime String
    (string) - Actual JWT cache max lifetime read from the database
    jwtRoleClaimKey String
    (string) - Actual JWT role claim key read from the database
    openapiMode String
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    serverCorsAllowedOrigins List<String>
    (list of string) - Actual CORS allowed origins read from the database
    serverTimingEnabled Boolean
    (boolean) - Actual Server-Timing header setting read from the database
    url String
    (string) - Data API endpoint URL
    availableSchemas string[]
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    dbAggregatesEnabled boolean
    (boolean) - Actual aggregate function setting read from the database
    dbExtraSearchPaths string[]
    (list of string) - Actual extra search path schemas read from the database
    dbMaxRows number
    (integer) - Actual max rows setting read from the database
    dbSchemas string[]
    (list of string) - Actual exposed schemas read from the database
    jwtCacheMaxLifetime string
    (string) - Actual JWT cache max lifetime read from the database
    jwtRoleClaimKey string
    (string) - Actual JWT role claim key read from the database
    openapiMode string
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    serverCorsAllowedOrigins string[]
    (list of string) - Actual CORS allowed origins read from the database
    serverTimingEnabled boolean
    (boolean) - Actual Server-Timing header setting read from the database
    url string
    (string) - Data API endpoint URL
    available_schemas Sequence[str]
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    db_aggregates_enabled bool
    (boolean) - Actual aggregate function setting read from the database
    db_extra_search_paths Sequence[str]
    (list of string) - Actual extra search path schemas read from the database
    db_max_rows int
    (integer) - Actual max rows setting read from the database
    db_schemas Sequence[str]
    (list of string) - Actual exposed schemas read from the database
    jwt_cache_max_lifetime str
    (string) - Actual JWT cache max lifetime read from the database
    jwt_role_claim_key str
    (string) - Actual JWT role claim key read from the database
    openapi_mode str
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    server_cors_allowed_origins Sequence[str]
    (list of string) - Actual CORS allowed origins read from the database
    server_timing_enabled bool
    (boolean) - Actual Server-Timing header setting read from the database
    url str
    (string) - Data API endpoint URL
    availableSchemas List<String>
    (list of string) - Schemas available in the database (for reference when configuring db_schemas)
    dbAggregatesEnabled Boolean
    (boolean) - Actual aggregate function setting read from the database
    dbExtraSearchPaths List<String>
    (list of string) - Actual extra search path schemas read from the database
    dbMaxRows Number
    (integer) - Actual max rows setting read from the database
    dbSchemas List<String>
    (list of string) - Actual exposed schemas read from the database
    jwtCacheMaxLifetime String
    (string) - Actual JWT cache max lifetime read from the database
    jwtRoleClaimKey String
    (string) - Actual JWT role claim key read from the database
    openapiMode String
    (string) - Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES
    serverCorsAllowedOrigins List<String>
    (list of string) - Actual CORS allowed origins read from the database
    serverTimingEnabled Boolean
    (boolean) - Actual Server-Timing header setting read from the database
    url String
    (string) - Data API endpoint URL

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.99.0
    published on Wednesday, Jul 8, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial