1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresCdfConfigs
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v1.101.0
published on Thursday, Jul 30, 2026 by Pulumi

    Public Beta

    API Documentation

    This data source lists all Postgres CDF (Change Data Feed) configurations under a database.

    Example Usage

    List All CDF Configurations in a Database

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const all = databricks.getPostgresCdfConfigs({
        parent: "projects/my-project/branches/main/databases/app_db",
    });
    export const cdfConfigNames = all.then(all => .map(config => (config.name)));
    
    import pulumi
    import pulumi_databricks as databricks
    
    all = databricks.get_postgres_cdf_configs(parent="projects/my-project/branches/main/databases/app_db")
    pulumi.export("cdfConfigNames", [config.name for config in all.cdf_configs])
    
    Example coming soon!
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Databricks.GetPostgresCdfConfigs.Invoke(new()
        {
            Parent = "projects/my-project/branches/main/databases/app_db",
        });
    
        return new Dictionary<string, object?>
        {
            ["cdfConfigNames"] = .Select(config => 
            {
                return config.Name;
            }).ToList(),
        };
    });
    
    Example coming soon!
    
    Example coming soon!
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    data "databricks_getpostgrescdfconfigs" "all" {
      parent = "projects/my-project/branches/main/databases/app_db"
    }
    
    output "cdfConfigNames" {
      value = [for config in data.databricks_getpostgrescdfconfigs.all.cdf_configs : config.name]
    }
    

    Using getPostgresCdfConfigs

    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 getPostgresCdfConfigs(args: GetPostgresCdfConfigsArgs, opts?: InvokeOptions): Promise<GetPostgresCdfConfigsResult>
    function getPostgresCdfConfigsOutput(args: GetPostgresCdfConfigsOutputArgs, opts?: InvokeOptions): Output<GetPostgresCdfConfigsResult>
    def get_postgres_cdf_configs(page_size: Optional[int] = None,
                                 parent: Optional[str] = None,
                                 provider_config: Optional[GetPostgresCdfConfigsProviderConfig] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetPostgresCdfConfigsResult
    def get_postgres_cdf_configs_output(page_size: pulumi.Input[Optional[int]] = None,
                                 parent: pulumi.Input[Optional[str]] = None,
                                 provider_config: pulumi.Input[Optional[GetPostgresCdfConfigsProviderConfigArgs]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetPostgresCdfConfigsResult]
    func GetPostgresCdfConfigs(ctx *Context, args *GetPostgresCdfConfigsArgs, opts ...InvokeOption) (*GetPostgresCdfConfigsResult, error)
    func GetPostgresCdfConfigsOutput(ctx *Context, args *GetPostgresCdfConfigsOutputArgs, opts ...InvokeOption) GetPostgresCdfConfigsResultOutput

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

    public static class GetPostgresCdfConfigs 
    {
        public static Task<GetPostgresCdfConfigsResult> InvokeAsync(GetPostgresCdfConfigsArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresCdfConfigsResult> Invoke(GetPostgresCdfConfigsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPostgresCdfConfigsResult> getPostgresCdfConfigs(GetPostgresCdfConfigsArgs args, InvokeOptions options)
    public static Output<GetPostgresCdfConfigsResult> getPostgresCdfConfigs(GetPostgresCdfConfigsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPostgresCdfConfigs:getPostgresCdfConfigs
      arguments:
        # arguments dictionary
    data "databricks_get_postgres_cdf_configs" "name" {
        # arguments
    }

    The following arguments are supported:

    Parent string
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    PageSize int
    Maximum number of CdfConfigs to return
    ProviderConfig GetPostgresCdfConfigsProviderConfig
    Configure the provider for management through account provider.
    Parent string
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    PageSize int
    Maximum number of CdfConfigs to return
    ProviderConfig GetPostgresCdfConfigsProviderConfig
    Configure the provider for management through account provider.
    parent string
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    page_size number
    Maximum number of CdfConfigs to return
    provider_config object
    Configure the provider for management through account provider.
    parent String
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    pageSize Integer
    Maximum number of CdfConfigs to return
    providerConfig GetPostgresCdfConfigsProviderConfig
    Configure the provider for management through account provider.
    parent string
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    pageSize number
    Maximum number of CdfConfigs to return
    providerConfig GetPostgresCdfConfigsProviderConfig
    Configure the provider for management through account provider.
    parent str
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    page_size int
    Maximum number of CdfConfigs to return
    provider_config GetPostgresCdfConfigsProviderConfig
    Configure the provider for management through account provider.
    parent String
    The parent database to list CdfConfigs for. Format: projects/{project}/branches/{branch}/databases/{database}
    pageSize Number
    Maximum number of CdfConfigs to return
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresCdfConfigs Result

    The following output properties are available:

    Supporting Types

    GetPostgresCdfConfigsCdfConfig

    Catalog string
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    CdfConfigId string
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    CreateTime string
    (string) - When the CdfConfig was created
    Name string
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    PostgresSchema string
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    Schema string
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    ProviderConfig GetPostgresCdfConfigsCdfConfigProviderConfig
    Configure the provider for management through account provider.
    Catalog string
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    CdfConfigId string
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    CreateTime string
    (string) - When the CdfConfig was created
    Name string
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    PostgresSchema string
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    Schema string
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    ProviderConfig GetPostgresCdfConfigsCdfConfigProviderConfig
    Configure the provider for management through account provider.
    catalog string
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    cdf_config_id string
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    create_time string
    (string) - When the CdfConfig was created
    name string
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    postgres_schema string
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    schema string
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    provider_config object
    Configure the provider for management through account provider.
    catalog String
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    cdfConfigId String
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    createTime String
    (string) - When the CdfConfig was created
    name String
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    postgresSchema String
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    schema String
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    providerConfig GetPostgresCdfConfigsCdfConfigProviderConfig
    Configure the provider for management through account provider.
    catalog string
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    cdfConfigId string
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    createTime string
    (string) - When the CdfConfig was created
    name string
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    postgresSchema string
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    schema string
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    providerConfig GetPostgresCdfConfigsCdfConfigProviderConfig
    Configure the provider for management through account provider.
    catalog str
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    cdf_config_id str
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    create_time str
    (string) - When the CdfConfig was created
    name str
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    postgres_schema str
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    schema str
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    provider_config GetPostgresCdfConfigsCdfConfigProviderConfig
    Configure the provider for management through account provider.
    catalog String
    (string) - The Unity Catalog catalog that replicated tables are written into. Set at creation; the CdfConfig is immutable
    cdfConfigId String
    (string) - The user-specified id; equals the final segment of name. Defaults to the Postgres schema name for configs without an explicit id
    createTime String
    (string) - When the CdfConfig was created
    name String
    (string) - Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    postgresSchema String
    (string) - The Postgres schema this CdfConfig replicates from. Unique within the parent database. Set at creation; the CdfConfig is immutable
    schema String
    (string) - The Unity Catalog schema that replicated tables are written into. Set at creation; the CdfConfig is immutable
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetPostgresCdfConfigsCdfConfigProviderConfig

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

    GetPostgresCdfConfigsProviderConfig

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

    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.101.0
    published on Thursday, Jul 30, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial