Confluent v1.11.0, Mar 20 23

confluentcloud.ClusterLink

Import

You can import a Kafka mirror topic by using the cluster link name, cluster link mode, cluster link connection mode, source Kafka cluster ID, and destination Kafka cluster ID, in the format <Cluster link name>/<Cluster link mode>/<Cluster connection mode>/<Source Kafka cluster ID>/<Destination Kafka cluster ID>, for example$ export IMPORT_SOURCE_KAFKA_BOOTSTRAP_ENDPOINT="<source_kafka_bootstrap_endpoint>" $ export IMPORT_SOURCE_KAFKA_API_KEY="<source_kafka_api_key>" $ export IMPORT_SOURCE_KAFKA_API_SECRET="<source_kafka_api_secret>" $ export IMPORT_DESTINATION_KAFKA_REST_ENDPOINT="<destination_kafka_rest_endpoint>" $ export IMPORT_DESTINATION_KAFKA_API_KEY="<destination_kafka_api_key>" $ export IMPORT_DESTINATION_KAFKA_API_SECRET="<destination_kafka_api_secret>"

 $ pulumi import confluentcloud:index/clusterLink:ClusterLink my_cluster_link my-cluster-link/DESTINATION/OUTBOUND/lkc-abc123/lkc-xyz456

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

Create ClusterLink Resource

new ClusterLink(name: string, args: ClusterLinkArgs, opts?: CustomResourceOptions);

@overload
def ClusterLink(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                config: Optional[Mapping[str, str]] = None,
                connection_mode: Optional[str] = None,
                destination_kafka_cluster: Optional[ClusterLinkDestinationKafkaClusterArgs] = None,
                link: Optional[str] = None,
                link_mode: Optional[str] = None,
                source_kafka_cluster: Optional[ClusterLinkSourceKafkaClusterArgs] = None)
@overload
def ClusterLink(resource_name: str,
                args: ClusterLinkArgs,
                opts: Optional[ResourceOptions] = None)

func NewClusterLink(ctx *Context, name string, args ClusterLinkArgs, opts ...ResourceOption) (*ClusterLink, error)

public ClusterLink(string name, ClusterLinkArgs args, CustomResourceOptions? opts = null)

public ClusterLink(String name, ClusterLinkArgs args)
public ClusterLink(String name, ClusterLinkArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args ClusterLinkArgs: 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 ClusterLinkArgs: 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 ClusterLinkArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterLinkArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ClusterLinkArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

DestinationKafkaCluster Pulumi.ConfluentCloud.Inputs.ClusterLinkDestinationKafkaClusterArgs
SourceKafkaCluster Pulumi.ConfluentCloud.Inputs.ClusterLinkSourceKafkaClusterArgs
Config Dictionary<string, string>: The custom cluster link settings to set:
ConnectionMode string: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
Link string: The name of the cluster link, for example, my-cluster-link.
LinkMode string: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".

DestinationKafkaCluster ClusterLinkDestinationKafkaClusterArgs
SourceKafkaCluster ClusterLinkSourceKafkaClusterArgs
Config map[string]string: The custom cluster link settings to set:
ConnectionMode string: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
Link string: The name of the cluster link, for example, my-cluster-link.
LinkMode string: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".

destinationKafkaCluster ClusterLinkDestinationKafkaClusterArgs
sourceKafkaCluster ClusterLinkSourceKafkaClusterArgs
config Map<String,String>: The custom cluster link settings to set:
connectionMode String: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
link String: The name of the cluster link, for example, my-cluster-link.
linkMode String: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".

destinationKafkaCluster ClusterLinkDestinationKafkaClusterArgs
sourceKafkaCluster ClusterLinkSourceKafkaClusterArgs
config {[key: string]: string}: The custom cluster link settings to set:
connectionMode string: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
link string: The name of the cluster link, for example, my-cluster-link.
linkMode string: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".

destination_kafka_cluster ClusterLinkDestinationKafkaClusterArgs
source_kafka_cluster ClusterLinkSourceKafkaClusterArgs
config Mapping[str, str]: The custom cluster link settings to set:
connection_mode str: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
link str: The name of the cluster link, for example, my-cluster-link.
link_mode str: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".

destinationKafkaCluster Property Map
sourceKafkaCluster Property Map
config Map<String>: The custom cluster link settings to set:
connectionMode String: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
link String: The name of the cluster link, for example, my-cluster-link.
linkMode String: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterLink 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 ClusterLink Resource

Get an existing ClusterLink 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?: ClusterLinkState, opts?: CustomResourceOptions): ClusterLink

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[Mapping[str, str]] = None,
        connection_mode: Optional[str] = None,
        destination_kafka_cluster: Optional[ClusterLinkDestinationKafkaClusterArgs] = None,
        link: Optional[str] = None,
        link_mode: Optional[str] = None,
        source_kafka_cluster: Optional[ClusterLinkSourceKafkaClusterArgs] = None) -> ClusterLink

func GetClusterLink(ctx *Context, name string, id IDInput, state *ClusterLinkState, opts ...ResourceOption) (*ClusterLink, error)

public static ClusterLink Get(string name, Input<string> id, ClusterLinkState? state, CustomResourceOptions? opts = null)

public static ClusterLink get(String name, Output<String> id, ClusterLinkState 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:

Config Dictionary<string, string>: The custom cluster link settings to set:
ConnectionMode string: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
DestinationKafkaCluster Pulumi.ConfluentCloud.Inputs.ClusterLinkDestinationKafkaClusterArgs
Link string: The name of the cluster link, for example, my-cluster-link.
LinkMode string: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".
SourceKafkaCluster Pulumi.ConfluentCloud.Inputs.ClusterLinkSourceKafkaClusterArgs

Config map[string]string: The custom cluster link settings to set:
ConnectionMode string: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
DestinationKafkaCluster ClusterLinkDestinationKafkaClusterArgs
Link string: The name of the cluster link, for example, my-cluster-link.
LinkMode string: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".
SourceKafkaCluster ClusterLinkSourceKafkaClusterArgs

config Map<String,String>: The custom cluster link settings to set:
connectionMode String: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
destinationKafkaCluster ClusterLinkDestinationKafkaClusterArgs
link String: The name of the cluster link, for example, my-cluster-link.
linkMode String: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".
sourceKafkaCluster ClusterLinkSourceKafkaClusterArgs

config {[key: string]: string}: The custom cluster link settings to set:
connectionMode string: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
destinationKafkaCluster ClusterLinkDestinationKafkaClusterArgs
link string: The name of the cluster link, for example, my-cluster-link.
linkMode string: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".
sourceKafkaCluster ClusterLinkSourceKafkaClusterArgs

config Mapping[str, str]: The custom cluster link settings to set:
connection_mode str: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
destination_kafka_cluster ClusterLinkDestinationKafkaClusterArgs
link str: The name of the cluster link, for example, my-cluster-link.
link_mode str: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".
source_kafka_cluster ClusterLinkSourceKafkaClusterArgs

config Map<String>: The custom cluster link settings to set:
connectionMode String: The connection mode of the cluster link. The supported values are "INBOUND" and "OUTBOUND". Defaults to "OUTBOUND".
destinationKafkaCluster Property Map
link String: The name of the cluster link, for example, my-cluster-link.
linkMode String: The mode of the cluster link. The supported values are "DESTINATION" and "SOURCE". Defaults to "DESTINATION".
sourceKafkaCluster Property Map

Supporting Types

ClusterLinkDestinationKafkaCluster

Id string: The ID of the destination Kafka cluster, for example, lkc-abc123.
BootstrapEndpoint string: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
Credentials Pulumi.ConfluentCloud.Inputs.ClusterLinkDestinationKafkaClusterCredentials
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.
BootstrapEndpoint string: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
Credentials ClusterLinkDestinationKafkaClusterCredentials
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.
bootstrapEndpoint String: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials ClusterLinkDestinationKafkaClusterCredentials
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.
bootstrapEndpoint string: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials ClusterLinkDestinationKafkaClusterCredentials
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.
bootstrap_endpoint str: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials ClusterLinkDestinationKafkaClusterCredentials
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.
bootstrapEndpoint String: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials Property Map
restEndpoint String: The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).

ClusterLinkDestinationKafkaClusterCredentials

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.

ClusterLinkSourceKafkaCluster

Id string: The ID of the destination Kafka cluster, for example, lkc-abc123.
BootstrapEndpoint string: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
Credentials Pulumi.ConfluentCloud.Inputs.ClusterLinkSourceKafkaClusterCredentials
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.
BootstrapEndpoint string: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
Credentials ClusterLinkSourceKafkaClusterCredentials
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.
bootstrapEndpoint String: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials ClusterLinkSourceKafkaClusterCredentials
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.
bootstrapEndpoint string: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials ClusterLinkSourceKafkaClusterCredentials
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.
bootstrap_endpoint str: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials ClusterLinkSourceKafkaClusterCredentials
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.
bootstrapEndpoint String: The bootstrap endpoint of the destination Kafka cluster, for example, SASL_SSL://pkc-00000.us-central1.gcp.confluent.cloud:9092 or pkc-00000.us-central1.gcp.confluent.cloud:9092).
credentials Property Map
restEndpoint String: The REST endpoint of the destination Kafka cluster, for example, https://pkc-00000.us-central1.gcp.confluent.cloud:443).

ClusterLinkSourceKafkaClusterCredentials

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.

Package Details

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