1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresCatalog
Viewing docs for Databricks v1.91.1
published on Friday, May 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getPostgresCatalog

databricks logo
Viewing docs for Databricks v1.91.1
published on Friday, May 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    Using getPostgresCatalog

    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 getPostgresCatalog(args: GetPostgresCatalogArgs, opts?: InvokeOptions): Promise<GetPostgresCatalogResult>
function getPostgresCatalogOutput(args: GetPostgresCatalogOutputArgs, opts?: InvokeOptions): Output<GetPostgresCatalogResult>
    def get_postgres_catalog(name: Optional[str] = None,
                         provider_config: Optional[GetPostgresCatalogProviderConfig] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPostgresCatalogResult
def get_postgres_catalog_output(name: Optional[pulumi.Input[str]] = None,
                         provider_config: Optional[pulumi.Input[GetPostgresCatalogProviderConfigArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPostgresCatalogResult]
    func LookupPostgresCatalog(ctx *Context, args *LookupPostgresCatalogArgs, opts ...InvokeOption) (*LookupPostgresCatalogResult, error)
func LookupPostgresCatalogOutput(ctx *Context, args *LookupPostgresCatalogOutputArgs, opts ...InvokeOption) LookupPostgresCatalogResultOutput

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

    public static class GetPostgresCatalog 
{
    public static Task<GetPostgresCatalogResult> InvokeAsync(GetPostgresCatalogArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresCatalogResult> Invoke(GetPostgresCatalogInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresCatalogResult> getPostgresCatalog(GetPostgresCatalogArgs args, InvokeOptions options)
public static Output<GetPostgresCatalogResult> getPostgresCatalog(GetPostgresCatalogArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Name string

    Output only. The full resource path of the catalog.

    Format: "catalogs/{catalog_id}"

    ProviderConfig GetPostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    Name string

    Output only. The full resource path of the catalog.

    Format: "catalogs/{catalog_id}"

    ProviderConfig GetPostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    name String

    Output only. The full resource path of the catalog.

    Format: "catalogs/{catalog_id}"

    providerConfig GetPostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    name string

    Output only. The full resource path of the catalog.

    Format: "catalogs/{catalog_id}"

    providerConfig GetPostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    name str

    Output only. The full resource path of the catalog.

    Format: "catalogs/{catalog_id}"

    provider_config GetPostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    name String

    Output only. The full resource path of the catalog.

    Format: "catalogs/{catalog_id}"

    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresCatalog Result

    The following output properties are available:

    CreateTime string
    (string) - A timestamp indicating when the catalog was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Output only. The full resource path of the catalog.
    Spec GetPostgresCatalogSpec
    (CatalogCatalogSpec) - The desired state of the Catalog
    Status GetPostgresCatalogStatus
    (CatalogCatalogStatus) - The observed state of the Catalog
    Uid string
    (string) - System-generated unique identifier for the catalog
    UpdateTime string
    (string) - A timestamp indicating when the catalog was last updated
    ProviderConfig GetPostgresCatalogProviderConfig
    CreateTime string
    (string) - A timestamp indicating when the catalog was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Output only. The full resource path of the catalog.
    Spec GetPostgresCatalogSpec
    (CatalogCatalogSpec) - The desired state of the Catalog
    Status GetPostgresCatalogStatus
    (CatalogCatalogStatus) - The observed state of the Catalog
    Uid string
    (string) - System-generated unique identifier for the catalog
    UpdateTime string
    (string) - A timestamp indicating when the catalog was last updated
    ProviderConfig GetPostgresCatalogProviderConfig
    createTime String
    (string) - A timestamp indicating when the catalog was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Output only. The full resource path of the catalog.
    spec GetPostgresCatalogSpec
    (CatalogCatalogSpec) - The desired state of the Catalog
    status GetPostgresCatalogStatus
    (CatalogCatalogStatus) - The observed state of the Catalog
    uid String
    (string) - System-generated unique identifier for the catalog
    updateTime String
    (string) - A timestamp indicating when the catalog was last updated
    providerConfig GetPostgresCatalogProviderConfig
    createTime string
    (string) - A timestamp indicating when the catalog was created
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Output only. The full resource path of the catalog.
    spec GetPostgresCatalogSpec
    (CatalogCatalogSpec) - The desired state of the Catalog
    status GetPostgresCatalogStatus
    (CatalogCatalogStatus) - The observed state of the Catalog
    uid string
    (string) - System-generated unique identifier for the catalog
    updateTime string
    (string) - A timestamp indicating when the catalog was last updated
    providerConfig GetPostgresCatalogProviderConfig
    create_time str
    (string) - A timestamp indicating when the catalog was created
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - Output only. The full resource path of the catalog.
    spec GetPostgresCatalogSpec
    (CatalogCatalogSpec) - The desired state of the Catalog
    status GetPostgresCatalogStatus
    (CatalogCatalogStatus) - The observed state of the Catalog
    uid str
    (string) - System-generated unique identifier for the catalog
    update_time str
    (string) - A timestamp indicating when the catalog was last updated
    provider_config GetPostgresCatalogProviderConfig
    createTime String
    (string) - A timestamp indicating when the catalog was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Output only. The full resource path of the catalog.
    spec Property Map
    (CatalogCatalogSpec) - The desired state of the Catalog
    status Property Map
    (CatalogCatalogStatus) - The observed state of the Catalog
    uid String
    (string) - System-generated unique identifier for the catalog
    updateTime String
    (string) - A timestamp indicating when the catalog was last updated
    providerConfig Property Map

    Supporting Types

    GetPostgresCatalogProviderConfig

    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.

    GetPostgresCatalogSpec

    CreateDatabaseIfMissing bool
    (boolean) - If set to true, the specified postgresDatabase is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
    PostgresDatabase string
    (string) - The name of the Postgres database associated with the catalog
    Branch string
    (string) - The resource path of the branch associated with the catalog.
    CreateDatabaseIfMissing bool
    (boolean) - If set to true, the specified postgresDatabase is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
    PostgresDatabase string
    (string) - The name of the Postgres database associated with the catalog
    Branch string
    (string) - The resource path of the branch associated with the catalog.
    createDatabaseIfMissing Boolean
    (boolean) - If set to true, the specified postgresDatabase is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
    postgresDatabase String
    (string) - The name of the Postgres database associated with the catalog
    branch String
    (string) - The resource path of the branch associated with the catalog.
    createDatabaseIfMissing boolean
    (boolean) - If set to true, the specified postgresDatabase is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
    postgresDatabase string
    (string) - The name of the Postgres database associated with the catalog
    branch string
    (string) - The resource path of the branch associated with the catalog.
    create_database_if_missing bool
    (boolean) - If set to true, the specified postgresDatabase is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
    postgres_database str
    (string) - The name of the Postgres database associated with the catalog
    branch str
    (string) - The resource path of the branch associated with the catalog.
    createDatabaseIfMissing Boolean
    (boolean) - If set to true, the specified postgresDatabase is created on behalf of the calling user if it does not already exist. In this case, the calling user has a role created for them in Postgres if they do not already have one.
    postgresDatabase String
    (string) - The name of the Postgres database associated with the catalog
    branch String
    (string) - The resource path of the branch associated with the catalog.

    GetPostgresCatalogStatus

    Branch string
    (string) - The resource path of the branch associated with the catalog.
    CatalogId string
    (string) - The short identifier of the catalog, suitable for showing to the users. For a catalog with name catalogs/my-catalog, the catalogId is my-catalog.
    PostgresDatabase string
    (string) - The name of the Postgres database associated with the catalog
    Project string
    (string) - The resource path of the project associated with the catalog.
    Branch string
    (string) - The resource path of the branch associated with the catalog.
    CatalogId string
    (string) - The short identifier of the catalog, suitable for showing to the users. For a catalog with name catalogs/my-catalog, the catalogId is my-catalog.
    PostgresDatabase string
    (string) - The name of the Postgres database associated with the catalog
    Project string
    (string) - The resource path of the project associated with the catalog.
    branch String
    (string) - The resource path of the branch associated with the catalog.
    catalogId String
    (string) - The short identifier of the catalog, suitable for showing to the users. For a catalog with name catalogs/my-catalog, the catalogId is my-catalog.
    postgresDatabase String
    (string) - The name of the Postgres database associated with the catalog
    project String
    (string) - The resource path of the project associated with the catalog.
    branch string
    (string) - The resource path of the branch associated with the catalog.
    catalogId string
    (string) - The short identifier of the catalog, suitable for showing to the users. For a catalog with name catalogs/my-catalog, the catalogId is my-catalog.
    postgresDatabase string
    (string) - The name of the Postgres database associated with the catalog
    project string
    (string) - The resource path of the project associated with the catalog.
    branch str
    (string) - The resource path of the branch associated with the catalog.
    catalog_id str
    (string) - The short identifier of the catalog, suitable for showing to the users. For a catalog with name catalogs/my-catalog, the catalogId is my-catalog.
    postgres_database str
    (string) - The name of the Postgres database associated with the catalog
    project str
    (string) - The resource path of the project associated with the catalog.
    branch String
    (string) - The resource path of the branch associated with the catalog.
    catalogId String
    (string) - The short identifier of the catalog, suitable for showing to the users. For a catalog with name catalogs/my-catalog, the catalogId is my-catalog.
    postgresDatabase String
    (string) - The name of the Postgres database associated with the catalog
    project String
    (string) - The resource path of the project associated with the catalog.

    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.91.1
    published on Friday, May 1, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.