1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPostgresEndpoint
Databricks v1.81.0 published on Thursday, Jan 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresEndpoint

databricks logo
Databricks v1.81.0 published on Thursday, Jan 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Private Preview

    Using getPostgresEndpoint

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

    function getPostgresEndpoint(args: GetPostgresEndpointArgs, opts?: InvokeOptions): Promise<GetPostgresEndpointResult>
function getPostgresEndpointOutput(args: GetPostgresEndpointOutputArgs, opts?: InvokeOptions): Output<GetPostgresEndpointResult>
    def get_postgres_endpoint(name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPostgresEndpointResult
def get_postgres_endpoint_output(name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPostgresEndpointResult]
    func LookupPostgresEndpoint(ctx *Context, args *LookupPostgresEndpointArgs, opts ...InvokeOption) (*LookupPostgresEndpointResult, error)
func LookupPostgresEndpointOutput(ctx *Context, args *LookupPostgresEndpointOutputArgs, opts ...InvokeOption) LookupPostgresEndpointResultOutput

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

    public static class GetPostgresEndpoint 
{
    public static Task<GetPostgresEndpointResult> InvokeAsync(GetPostgresEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresEndpointResult> Invoke(GetPostgresEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresEndpointResult> getPostgresEndpoint(GetPostgresEndpointArgs args, InvokeOptions options)
public static Output<GetPostgresEndpointResult> getPostgresEndpoint(GetPostgresEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getPostgresEndpoint:getPostgresEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    Name string
    The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    name String
    The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    name string
    The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    name str
    The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    name String
    The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}

    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) - The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    Parent string
    (string) - The branch containing this endpoint. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresEndpointSpec
    (EndpointSpec) - The desired state of an Endpoint
    Status GetPostgresEndpointStatus
    (EndpointStatus) - The current status of an Endpoint
    Uid string
    (string) - System generated unique ID for the endpoint
    UpdateTime string
    (string) - A timestamp indicating when the compute endpoint was last updated
    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) - The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    Parent string
    (string) - The branch containing this endpoint. Format: projects/{project_id}/branches/{branch_id}
    Spec GetPostgresEndpointSpec
    (EndpointSpec) - The desired state of an Endpoint
    Status GetPostgresEndpointStatus
    (EndpointStatus) - The current status of an Endpoint
    Uid string
    (string) - System generated unique ID for the endpoint
    UpdateTime string
    (string) - A timestamp indicating when the compute endpoint was last updated
    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) - The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    parent String
    (string) - The branch containing this endpoint. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresEndpointSpec
    (EndpointSpec) - The desired state of an Endpoint
    status GetPostgresEndpointStatus
    (EndpointStatus) - The current status of an Endpoint
    uid String
    (string) - System generated unique ID for the endpoint
    updateTime String
    (string) - A timestamp indicating when the compute endpoint was last updated
    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) - The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    parent string
    (string) - The branch containing this endpoint. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresEndpointSpec
    (EndpointSpec) - The desired state of an Endpoint
    status GetPostgresEndpointStatus
    (EndpointStatus) - The current status of an Endpoint
    uid string
    (string) - System generated unique ID for the endpoint
    updateTime string
    (string) - A timestamp indicating when the compute endpoint was last updated
    create_time str
    (string) - A timestamp indicating when the compute endpoint was created
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    parent str
    (string) - The branch containing this endpoint. Format: projects/{project_id}/branches/{branch_id}
    spec GetPostgresEndpointSpec
    (EndpointSpec) - The desired state of an Endpoint
    status GetPostgresEndpointStatus
    (EndpointStatus) - The current status of an 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
    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) - The resource name of the endpoint. Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
    parent String
    (string) - The branch containing this endpoint. Format: projects/{project_id}/branches/{branch_id}
    spec Property Map
    (EndpointSpec) - The desired state of an Endpoint
    status Property Map
    (EndpointStatus) - The current status of an Endpoint
    uid String
    (string) - System generated unique ID for the endpoint
    updateTime String
    (string) - A timestamp indicating when the compute endpoint was last updated

    Supporting Types

    GetPostgresEndpointSpec

    EndpointType string
    (string) - The endpoint type. A branch can only have one READ_WRITE endpoint. Possible values are: READ_ONLY, 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
    PoolerMode string
    (string) - Possible values are: TRANSACTION
    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: READ_ONLY, 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
    PoolerMode string
    (string) - Possible values are: TRANSACTION
    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: READ_ONLY, 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
    poolerMode String
    (string) - Possible values are: TRANSACTION
    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: READ_ONLY, 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
    poolerMode string
    (string) - Possible values are: TRANSACTION
    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: READ_ONLY, 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
    pooler_mode str
    (string) - Possible values are: TRANSACTION
    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: READ_ONLY, 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
    poolerMode String
    (string) - Possible values are: TRANSACTION
    settings Property Map
    (EndpointSettings)
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended

    GetPostgresEndpointSpecSettings

    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    PgbouncerSettings Dictionary<string, string>
    (object) - A raw representation of PgBouncer settings
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    PgbouncerSettings map[string]string
    (object) - A raw representation of PgBouncer settings
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    pgbouncerSettings Map<String,String>
    (object) - A raw representation of PgBouncer settings
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    pgbouncerSettings {[key: string]: string}
    (object) - A raw representation of PgBouncer settings
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    pgbouncer_settings Mapping[str, str]
    (object) - A raw representation of PgBouncer settings
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings
    pgbouncerSettings Map<String>
    (object) - A raw representation of PgBouncer 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, 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: READ_ONLY, READ_WRITE
    Host string
    (string) - The hostname of the compute endpoint. This is the hostname specified when connecting to a database
    LastActiveTime string
    (string) - A timestamp indicating when the compute endpoint was last active
    PendingState string
    (string) - Possible values are: ACTIVE, IDLE, INIT
    PoolerMode string
    (string) - Possible values are: TRANSACTION
    Settings GetPostgresEndpointStatusSettings
    (EndpointSettings)
    StartTime string
    (string) - A timestamp indicating when the compute endpoint was last started
    SuspendTime string
    (string) - A timestamp indicating when the compute endpoint was last suspended
    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, 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: READ_ONLY, READ_WRITE
    Host string
    (string) - The hostname of the compute endpoint. This is the hostname specified when connecting to a database
    LastActiveTime string
    (string) - A timestamp indicating when the compute endpoint was last active
    PendingState string
    (string) - Possible values are: ACTIVE, IDLE, INIT
    PoolerMode string
    (string) - Possible values are: TRANSACTION
    Settings GetPostgresEndpointStatusSettings
    (EndpointSettings)
    StartTime string
    (string) - A timestamp indicating when the compute endpoint was last started
    SuspendTime string
    (string) - A timestamp indicating when the compute endpoint was last suspended
    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, 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: READ_ONLY, READ_WRITE
    host String
    (string) - The hostname of the compute endpoint. This is the hostname specified when connecting to a database
    lastActiveTime String
    (string) - A timestamp indicating when the compute endpoint was last active
    pendingState String
    (string) - Possible values are: ACTIVE, IDLE, INIT
    poolerMode String
    (string) - Possible values are: TRANSACTION
    settings GetPostgresEndpointStatusSettings
    (EndpointSettings)
    startTime String
    (string) - A timestamp indicating when the compute endpoint was last started
    suspendTime String
    (string) - A timestamp indicating when the compute endpoint was last suspended
    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, 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: READ_ONLY, READ_WRITE
    host string
    (string) - The hostname of the compute endpoint. This is the hostname specified when connecting to a database
    lastActiveTime string
    (string) - A timestamp indicating when the compute endpoint was last active
    pendingState string
    (string) - Possible values are: ACTIVE, IDLE, INIT
    poolerMode string
    (string) - Possible values are: TRANSACTION
    settings GetPostgresEndpointStatusSettings
    (EndpointSettings)
    startTime string
    (string) - A timestamp indicating when the compute endpoint was last started
    suspendTime string
    (string) - A timestamp indicating when the compute endpoint was last suspended
    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, 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: READ_ONLY, READ_WRITE
    host str
    (string) - The hostname of the compute endpoint. This is the hostname specified when connecting to a database
    last_active_time str
    (string) - A timestamp indicating when the compute endpoint was last active
    pending_state str
    (string) - Possible values are: ACTIVE, IDLE, INIT
    pooler_mode str
    (string) - Possible values are: TRANSACTION
    settings GetPostgresEndpointStatusSettings
    (EndpointSettings)
    start_time str
    (string) - A timestamp indicating when the compute endpoint was last started
    suspend_time str
    (string) - A timestamp indicating when the compute endpoint was last suspended
    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, 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: READ_ONLY, READ_WRITE
    host String
    (string) - The hostname of the compute endpoint. This is the hostname specified when connecting to a database
    lastActiveTime String
    (string) - A timestamp indicating when the compute endpoint was last active
    pendingState String
    (string) - Possible values are: ACTIVE, IDLE, INIT
    poolerMode String
    (string) - Possible values are: TRANSACTION
    settings Property Map
    (EndpointSettings)
    startTime String
    (string) - A timestamp indicating when the compute endpoint was last started
    suspendTime String
    (string) - A timestamp indicating when the compute endpoint was last suspended
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended

    GetPostgresEndpointStatusSettings

    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    PgbouncerSettings Dictionary<string, string>
    (object) - A raw representation of PgBouncer settings
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    PgbouncerSettings map[string]string
    (object) - A raw representation of PgBouncer settings
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    pgbouncerSettings Map<String,String>
    (object) - A raw representation of PgBouncer settings
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    pgbouncerSettings {[key: string]: string}
    (object) - A raw representation of PgBouncer settings
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    pgbouncer_settings Mapping[str, str]
    (object) - A raw representation of PgBouncer settings
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings
    pgbouncerSettings Map<String>
    (object) - A raw representation of PgBouncer 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
    Databricks v1.81.0 published on Thursday, Jan 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate