Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. KafkaMirrorTopic
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.KafkaMirrorTopic

Explore with Pulumi AI

Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

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,
        },
    },
});
Copy
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"],
        },
    })
Copy
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
	})
}
Copy
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,
            },
        },
    });

});
Copy
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());

    }
}
Copy
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}
Copy

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 This property is required. string
The unique name of the resource.
args This property is required. KafkaMirrorTopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. KafkaMirrorTopicArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KafkaMirrorTopicArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
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());
Copy
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")
Copy
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",
});
Copy
type: confluentcloud:KafkaMirrorTopic
properties:
    clusterLink:
        linkName: string
    kafkaCluster:
        credentials:
            key: string
            secret: string
        id: string
        restEndpoint: string
    mirrorTopicName: string
    sourceKafkaTopic:
        topicName: string
    status: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicClusterLink
KafkaCluster This property is required. Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicKafkaCluster
SourceKafkaTopic
This property is required.
Changes to this property will trigger replacement.
Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicSourceKafkaTopic
MirrorTopicName Changes to this property will trigger replacement. 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
ClusterLink
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicClusterLinkArgs
KafkaCluster This property is required. KafkaMirrorTopicKafkaClusterArgs
SourceKafkaTopic
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicSourceKafkaTopicArgs
MirrorTopicName Changes to this property will trigger replacement. 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
clusterLink
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicClusterLink
kafkaCluster This property is required. KafkaMirrorTopicKafkaCluster
sourceKafkaTopic
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicSourceKafkaTopic
mirrorTopicName Changes to this property will trigger replacement. 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
clusterLink
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicClusterLink
kafkaCluster This property is required. KafkaMirrorTopicKafkaCluster
sourceKafkaTopic
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicSourceKafkaTopic
mirrorTopicName Changes to this property will trigger replacement. 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
cluster_link
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicClusterLinkArgs
kafka_cluster This property is required. KafkaMirrorTopicKafkaClusterArgs
source_kafka_topic
This property is required.
Changes to this property will trigger replacement.
KafkaMirrorTopicSourceKafkaTopicArgs
mirror_topic_name Changes to this property will trigger replacement. 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
clusterLink
This property is required.
Changes to this property will trigger replacement.
Property Map
kafkaCluster This property is required. Property Map
sourceKafkaTopic
This property is required.
Changes to this property will trigger replacement.
Property Map
mirrorTopicName Changes to this property will trigger replacement. 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

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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicClusterLink
KafkaCluster Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicKafkaCluster
MirrorTopicName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Pulumi.ConfluentCloud.Inputs.KafkaMirrorTopicSourceKafkaTopic
Status string
ClusterLink Changes to this property will trigger replacement. KafkaMirrorTopicClusterLinkArgs
KafkaCluster KafkaMirrorTopicKafkaClusterArgs
MirrorTopicName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. KafkaMirrorTopicSourceKafkaTopicArgs
Status string
clusterLink Changes to this property will trigger replacement. KafkaMirrorTopicClusterLink
kafkaCluster KafkaMirrorTopicKafkaCluster
mirrorTopicName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. KafkaMirrorTopicSourceKafkaTopic
status String
clusterLink Changes to this property will trigger replacement. KafkaMirrorTopicClusterLink
kafkaCluster KafkaMirrorTopicKafkaCluster
mirrorTopicName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. KafkaMirrorTopicSourceKafkaTopic
status string
cluster_link Changes to this property will trigger replacement. KafkaMirrorTopicClusterLinkArgs
kafka_cluster KafkaMirrorTopicKafkaClusterArgs
mirror_topic_name Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. KafkaMirrorTopicSourceKafkaTopicArgs
status str
clusterLink Changes to this property will trigger replacement. Property Map
kafkaCluster Property Map
mirrorTopicName Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Property Map
status String

Supporting Types

LinkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
LinkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
linkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
linkName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
link_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.
linkName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster link to attach to the mirror topic, for example, my-cluster-link.

KafkaMirrorTopicKafkaCluster
, KafkaMirrorTopicKafkaClusterArgs

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

KafkaMirrorTopicKafkaClusterCredentials
, KafkaMirrorTopicKafkaClusterCredentialsArgs

Key This property is required. string
The Kafka API Key.
Secret This property is required. string
The Kafka API Secret.
Key This property is required. string
The Kafka API Key.
Secret This property is required. string
The Kafka API Secret.
key This property is required. String
The Kafka API Key.
secret This property is required. String
The Kafka API Secret.
key This property is required. string
The Kafka API Key.
secret This property is required. string
The Kafka API Secret.
key This property is required. str
The Kafka API Key.
secret This property is required. str
The Kafka API Secret.
key This property is required. String
The Kafka API Key.
secret This property is required. String
The Kafka API Secret.

KafkaMirrorTopicSourceKafkaTopic
, KafkaMirrorTopicSourceKafkaTopicArgs

TopicName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
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

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
Copy

!> 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.
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud