Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
This data source retrieves a single Postgres endpoint.
Example Usage
Retrieve Endpoint by Name
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const _this = databricks.getPostgresEndpoint({
name: "projects/my-project/branches/dev-branch/endpoints/primary",
});
export const endpointType = _this.then(_this => _this.status?.endpointType);
import pulumi
import pulumi_databricks as databricks
this = databricks.get_postgres_endpoint(name="projects/my-project/branches/dev-branch/endpoints/primary")
pulumi.export("endpointType", this.status.endpoint_type)
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 {
this, err := databricks.LookupPostgresEndpoint(ctx, &databricks.LookupPostgresEndpointArgs{
Name: "projects/my-project/branches/dev-branch/endpoints/primary",
}, nil)
if err != nil {
return err
}
ctx.Export("endpointType", this.Status.EndpointType)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var @this = Databricks.GetPostgresEndpoint.Invoke(new()
{
Name = "projects/my-project/branches/dev-branch/endpoints/primary",
});
return new Dictionary<string, object?>
{
["endpointType"] = @this.Apply(@this => @this.Apply(getPostgresEndpointResult => getPostgresEndpointResult.Status?.EndpointType)),
};
});
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.GetPostgresEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var this = DatabricksFunctions.getPostgresEndpoint(GetPostgresEndpointArgs.builder()
.name("projects/my-project/branches/dev-branch/endpoints/primary")
.build());
ctx.export("endpointType", this_.status().endpointType());
}
}
variables:
this:
fn::invoke:
function: databricks:getPostgresEndpoint
arguments:
name: projects/my-project/branches/dev-branch/endpoints/primary
outputs:
endpointType: ${this.status.endpointType}
Using getPostgresEndpoint
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 getPostgresEndpoint(args: GetPostgresEndpointArgs, opts?: InvokeOptions): Promise<GetPostgresEndpointResult>
function getPostgresEndpointOutput(args: GetPostgresEndpointOutputArgs, opts?: InvokeOptions): Output<GetPostgresEndpointResult>def get_postgres_endpoint(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPostgresEndpointResult
def get_postgres_endpoint_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPostgresEndpointResult]func LookupPostgresEndpoint(ctx *Context, args *LookupPostgresEndpointArgs, opts ...InvokeOption) (*LookupPostgresEndpointResult, error)
func LookupPostgresEndpointOutput(ctx *Context, args *LookupPostgresEndpointOutputArgs, opts ...InvokeOption) LookupPostgresEndpointResultOutput> Note: This function is named LookupPostgresEndpoint in the Go SDK.
public static class GetPostgresEndpoint
{
public static Task<GetPostgresEndpointResult> InvokeAsync(GetPostgresEndpointArgs args, InvokeOptions? opts = null)
public static Output<GetPostgresEndpointResult> Invoke(GetPostgresEndpointInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPostgresEndpointResult> getPostgresEndpoint(GetPostgresEndpointArgs args, InvokeOptions options)
public static Output<GetPostgresEndpointResult> getPostgresEndpoint(GetPostgresEndpointArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getPostgresEndpoint:getPostgresEndpoint
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- Name string
- The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- name String
- The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- name string
- The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- name str
- The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
- name String
- The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
getPostgresEndpoint Result
The following output properties are available:
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - Parent string
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Spec
Get
Postgres Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Status
Get
Postgres Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- Uid string
- (string) - System-generated unique ID for the endpoint
- Update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - Parent string
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Spec
Get
Postgres Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Status
Get
Postgres Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- Uid string
- (string) - System-generated unique ID for the endpoint
- Update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time String - (string) - A timestamp indicating when the compute endpoint was created
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - parent String
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- spec
Get
Postgres Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Get
Postgres Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid String
- (string) - System-generated unique ID for the endpoint
- update
Time String - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - parent string
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- spec
Get
Postgres Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Get
Postgres Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid string
- (string) - System-generated unique ID for the endpoint
- update
Time string - (string) - A timestamp indicating when the compute endpoint was last updated
- create_
time str - (string) - A timestamp indicating when the compute endpoint was created
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - parent str
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- spec
Get
Postgres Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Get
Postgres Endpoint Status - (EndpointStatus) - Current operational status of the compute endpoint
- uid str
- (string) - System-generated unique ID for the endpoint
- update_
time str - (string) - A timestamp indicating when the compute endpoint was last updated
- create
Time String - (string) - A timestamp indicating when the compute endpoint was created
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- (string) - The resource name of the endpoint. This field is output-only and constructed by the system.
Format:
projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id} - parent String
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- spec Property Map
- (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status Property Map
- (EndpointStatus) - Current operational status of the compute endpoint
- uid String
- (string) - System-generated unique ID for the endpoint
- update
Time String - (string) - A timestamp indicating when the compute endpoint was last updated
Supporting Types
GetPostgresEndpointSpec
- Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Autoscaling
Limit doubleMax Cu - (number) - The maximum number of Compute Units
- Autoscaling
Limit doubleMin Cu - (number) - The minimum number of Compute Units
- Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- No
Suspension bool - (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- Settings
Get
Postgres Endpoint Spec Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Autoscaling
Limit float64Max Cu - (number) - The maximum number of Compute Units
- Autoscaling
Limit float64Min Cu - (number) - The minimum number of Compute Units
- Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- No
Suspension bool - (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- Settings
Get
Postgres Endpoint Spec Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling
Limit DoubleMax Cu - (number) - The maximum number of Compute Units
- autoscaling
Limit DoubleMin Cu - (number) - The minimum number of Compute Units
- disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- no
Suspension Boolean - (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- settings
Get
Postgres Endpoint Spec Settings - (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling
Limit numberMax Cu - (number) - The maximum number of Compute Units
- autoscaling
Limit numberMin Cu - (number) - The minimum number of Compute Units
- disabled boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- no
Suspension boolean - (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- settings
Get
Postgres Endpoint Spec Settings - (EndpointSettings)
- suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint_
type str - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling_
limit_ floatmax_ cu - (number) - The maximum number of Compute Units
- autoscaling_
limit_ floatmin_ cu - (number) - The minimum number of Compute Units
- disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- no_
suspension bool - (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- settings
Get
Postgres Endpoint Spec Settings - (EndpointSettings)
- suspend_
timeout_ strduration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - autoscaling
Limit NumberMax Cu - (number) - The maximum number of Compute Units
- autoscaling
Limit NumberMin Cu - (number) - The minimum number of Compute Units
- disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- no
Suspension Boolean - (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
- settings Property Map
- (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
GetPostgresEndpointSpecSettings
- Pg
Settings Dictionary<string, string> - (object) - A raw representation of Postgres settings
- Pg
Settings map[string]string - (object) - A raw representation of Postgres settings
- pg
Settings Map<String,String> - (object) - A raw representation of Postgres settings
- pg
Settings {[key: string]: string} - (object) - A raw representation of Postgres settings
- pg_
settings Mapping[str, str] - (object) - A raw representation of Postgres settings
- pg
Settings Map<String> - (object) - A raw representation of Postgres settings
GetPostgresEndpointStatus
- Autoscaling
Limit doubleMax Cu - (number) - The maximum number of Compute Units
- Autoscaling
Limit doubleMin Cu - (number) - The minimum number of Compute Units
- Current
State string - (string) - Possible values are:
ACTIVE,IDLE,INIT - Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Hosts
Get
Postgres Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- Pending
State string - (string) - Possible values are:
ACTIVE,IDLE,INIT - Settings
Get
Postgres Endpoint Status Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- Autoscaling
Limit float64Max Cu - (number) - The maximum number of Compute Units
- Autoscaling
Limit float64Min Cu - (number) - The minimum number of Compute Units
- Current
State string - (string) - Possible values are:
ACTIVE,IDLE,INIT - Disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- Endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - Hosts
Get
Postgres Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- Pending
State string - (string) - Possible values are:
ACTIVE,IDLE,INIT - Settings
Get
Postgres Endpoint Status Settings - (EndpointSettings)
- Suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling
Limit DoubleMax Cu - (number) - The maximum number of Compute Units
- autoscaling
Limit DoubleMin Cu - (number) - The minimum number of Compute Units
- current
State String - (string) - Possible values are:
ACTIVE,IDLE,INIT - disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - hosts
Get
Postgres Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- pending
State String - (string) - Possible values are:
ACTIVE,IDLE,INIT - settings
Get
Postgres Endpoint Status Settings - (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling
Limit numberMax Cu - (number) - The maximum number of Compute Units
- autoscaling
Limit numberMin Cu - (number) - The minimum number of Compute Units
- current
State string - (string) - Possible values are:
ACTIVE,IDLE,INIT - disabled boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint
Type string - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - hosts
Get
Postgres Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- pending
State string - (string) - Possible values are:
ACTIVE,IDLE,INIT - settings
Get
Postgres Endpoint Status Settings - (EndpointSettings)
- suspend
Timeout stringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling_
limit_ floatmax_ cu - (number) - The maximum number of Compute Units
- autoscaling_
limit_ floatmin_ cu - (number) - The minimum number of Compute Units
- current_
state str - (string) - Possible values are:
ACTIVE,IDLE,INIT - disabled bool
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint_
type str - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - hosts
Get
Postgres Endpoint Status Hosts - (EndpointHosts) - Contains host information for connecting to the endpoint
- pending_
state str - (string) - Possible values are:
ACTIVE,IDLE,INIT - settings
Get
Postgres Endpoint Status Settings - (EndpointSettings)
- suspend_
timeout_ strduration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
- autoscaling
Limit NumberMax Cu - (number) - The maximum number of Compute Units
- autoscaling
Limit NumberMin Cu - (number) - The minimum number of Compute Units
- current
State String - (string) - Possible values are:
ACTIVE,IDLE,INIT - disabled Boolean
- (boolean) - Whether to restrict connections to the compute endpoint. Enabling this option schedules a suspend compute operation. A disabled compute endpoint cannot be enabled by a connection or console action
- endpoint
Type String - (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are:
ENDPOINT_TYPE_READ_ONLY,ENDPOINT_TYPE_READ_WRITE - hosts Property Map
- (EndpointHosts) - Contains host information for connecting to the endpoint
- pending
State String - (string) - Possible values are:
ACTIVE,IDLE,INIT - settings Property Map
- (EndpointSettings)
- suspend
Timeout StringDuration - (string) - Duration of inactivity after which the compute endpoint is automatically suspended
GetPostgresEndpointStatusHosts
- Host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- Host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- host String
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- host string
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- host str
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
- host String
- (string) - The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations
GetPostgresEndpointStatusSettings
- Pg
Settings Dictionary<string, string> - (object) - A raw representation of Postgres settings
- Pg
Settings map[string]string - (object) - A raw representation of Postgres settings
- pg
Settings Map<String,String> - (object) - A raw representation of Postgres settings
- pg
Settings {[key: string]: string} - (object) - A raw representation of Postgres settings
- pg_
settings Mapping[str, str] - (object) - A raw representation of Postgres settings
- pg
Settings Map<String> - (object) - A raw representation of Postgres settings
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricksTerraform Provider.
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
