1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPostgresEndpoints
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresEndpoints

databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    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,
                           provider_config: Optional[GetPostgresEndpointsProviderConfig] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPostgresEndpointsResult
def get_postgres_endpoints_output(page_size: Optional[pulumi.Input[int]] = None,
                           parent: Optional[pulumi.Input[str]] = None,
                           provider_config: Optional[pulumi.Input[GetPostgresEndpointsProviderConfigArgs]] = 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 dictionary

    The following arguments are supported:

    Parent string
    The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
    PageSize int
    Upper bound for items returned. Cannot be negative
    ProviderConfig GetPostgresEndpointsProviderConfig
    Configure the provider for management through account provider.
    Parent string
    The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
    PageSize int
    Upper bound for items returned. Cannot be negative
    ProviderConfig GetPostgresEndpointsProviderConfig
    Configure the provider for management through account provider.
    parent String
    The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
    pageSize Integer
    Upper bound for items returned. Cannot be negative
    providerConfig GetPostgresEndpointsProviderConfig
    Configure the provider for management through account provider.
    parent string
    The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
    pageSize number
    Upper bound for items returned. Cannot be negative
    providerConfig GetPostgresEndpointsProviderConfig
    Configure the provider for management through account provider.
    parent str
    The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
    page_size int
    Upper bound for items returned. Cannot be negative
    provider_config GetPostgresEndpointsProviderConfig
    Configure the provider for management through account provider.
    parent String
    The Branch that owns this collection of endpoints. Format: projects/{project_id}/branches/{branch_id}
    pageSize Number
    Upper bound for items returned. Cannot be negative
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresEndpoints Result

    The following output properties are available:

    Endpoints List<GetPostgresEndpointsEndpoint>
    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}
    PageSize int
    ProviderConfig GetPostgresEndpointsProviderConfig
    Endpoints []GetPostgresEndpointsEndpoint
    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}
    PageSize int
    ProviderConfig GetPostgresEndpointsProviderConfig
    endpoints List<GetPostgresEndpointsEndpoint>
    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}
    pageSize Integer
    providerConfig GetPostgresEndpointsProviderConfig
    endpoints GetPostgresEndpointsEndpoint[]
    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}
    pageSize number
    providerConfig GetPostgresEndpointsProviderConfig
    endpoints Sequence[GetPostgresEndpointsEndpoint]
    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
    provider_config GetPostgresEndpointsProviderConfig
    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}
    pageSize Number
    providerConfig Property Map

    Supporting Types

    GetPostgresEndpointsEndpoint

    CreateTime string
    (string) - A timestamp indicating when the compute endpoint was created
    Name string
    (string) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointsEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    Status GetPostgresEndpointsEndpointStatus
    (EndpointStatus) - Current operational status of the compute endpoint
    Uid string
    (string) - System-generated unique ID for the endpoint
    UpdateTime string
    (string) - A timestamp indicating when the compute endpoint was last updated
    ProviderConfig GetPostgresEndpointsEndpointProviderConfig
    Configure the provider for management through account provider.
    CreateTime string
    (string) - A timestamp indicating when the compute endpoint was created
    Name string
    (string) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointsEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    Status GetPostgresEndpointsEndpointStatus
    (EndpointStatus) - Current operational status of the compute endpoint
    Uid string
    (string) - System-generated unique ID for the endpoint
    UpdateTime string
    (string) - A timestamp indicating when the compute endpoint was last updated
    ProviderConfig GetPostgresEndpointsEndpointProviderConfig
    Configure the provider for management through account provider.
    createTime String
    (string) - A timestamp indicating when the compute endpoint was created
    name String
    (string) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointsEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    status GetPostgresEndpointsEndpointStatus
    (EndpointStatus) - Current operational status of the compute endpoint
    uid String
    (string) - System-generated unique ID for the endpoint
    updateTime String
    (string) - A timestamp indicating when the compute endpoint was last updated
    providerConfig GetPostgresEndpointsEndpointProviderConfig
    Configure the provider for management through account provider.
    createTime string
    (string) - A timestamp indicating when the compute endpoint was created
    name string
    (string) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointsEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    status GetPostgresEndpointsEndpointStatus
    (EndpointStatus) - Current operational status of the compute endpoint
    uid string
    (string) - System-generated unique ID for the endpoint
    updateTime string
    (string) - A timestamp indicating when the compute endpoint was last updated
    providerConfig GetPostgresEndpointsEndpointProviderConfig
    Configure the provider for management through account provider.
    create_time str
    (string) - A timestamp indicating when the compute endpoint was created
    name str
    (string) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointsEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    status GetPostgresEndpointsEndpointStatus
    (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
    provider_config GetPostgresEndpointsEndpointProviderConfig
    Configure the provider for management through account provider.
    createTime String
    (string) - A timestamp indicating when the compute endpoint was created
    name String
    (string) - Output only. The full resource path of the endpoint. 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
    updateTime String
    (string) - A timestamp indicating when the compute endpoint was last updated
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetPostgresEndpointsEndpointProviderConfig

    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.
    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.

    GetPostgresEndpointsEndpointSpec

    EndpointType 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
    AutoscalingLimitMaxCu double
    (number) - The maximum number of Compute Units
    AutoscalingLimitMinCu double
    (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
    Group GetPostgresEndpointsEndpointSpecGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    NoSuspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    Settings GetPostgresEndpointsEndpointSpecSettings
    (EndpointSettings)
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    EndpointType 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
    AutoscalingLimitMaxCu float64
    (number) - The maximum number of Compute Units
    AutoscalingLimitMinCu float64
    (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
    Group GetPostgresEndpointsEndpointSpecGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    NoSuspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    Settings GetPostgresEndpointsEndpointSpecSettings
    (EndpointSettings)
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    endpointType 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
    autoscalingLimitMaxCu Double
    (number) - The maximum number of Compute Units
    autoscalingLimitMinCu Double
    (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
    group GetPostgresEndpointsEndpointSpecGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    noSuspension Boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    settings GetPostgresEndpointsEndpointSpecSettings
    (EndpointSettings)
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    endpointType 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
    autoscalingLimitMaxCu number
    (number) - The maximum number of Compute Units
    autoscalingLimitMinCu number
    (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
    group GetPostgresEndpointsEndpointSpecGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    noSuspension boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    settings GetPostgresEndpointsEndpointSpecSettings
    (EndpointSettings)
    suspendTimeoutDuration string
    (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_max_cu float
    (number) - The maximum number of Compute Units
    autoscaling_limit_min_cu float
    (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
    group GetPostgresEndpointsEndpointSpecGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    no_suspension bool
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    settings GetPostgresEndpointsEndpointSpecSettings
    (EndpointSettings)
    suspend_timeout_duration str
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    endpointType 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
    autoscalingLimitMaxCu Number
    (number) - The maximum number of Compute Units
    autoscalingLimitMinCu Number
    (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
    group Property Map
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    noSuspension Boolean
    (boolean) - When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided
    settings Property Map
    (EndpointSettings)
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended

    GetPostgresEndpointsEndpointSpecGroup

    Max int
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    Min int
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    EnableReadableSecondaries bool
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    Max int
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    Min int
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    EnableReadableSecondaries bool
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max Integer
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min Integer
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enableReadableSecondaries Boolean
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max number
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min number
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enableReadableSecondaries boolean
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max int
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min int
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enable_readable_secondaries bool
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max Number
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min Number
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enableReadableSecondaries Boolean
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1

    GetPostgresEndpointsEndpointSpecSettings

    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings

    GetPostgresEndpointsEndpointStatus

    AutoscalingLimitMaxCu double
    (number) - The maximum number of Compute Units
    AutoscalingLimitMinCu double
    (number) - The minimum number of Compute Units
    CurrentState string
    (string) - Possible values are: ACTIVE, DEGRADED, 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
    EndpointType 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
    Group GetPostgresEndpointsEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    Hosts GetPostgresEndpointsEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    PendingState string
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    Settings GetPostgresEndpointsEndpointStatusSettings
    (EndpointSettings)
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    AutoscalingLimitMaxCu float64
    (number) - The maximum number of Compute Units
    AutoscalingLimitMinCu float64
    (number) - The minimum number of Compute Units
    CurrentState string
    (string) - Possible values are: ACTIVE, DEGRADED, 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
    EndpointType 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
    Group GetPostgresEndpointsEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    Hosts GetPostgresEndpointsEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    PendingState string
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    Settings GetPostgresEndpointsEndpointStatusSettings
    (EndpointSettings)
    SuspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    autoscalingLimitMaxCu Double
    (number) - The maximum number of Compute Units
    autoscalingLimitMinCu Double
    (number) - The minimum number of Compute Units
    currentState String
    (string) - Possible values are: ACTIVE, DEGRADED, 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
    endpointType 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
    group GetPostgresEndpointsEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts GetPostgresEndpointsEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pendingState String
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings GetPostgresEndpointsEndpointStatusSettings
    (EndpointSettings)
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    autoscalingLimitMaxCu number
    (number) - The maximum number of Compute Units
    autoscalingLimitMinCu number
    (number) - The minimum number of Compute Units
    currentState string
    (string) - Possible values are: ACTIVE, DEGRADED, 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
    endpointType 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
    group GetPostgresEndpointsEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts GetPostgresEndpointsEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pendingState string
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings GetPostgresEndpointsEndpointStatusSettings
    (EndpointSettings)
    suspendTimeoutDuration string
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    autoscaling_limit_max_cu float
    (number) - The maximum number of Compute Units
    autoscaling_limit_min_cu float
    (number) - The minimum number of Compute Units
    current_state str
    (string) - Possible values are: ACTIVE, DEGRADED, 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
    group GetPostgresEndpointsEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts GetPostgresEndpointsEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pending_state str
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings GetPostgresEndpointsEndpointStatusSettings
    (EndpointSettings)
    suspend_timeout_duration str
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended
    autoscalingLimitMaxCu Number
    (number) - The maximum number of Compute Units
    autoscalingLimitMinCu Number
    (number) - The minimum number of Compute Units
    currentState String
    (string) - Possible values are: ACTIVE, DEGRADED, 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
    endpointType 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
    group Property Map
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts Property Map
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pendingState String
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings Property Map
    (EndpointSettings)
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended

    GetPostgresEndpointsEndpointStatusGroup

    EnableReadableSecondaries bool
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    Max int
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    Min int
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    EnableReadableSecondaries bool
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    Max int
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    Min int
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enableReadableSecondaries Boolean
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max Integer
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min Integer
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enableReadableSecondaries boolean
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max number
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min number
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enable_readable_secondaries bool
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max int
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min int
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1
    enableReadableSecondaries Boolean
    (boolean) - Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured by specifying size.max > 1
    max Number
    (integer) - The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to true on the EndpointSpec
    min Number
    (integer) - The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater than or equal to 1

    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
    ReadOnlyHost string
    (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
    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
    ReadOnlyHost string
    (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
    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
    readOnlyHost String
    (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
    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
    readOnlyHost string
    (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
    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
    read_only_host str
    (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled
    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
    readOnlyHost String
    (string) - An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints, this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled

    GetPostgresEndpointsEndpointStatusSettings

    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings

    GetPostgresEndpointsProviderConfig

    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.
    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.

    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.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.