1. Packages
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. Connector
Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.Connector

confluentcloud logo
Viewing docs for Confluent v0.1.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

    Import

    You can import a connector by using Environment ID, Kafka cluster ID, and connector’s name, in the format <Environment ID>/<Kafka cluster ID>/<Connector name>, for example$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>" $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

     $ pulumi import confluentcloud:index/connector:Connector my_connector "env-abc123/lkc-abc123/S3_SINKConnector_0"

    Create Connector Resource

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

    Constructor syntax

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

@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              config_nonsensitive: Optional[Mapping[str, str]] = None,
              environment: Optional[ConnectorEnvironmentArgs] = None,
              kafka_cluster: Optional[ConnectorKafkaClusterArgs] = None,
              config_sensitive: Optional[Mapping[str, str]] = None)
    func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
    public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
    public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)

    type: confluentcloud:Connector
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 ConnectorArgs
    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 ConnectorArgs
    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 ConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorArgs
    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 connectorResource = new ConfluentCloud.Connector("connectorResource", new()
{
    ConfigNonsensitive = 
    {
        { "string", "string" },
    },
    Environment = new ConfluentCloud.Inputs.ConnectorEnvironmentArgs
    {
        Id = "string",
    },
    KafkaCluster = new ConfluentCloud.Inputs.ConnectorKafkaClusterArgs
    {
        Id = "string",
    },
    ConfigSensitive = 
    {
        { "string", "string" },
    },
});

    example, err := confluentcloud.NewConnector(ctx, "connectorResource", &confluentcloud.ConnectorArgs{
	ConfigNonsensitive: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Environment: &confluentcloud.ConnectorEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	KafkaCluster: &confluentcloud.ConnectorKafkaClusterArgs{
		Id: pulumi.String("string"),
	},
	ConfigSensitive: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var connectorResource = new Connector("connectorResource", ConnectorArgs.builder()
    .configNonsensitive(Map.of("string", "string"))
    .environment(ConnectorEnvironmentArgs.builder()
        .id("string")
        .build())
    .kafkaCluster(ConnectorKafkaClusterArgs.builder()
        .id("string")
        .build())
    .configSensitive(Map.of("string", "string"))
    .build());

    connector_resource = confluentcloud.Connector("connectorResource",
    config_nonsensitive={
        "string": "string",
    },
    environment={
        "id": "string",
    },
    kafka_cluster={
        "id": "string",
    },
    config_sensitive={
        "string": "string",
    })

    const connectorResource = new confluentcloud.Connector("connectorResource", {
    configNonsensitive: {
        string: "string",
    },
    environment: {
        id: "string",
    },
    kafkaCluster: {
        id: "string",
    },
    configSensitive: {
        string: "string",
    },
});

    type: confluentcloud:Connector
properties:
    configNonsensitive:
        string: string
    configSensitive:
        string: string
    environment:
        id: string
    kafkaCluster:
        id: string

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

    ConfigNonsensitive Dictionary<string, string>
    The custom connector nonsensitive configuration settings to set:
    Environment Pulumi.ConfluentCloud.Inputs.ConnectorEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    KafkaCluster Pulumi.ConfluentCloud.Inputs.ConnectorKafkaCluster
    ConfigSensitive Dictionary<string, string>
    The custom connector sensitive configuration settings to set:
    ConfigNonsensitive map[string]string
    The custom connector nonsensitive configuration settings to set:
    Environment ConnectorEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    KafkaCluster ConnectorKafkaClusterArgs
    ConfigSensitive map[string]string
    The custom connector sensitive configuration settings to set:
    configNonsensitive Map<String,String>
    The custom connector nonsensitive configuration settings to set:
    environment ConnectorEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafkaCluster ConnectorKafkaCluster
    configSensitive Map<String,String>
    The custom connector sensitive configuration settings to set:
    configNonsensitive {[key: string]: string}
    The custom connector nonsensitive configuration settings to set:
    environment ConnectorEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafkaCluster ConnectorKafkaCluster
    configSensitive {[key: string]: string}
    The custom connector sensitive configuration settings to set:
    config_nonsensitive Mapping[str, str]
    The custom connector nonsensitive configuration settings to set:
    environment ConnectorEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafka_cluster ConnectorKafkaClusterArgs
    config_sensitive Mapping[str, str]
    The custom connector sensitive configuration settings to set:
    configNonsensitive Map<String>
    The custom connector nonsensitive configuration settings to set:
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafkaCluster Property Map
    configSensitive Map<String>
    The custom connector sensitive configuration settings to set:

    Outputs

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

    Get an existing Connector 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?: ConnectorState, opts?: CustomResourceOptions): Connector
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_nonsensitive: Optional[Mapping[str, str]] = None,
        config_sensitive: Optional[Mapping[str, str]] = None,
        environment: Optional[ConnectorEnvironmentArgs] = None,
        kafka_cluster: Optional[ConnectorKafkaClusterArgs] = None) -> Connector
    func GetConnector(ctx *Context, name string, id IDInput, state *ConnectorState, opts ...ResourceOption) (*Connector, error)
    public static Connector Get(string name, Input<string> id, ConnectorState? state, CustomResourceOptions? opts = null)
    public static Connector get(String name, Output<String> id, ConnectorState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:Connector    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:
    ConfigNonsensitive Dictionary<string, string>
    The custom connector nonsensitive configuration settings to set:
    ConfigSensitive Dictionary<string, string>
    The custom connector sensitive configuration settings to set:
    Environment Pulumi.ConfluentCloud.Inputs.ConnectorEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    KafkaCluster Pulumi.ConfluentCloud.Inputs.ConnectorKafkaCluster
    ConfigNonsensitive map[string]string
    The custom connector nonsensitive configuration settings to set:
    ConfigSensitive map[string]string
    The custom connector sensitive configuration settings to set:
    Environment ConnectorEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    KafkaCluster ConnectorKafkaClusterArgs
    configNonsensitive Map<String,String>
    The custom connector nonsensitive configuration settings to set:
    configSensitive Map<String,String>
    The custom connector sensitive configuration settings to set:
    environment ConnectorEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafkaCluster ConnectorKafkaCluster
    configNonsensitive {[key: string]: string}
    The custom connector nonsensitive configuration settings to set:
    configSensitive {[key: string]: string}
    The custom connector sensitive configuration settings to set:
    environment ConnectorEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafkaCluster ConnectorKafkaCluster
    config_nonsensitive Mapping[str, str]
    The custom connector nonsensitive configuration settings to set:
    config_sensitive Mapping[str, str]
    The custom connector sensitive configuration settings to set:
    environment ConnectorEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafka_cluster ConnectorKafkaClusterArgs
    configNonsensitive Map<String>
    The custom connector nonsensitive configuration settings to set:
    configSensitive Map<String>
    The custom connector sensitive configuration settings to set:
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kafkaCluster Property Map

    Supporting Types

    ConnectorEnvironment, ConnectorEnvironmentArgs

    Id string
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    Id string
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id string
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id str
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.

    ConnectorKafkaCluster, ConnectorKafkaClusterArgs

    Id string
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    Id string
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id string
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id str
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.
    id String
    The ID of the Kafka cluster that the connector belongs to, for example, lkc-abc123.

    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 v0.1.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.