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

databricks.PostgresCatalog

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

    Public Beta

    Create PostgresCatalog Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PostgresCatalog(name: string, args: PostgresCatalogArgs, opts?: CustomResourceOptions);
    @overload
def PostgresCatalog(resource_name: str,
                    args: PostgresCatalogArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def PostgresCatalog(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    catalog_id: Optional[str] = None,
                    provider_config: Optional[PostgresCatalogProviderConfigArgs] = None,
                    spec: Optional[PostgresCatalogSpecArgs] = None)
    func NewPostgresCatalog(ctx *Context, name string, args PostgresCatalogArgs, opts ...ResourceOption) (*PostgresCatalog, error)
    public PostgresCatalog(string name, PostgresCatalogArgs args, CustomResourceOptions? opts = null)
    public PostgresCatalog(String name, PostgresCatalogArgs args)
public PostgresCatalog(String name, PostgresCatalogArgs args, CustomResourceOptions options)

    type: databricks:PostgresCatalog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PostgresCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PostgresCatalogArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PostgresCatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresCatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresCatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var postgresCatalogResource = new Databricks.PostgresCatalog("postgresCatalogResource", new()
{
    CatalogId = "string",
    ProviderConfig = new Databricks.Inputs.PostgresCatalogProviderConfigArgs
    {
        WorkspaceId = "string",
    },
    Spec = new Databricks.Inputs.PostgresCatalogSpecArgs
    {
        PostgresDatabase = "string",
        Branch = "string",
        CreateDatabaseIfMissing = false,
    },
});

    example, err := databricks.NewPostgresCatalog(ctx, "postgresCatalogResource", &databricks.PostgresCatalogArgs{
	CatalogId: pulumi.String("string"),
	ProviderConfig: &databricks.PostgresCatalogProviderConfigArgs{
		WorkspaceId: pulumi.String("string"),
	},
	Spec: &databricks.PostgresCatalogSpecArgs{
		PostgresDatabase:        pulumi.String("string"),
		Branch:                  pulumi.String("string"),
		CreateDatabaseIfMissing: pulumi.Bool(false),
	},
})

    var postgresCatalogResource = new PostgresCatalog("postgresCatalogResource", PostgresCatalogArgs.builder()
    .catalogId("string")
    .providerConfig(PostgresCatalogProviderConfigArgs.builder()
        .workspaceId("string")
        .build())
    .spec(PostgresCatalogSpecArgs.builder()
        .postgresDatabase("string")
        .branch("string")
        .createDatabaseIfMissing(false)
        .build())
    .build());

    postgres_catalog_resource = databricks.PostgresCatalog("postgresCatalogResource",
    catalog_id="string",
    provider_config={
        "workspace_id": "string",
    },
    spec={
        "postgres_database": "string",
        "branch": "string",
        "create_database_if_missing": False,
    })

    const postgresCatalogResource = new databricks.PostgresCatalog("postgresCatalogResource", {
    catalogId: "string",
    providerConfig: {
        workspaceId: "string",
    },
    spec: {
        postgresDatabase: "string",
        branch: "string",
        createDatabaseIfMissing: false,
    },
});

    type: databricks:PostgresCatalog
properties:
    catalogId: string
    providerConfig:
        workspaceId: string
    spec:
        branch: string
        createDatabaseIfMissing: false
        postgresDatabase: string

    PostgresCatalog Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PostgresCatalog resource accepts the following input properties:

    CatalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    ProviderConfig PostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    Spec PostgresCatalogSpec
    The desired state of the Catalog
    CatalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    ProviderConfig PostgresCatalogProviderConfigArgs
    Configure the provider for management through account provider.
    Spec PostgresCatalogSpecArgs
    The desired state of the Catalog
    catalogId String
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    providerConfig PostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    spec PostgresCatalogSpec
    The desired state of the Catalog
    catalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    providerConfig PostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    spec PostgresCatalogSpec
    The desired state of the Catalog
    catalog_id str
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    provider_config PostgresCatalogProviderConfigArgs
    Configure the provider for management through account provider.
    spec PostgresCatalogSpecArgs
    The desired state of the Catalog
    catalogId String
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    providerConfig Property Map
    Configure the provider for management through account provider.
    spec Property Map
    The desired state of the Catalog

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PostgresCatalog resource produces the following output properties:

    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.
    Status PostgresCatalogStatus
    (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
    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.
    Status PostgresCatalogStatus
    (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
    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.
    status PostgresCatalogStatus
    (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
    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.
    status PostgresCatalogStatus
    (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
    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.
    status PostgresCatalogStatus
    (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
    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.
    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

    Look up Existing PostgresCatalog Resource

    Get an existing PostgresCatalog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PostgresCatalogState, opts?: CustomResourceOptions): PostgresCatalog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_id: Optional[str] = None,
        create_time: Optional[str] = None,
        name: Optional[str] = None,
        provider_config: Optional[PostgresCatalogProviderConfigArgs] = None,
        spec: Optional[PostgresCatalogSpecArgs] = None,
        status: Optional[PostgresCatalogStatusArgs] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> PostgresCatalog
    func GetPostgresCatalog(ctx *Context, name string, id IDInput, state *PostgresCatalogState, opts ...ResourceOption) (*PostgresCatalog, error)
    public static PostgresCatalog Get(string name, Input<string> id, PostgresCatalogState? state, CustomResourceOptions? opts = null)
    public static PostgresCatalog get(String name, Output<String> id, PostgresCatalogState state, CustomResourceOptions options)
    resources:  _:    type: databricks:PostgresCatalog    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CatalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    CreateTime string
    (string) - A timestamp indicating when the catalog was created
    Name string
    (string) - Output only. The full resource path of the catalog.
    ProviderConfig PostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    Spec PostgresCatalogSpec
    The desired state of the Catalog
    Status PostgresCatalogStatus
    (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
    CatalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    CreateTime string
    (string) - A timestamp indicating when the catalog was created
    Name string
    (string) - Output only. The full resource path of the catalog.
    ProviderConfig PostgresCatalogProviderConfigArgs
    Configure the provider for management through account provider.
    Spec PostgresCatalogSpecArgs
    The desired state of the Catalog
    Status PostgresCatalogStatusArgs
    (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
    catalogId String
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    createTime String
    (string) - A timestamp indicating when the catalog was created
    name String
    (string) - Output only. The full resource path of the catalog.
    providerConfig PostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    spec PostgresCatalogSpec
    The desired state of the Catalog
    status PostgresCatalogStatus
    (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
    catalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    createTime string
    (string) - A timestamp indicating when the catalog was created
    name string
    (string) - Output only. The full resource path of the catalog.
    providerConfig PostgresCatalogProviderConfig
    Configure the provider for management through account provider.
    spec PostgresCatalogSpec
    The desired state of the Catalog
    status PostgresCatalogStatus
    (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
    catalog_id str
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    create_time str
    (string) - A timestamp indicating when the catalog was created
    name str
    (string) - Output only. The full resource path of the catalog.
    provider_config PostgresCatalogProviderConfigArgs
    Configure the provider for management through account provider.
    spec PostgresCatalogSpecArgs
    The desired state of the Catalog
    status PostgresCatalogStatusArgs
    (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
    catalogId String
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/my_catalog"
    createTime String
    (string) - A timestamp indicating when the catalog was created
    name String
    (string) - Output only. The full resource path of the catalog.
    providerConfig Property Map
    Configure the provider for management through account provider.
    spec Property Map
    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

    Supporting Types

    PostgresCatalogProviderConfig, PostgresCatalogProviderConfigArgs

    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.

    PostgresCatalogSpec, PostgresCatalogSpecArgs

    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

    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.

    Defaults to false, meaning that the request fails if the specified postgresDatabase does not already exist

    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

    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.

    Defaults to false, meaning that the request fails if the specified postgresDatabase does not already exist

    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

    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.

    Defaults to false, meaning that the request fails if the specified postgresDatabase does not already exist

    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

    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.

    Defaults to false, meaning that the request fails if the specified postgresDatabase does not already exist

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

    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.

    Defaults to false, meaning that the request fails if the specified postgresDatabase does not already exist

    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

    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.

    Defaults to false, meaning that the request fails if the specified postgresDatabase does not already exist

    PostgresCatalogStatus, PostgresCatalogStatusArgs

    Branch string
    (string) - The resource path of the branch associated with the catalog.
    CatalogId string
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/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
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/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
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/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
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/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
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/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
    The ID in the Unity Catalog. It becomes the full resource name, for example "myCatalog" becomes "catalogs/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.