1. Packages
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. RtceTopic
Viewing docs for Confluent v2.69.0
published on Friday, May 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.RtceTopic

confluentcloud logo
Viewing docs for Confluent v2.69.0
published on Friday, May 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.RtceTopic provides a RtceTopic resource that enables creating, editing, and deleting RtceTopics on Confluent Cloud.

    Note: It is recommended to set lifecycle { preventDestroy = true } on production instances to prevent accidental rtce topic deletion. This setting rejects plans that would destroy or recreate the rtce topic, such as attempting to change uneditable attributes. Read more about it in the Terraform docs.

    Example Usage

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

const example = new confluentcloud.RtceTopic("example", {
    cloud: "AWS",
    description: "Customer orders table for real-time analytics",
    environment: {
        id: "env-00000",
    },
    kafkaCluster: {
        id: "lkc-00000",
    },
    region: "us-west-2",
    topicName: "orders_topic",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.RtceTopic("example",
    cloud="AWS",
    description="Customer orders table for real-time analytics",
    environment={
        "id": "env-00000",
    },
    kafka_cluster={
        "id": "lkc-00000",
    },
    region="us-west-2",
    topic_name="orders_topic")

    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 {
		_, err := confluentcloud.NewRtceTopic(ctx, "example", &confluentcloud.RtceTopicArgs{
			Cloud:       pulumi.String("AWS"),
			Description: pulumi.String("Customer orders table for real-time analytics"),
			Environment: &confluentcloud.RtceTopicEnvironmentArgs{
				Id: pulumi.String("env-00000"),
			},
			KafkaCluster: &confluentcloud.RtceTopicKafkaClusterArgs{
				Id: pulumi.String("lkc-00000"),
			},
			Region:    pulumi.String("us-west-2"),
			TopicName: pulumi.String("orders_topic"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new ConfluentCloud.RtceTopic("example", new()
    {
        Cloud = "AWS",
        Description = "Customer orders table for real-time analytics",
        Environment = new ConfluentCloud.Inputs.RtceTopicEnvironmentArgs
        {
            Id = "env-00000",
        },
        KafkaCluster = new ConfluentCloud.Inputs.RtceTopicKafkaClusterArgs
        {
            Id = "lkc-00000",
        },
        Region = "us-west-2",
        TopicName = "orders_topic",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.RtceTopic;
import com.pulumi.confluentcloud.RtceTopicArgs;
import com.pulumi.confluentcloud.inputs.RtceTopicEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.RtceTopicKafkaClusterArgs;
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) {
        var example = new RtceTopic("example", RtceTopicArgs.builder()
            .cloud("AWS")
            .description("Customer orders table for real-time analytics")
            .environment(RtceTopicEnvironmentArgs.builder()
                .id("env-00000")
                .build())
            .kafkaCluster(RtceTopicKafkaClusterArgs.builder()
                .id("lkc-00000")
                .build())
            .region("us-west-2")
            .topicName("orders_topic")
            .build());

    }
}

    resources:
  example:
    type: confluentcloud:RtceTopic
    properties:
      cloud: AWS
      description: Customer orders table for real-time analytics
      environment:
        id: env-00000
      kafkaCluster:
        id: lkc-00000
      region: us-west-2
      topicName: orders_topic

    Example coming soon!

    Create RtceTopic Resource

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

    Constructor syntax

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

@overload
def RtceTopic(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cloud: Optional[str] = None,
              description: Optional[str] = None,
              environment: Optional[RtceTopicEnvironmentArgs] = None,
              kafka_cluster: Optional[RtceTopicKafkaClusterArgs] = None,
              region: Optional[str] = None,
              topic_name: Optional[str] = None)
    func NewRtceTopic(ctx *Context, name string, args RtceTopicArgs, opts ...ResourceOption) (*RtceTopic, error)
    public RtceTopic(string name, RtceTopicArgs args, CustomResourceOptions? opts = null)
    public RtceTopic(String name, RtceTopicArgs args)
public RtceTopic(String name, RtceTopicArgs args, CustomResourceOptions options)

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


    resource "confluentcloud_rtcetopic" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RtceTopicArgs
    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 RtceTopicArgs
    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 RtceTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RtceTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RtceTopicArgs
    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 rtceTopicResource = new ConfluentCloud.RtceTopic("rtceTopicResource", new()
{
    Cloud = "string",
    Description = "string",
    Environment = new ConfluentCloud.Inputs.RtceTopicEnvironmentArgs
    {
        Id = "string",
    },
    KafkaCluster = new ConfluentCloud.Inputs.RtceTopicKafkaClusterArgs
    {
        Id = "string",
    },
    Region = "string",
    TopicName = "string",
});

    example, err := confluentcloud.NewRtceTopic(ctx, "rtceTopicResource", &confluentcloud.RtceTopicArgs{
	Cloud:       pulumi.String("string"),
	Description: pulumi.String("string"),
	Environment: &confluentcloud.RtceTopicEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	KafkaCluster: &confluentcloud.RtceTopicKafkaClusterArgs{
		Id: pulumi.String("string"),
	},
	Region:    pulumi.String("string"),
	TopicName: pulumi.String("string"),
})

    resource "confluentcloud_rtcetopic" "rtceTopicResource" {
  cloud       = "string"
  description = "string"
  environment = {
    id = "string"
  }
  kafka_cluster = {
    id = "string"
  }
  region     = "string"
  topic_name = "string"
}

    var rtceTopicResource = new RtceTopic("rtceTopicResource", RtceTopicArgs.builder()
    .cloud("string")
    .description("string")
    .environment(RtceTopicEnvironmentArgs.builder()
        .id("string")
        .build())
    .kafkaCluster(RtceTopicKafkaClusterArgs.builder()
        .id("string")
        .build())
    .region("string")
    .topicName("string")
    .build());

    rtce_topic_resource = confluentcloud.RtceTopic("rtceTopicResource",
    cloud="string",
    description="string",
    environment={
        "id": "string",
    },
    kafka_cluster={
        "id": "string",
    },
    region="string",
    topic_name="string")

    const rtceTopicResource = new confluentcloud.RtceTopic("rtceTopicResource", {
    cloud: "string",
    description: "string",
    environment: {
        id: "string",
    },
    kafkaCluster: {
        id: "string",
    },
    region: "string",
    topicName: "string",
});

    type: confluentcloud:RtceTopic
properties:
    cloud: string
    description: string
    environment:
        id: string
    kafkaCluster:
        id: string
    region: string
    topicName: string

    RtceTopic 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 RtceTopic resource accepts the following input properties:

    Cloud string
    The cloud provider where the RTCE topic is deployed.
    Description string
    A model-readable description of the RTCE topic.
    Environment Pulumi.ConfluentCloud.Inputs.RtceTopicEnvironment
    The environment to which the target Kafka cluster belongs. Supports the following:
    KafkaCluster Pulumi.ConfluentCloud.Inputs.RtceTopicKafkaCluster
    The Kafka cluster containing the topic to be materialized. Supports the following:
    Region string
    The cloud region where the RTCE topic is deployed.
    TopicName string
    The Kafka topic name containing the data for the RTCE topic.
    Cloud string
    The cloud provider where the RTCE topic is deployed.
    Description string
    A model-readable description of the RTCE topic.
    Environment RtceTopicEnvironmentArgs
    The environment to which the target Kafka cluster belongs. Supports the following:
    KafkaCluster RtceTopicKafkaClusterArgs
    The Kafka cluster containing the topic to be materialized. Supports the following:
    Region string
    The cloud region where the RTCE topic is deployed.
    TopicName string
    The Kafka topic name containing the data for the RTCE topic.
    cloud string
    The cloud provider where the RTCE topic is deployed.
    description string
    A model-readable description of the RTCE topic.
    environment object
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafka_cluster object
    The Kafka cluster containing the topic to be materialized. Supports the following:
    region string
    The cloud region where the RTCE topic is deployed.
    topic_name string
    The Kafka topic name containing the data for the RTCE topic.
    cloud String
    The cloud provider where the RTCE topic is deployed.
    description String
    A model-readable description of the RTCE topic.
    environment RtceTopicEnvironment
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafkaCluster RtceTopicKafkaCluster
    The Kafka cluster containing the topic to be materialized. Supports the following:
    region String
    The cloud region where the RTCE topic is deployed.
    topicName String
    The Kafka topic name containing the data for the RTCE topic.
    cloud string
    The cloud provider where the RTCE topic is deployed.
    description string
    A model-readable description of the RTCE topic.
    environment RtceTopicEnvironment
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafkaCluster RtceTopicKafkaCluster
    The Kafka cluster containing the topic to be materialized. Supports the following:
    region string
    The cloud region where the RTCE topic is deployed.
    topicName string
    The Kafka topic name containing the data for the RTCE topic.
    cloud str
    The cloud provider where the RTCE topic is deployed.
    description str
    A model-readable description of the RTCE topic.
    environment RtceTopicEnvironmentArgs
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafka_cluster RtceTopicKafkaClusterArgs
    The Kafka cluster containing the topic to be materialized. Supports the following:
    region str
    The cloud region where the RTCE topic is deployed.
    topic_name str
    The Kafka topic name containing the data for the RTCE topic.
    cloud String
    The cloud provider where the RTCE topic is deployed.
    description String
    A model-readable description of the RTCE topic.
    environment Property Map
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafkaCluster Property Map
    The Kafka cluster containing the topic to be materialized. Supports the following:
    region String
    The cloud region where the RTCE topic is deployed.
    topicName String
    The Kafka topic name containing the data for the RTCE topic.

    Outputs

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

    ApiVersion string
    (Required String) API Version defines the schema version of this representation of a resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) Kind defines the object this REST resource represents.
    ResourceName string
    (Required String) The Confluent Resource Name of the resource.
    ApiVersion string
    (Required String) API Version defines the schema version of this representation of a resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) Kind defines the object this REST resource represents.
    ResourceName string
    (Required String) The Confluent Resource Name of the resource.
    api_version string
    (Required String) API Version defines the schema version of this representation of a resource.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    (Required String) Kind defines the object this REST resource represents.
    resource_name string
    (Required String) The Confluent Resource Name of the resource.
    apiVersion String
    (Required String) API Version defines the schema version of this representation of a resource.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) Kind defines the object this REST resource represents.
    resourceName String
    (Required String) The Confluent Resource Name of the resource.
    apiVersion string
    (Required String) API Version defines the schema version of this representation of a resource.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    (Required String) Kind defines the object this REST resource represents.
    resourceName string
    (Required String) The Confluent Resource Name of the resource.
    api_version str
    (Required String) API Version defines the schema version of this representation of a resource.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    (Required String) Kind defines the object this REST resource represents.
    resource_name str
    (Required String) The Confluent Resource Name of the resource.
    apiVersion String
    (Required String) API Version defines the schema version of this representation of a resource.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) Kind defines the object this REST resource represents.
    resourceName String
    (Required String) The Confluent Resource Name of the resource.

    Look up Existing RtceTopic Resource

    Get an existing RtceTopic 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?: RtceTopicState, opts?: CustomResourceOptions): RtceTopic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        cloud: Optional[str] = None,
        description: Optional[str] = None,
        environment: Optional[RtceTopicEnvironmentArgs] = None,
        kafka_cluster: Optional[RtceTopicKafkaClusterArgs] = None,
        kind: Optional[str] = None,
        region: Optional[str] = None,
        resource_name: Optional[str] = None,
        topic_name: Optional[str] = None) -> RtceTopic
    func GetRtceTopic(ctx *Context, name string, id IDInput, state *RtceTopicState, opts ...ResourceOption) (*RtceTopic, error)
    public static RtceTopic Get(string name, Input<string> id, RtceTopicState? state, CustomResourceOptions? opts = null)
    public static RtceTopic get(String name, Output<String> id, RtceTopicState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:RtceTopic    get:      id: ${id}
    import {
  to = confluentcloud_rtcetopic.example
  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:
    ApiVersion string
    (Required String) API Version defines the schema version of this representation of a resource.
    Cloud string
    The cloud provider where the RTCE topic is deployed.
    Description string
    A model-readable description of the RTCE topic.
    Environment Pulumi.ConfluentCloud.Inputs.RtceTopicEnvironment
    The environment to which the target Kafka cluster belongs. Supports the following:
    KafkaCluster Pulumi.ConfluentCloud.Inputs.RtceTopicKafkaCluster
    The Kafka cluster containing the topic to be materialized. Supports the following:
    Kind string
    (Required String) Kind defines the object this REST resource represents.
    Region string
    The cloud region where the RTCE topic is deployed.
    ResourceName string
    (Required String) The Confluent Resource Name of the resource.
    TopicName string
    The Kafka topic name containing the data for the RTCE topic.
    ApiVersion string
    (Required String) API Version defines the schema version of this representation of a resource.
    Cloud string
    The cloud provider where the RTCE topic is deployed.
    Description string
    A model-readable description of the RTCE topic.
    Environment RtceTopicEnvironmentArgs
    The environment to which the target Kafka cluster belongs. Supports the following:
    KafkaCluster RtceTopicKafkaClusterArgs
    The Kafka cluster containing the topic to be materialized. Supports the following:
    Kind string
    (Required String) Kind defines the object this REST resource represents.
    Region string
    The cloud region where the RTCE topic is deployed.
    ResourceName string
    (Required String) The Confluent Resource Name of the resource.
    TopicName string
    The Kafka topic name containing the data for the RTCE topic.
    api_version string
    (Required String) API Version defines the schema version of this representation of a resource.
    cloud string
    The cloud provider where the RTCE topic is deployed.
    description string
    A model-readable description of the RTCE topic.
    environment object
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafka_cluster object
    The Kafka cluster containing the topic to be materialized. Supports the following:
    kind string
    (Required String) Kind defines the object this REST resource represents.
    region string
    The cloud region where the RTCE topic is deployed.
    resource_name string
    (Required String) The Confluent Resource Name of the resource.
    topic_name string
    The Kafka topic name containing the data for the RTCE topic.
    apiVersion String
    (Required String) API Version defines the schema version of this representation of a resource.
    cloud String
    The cloud provider where the RTCE topic is deployed.
    description String
    A model-readable description of the RTCE topic.
    environment RtceTopicEnvironment
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafkaCluster RtceTopicKafkaCluster
    The Kafka cluster containing the topic to be materialized. Supports the following:
    kind String
    (Required String) Kind defines the object this REST resource represents.
    region String
    The cloud region where the RTCE topic is deployed.
    resourceName String
    (Required String) The Confluent Resource Name of the resource.
    topicName String
    The Kafka topic name containing the data for the RTCE topic.
    apiVersion string
    (Required String) API Version defines the schema version of this representation of a resource.
    cloud string
    The cloud provider where the RTCE topic is deployed.
    description string
    A model-readable description of the RTCE topic.
    environment RtceTopicEnvironment
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafkaCluster RtceTopicKafkaCluster
    The Kafka cluster containing the topic to be materialized. Supports the following:
    kind string
    (Required String) Kind defines the object this REST resource represents.
    region string
    The cloud region where the RTCE topic is deployed.
    resourceName string
    (Required String) The Confluent Resource Name of the resource.
    topicName string
    The Kafka topic name containing the data for the RTCE topic.
    api_version str
    (Required String) API Version defines the schema version of this representation of a resource.
    cloud str
    The cloud provider where the RTCE topic is deployed.
    description str
    A model-readable description of the RTCE topic.
    environment RtceTopicEnvironmentArgs
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafka_cluster RtceTopicKafkaClusterArgs
    The Kafka cluster containing the topic to be materialized. Supports the following:
    kind str
    (Required String) Kind defines the object this REST resource represents.
    region str
    The cloud region where the RTCE topic is deployed.
    resource_name str
    (Required String) The Confluent Resource Name of the resource.
    topic_name str
    The Kafka topic name containing the data for the RTCE topic.
    apiVersion String
    (Required String) API Version defines the schema version of this representation of a resource.
    cloud String
    The cloud provider where the RTCE topic is deployed.
    description String
    A model-readable description of the RTCE topic.
    environment Property Map
    The environment to which the target Kafka cluster belongs. Supports the following:
    kafkaCluster Property Map
    The Kafka cluster containing the topic to be materialized. Supports the following:
    kind String
    (Required String) Kind defines the object this REST resource represents.
    region String
    The cloud region where the RTCE topic is deployed.
    resourceName String
    (Required String) The Confluent Resource Name of the resource.
    topicName String
    The Kafka topic name containing the data for the RTCE topic.

    Supporting Types

    RtceTopicEnvironment, RtceTopicEnvironmentArgs

    Id string
    The ID of the Environment.
    Id string
    The ID of the Environment.
    id string
    The ID of the Environment.
    id String
    The ID of the Environment.
    id string
    The ID of the Environment.
    id str
    The ID of the Environment.
    id String
    The ID of the Environment.

    RtceTopicKafkaCluster, RtceTopicKafkaClusterArgs

    Id string
    The ID of the Kafka Cluster.
    Id string
    The ID of the Kafka Cluster.
    id string
    The ID of the Kafka Cluster.
    id String
    The ID of the Kafka Cluster.
    id string
    The ID of the Kafka Cluster.
    id str
    The ID of the Kafka Cluster.
    id String
    The ID of the Kafka Cluster.

    Import

    Note: CONFLUENT_CLOUD_API_KEY and CONFLUENT_CLOUD_API_SECRET environment variables must be set before importing a RtceTopic.

    You can import a RtceTopic by using the composite ID <Environment ID>/<Kafka Cluster ID>/<topic_name>, for example:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/rtceTopic:RtceTopic example env-abc123/lkc-abc123/orders_topic

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    To learn more about importing existing cloud resources, see Importing resources.

    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
    Viewing docs for Confluent v2.69.0
    published on Friday, May 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.