Confluent v1.26.0, Sep 28 23

Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

confluentcloud.KafkaMirrorTopic

Explore with Pulumi AI

Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

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

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

Create KafkaMirrorTopic Resource

new KafkaMirrorTopic(name: string, args: KafkaMirrorTopicArgs, opts?: CustomResourceOptions);

@overload
def KafkaMirrorTopic(resource_name: 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)
@overload
def KafkaMirrorTopic(resource_name: str,
                     args: KafkaMirrorTopicArgs,
                     opts: Optional[ResourceOptions] = 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.

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.

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

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

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

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

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

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

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

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)

Resource lookup is not supported in YAML

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

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

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

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

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

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

Supporting Types

KafkaMirrorTopicClusterLink, KafkaMirrorTopicClusterLinkArgs

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
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
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
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
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
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
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.

Package Details

Repository: Confluent Cloud pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.

Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

pulumi/pulumi-confluentcloud

confluentcloud.KafkaMirrorTopic

On this page

On this page

Import

Create KafkaMirrorTopic Resource

KafkaMirrorTopic Resource Properties

Inputs

Outputs

Look up Existing KafkaMirrorTopic Resource

Supporting Types

KafkaMirrorTopicClusterLink, KafkaMirrorTopicClusterLinkArgs

KafkaMirrorTopicKafkaCluster, KafkaMirrorTopicKafkaClusterArgs

KafkaMirrorTopicKafkaClusterCredentials, KafkaMirrorTopicKafkaClusterCredentialsArgs

KafkaMirrorTopicSourceKafkaTopic, KafkaMirrorTopicSourceKafkaTopicArgs

Package Details

On this page

On this page