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 lists all Postgres endpoints in a branch.
Example Usage
List All Endpoints in a Branch
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const all = databricks.getPostgresEndpoints({
parent: "projects/my-project/branches/dev-branch",
});
export const endpointNames = all.then(all => .map(endpoint => (endpoint.name)));
export const endpointTypes = all.then(all => .map(endpoint => (endpoint.status?.endpointType)));
import pulumi
import pulumi_databricks as databricks
all = databricks.get_postgres_endpoints(parent="projects/my-project/branches/dev-branch")
pulumi.export("endpointNames", [endpoint.name for endpoint in all.endpoints])
pulumi.export("endpointTypes", [endpoint.status.endpoint_type for endpoint in all.endpoints])
Example coming soon!
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var all = Databricks.GetPostgresEndpoints.Invoke(new()
{
Parent = "projects/my-project/branches/dev-branch",
});
return new Dictionary<string, object?>
{
["endpointNames"] = .Select(endpoint =>
{
return endpoint.Name;
}).ToList(),
["endpointTypes"] = .Select(endpoint =>
{
return endpoint.Status?.EndpointType;
}).ToList(),
};
});
Example coming soon!
Example coming soon!
Using getPostgresEndpoints
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 getPostgresEndpoints(args: GetPostgresEndpointsArgs, opts?: InvokeOptions): Promise<GetPostgresEndpointsResult>
function getPostgresEndpointsOutput(args: GetPostgresEndpointsOutputArgs, opts?: InvokeOptions): Output<GetPostgresEndpointsResult>def get_postgres_endpoints(page_size: Optional[int] = None,
parent: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPostgresEndpointsResult
def get_postgres_endpoints_output(page_size: Optional[pulumi.Input[int]] = None,
parent: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPostgresEndpointsResult]func GetPostgresEndpoints(ctx *Context, args *GetPostgresEndpointsArgs, opts ...InvokeOption) (*GetPostgresEndpointsResult, error)
func GetPostgresEndpointsOutput(ctx *Context, args *GetPostgresEndpointsOutputArgs, opts ...InvokeOption) GetPostgresEndpointsResultOutput> Note: This function is named GetPostgresEndpoints in the Go SDK.
public static class GetPostgresEndpoints
{
public static Task<GetPostgresEndpointsResult> InvokeAsync(GetPostgresEndpointsArgs args, InvokeOptions? opts = null)
public static Output<GetPostgresEndpointsResult> Invoke(GetPostgresEndpointsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPostgresEndpointsResult> getPostgresEndpoints(GetPostgresEndpointsArgs args, InvokeOptions options)
public static Output<GetPostgresEndpointsResult> getPostgresEndpoints(GetPostgresEndpointsArgs args, InvokeOptions options)
fn::invoke:
function: databricks:index/getPostgresEndpoints:getPostgresEndpoints
arguments:
# arguments dictionaryThe following arguments are supported:
getPostgresEndpoints Result
The following output properties are available:
- Endpoints
List<Get
Postgres Endpoints Endpoint> - Id string
- The provider-assigned unique ID for this managed resource.
- Parent string
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Page
Size int
- Endpoints
[]Get
Postgres Endpoints Endpoint - Id string
- The provider-assigned unique ID for this managed resource.
- Parent string
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- Page
Size int
- endpoints
List<Get
Postgres Endpoints Endpoint> - id String
- The provider-assigned unique ID for this managed resource.
- parent String
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- page
Size Integer
- endpoints
Get
Postgres Endpoints Endpoint[] - id string
- The provider-assigned unique ID for this managed resource.
- parent string
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- page
Size number
- endpoints
Sequence[Get
Postgres Endpoints Endpoint] - id str
- The provider-assigned unique ID for this managed resource.
- parent str
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- page_
size int
- endpoints List<Property Map>
- id String
- The provider-assigned unique ID for this managed resource.
- parent String
- (string) - The branch containing this endpoint (API resource hierarchy). Format: projects/{project_id}/branches/{branch_id}
- page
Size Number
Supporting Types
GetPostgresEndpointsEndpoint
- Create
Time string - (string) - A timestamp indicating when the compute endpoint was created
- 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
- The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
- Spec
Get
Postgres Endpoints Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Status
Get
Postgres Endpoints 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
- 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
- The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
- Spec
Get
Postgres Endpoints Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- Status
Get
Postgres Endpoints 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
- 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
- The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
- spec
Get
Postgres Endpoints Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Get
Postgres Endpoints 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
- 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
- The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
- spec
Get
Postgres Endpoints Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Get
Postgres Endpoints 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
- 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
- The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
- spec
Get
Postgres Endpoints Endpoint Spec - (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
- status
Get
Postgres Endpoints 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
- 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
- The Branch that owns this collection of endpoints. 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
GetPostgresEndpointsEndpointSpec
- 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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
GetPostgresEndpointsEndpointSpecSettings
- 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
GetPostgresEndpointsEndpointStatus
- 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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 Endpoints 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
GetPostgresEndpointsEndpointStatusHosts
- 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
GetPostgresEndpointsEndpointStatusSettings
- 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
