1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getPostgresCdfConfig
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 retrieves a single Postgres CDF (Change Data Feed) configuration.

    Example Usage

    Retrieve CDF Configuration by Name

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = databricks.getPostgresCdfConfig({
        name: "projects/my-project/branches/main/databases/app_db/cdf-configs/public",
    });
    export const cdfTargetCatalog = _this.then(_this => _this.catalog);
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.get_postgres_cdf_config(name="projects/my-project/branches/main/databases/app_db/cdf-configs/public")
    pulumi.export("cdfTargetCatalog", this.catalog)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		this, err := databricks.GetPostgresCdfConfig(ctx, &databricks.LookupPostgresCdfConfigArgs{
    			Name: "projects/my-project/branches/main/databases/app_db/cdf-configs/public",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("cdfTargetCatalog", this.Catalog)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Databricks.GetPostgresCdfConfig.Invoke(new()
        {
            Name = "projects/my-project/branches/main/databases/app_db/cdf-configs/public",
        });
    
        return new Dictionary<string, object?>
        {
            ["cdfTargetCatalog"] = @this.Apply(@this => @this.Apply(getPostgresCdfConfigResult => getPostgresCdfConfigResult.Catalog)),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.DatabricksFunctions;
    import com.pulumi.databricks.inputs.GetPostgresCdfConfigArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var this = DatabricksFunctions.getPostgresCdfConfig(GetPostgresCdfConfigArgs.builder()
                .name("projects/my-project/branches/main/databases/app_db/cdf-configs/public")
                .build());
    
            ctx.export("cdfTargetCatalog", this_.catalog());
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: databricks:getPostgresCdfConfig
          arguments:
            name: projects/my-project/branches/main/databases/app_db/cdf-configs/public
    outputs:
      cdfTargetCatalog: ${this.catalog}
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    data "databricks_getpostgrescdfconfig" "this" {
      name = "projects/my-project/branches/main/databases/app_db/cdf-configs/public"
    }
    
    output "cdfTargetCatalog" {
      value = data.databricks_getpostgrescdfconfig.this.catalog
    }
    

    Using getPostgresCdfConfig

    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 getPostgresCdfConfig(args: GetPostgresCdfConfigArgs, opts?: InvokeOptions): Promise<GetPostgresCdfConfigResult>
    function getPostgresCdfConfigOutput(args: GetPostgresCdfConfigOutputArgs, opts?: InvokeOptions): Output<GetPostgresCdfConfigResult>
    def get_postgres_cdf_config(name: Optional[str] = None,
                                provider_config: Optional[GetPostgresCdfConfigProviderConfig] = None,
                                opts: Optional[InvokeOptions] = None) -> GetPostgresCdfConfigResult
    def get_postgres_cdf_config_output(name: pulumi.Input[Optional[str]] = None,
                                provider_config: pulumi.Input[Optional[GetPostgresCdfConfigProviderConfigArgs]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetPostgresCdfConfigResult]
    func LookupPostgresCdfConfig(ctx *Context, args *LookupPostgresCdfConfigArgs, opts ...InvokeOption) (*LookupPostgresCdfConfigResult, error)
    func LookupPostgresCdfConfigOutput(ctx *Context, args *LookupPostgresCdfConfigOutputArgs, opts ...InvokeOption) LookupPostgresCdfConfigResultOutput

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

    public static class GetPostgresCdfConfig 
    {
        public static Task<GetPostgresCdfConfigResult> InvokeAsync(GetPostgresCdfConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresCdfConfigResult> Invoke(GetPostgresCdfConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPostgresCdfConfigResult> getPostgresCdfConfig(GetPostgresCdfConfigArgs args, InvokeOptions options)
    public static Output<GetPostgresCdfConfigResult> getPostgresCdfConfig(GetPostgresCdfConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getPostgresCdfConfig:getPostgresCdfConfig
      arguments:
        # arguments dictionary
    data "databricks_get_postgres_cdf_config" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    ProviderConfig GetPostgresCdfConfigProviderConfig
    Configure the provider for management through account provider.
    Name string
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    ProviderConfig GetPostgresCdfConfigProviderConfig
    Configure the provider for management through account provider.
    name string
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    provider_config object
    Configure the provider for management through account provider.
    name String
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    providerConfig GetPostgresCdfConfigProviderConfig
    Configure the provider for management through account provider.
    name string
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    providerConfig GetPostgresCdfConfigProviderConfig
    Configure the provider for management through account provider.
    name str
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    provider_config GetPostgresCdfConfigProviderConfig
    Configure the provider for management through account provider.
    name String
    Output only. The full resource name of the CdfConfig. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
    providerConfig Property Map
    Configure the provider for management through account provider.

    getPostgresCdfConfig Result

    The following output properties are available:

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

    Supporting Types

    GetPostgresCdfConfigProviderConfig

    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