1. Packages
  2. Confluent Provider
  3. API Docs
  4. getCatalogIntegration
Confluent v2.52.0 published on Friday, Nov 21, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.getCatalogIntegration

confluentcloud logo
Confluent v2.52.0 published on Friday, Nov 21, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.CatalogIntegration describes a Catalog Integration data source.

    Example Usage

    Option #1: Manage multiple Catalog Integrations in the same Pulumi Stack

    import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

export = async () => {
    const example = await confluentcloud.getCatalogIntegration({
        environment: {
            id: staging.id,
        },
        kafkaCluster: {
            id: stagingConfluentKafkaCluster.id,
        },
        id: "tci-abc123",
        credentials: {
            key: env_admin_tableflow_api_key.id,
            secret: env_admin_tableflow_api_key.secret,
        },
    });
    return {
        "retention-ms": example.retentionMs,
    };
}

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.get_catalog_integration(environment={
        "id": staging["id"],
    },
    kafka_cluster={
        "id": staging_confluent_kafka_cluster["id"],
    },
    id="tci-abc123",
    credentials={
        "key": env_admin_tableflow_api_key["id"],
        "secret": env_admin_tableflow_api_key["secret"],
    })
pulumi.export("retention-ms", example.retention_ms)

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := confluentcloud.LookupCatalogIntegration(ctx, &confluentcloud.LookupCatalogIntegrationArgs{
			Environment: confluentcloud.GetCatalogIntegrationEnvironment{
				Id: staging.Id,
			},
			KafkaCluster: confluentcloud.GetCatalogIntegrationKafkaCluster{
				Id: stagingConfluentKafkaCluster.Id,
			},
			Id: "tci-abc123",
			Credentials: confluentcloud.GetCatalogIntegrationCredentials{
				Key:    env_admin_tableflow_api_key.Id,
				Secret: env_admin_tableflow_api_key.Secret,
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("retention-ms", example.RetentionMs)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var example = ConfluentCloud.GetCatalogIntegration.Invoke(new()
    {
        Environment = new ConfluentCloud.Inputs.GetCatalogIntegrationEnvironmentInputArgs
        {
            Id = staging.Id,
        },
        KafkaCluster = new ConfluentCloud.Inputs.GetCatalogIntegrationKafkaClusterInputArgs
        {
            Id = stagingConfluentKafkaCluster.Id,
        },
        Id = "tci-abc123",
        Credentials = new ConfluentCloud.Inputs.GetCatalogIntegrationCredentialsInputArgs
        {
            Key = env_admin_tableflow_api_key.Id,
            Secret = env_admin_tableflow_api_key.Secret,
        },
    });

    return new Dictionary<string, object?>
    {
        ["retention-ms"] = example.Apply(getCatalogIntegrationResult => getCatalogIntegrationResult.RetentionMs),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetCatalogIntegrationArgs;
import com.pulumi.confluentcloud.inputs.GetCatalogIntegrationEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.GetCatalogIntegrationKafkaClusterArgs;
import com.pulumi.confluentcloud.inputs.GetCatalogIntegrationCredentialsArgs;
import java.util.List;
import java.util.ArrayList;
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 example = ConfluentcloudFunctions.getCatalogIntegration(GetCatalogIntegrationArgs.builder()
            .environment(GetCatalogIntegrationEnvironmentArgs.builder()
                .id(staging.id())
                .build())
            .kafkaCluster(GetCatalogIntegrationKafkaClusterArgs.builder()
                .id(stagingConfluentKafkaCluster.id())
                .build())
            .id("tci-abc123")
            .credentials(GetCatalogIntegrationCredentialsArgs.builder()
                .key(env_admin_tableflow_api_key.id())
                .secret(env_admin_tableflow_api_key.secret())
                .build())
            .build());

        ctx.export("retention-ms", example.retentionMs());
    }
}

    variables:
  example:
    fn::invoke:
      function: confluentcloud:getCatalogIntegration
      arguments:
        environment:
          id: ${staging.id}
        kafkaCluster:
          id: ${stagingConfluentKafkaCluster.id}
        id: tci-abc123
        credentials:
          key: ${["env-admin-tableflow-api-key"].id}
          secret: ${["env-admin-tableflow-api-key"].secret}
outputs:
  retention-ms: ${example.retentionMs}

    Option #2: Manage a single Catalog Integration in the same Pulumi Stack

    import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

export = async () => {
    const example = await confluentcloud.getCatalogIntegration({
        id: "tci-abc123",
    });
    return {
        "retention-ms": example.retentionMs,
    };
}

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.get_catalog_integration(id="tci-abc123")
pulumi.export("retention-ms", example.retention_ms)

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := confluentcloud.LookupCatalogIntegration(ctx, &confluentcloud.LookupCatalogIntegrationArgs{
			Id: "tci-abc123",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("retention-ms", example.RetentionMs)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var example = ConfluentCloud.GetCatalogIntegration.Invoke(new()
    {
        Id = "tci-abc123",
    });

    return new Dictionary<string, object?>
    {
        ["retention-ms"] = example.Apply(getCatalogIntegrationResult => getCatalogIntegrationResult.RetentionMs),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetCatalogIntegrationArgs;
import java.util.List;
import java.util.ArrayList;
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 example = ConfluentcloudFunctions.getCatalogIntegration(GetCatalogIntegrationArgs.builder()
            .id("tci-abc123")
            .build());

        ctx.export("retention-ms", example.retentionMs());
    }
}

    variables:
  example:
    fn::invoke:
      function: confluentcloud:getCatalogIntegration
      arguments:
        id: tci-abc123
outputs:
  retention-ms: ${example.retentionMs}

    Using getCatalogIntegration

    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 getCatalogIntegration(args: GetCatalogIntegrationArgs, opts?: InvokeOptions): Promise<GetCatalogIntegrationResult>
function getCatalogIntegrationOutput(args: GetCatalogIntegrationOutputArgs, opts?: InvokeOptions): Output<GetCatalogIntegrationResult>
    def get_catalog_integration(credentials: Optional[GetCatalogIntegrationCredentials] = None,
                            environment: Optional[GetCatalogIntegrationEnvironment] = None,
                            id: Optional[str] = None,
                            kafka_cluster: Optional[GetCatalogIntegrationKafkaCluster] = None,
                            opts: Optional[InvokeOptions] = None) -> GetCatalogIntegrationResult
def get_catalog_integration_output(credentials: Optional[pulumi.Input[GetCatalogIntegrationCredentialsArgs]] = None,
                            environment: Optional[pulumi.Input[GetCatalogIntegrationEnvironmentArgs]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            kafka_cluster: Optional[pulumi.Input[GetCatalogIntegrationKafkaClusterArgs]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetCatalogIntegrationResult]
    func LookupCatalogIntegration(ctx *Context, args *LookupCatalogIntegrationArgs, opts ...InvokeOption) (*LookupCatalogIntegrationResult, error)
func LookupCatalogIntegrationOutput(ctx *Context, args *LookupCatalogIntegrationOutputArgs, opts ...InvokeOption) LookupCatalogIntegrationResultOutput

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

    public static class GetCatalogIntegration 
{
    public static Task<GetCatalogIntegrationResult> InvokeAsync(GetCatalogIntegrationArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogIntegrationResult> Invoke(GetCatalogIntegrationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCatalogIntegrationResult> getCatalogIntegration(GetCatalogIntegrationArgs args, InvokeOptions options)
public static Output<GetCatalogIntegrationResult> getCatalogIntegration(GetCatalogIntegrationArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getCatalogIntegration:getCatalogIntegration
  arguments:
    # arguments dictionary

    The following arguments are supported:

    environment Property Map
    id String
    The ID of the Catalog Integration, for example, tci-abc123.
    kafkaCluster Property Map
    credentials Property Map

    getCatalogIntegration Result

    The following output properties are available:

    AwsGlues List<Pulumi.ConfluentCloud.Outputs.GetCatalogIntegrationAwsGlue>
    (Optional Configuration Block) supports the following:
    DisplayName string
    (Required String) The name of the catalog integration.
    Environment Pulumi.ConfluentCloud.Outputs.GetCatalogIntegrationEnvironment
    Id string
    KafkaCluster Pulumi.ConfluentCloud.Outputs.GetCatalogIntegrationKafkaCluster
    Snowflakes List<Pulumi.ConfluentCloud.Outputs.GetCatalogIntegrationSnowflake>
    (Optional Configuration Block) supports the following:
    Suspended bool
    (Optional Boolean) Indicates whether the Catalog Integration should be suspended.
    Credentials Pulumi.ConfluentCloud.Outputs.GetCatalogIntegrationCredentials
    AwsGlues []GetCatalogIntegrationAwsGlue
    (Optional Configuration Block) supports the following:
    DisplayName string
    (Required String) The name of the catalog integration.
    Environment GetCatalogIntegrationEnvironment
    Id string
    KafkaCluster GetCatalogIntegrationKafkaCluster
    Snowflakes []GetCatalogIntegrationSnowflake
    (Optional Configuration Block) supports the following:
    Suspended bool
    (Optional Boolean) Indicates whether the Catalog Integration should be suspended.
    Credentials GetCatalogIntegrationCredentials
    awsGlues List<GetCatalogIntegrationAwsGlue>
    (Optional Configuration Block) supports the following:
    displayName String
    (Required String) The name of the catalog integration.
    environment GetCatalogIntegrationEnvironment
    id String
    kafkaCluster GetCatalogIntegrationKafkaCluster
    snowflakes List<GetCatalogIntegrationSnowflake>
    (Optional Configuration Block) supports the following:
    suspended Boolean
    (Optional Boolean) Indicates whether the Catalog Integration should be suspended.
    credentials GetCatalogIntegrationCredentials
    awsGlues GetCatalogIntegrationAwsGlue[]
    (Optional Configuration Block) supports the following:
    displayName string
    (Required String) The name of the catalog integration.
    environment GetCatalogIntegrationEnvironment
    id string
    kafkaCluster GetCatalogIntegrationKafkaCluster
    snowflakes GetCatalogIntegrationSnowflake[]
    (Optional Configuration Block) supports the following:
    suspended boolean
    (Optional Boolean) Indicates whether the Catalog Integration should be suspended.
    credentials GetCatalogIntegrationCredentials
    aws_glues Sequence[GetCatalogIntegrationAwsGlue]
    (Optional Configuration Block) supports the following:
    display_name str
    (Required String) The name of the catalog integration.
    environment GetCatalogIntegrationEnvironment
    id str
    kafka_cluster GetCatalogIntegrationKafkaCluster
    snowflakes Sequence[GetCatalogIntegrationSnowflake]
    (Optional Configuration Block) supports the following:
    suspended bool
    (Optional Boolean) Indicates whether the Catalog Integration should be suspended.
    credentials GetCatalogIntegrationCredentials
    awsGlues List<Property Map>
    (Optional Configuration Block) supports the following:
    displayName String
    (Required String) The name of the catalog integration.
    environment Property Map
    id String
    kafkaCluster Property Map
    snowflakes List<Property Map>
    (Optional Configuration Block) supports the following:
    suspended Boolean
    (Optional Boolean) Indicates whether the Catalog Integration should be suspended.
    credentials Property Map

    Supporting Types

    GetCatalogIntegrationAwsGlue

    ProviderIntegrationId string
    (Required String) The provider integration id.
    ProviderIntegrationId string
    (Required String) The provider integration id.
    providerIntegrationId String
    (Required String) The provider integration id.
    providerIntegrationId string
    (Required String) The provider integration id.
    provider_integration_id str
    (Required String) The provider integration id.
    providerIntegrationId String
    (Required String) The provider integration id.

    GetCatalogIntegrationCredentials

    Key string
    The Tableflow API Key.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    Key string
    The Tableflow API Key.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Tableflow API Key.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.
    key string
    The Tableflow API Key.
    secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key str
    The Tableflow API Key.
    secret str
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Tableflow API Key.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.

    GetCatalogIntegrationEnvironment

    Id string
    The ID of the Environment, for example, env-abc123.
    Id string
    The ID of the Environment, for example, env-abc123.
    id String
    The ID of the Environment, for example, env-abc123.
    id string
    The ID of the Environment, for example, env-abc123.
    id str
    The ID of the Environment, for example, env-abc123.
    id String
    The ID of the Environment, for example, env-abc123.

    GetCatalogIntegrationKafkaCluster

    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    Id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.
    id string
    The ID of the Kafka cluster, for example, lkc-abc123.
    id str
    The ID of the Kafka cluster, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster, for example, lkc-abc123.

    GetCatalogIntegrationSnowflake

    AllowedScope string
    (Required String) Allowed scope of the Snowflake Open Catalog.
    Endpoint string
    (Required String) The catalog integration connection endpoint for Snowflake Open Catalog.
    Warehouse string
    (Required String) Warehouse name of the Snowflake Open Catalog.
    AllowedScope string
    (Required String) Allowed scope of the Snowflake Open Catalog.
    Endpoint string
    (Required String) The catalog integration connection endpoint for Snowflake Open Catalog.
    Warehouse string
    (Required String) Warehouse name of the Snowflake Open Catalog.
    allowedScope String
    (Required String) Allowed scope of the Snowflake Open Catalog.
    endpoint String
    (Required String) The catalog integration connection endpoint for Snowflake Open Catalog.
    warehouse String
    (Required String) Warehouse name of the Snowflake Open Catalog.
    allowedScope string
    (Required String) Allowed scope of the Snowflake Open Catalog.
    endpoint string
    (Required String) The catalog integration connection endpoint for Snowflake Open Catalog.
    warehouse string
    (Required String) Warehouse name of the Snowflake Open Catalog.
    allowed_scope str
    (Required String) Allowed scope of the Snowflake Open Catalog.
    endpoint str
    (Required String) The catalog integration connection endpoint for Snowflake Open Catalog.
    warehouse str
    (Required String) Warehouse name of the Snowflake Open Catalog.
    allowedScope String
    (Required String) Allowed scope of the Snowflake Open Catalog.
    endpoint String
    (Required String) The catalog integration connection endpoint for Snowflake Open Catalog.
    warehouse String
    (Required String) Warehouse name of the Snowflake Open Catalog.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.52.0 published on Friday, Nov 21, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Meet Neo: Your AI Platform Teammate