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

databricks.getPostgresEndpoint

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 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,
                          provider_config: Optional[GetPostgresEndpointProviderConfig] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPostgresEndpointResult
def get_postgres_endpoint_output(name: Optional[pulumi.Input[str]] = None,
                          provider_config: Optional[pulumi.Input[GetPostgresEndpointProviderConfigArgs]] = 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 dictionary

    The following arguments are supported:

    Name string
    Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    ProviderConfig GetPostgresEndpointProviderConfig
    Configure the provider for management through account provider.
    Name string
    Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    ProviderConfig GetPostgresEndpointProviderConfig
    Configure the provider for management through account provider.
    name String
    Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    providerConfig GetPostgresEndpointProviderConfig
    Configure the provider for management through account provider.
    name string
    Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    providerConfig GetPostgresEndpointProviderConfig
    Configure the provider for management through account provider.
    name str
    Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    provider_config GetPostgresEndpointProviderConfig
    Configure the provider for management through account provider.
    name String
    Output only. The full resource path of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresEndpoint Result

    The following output properties are available:

    CreateTime 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) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    Status GetPostgresEndpointStatus
    (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 GetPostgresEndpointProviderConfig
    CreateTime 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) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    Status GetPostgresEndpointStatus
    (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 GetPostgresEndpointProviderConfig
    createTime 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) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    status GetPostgresEndpointStatus
    (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 GetPostgresEndpointProviderConfig
    createTime 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) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    status GetPostgresEndpointStatus
    (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 GetPostgresEndpointProviderConfig
    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) - Output only. The full resource path of the endpoint. 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 GetPostgresEndpointSpec
    (EndpointSpec) - The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state
    status GetPostgresEndpointStatus
    (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 GetPostgresEndpointProviderConfig
    createTime 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) - Output only. The full resource path of the endpoint. 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
    updateTime String
    (string) - A timestamp indicating when the compute endpoint was last updated
    providerConfig Property Map

    Supporting Types

    GetPostgresEndpointProviderConfig

    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.

    GetPostgresEndpointSpec

    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 GetPostgresEndpointSpecGroup
    (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 GetPostgresEndpointSpecSettings
    (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 GetPostgresEndpointSpecGroup
    (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 GetPostgresEndpointSpecSettings
    (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 GetPostgresEndpointSpecGroup
    (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 GetPostgresEndpointSpecSettings
    (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 GetPostgresEndpointSpecGroup
    (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 GetPostgresEndpointSpecSettings
    (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 GetPostgresEndpointSpecGroup
    (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 GetPostgresEndpointSpecSettings
    (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

    GetPostgresEndpointSpecGroup

    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

    GetPostgresEndpointSpecSettings

    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

    GetPostgresEndpointStatus

    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 GetPostgresEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    Hosts GetPostgresEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    PendingState string
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    Settings GetPostgresEndpointStatusSettings
    (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 GetPostgresEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    Hosts GetPostgresEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    PendingState string
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    Settings GetPostgresEndpointStatusSettings
    (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 GetPostgresEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts GetPostgresEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pendingState String
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings GetPostgresEndpointStatusSettings
    (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 GetPostgresEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts GetPostgresEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pendingState string
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings GetPostgresEndpointStatusSettings
    (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 GetPostgresEndpointStatusGroup
    (EndpointGroupStatus) - Details on the HA configuration of the endpoint
    hosts GetPostgresEndpointStatusHosts
    (EndpointHosts) - Contains host information for connecting to the endpoint
    pending_state str
    (string) - Possible values are: ACTIVE, DEGRADED, IDLE, INIT
    settings GetPostgresEndpointStatusSettings
    (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

    GetPostgresEndpointStatusGroup

    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

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

    GetPostgresEndpointStatusSettings

    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

    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.