Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getTableflowTopic
Confluent v2.21.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getTableflowTopic

Explore with Pulumi AI

confluentcloud logo
Confluent v2.21.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.TableflowTopic describes a Tableflow Topic data source.

    Example Usage

    Option #1: Manage multiple Tableflow Topics in the same Pulumi Stack

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

export = async () => {
    const example = await confluentcloud.getTableflowTopic({
        environment: {
            id: staging.id,
        },
        kafkaCluster: {
            id: stagingConfluentKafkaCluster.id,
        },
        displayName: "tableflow-example",
        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_tableflow_topic(environment={
        "id": staging["id"],
    },
    kafka_cluster={
        "id": staging_confluent_kafka_cluster["id"],
    },
    display_name="tableflow-example",
    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.LookupTableflowTopic(ctx, &confluentcloud.LookupTableflowTopicArgs{
			Environment: confluentcloud.GetTableflowTopicEnvironment{
				Id: staging.Id,
			},
			KafkaCluster: confluentcloud.GetTableflowTopicKafkaCluster{
				Id: stagingConfluentKafkaCluster.Id,
			},
			DisplayName: "tableflow-example",
			Credentials: confluentcloud.GetTableflowTopicCredentials{
				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.GetTableflowTopic.Invoke(new()
    {
        Environment = new ConfluentCloud.Inputs.GetTableflowTopicEnvironmentInputArgs
        {
            Id = staging.Id,
        },
        KafkaCluster = new ConfluentCloud.Inputs.GetTableflowTopicKafkaClusterInputArgs
        {
            Id = stagingConfluentKafkaCluster.Id,
        },
        DisplayName = "tableflow-example",
        Credentials = new ConfluentCloud.Inputs.GetTableflowTopicCredentialsInputArgs
        {
            Key = env_admin_tableflow_api_key.Id,
            Secret = env_admin_tableflow_api_key.Secret,
        },
    });

    return new Dictionary<string, object?>
    {
        ["retention-ms"] = example.Apply(getTableflowTopicResult => getTableflowTopicResult.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.GetTableflowTopicArgs;
import com.pulumi.confluentcloud.inputs.GetTableflowTopicEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.GetTableflowTopicKafkaClusterArgs;
import com.pulumi.confluentcloud.inputs.GetTableflowTopicCredentialsArgs;
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.getTableflowTopic(GetTableflowTopicArgs.builder()
            .environment(GetTableflowTopicEnvironmentArgs.builder()
                .id(staging.id())
                .build())
            .kafkaCluster(GetTableflowTopicKafkaClusterArgs.builder()
                .id(stagingConfluentKafkaCluster.id())
                .build())
            .displayName("tableflow-example")
            .credentials(GetTableflowTopicCredentialsArgs.builder()
                .key(env_admin_tableflow_api_key.id())
                .secret(env_admin_tableflow_api_key.secret())
                .build())
            .build());

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

    variables:
  example:
    fn::invoke:
      function: confluentcloud:getTableflowTopic
      arguments:
        environment:
          id: ${staging.id}
        kafkaCluster:
          id: ${stagingConfluentKafkaCluster.id}
        displayName: tableflow-example
        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 Tableflow Topic in the same Pulumi Stack

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

export = async () => {
    const example = await confluentcloud.getTableflowTopic({
        displayName: "tableflow-example",
    });
    return {
        "retention-ms": example.retentionMs,
    };
}

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.get_tableflow_topic(display_name="tableflow-example")
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.LookupTableflowTopic(ctx, &confluentcloud.LookupTableflowTopicArgs{
			DisplayName: "tableflow-example",
		}, 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.GetTableflowTopic.Invoke(new()
    {
        DisplayName = "tableflow-example",
    });

    return new Dictionary<string, object?>
    {
        ["retention-ms"] = example.Apply(getTableflowTopicResult => getTableflowTopicResult.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.GetTableflowTopicArgs;
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.getTableflowTopic(GetTableflowTopicArgs.builder()
            .displayName("tableflow-example")
            .build());

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

    variables:
  example:
    fn::invoke:
      function: confluentcloud:getTableflowTopic
      arguments:
        displayName: tableflow-example
outputs:
  retention-ms: ${example.retentionMs}

    Using getTableflowTopic

    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 getTableflowTopic(args: GetTableflowTopicArgs, opts?: InvokeOptions): Promise<GetTableflowTopicResult>
function getTableflowTopicOutput(args: GetTableflowTopicOutputArgs, opts?: InvokeOptions): Output<GetTableflowTopicResult>
    def get_tableflow_topic(credentials: Optional[GetTableflowTopicCredentials] = None,
                        display_name: Optional[str] = None,
                        environment: Optional[GetTableflowTopicEnvironment] = None,
                        kafka_cluster: Optional[GetTableflowTopicKafkaCluster] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTableflowTopicResult
def get_tableflow_topic_output(credentials: Optional[pulumi.Input[GetTableflowTopicCredentialsArgs]] = None,
                        display_name: Optional[pulumi.Input[str]] = None,
                        environment: Optional[pulumi.Input[GetTableflowTopicEnvironmentArgs]] = None,
                        kafka_cluster: Optional[pulumi.Input[GetTableflowTopicKafkaClusterArgs]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTableflowTopicResult]
    func LookupTableflowTopic(ctx *Context, args *LookupTableflowTopicArgs, opts ...InvokeOption) (*LookupTableflowTopicResult, error)
func LookupTableflowTopicOutput(ctx *Context, args *LookupTableflowTopicOutputArgs, opts ...InvokeOption) LookupTableflowTopicResultOutput

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

    public static class GetTableflowTopic 
{
    public static Task<GetTableflowTopicResult> InvokeAsync(GetTableflowTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetTableflowTopicResult> Invoke(GetTableflowTopicInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTableflowTopicResult> getTableflowTopic(GetTableflowTopicArgs args, InvokeOptions options)
public static Output<GetTableflowTopicResult> getTableflowTopic(GetTableflowTopicArgs args, InvokeOptions options)

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

    The following arguments are supported:

    getTableflowTopic Result

    The following output properties are available:

    ByobAws List<Pulumi.ConfluentCloud.Outputs.GetTableflowTopicByobAw>
    (Optional Configuration Block) supports the following:
    DisplayName string
    EnableCompaction bool
    (Optional Boolean) This flag determines whether to enable compaction for the Tableflow enabled topic.
    EnablePartitioning bool
    (Optional Boolean) This flag determines whether to enable partitioning for the Tableflow enabled topic.
    Environment Pulumi.ConfluentCloud.Outputs.GetTableflowTopicEnvironment
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaCluster Pulumi.ConfluentCloud.Outputs.GetTableflowTopicKafkaCluster
    ManagedStorages List<Pulumi.ConfluentCloud.Outputs.GetTableflowTopicManagedStorage>
    (Optional Configuration Block) The configuration of the Confluent managed bucket.
    RecordFailureStrategy string
    (Optional String) The strategy to handle record failures in the Tableflow enabled topic during materialization. For SKIP, we skip the bad records and move to the next record. For SUSPEND, we suspend the materialization of the topic.
    RetentionMs string
    (Optional String) The max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic.
    Suspended bool
    (Optional Boolean) Indicates whether the Tableflow should be suspended.
    TableFormats List<string>
    (Optional List) The supported table formats for the Tableflow-enabled topic.
    Credentials Pulumi.ConfluentCloud.Outputs.GetTableflowTopicCredentials
    ByobAws []GetTableflowTopicByobAw
    (Optional Configuration Block) supports the following:
    DisplayName string
    EnableCompaction bool
    (Optional Boolean) This flag determines whether to enable compaction for the Tableflow enabled topic.
    EnablePartitioning bool
    (Optional Boolean) This flag determines whether to enable partitioning for the Tableflow enabled topic.
    Environment GetTableflowTopicEnvironment
    Id string
    The provider-assigned unique ID for this managed resource.
    KafkaCluster GetTableflowTopicKafkaCluster
    ManagedStorages []GetTableflowTopicManagedStorage
    (Optional Configuration Block) The configuration of the Confluent managed bucket.
    RecordFailureStrategy string
    (Optional String) The strategy to handle record failures in the Tableflow enabled topic during materialization. For SKIP, we skip the bad records and move to the next record. For SUSPEND, we suspend the materialization of the topic.
    RetentionMs string
    (Optional String) The max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic.
    Suspended bool
    (Optional Boolean) Indicates whether the Tableflow should be suspended.
    TableFormats []string
    (Optional List) The supported table formats for the Tableflow-enabled topic.
    Credentials GetTableflowTopicCredentials
    byobAws List<GetTableflowTopicByobAw>
    (Optional Configuration Block) supports the following:
    displayName String
    enableCompaction Boolean
    (Optional Boolean) This flag determines whether to enable compaction for the Tableflow enabled topic.
    enablePartitioning Boolean
    (Optional Boolean) This flag determines whether to enable partitioning for the Tableflow enabled topic.
    environment GetTableflowTopicEnvironment
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaCluster GetTableflowTopicKafkaCluster
    managedStorages List<GetTableflowTopicManagedStorage>
    (Optional Configuration Block) The configuration of the Confluent managed bucket.
    recordFailureStrategy String
    (Optional String) The strategy to handle record failures in the Tableflow enabled topic during materialization. For SKIP, we skip the bad records and move to the next record. For SUSPEND, we suspend the materialization of the topic.
    retentionMs String
    (Optional String) The max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic.
    suspended Boolean
    (Optional Boolean) Indicates whether the Tableflow should be suspended.
    tableFormats List<String>
    (Optional List) The supported table formats for the Tableflow-enabled topic.
    credentials GetTableflowTopicCredentials
    byobAws GetTableflowTopicByobAw[]
    (Optional Configuration Block) supports the following:
    displayName string
    enableCompaction boolean
    (Optional Boolean) This flag determines whether to enable compaction for the Tableflow enabled topic.
    enablePartitioning boolean
    (Optional Boolean) This flag determines whether to enable partitioning for the Tableflow enabled topic.
    environment GetTableflowTopicEnvironment
    id string
    The provider-assigned unique ID for this managed resource.
    kafkaCluster GetTableflowTopicKafkaCluster
    managedStorages GetTableflowTopicManagedStorage[]
    (Optional Configuration Block) The configuration of the Confluent managed bucket.
    recordFailureStrategy string
    (Optional String) The strategy to handle record failures in the Tableflow enabled topic during materialization. For SKIP, we skip the bad records and move to the next record. For SUSPEND, we suspend the materialization of the topic.
    retentionMs string
    (Optional String) The max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic.
    suspended boolean
    (Optional Boolean) Indicates whether the Tableflow should be suspended.
    tableFormats string[]
    (Optional List) The supported table formats for the Tableflow-enabled topic.
    credentials GetTableflowTopicCredentials
    byob_aws Sequence[GetTableflowTopicByobAw]
    (Optional Configuration Block) supports the following:
    display_name str
    enable_compaction bool
    (Optional Boolean) This flag determines whether to enable compaction for the Tableflow enabled topic.
    enable_partitioning bool
    (Optional Boolean) This flag determines whether to enable partitioning for the Tableflow enabled topic.
    environment GetTableflowTopicEnvironment
    id str
    The provider-assigned unique ID for this managed resource.
    kafka_cluster GetTableflowTopicKafkaCluster
    managed_storages Sequence[GetTableflowTopicManagedStorage]
    (Optional Configuration Block) The configuration of the Confluent managed bucket.
    record_failure_strategy str
    (Optional String) The strategy to handle record failures in the Tableflow enabled topic during materialization. For SKIP, we skip the bad records and move to the next record. For SUSPEND, we suspend the materialization of the topic.
    retention_ms str
    (Optional String) The max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic.
    suspended bool
    (Optional Boolean) Indicates whether the Tableflow should be suspended.
    table_formats Sequence[str]
    (Optional List) The supported table formats for the Tableflow-enabled topic.
    credentials GetTableflowTopicCredentials
    byobAws List<Property Map>
    (Optional Configuration Block) supports the following:
    displayName String
    enableCompaction Boolean
    (Optional Boolean) This flag determines whether to enable compaction for the Tableflow enabled topic.
    enablePartitioning Boolean
    (Optional Boolean) This flag determines whether to enable partitioning for the Tableflow enabled topic.
    environment Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    kafkaCluster Property Map
    managedStorages List<Property Map>
    (Optional Configuration Block) The configuration of the Confluent managed bucket.
    recordFailureStrategy String
    (Optional String) The strategy to handle record failures in the Tableflow enabled topic during materialization. For SKIP, we skip the bad records and move to the next record. For SUSPEND, we suspend the materialization of the topic.
    retentionMs String
    (Optional String) The max age of snapshots (Iceberg) or versions (Delta) (snapshot/version expiration) to keep on the table in milliseconds for the Tableflow enabled topic.
    suspended Boolean
    (Optional Boolean) Indicates whether the Tableflow should be suspended.
    tableFormats List<String>
    (Optional List) The supported table formats for the Tableflow-enabled topic.
    credentials Property Map

    Supporting Types

    GetTableflowTopicByobAw

    BucketName string
    (Required String) The bucket name.
    BucketRegion string
    (Required String) The bucket region.
    ProviderIntegrationId string
    (Required String) The provider integration id.
    BucketName string
    (Required String) The bucket name.
    BucketRegion string
    (Required String) The bucket region.
    ProviderIntegrationId string
    (Required String) The provider integration id.
    bucketName String
    (Required String) The bucket name.
    bucketRegion String
    (Required String) The bucket region.
    providerIntegrationId String
    (Required String) The provider integration id.
    bucketName string
    (Required String) The bucket name.
    bucketRegion string
    (Required String) The bucket region.
    providerIntegrationId string
    (Required String) The provider integration id.
    bucket_name str
    (Required String) The bucket name.
    bucket_region str
    (Required String) The bucket region.
    provider_integration_id str
    (Required String) The provider integration id.
    bucketName String
    (Required String) The bucket name.
    bucketRegion String
    (Required String) The bucket region.
    providerIntegrationId String
    (Required String) The provider integration id.

    GetTableflowTopicCredentials

    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.

    GetTableflowTopicEnvironment

    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.

    GetTableflowTopicKafkaCluster

    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.

    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.21.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-confluentcloud