1. Packages
  2. Confluent Provider
  3. API Docs
  4. KafkaMirrorTopic
Viewing docs for Confluent v2.61.0
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.KafkaMirrorTopic

confluentcloud logo
Viewing docs for Confluent v2.61.0
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.KafkaMirrorTopic provides a Kafka Mirror Topic resource that enables creating and deleting Kafka Mirror Topics on a Kafka cluster on Confluent Cloud.

    Note: It is recommended to set lifecycle {<span pulumi-lang-nodejs=" preventDestroy " pulumi-lang-dotnet=" PreventDestroy " pulumi-lang-go=" preventDestroy " pulumi-lang-python=" prevent_destroy " pulumi-lang-yaml=" preventDestroy " pulumi-lang-java=" preventDestroy "> prevent_destroy </span>= true } on production instances to prevent accidental mirror topic deletion. This setting rejects plans that would destroy or recreate the mirror topic. 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.KafkaMirrorTopic("example", {
    sourceKafkaTopic: {
        topicName: "orders",
    },
    clusterLink: {
        linkName: source_outbound.linkName,
    },
    kafkaCluster: {
        id: destination.id,
        restEndpoint: destination.restEndpoint,
        credentials: {
            key: app_manager_destination_cluster_api_key.id,
            secret: app_manager_destination_cluster_api_key.secret,
        },
    },
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.KafkaMirrorTopic("example",
    source_kafka_topic={
        "topic_name": "orders",
    },
    cluster_link={
        "link_name": source_outbound["linkName"],
    },
    kafka_cluster={
        "id": destination["id"],
        "rest_endpoint": destination["restEndpoint"],
        "credentials": {
            "key": app_manager_destination_cluster_api_key["id"],
            "secret": app_manager_destination_cluster_api_key["secret"],
        },
    })

    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.NewKafkaMirrorTopic(ctx, "example", &confluentcloud.KafkaMirrorTopicArgs{
			SourceKafkaTopic: &confluentcloud.KafkaMirrorTopicSourceKafkaTopicArgs{
				TopicName: pulumi.String("orders"),
			},
			ClusterLink: &confluentcloud.KafkaMirrorTopicClusterLinkArgs{
				LinkName: pulumi.Any(source_outbound.LinkName),
			},
			KafkaCluster: &confluentcloud.KafkaMirrorTopicKafkaClusterArgs{
				Id:           pulumi.Any(destination.Id),
				RestEndpoint: pulumi.Any(destination.RestEndpoint),
				Credentials: &confluentcloud.KafkaMirrorTopicKafkaClusterCredentialsArgs{
					Key:    pulumi.Any(app_manager_destination_cluster_api_key.Id),
					Secret: pulumi.Any(app_manager_destination_cluster_api_key.Secret),
				},
			},
		})
		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.KafkaMirrorTopic("example", new()
    {
        SourceKafkaTopic = new ConfluentCloud.Inputs.KafkaMirrorTopicSourceKafkaTopicArgs
        {
            TopicName = "orders",
        },
        ClusterLink = new ConfluentCloud.Inputs.KafkaMirrorTopicClusterLinkArgs
        {
            LinkName = source_outbound.LinkName,
        },
        KafkaCluster = new ConfluentCloud.Inputs.KafkaMirrorTopicKafkaClusterArgs
        {
            Id = destination.Id,
            RestEndpoint = destination.RestEndpoint,
            Credentials = new ConfluentCloud.Inputs.KafkaMirrorTopicKafkaClusterCredentialsArgs
            {
                Key = app_manager_destination_cluster_api_key.Id,
                Secret = app_manager_destination_cluster_api_key.Secret,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.KafkaMirrorTopic;
import com.pulumi.confluentcloud.KafkaMirrorTopicArgs;
import com.pulumi.confluentcloud.inputs.KafkaMirrorTopicSourceKafkaTopicArgs;
import com.pulumi.confluentcloud.inputs.KafkaMirrorTopicClusterLinkArgs;
import com.pulumi.confluentcloud.inputs.KafkaMirrorTopicKafkaClusterArgs;
import com.pulumi.confluentcloud.inputs.KafkaMirrorTopicKafkaClusterCredentialsArgs;
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) {
        var example = new KafkaMirrorTopic("example", KafkaMirrorTopicArgs.builder()
            .sourceKafkaTopic(KafkaMirrorTopicSourceKafkaTopicArgs.builder()
                .topicName("orders")
                .build())
            .clusterLink(KafkaMirrorTopicClusterLinkArgs.builder()
                .linkName(source_outbound.linkName())
                .build())
            .kafkaCluster(KafkaMirrorTopicKafkaClusterArgs.builder()
                .id(destination.id())
                .restEndpoint(destination.restEndpoint())
                .credentials(KafkaMirrorTopicKafkaClusterCredentialsArgs.builder()
                    .key(app_manager_destination_cluster_api_key.id())
                    .secret(app_manager_destination_cluster_api_key.secret())
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: confluentcloud:KafkaMirrorTopic
    properties:
      sourceKafkaTopic:
        topicName: orders
      clusterLink:
        linkName: ${["source-outbound"].linkName}
      kafkaCluster:
        id: ${destination.id}
        restEndpoint: ${destination.restEndpoint}
        credentials:
          key: ${["app-manager-destination-cluster-api-key"].id}
          secret: ${["app-manager-destination-cluster-api-key"].secret}

    Getting Started

    The following end-to-end examples might help to get started with confluentcloud.KafkaMirrorTopic resource:

    • destination-initiated-cluster-link-rbac: An example of setting up a destination initiated cluster link with a mirror topic
    • source-initiated-cluster-link-rbac: An example of setting up a source initiated cluster link with a mirror topic

    See Mirror Topics on Confluent Cloud to learn more about Mirror Topics on Confluent Cloud.

    Create KafkaMirrorTopic Resource

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

    Constructor syntax

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

@overload
def KafkaMirrorTopic(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cluster_link: Optional[KafkaMirrorTopicClusterLinkArgs] = None,
                     kafka_cluster: Optional[KafkaMirrorTopicKafkaClusterArgs] = None,
                     source_kafka_topic: Optional[KafkaMirrorTopicSourceKafkaTopicArgs] = None,
                     mirror_topic_name: Optional[str] = None,
                     status: Optional[str] = None)
    func NewKafkaMirrorTopic(ctx *Context, name string, args KafkaMirrorTopicArgs, opts ...ResourceOption) (*KafkaMirrorTopic, error)
    public KafkaMirrorTopic(string name, KafkaMirrorTopicArgs args, CustomResourceOptions? opts = null)
    public KafkaMirrorTopic(String name, KafkaMirrorTopicArgs args)
public KafkaMirrorTopic(String name, KafkaMirrorTopicArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args KafkaMirrorTopicArgs
    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 KafkaMirrorTopicArgs
    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 KafkaMirrorTopicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KafkaMirrorTopicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KafkaMirrorTopicArgs
    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 kafkaMirrorTopicResource = new ConfluentCloud.KafkaMirrorTopic("kafkaMirrorTopicResource", new()
{
    ClusterLink = new ConfluentCloud.Inputs.KafkaMirrorTopicClusterLinkArgs
    {
        LinkName = "string",
    },
    KafkaCluster = new ConfluentCloud.Inputs.KafkaMirrorTopicKafkaClusterArgs
    {
        Id = "string",
        Credentials = new ConfluentCloud.Inputs.KafkaMirrorTopicKafkaClusterCredentialsArgs
        {
            Key = "string",
            Secret = "string",
        },
        RestEndpoint = "string",
    },
    SourceKafkaTopic = new ConfluentCloud.Inputs.KafkaMirrorTopicSourceKafkaTopicArgs
    {
        TopicName = "string",
    },
    MirrorTopicName = "string",
    Status = "string",
});

    example, err := confluentcloud.NewKafkaMirrorTopic(ctx, "kafkaMirrorTopicResource", &confluentcloud.KafkaMirrorTopicArgs{
	ClusterLink: &confluentcloud.KafkaMirrorTopicClusterLinkArgs{
		LinkName: pulumi.String("string"),
	},
	KafkaCluster: &confluentcloud.KafkaMirrorTopicKafkaClusterArgs{
		Id: pulumi.String("string"),
		Credentials: &confluentcloud.KafkaMirrorTopicKafkaClusterCredentialsArgs{
			Key:    pulumi.String("string"),
			Secret: pulumi.String("string"),
		},
		RestEndpoint: pulumi.String("string"),
	},
	SourceKafkaTopic: &confluentcloud.KafkaMirrorTopicSourceKafkaTopicArgs{
		TopicName: pulumi.String("string"),
	},
	MirrorTopicName: pulumi.String("string"),
	Status:          pulumi.String("string"),
})

    var kafkaMirrorTopicResource = new KafkaMirrorTopic("kafkaMirrorTopicResource", KafkaMirrorTopicArgs.builder()
    .clusterLink(KafkaMirrorTopicClusterLinkArgs.builder()
        .linkName("string")
        .build())
    .kafkaCluster(KafkaMirrorTopicKafkaClusterArgs.builder()
        .id("string")
        .credentials(KafkaMirrorTopicKafkaClusterCredentialsArgs.builder()
            .key("string")
            .secret("string")
            .build())
        .restEndpoint("string")
        .build())
    .sourceKafkaTopic(KafkaMirrorTopicSourceKafkaTopicArgs.builder()
        .topicName("string")
        .build())
    .mirrorTopicName("string")
    .status("string")
    .build());

    kafka_mirror_topic_resource = confluentcloud.KafkaMirrorTopic("kafkaMirrorTopicResource",
    cluster_link={
        "link_name": "string",
    },
    kafka_cluster={
        "id": "string",
        "credentials": {
            "key": "string",
            "secret": "string",
        },
        "rest_endpoint": "string",
    },
    source_kafka_topic={
        "topic_name": "string",
    },
    mirror_topic_name="string",
    status="string")

    const kafkaMirrorTopicResource = new confluentcloud.KafkaMirrorTopic("kafkaMirrorTopicResource", {
    clusterLink: {
        linkName: "string",
    },
    kafkaCluster: {
        id: "string",
        credentials: {
            key: "string",
            secret: "string",
        },
        restEndpoint: "string",
    },
    sourceKafkaTopic: {
        topicName: "string",
    },
    mirrorTopicName: "string",
    status: "string",
});

    type: confluentcloud:KafkaMirrorTopic
properties:
    clusterLink:
        linkName: string
    kafkaCluster:
        credentials:
            key: string
            secret: string
        id: string
        restEndpoint: string
    mirrorTopicName: string
    sourceKafkaTopic:
        topicName: string
    status: string

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

    ClusterLink Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicClusterLink
    KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicKafkaCluster
    SourceKafkaTopic Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicSourceKafkaTopic
    MirrorTopicName string
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    Status string

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    ClusterLink KafkaMirrorTopicClusterLinkArgs
    KafkaCluster KafkaMirrorTopicKafkaClusterArgs
    SourceKafkaTopic KafkaMirrorTopicSourceKafkaTopicArgs
    MirrorTopicName string
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    Status string

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    clusterLink KafkaMirrorTopicClusterLink
    kafkaCluster KafkaMirrorTopicKafkaCluster
    sourceKafkaTopic KafkaMirrorTopicSourceKafkaTopic
    mirrorTopicName String
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    status String

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    clusterLink KafkaMirrorTopicClusterLink
    kafkaCluster KafkaMirrorTopicKafkaCluster
    sourceKafkaTopic KafkaMirrorTopicSourceKafkaTopic
    mirrorTopicName string
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    status string

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    cluster_link KafkaMirrorTopicClusterLinkArgs
    kafka_cluster KafkaMirrorTopicKafkaClusterArgs
    source_kafka_topic KafkaMirrorTopicSourceKafkaTopicArgs
    mirror_topic_name str
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    status str

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    clusterLink Property Map
    kafkaCluster Property Map
    sourceKafkaTopic Property Map
    mirrorTopicName String
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    status String

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KafkaMirrorTopic Resource

    Get an existing KafkaMirrorTopic 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?: KafkaMirrorTopicState, opts?: CustomResourceOptions): KafkaMirrorTopic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_link: Optional[KafkaMirrorTopicClusterLinkArgs] = None,
        kafka_cluster: Optional[KafkaMirrorTopicKafkaClusterArgs] = None,
        mirror_topic_name: Optional[str] = None,
        source_kafka_topic: Optional[KafkaMirrorTopicSourceKafkaTopicArgs] = None,
        status: Optional[str] = None) -> KafkaMirrorTopic
    func GetKafkaMirrorTopic(ctx *Context, name string, id IDInput, state *KafkaMirrorTopicState, opts ...ResourceOption) (*KafkaMirrorTopic, error)
    public static KafkaMirrorTopic Get(string name, Input<string> id, KafkaMirrorTopicState? state, CustomResourceOptions? opts = null)
    public static KafkaMirrorTopic get(String name, Output<String> id, KafkaMirrorTopicState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:KafkaMirrorTopic    get:      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:
    ClusterLink Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicClusterLink
    KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicKafkaCluster
    MirrorTopicName string
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    SourceKafkaTopic Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicSourceKafkaTopic
    Status string

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    ClusterLink KafkaMirrorTopicClusterLinkArgs
    KafkaCluster KafkaMirrorTopicKafkaClusterArgs
    MirrorTopicName string
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    SourceKafkaTopic KafkaMirrorTopicSourceKafkaTopicArgs
    Status string

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    clusterLink KafkaMirrorTopicClusterLink
    kafkaCluster KafkaMirrorTopicKafkaCluster
    mirrorTopicName String
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    sourceKafkaTopic KafkaMirrorTopicSourceKafkaTopic
    status String

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    clusterLink KafkaMirrorTopicClusterLink
    kafkaCluster KafkaMirrorTopicKafkaCluster
    mirrorTopicName string
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    sourceKafkaTopic KafkaMirrorTopicSourceKafkaTopic
    status string

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    cluster_link KafkaMirrorTopicClusterLinkArgs
    kafka_cluster KafkaMirrorTopicKafkaClusterArgs
    mirror_topic_name str
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    source_kafka_topic KafkaMirrorTopicSourceKafkaTopicArgs
    status str

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    clusterLink Property Map
    kafkaCluster Property Map
    mirrorTopicName String
    The name of the mirror topic. Only required when there is a prefix configured on the cluster link. For example, when <prefix> is configured for the cluster link, the mirror topic name has to be of the format <prefix><source_topic_name>.
    sourceKafkaTopic Property Map
    status String

    The status of the mirror topic. The supported values are "ACTIVE", "PAUSED", "PROMOTED", "FAILED_OVER". Pausing ("ACTIVE" > "PAUSED"), resuming ("PAUSED" > "ACTIVE"), promoting, and failing over a mirror topic is supported via an update operation. Defaults to "ACTIVE".

    Note: A Kafka API key consists of a key and a secret. Kafka API keys are required to interact with Kafka clusters in Confluent Cloud. Each Kafka API key is valid for one specific Kafka cluster.

    Note: To rotate a Kafka API key, create a new Kafka API key, update the credentials block in all configuration files to use the new Kafka API key, run pulumi up -target="confluent_kafka_mirror_topic.example", and remove the old Kafka API key. Alternatively, in case the old Kafka API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_kafka_mirror_topic.example" -out=rotate-kafka-api-key and pulumi up rotate-kafka-api-key instead.

    Note: Setting or updating mirror topic settings is currently not supported.

    Note: For more information on the topic settings, see Cluster Linking configurations.

    !> Warning: Terraform doesn't encrypt the sensitive credentials value of the confluentcloud.KafkaMirrorTopic resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    !> Warning: When promoting or failing over a mirror topic, don't destroy a mirror topic. Instead, import a Kafka topic, and then save have both resource definitions in Terraform configuration or run terraform state rm confluent_kafka_mirror_topic.example command to delete a mirror topic from Terraform state.

    Supporting Types

    LinkName string
    The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
    LinkName string
    The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
    linkName String
    The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
    linkName string
    The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
    link_name str
    The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
    linkName String
    The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.

    KafkaMirrorTopicKafkaCluster, KafkaMirrorTopicKafkaClusterArgs

    Id string
    The ID of the destination Kafka cluster, for example, lkc-abc123.
    Credentials Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicKafkaClusterCredentials
    The Kafka API Credentials.
    RestEndpoint string
    The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    Id string
    The ID of the destination Kafka cluster, for example, lkc-abc123.
    Credentials KafkaMirrorTopicKafkaClusterCredentials
    The Kafka API Credentials.
    RestEndpoint string
    The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    id String
    The ID of the destination Kafka cluster, for example, lkc-abc123.
    credentials KafkaMirrorTopicKafkaClusterCredentials
    The Kafka API Credentials.
    restEndpoint String
    The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    id string
    The ID of the destination Kafka cluster, for example, lkc-abc123.
    credentials KafkaMirrorTopicKafkaClusterCredentials
    The Kafka API Credentials.
    restEndpoint string
    The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    id str
    The ID of the destination Kafka cluster, for example, lkc-abc123.
    credentials KafkaMirrorTopicKafkaClusterCredentials
    The Kafka API Credentials.
    rest_endpoint str
    The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).
    id String
    The ID of the destination Kafka cluster, for example, lkc-abc123.
    credentials Property Map
    The Kafka API Credentials.
    restEndpoint String
    The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).

    KafkaMirrorTopicKafkaClusterCredentials, KafkaMirrorTopicKafkaClusterCredentialsArgs

    Key string
    The Kafka API Key.
    Secret string
    The Kafka API Secret.
    Key string
    The Kafka API Key.
    Secret string
    The Kafka API Secret.
    key String
    The Kafka API Key.
    secret String
    The Kafka API Secret.
    key string
    The Kafka API Key.
    secret string
    The Kafka API Secret.
    key str
    The Kafka API Key.
    secret str
    The Kafka API Secret.
    key String
    The Kafka API Key.
    secret String
    The Kafka API Secret.

    KafkaMirrorTopicSourceKafkaTopic, KafkaMirrorTopicSourceKafkaTopicArgs

    TopicName string
    The name of the topic on the source cluster to be mirrored over the cluster link, for example, orders. A topic with the exact same name must exist on the source cluster, and no topic with this name should exist on the destination cluster.
    TopicName string
    The name of the topic on the source cluster to be mirrored over the cluster link, for example, orders. A topic with the exact same name must exist on the source cluster, and no topic with this name should exist on the destination cluster.
    topicName String
    The name of the topic on the source cluster to be mirrored over the cluster link, for example, orders. A topic with the exact same name must exist on the source cluster, and no topic with this name should exist on the destination cluster.
    topicName string
    The name of the topic on the source cluster to be mirrored over the cluster link, for example, orders. A topic with the exact same name must exist on the source cluster, and no topic with this name should exist on the destination cluster.
    topic_name str
    The name of the topic on the source cluster to be mirrored over the cluster link, for example, orders. A topic with the exact same name must exist on the source cluster, and no topic with this name should exist on the destination cluster.
    topicName String
    The name of the topic on the source cluster to be mirrored over the cluster link, for example, orders. A topic with the exact same name must exist on the source cluster, and no topic with this name should exist on the destination cluster.

    Import

    Note: IMPORT_KAFKA_API_KEY (kafka_cluster.credentials.key), IMPORT_KAFKA_API_SECRET (kafka_cluster.credentials.secret), and IMPORT_KAFKA_REST_ENDPOINT (kafka_cluster.rest_endpoint) environment variables must be set before importing a Kafka mirror topic.

    You can import a Kafka mirror topic by using the Kafka cluster ID, cluster link name, and Kafka topic name in the format <Kafka cluster ID>/<Cluster link name>/<Kafka topic name>, for example:

    $ export IMPORT_KAFKA_API_KEY="<kafka_api_key>"
$ export IMPORT_KAFKA_API_SECRET="<kafka_api_secret>"
$ export IMPORT_KAFKA_REST_ENDPOINT="<kafka_rest_endpoint>"
$ pulumi import confluentcloud:index/kafkaMirrorTopic:KafkaMirrorTopic my_mirror_topic lkc-abc123/my-cluster-link/orders-123

    !> 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.61.0
    published on Saturday, Mar 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.