1. Packages
  2. Databricks Provider
  3. API Docs
  4. getPostgresProject
Databricks v1.82.0 published on Friday, Jan 16, 2026 by Pulumi
databricks logo
Databricks v1.82.0 published on Friday, Jan 16, 2026 by Pulumi

    Private Preview

    Using getPostgresProject

    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 getPostgresProject(args: GetPostgresProjectArgs, opts?: InvokeOptions): Promise<GetPostgresProjectResult>
    function getPostgresProjectOutput(args: GetPostgresProjectOutputArgs, opts?: InvokeOptions): Output<GetPostgresProjectResult>
    def get_postgres_project(name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPostgresProjectResult
    def get_postgres_project_output(name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPostgresProjectResult]
    func LookupPostgresProject(ctx *Context, args *LookupPostgresProjectArgs, opts ...InvokeOption) (*LookupPostgresProjectResult, error)
    func LookupPostgresProjectOutput(ctx *Context, args *LookupPostgresProjectOutputArgs, opts ...InvokeOption) LookupPostgresProjectResultOutput

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

    public static class GetPostgresProject 
    {
        public static Task<GetPostgresProjectResult> InvokeAsync(GetPostgresProjectArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresProjectResult> Invoke(GetPostgresProjectInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPostgresProjectResult> getPostgresProject(GetPostgresProjectArgs args, InvokeOptions options)
    public static Output<GetPostgresProjectResult> getPostgresProject(GetPostgresProjectArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPostgresProject:getPostgresProject
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The resource name of the project. Format: projects/{project_id}
    Name string
    The resource name of the project. Format: projects/{project_id}
    name String
    The resource name of the project. Format: projects/{project_id}
    name string
    The resource name of the project. Format: projects/{project_id}
    name str
    The resource name of the project. Format: projects/{project_id}
    name String
    The resource name of the project. Format: projects/{project_id}

    getPostgresProject Result

    The following output properties are available:

    CreateTime string
    (string) - A timestamp indicating when the project was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the project. Format: projects/{project_id}
    Spec GetPostgresProjectSpec
    (ProjectSpec) - The desired state of a Project
    Status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    Uid string
    (string) - System generated unique ID for the project
    UpdateTime string
    (string) - A timestamp indicating when the project was last updated
    CreateTime string
    (string) - A timestamp indicating when the project was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the project. Format: projects/{project_id}
    Spec GetPostgresProjectSpec
    (ProjectSpec) - The desired state of a Project
    Status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    Uid string
    (string) - System generated unique ID for the project
    UpdateTime string
    (string) - A timestamp indicating when the project was last updated
    createTime String
    (string) - A timestamp indicating when the project was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the project. Format: projects/{project_id}
    spec GetPostgresProjectSpec
    (ProjectSpec) - The desired state of a Project
    status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    uid String
    (string) - System generated unique ID for the project
    updateTime String
    (string) - A timestamp indicating when the project was last updated
    createTime string
    (string) - A timestamp indicating when the project was created
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - The resource name of the project. Format: projects/{project_id}
    spec GetPostgresProjectSpec
    (ProjectSpec) - The desired state of a Project
    status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    uid string
    (string) - System generated unique ID for the project
    updateTime string
    (string) - A timestamp indicating when the project was last updated
    create_time str
    (string) - A timestamp indicating when the project was created
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - The resource name of the project. Format: projects/{project_id}
    spec GetPostgresProjectSpec
    (ProjectSpec) - The desired state of a Project
    status GetPostgresProjectStatus
    (ProjectStatus) - The current status of a Project
    uid str
    (string) - System generated unique ID for the project
    update_time str
    (string) - A timestamp indicating when the project was last updated
    createTime String
    (string) - A timestamp indicating when the project was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the project. Format: projects/{project_id}
    spec Property Map
    (ProjectSpec) - The desired state of a Project
    status Property Map
    (ProjectStatus) - The current status of a Project
    uid String
    (string) - System generated unique ID for the project
    updateTime String
    (string) - A timestamp indicating when the project was last updated

    Supporting Types

    GetPostgresProjectSpec

    DefaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    PgVersion int
    (integer) - The effective major Postgres version number
    Settings GetPostgresProjectSpecSettings
    (ProjectSettings) - The effective project settings
    DefaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    PgVersion int
    (integer) - The effective major Postgres version number
    Settings GetPostgresProjectSpecSettings
    (ProjectSettings) - The effective project settings
    defaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pgVersion Integer
    (integer) - The effective major Postgres version number
    settings GetPostgresProjectSpecSettings
    (ProjectSettings) - The effective project settings
    defaultEndpointSettings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName string
    (string) - The effective human-readable project name
    historyRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pgVersion number
    (integer) - The effective major Postgres version number
    settings GetPostgresProjectSpecSettings
    (ProjectSettings) - The effective project settings
    default_endpoint_settings GetPostgresProjectSpecDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    display_name str
    (string) - The effective human-readable project name
    history_retention_duration str
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pg_version int
    (integer) - The effective major Postgres version number
    settings GetPostgresProjectSpecSettings
    (ProjectSettings) - The effective project settings
    defaultEndpointSettings Property Map
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    pgVersion Number
    (integer) - The effective major Postgres version number
    settings Property Map
    (ProjectSettings) - The effective project settings

    GetPostgresProjectSpecDefaultEndpointSettings

    AutoscalingLimitMaxCu double
    (number) - The maximum number of Compute Units
    AutoscalingLimitMinCu double
    (number) - The minimum number of Compute Units
    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    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
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    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
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    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
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    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
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    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
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended

    GetPostgresProjectSpecSettings

    EnableLogicalReplication bool
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    EnableLogicalReplication bool
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enableLogicalReplication Boolean
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enableLogicalReplication boolean
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enable_logical_replication bool
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enableLogicalReplication Boolean
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled

    GetPostgresProjectStatus

    BranchLogicalSizeLimitBytes int
    (integer) - The logical size limit for a branch
    ComputeLastActiveTime string
    (string) - The most recent time when any endpoint of this project was active
    DefaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    Owner string
    (string) - The email of the project owner
    PgVersion int
    (integer) - The effective major Postgres version number
    Settings GetPostgresProjectStatusSettings
    (ProjectSettings) - The effective project settings
    SyntheticStorageSizeBytes int
    (integer) - The current space occupied by the project in storage
    BranchLogicalSizeLimitBytes int
    (integer) - The logical size limit for a branch
    ComputeLastActiveTime string
    (string) - The most recent time when any endpoint of this project was active
    DefaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    DisplayName string
    (string) - The effective human-readable project name
    HistoryRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    Owner string
    (string) - The email of the project owner
    PgVersion int
    (integer) - The effective major Postgres version number
    Settings GetPostgresProjectStatusSettings
    (ProjectSettings) - The effective project settings
    SyntheticStorageSizeBytes int
    (integer) - The current space occupied by the project in storage
    branchLogicalSizeLimitBytes Integer
    (integer) - The logical size limit for a branch
    computeLastActiveTime String
    (string) - The most recent time when any endpoint of this project was active
    defaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner String
    (string) - The email of the project owner
    pgVersion Integer
    (integer) - The effective major Postgres version number
    settings GetPostgresProjectStatusSettings
    (ProjectSettings) - The effective project settings
    syntheticStorageSizeBytes Integer
    (integer) - The current space occupied by the project in storage
    branchLogicalSizeLimitBytes number
    (integer) - The logical size limit for a branch
    computeLastActiveTime string
    (string) - The most recent time when any endpoint of this project was active
    defaultEndpointSettings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName string
    (string) - The effective human-readable project name
    historyRetentionDuration string
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner string
    (string) - The email of the project owner
    pgVersion number
    (integer) - The effective major Postgres version number
    settings GetPostgresProjectStatusSettings
    (ProjectSettings) - The effective project settings
    syntheticStorageSizeBytes number
    (integer) - The current space occupied by the project in storage
    branch_logical_size_limit_bytes int
    (integer) - The logical size limit for a branch
    compute_last_active_time str
    (string) - The most recent time when any endpoint of this project was active
    default_endpoint_settings GetPostgresProjectStatusDefaultEndpointSettings
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    display_name str
    (string) - The effective human-readable project name
    history_retention_duration str
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner str
    (string) - The email of the project owner
    pg_version int
    (integer) - The effective major Postgres version number
    settings GetPostgresProjectStatusSettings
    (ProjectSettings) - The effective project settings
    synthetic_storage_size_bytes int
    (integer) - The current space occupied by the project in storage
    branchLogicalSizeLimitBytes Number
    (integer) - The logical size limit for a branch
    computeLastActiveTime String
    (string) - The most recent time when any endpoint of this project was active
    defaultEndpointSettings Property Map
    (ProjectDefaultEndpointSettings) - The effective default endpoint settings
    displayName String
    (string) - The effective human-readable project name
    historyRetentionDuration String
    (string) - The effective number of seconds to retain the shared history for point in time recovery
    owner String
    (string) - The email of the project owner
    pgVersion Number
    (integer) - The effective major Postgres version number
    settings Property Map
    (ProjectSettings) - The effective project settings
    syntheticStorageSizeBytes Number
    (integer) - The current space occupied by the project in storage

    GetPostgresProjectStatusDefaultEndpointSettings

    AutoscalingLimitMaxCu double
    (number) - The maximum number of Compute Units
    AutoscalingLimitMinCu double
    (number) - The minimum number of Compute Units
    PgSettings Dictionary<string, string>
    (object) - A raw representation of Postgres settings
    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
    PgSettings map[string]string
    (object) - A raw representation of Postgres settings
    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
    pgSettings Map<String,String>
    (object) - A raw representation of Postgres settings
    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
    pgSettings {[key: string]: string}
    (object) - A raw representation of Postgres settings
    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
    pg_settings Mapping[str, str]
    (object) - A raw representation of Postgres settings
    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
    pgSettings Map<String>
    (object) - A raw representation of Postgres settings
    suspendTimeoutDuration String
    (string) - Duration of inactivity after which the compute endpoint is automatically suspended

    GetPostgresProjectStatusSettings

    EnableLogicalReplication bool
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    EnableLogicalReplication bool
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enableLogicalReplication Boolean
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enableLogicalReplication boolean
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enable_logical_replication bool
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled
    enableLogicalReplication Boolean
    (boolean) - Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled

    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.82.0 published on Friday, Jan 16, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate