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

confluentcloud.CustomConnectorPlugin

Explore with Pulumi AI

Confluent v2.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";

const source = new confluentcloud.CustomConnectorPlugin("source", {
    displayName: "Datagen Source Connector Plugin",
    documentationLink: "https://www.confluent.io/hub/confluentinc/kafka-connect-datagen",
    connectorClass: "io.confluent.kafka.connect.datagen.DatagenConnector",
    connectorType: "SOURCE",
    sensitiveConfigProperties: [],
    filename: "confluentinc-kafka-connect-datagen-0.6.2.zip",
});
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

source = confluentcloud.CustomConnectorPlugin("source",
    display_name="Datagen Source Connector Plugin",
    documentation_link="https://www.confluent.io/hub/confluentinc/kafka-connect-datagen",
    connector_class="io.confluent.kafka.connect.datagen.DatagenConnector",
    connector_type="SOURCE",
    sensitive_config_properties=[],
    filename="confluentinc-kafka-connect-datagen-0.6.2.zip")
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.NewCustomConnectorPlugin(ctx, "source", &confluentcloud.CustomConnectorPluginArgs{
			DisplayName:               pulumi.String("Datagen Source Connector Plugin"),
			DocumentationLink:         pulumi.String("https://www.confluent.io/hub/confluentinc/kafka-connect-datagen"),
			ConnectorClass:            pulumi.String("io.confluent.kafka.connect.datagen.DatagenConnector"),
			ConnectorType:             pulumi.String("SOURCE"),
			SensitiveConfigProperties: pulumi.StringArray{},
			Filename:                  pulumi.String("confluentinc-kafka-connect-datagen-0.6.2.zip"),
		})
		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 source = new ConfluentCloud.CustomConnectorPlugin("source", new()
    {
        DisplayName = "Datagen Source Connector Plugin",
        DocumentationLink = "https://www.confluent.io/hub/confluentinc/kafka-connect-datagen",
        ConnectorClass = "io.confluent.kafka.connect.datagen.DatagenConnector",
        ConnectorType = "SOURCE",
        SensitiveConfigProperties = new[] {},
        Filename = "confluentinc-kafka-connect-datagen-0.6.2.zip",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.CustomConnectorPlugin;
import com.pulumi.confluentcloud.CustomConnectorPluginArgs;
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 source = new CustomConnectorPlugin("source", CustomConnectorPluginArgs.builder()
            .displayName("Datagen Source Connector Plugin")
            .documentationLink("https://www.confluent.io/hub/confluentinc/kafka-connect-datagen")
            .connectorClass("io.confluent.kafka.connect.datagen.DatagenConnector")
            .connectorType("SOURCE")
            .sensitiveConfigProperties()
            .filename("confluentinc-kafka-connect-datagen-0.6.2.zip")
            .build());

    }
}
Copy
resources:
  source:
    type: confluentcloud:CustomConnectorPlugin
    properties:
      displayName: Datagen Source Connector Plugin
      documentationLink: https://www.confluent.io/hub/confluentinc/kafka-connect-datagen
      connectorClass: io.confluent.kafka.connect.datagen.DatagenConnector
      connectorType: SOURCE
      sensitiveConfigProperties: []
      filename: confluentinc-kafka-connect-datagen-0.6.2.zip
Copy

Create CustomConnectorPlugin Resource

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

Constructor syntax

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

@overload
def CustomConnectorPlugin(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          connector_class: Optional[str] = None,
                          connector_type: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filename: Optional[str] = None,
                          cloud: Optional[str] = None,
                          description: Optional[str] = None,
                          documentation_link: Optional[str] = None,
                          sensitive_config_properties: Optional[Sequence[str]] = None)
func NewCustomConnectorPlugin(ctx *Context, name string, args CustomConnectorPluginArgs, opts ...ResourceOption) (*CustomConnectorPlugin, error)
public CustomConnectorPlugin(string name, CustomConnectorPluginArgs args, CustomResourceOptions? opts = null)
public CustomConnectorPlugin(String name, CustomConnectorPluginArgs args)
public CustomConnectorPlugin(String name, CustomConnectorPluginArgs args, CustomResourceOptions options)

type: confluentcloud:CustomConnectorPlugin
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. CustomConnectorPluginArgs
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. CustomConnectorPluginArgs
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. CustomConnectorPluginArgs
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. CustomConnectorPluginArgs
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. CustomConnectorPluginArgs
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 customConnectorPluginResource = new ConfluentCloud.CustomConnectorPlugin("customConnectorPluginResource", new()
{
    ConnectorClass = "string",
    ConnectorType = "string",
    DisplayName = "string",
    Filename = "string",
    Cloud = "string",
    Description = "string",
    DocumentationLink = "string",
    SensitiveConfigProperties = new[]
    {
        "string",
    },
});
Copy
example, err := confluentcloud.NewCustomConnectorPlugin(ctx, "customConnectorPluginResource", &confluentcloud.CustomConnectorPluginArgs{
	ConnectorClass:    pulumi.String("string"),
	ConnectorType:     pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Filename:          pulumi.String("string"),
	Cloud:             pulumi.String("string"),
	Description:       pulumi.String("string"),
	DocumentationLink: pulumi.String("string"),
	SensitiveConfigProperties: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var customConnectorPluginResource = new CustomConnectorPlugin("customConnectorPluginResource", CustomConnectorPluginArgs.builder()
    .connectorClass("string")
    .connectorType("string")
    .displayName("string")
    .filename("string")
    .cloud("string")
    .description("string")
    .documentationLink("string")
    .sensitiveConfigProperties("string")
    .build());
Copy
custom_connector_plugin_resource = confluentcloud.CustomConnectorPlugin("customConnectorPluginResource",
    connector_class="string",
    connector_type="string",
    display_name="string",
    filename="string",
    cloud="string",
    description="string",
    documentation_link="string",
    sensitive_config_properties=["string"])
Copy
const customConnectorPluginResource = new confluentcloud.CustomConnectorPlugin("customConnectorPluginResource", {
    connectorClass: "string",
    connectorType: "string",
    displayName: "string",
    filename: "string",
    cloud: "string",
    description: "string",
    documentationLink: "string",
    sensitiveConfigProperties: ["string"],
});
Copy
type: confluentcloud:CustomConnectorPlugin
properties:
    cloud: string
    connectorClass: string
    connectorType: string
    description: string
    displayName: string
    documentationLink: string
    filename: string
    sensitiveConfigProperties:
        - string
Copy

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

ConnectorClass
This property is required.
Changes to this property will trigger replacement.
string
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
ConnectorType
This property is required.
Changes to this property will trigger replacement.
string
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
DisplayName This property is required. string
The name of the Custom Connector Plugin.
Filename
This property is required.
Changes to this property will trigger replacement.
string
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
Cloud Changes to this property will trigger replacement. string
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
Description string
The description of the Custom Connector Plugin.
DocumentationLink string
The documentation link of the Custom Connector Plugin.
SensitiveConfigProperties List<string>
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
ConnectorClass
This property is required.
Changes to this property will trigger replacement.
string
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
ConnectorType
This property is required.
Changes to this property will trigger replacement.
string
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
DisplayName This property is required. string
The name of the Custom Connector Plugin.
Filename
This property is required.
Changes to this property will trigger replacement.
string
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
Cloud Changes to this property will trigger replacement. string
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
Description string
The description of the Custom Connector Plugin.
DocumentationLink string
The documentation link of the Custom Connector Plugin.
SensitiveConfigProperties []string
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
connectorClass
This property is required.
Changes to this property will trigger replacement.
String
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connectorType
This property is required.
Changes to this property will trigger replacement.
String
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
displayName This property is required. String
The name of the Custom Connector Plugin.
filename
This property is required.
Changes to this property will trigger replacement.
String
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
cloud Changes to this property will trigger replacement. String
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
description String
The description of the Custom Connector Plugin.
documentationLink String
The documentation link of the Custom Connector Plugin.
sensitiveConfigProperties List<String>
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
connectorClass
This property is required.
Changes to this property will trigger replacement.
string
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connectorType
This property is required.
Changes to this property will trigger replacement.
string
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
displayName This property is required. string
The name of the Custom Connector Plugin.
filename
This property is required.
Changes to this property will trigger replacement.
string
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
cloud Changes to this property will trigger replacement. string
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
description string
The description of the Custom Connector Plugin.
documentationLink string
The documentation link of the Custom Connector Plugin.
sensitiveConfigProperties string[]
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
connector_class
This property is required.
Changes to this property will trigger replacement.
str
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connector_type
This property is required.
Changes to this property will trigger replacement.
str
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
display_name This property is required. str
The name of the Custom Connector Plugin.
filename
This property is required.
Changes to this property will trigger replacement.
str
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
cloud Changes to this property will trigger replacement. str
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
description str
The description of the Custom Connector Plugin.
documentation_link str
The documentation link of the Custom Connector Plugin.
sensitive_config_properties Sequence[str]
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
connectorClass
This property is required.
Changes to this property will trigger replacement.
String
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connectorType
This property is required.
Changes to this property will trigger replacement.
String
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
displayName This property is required. String
The name of the Custom Connector Plugin.
filename
This property is required.
Changes to this property will trigger replacement.
String
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
cloud Changes to this property will trigger replacement. String
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
description String
The description of the Custom Connector Plugin.
documentationLink String
The documentation link of the Custom Connector Plugin.
sensitiveConfigProperties List<String>
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.

Outputs

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

Get an existing CustomConnectorPlugin 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?: CustomConnectorPluginState, opts?: CustomResourceOptions): CustomConnectorPlugin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud: Optional[str] = None,
        connector_class: Optional[str] = None,
        connector_type: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        documentation_link: Optional[str] = None,
        filename: Optional[str] = None,
        sensitive_config_properties: Optional[Sequence[str]] = None) -> CustomConnectorPlugin
func GetCustomConnectorPlugin(ctx *Context, name string, id IDInput, state *CustomConnectorPluginState, opts ...ResourceOption) (*CustomConnectorPlugin, error)
public static CustomConnectorPlugin Get(string name, Input<string> id, CustomConnectorPluginState? state, CustomResourceOptions? opts = null)
public static CustomConnectorPlugin get(String name, Output<String> id, CustomConnectorPluginState state, CustomResourceOptions options)
resources:  _:    type: confluentcloud:CustomConnectorPlugin    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:
Cloud Changes to this property will trigger replacement. string
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
ConnectorClass Changes to this property will trigger replacement. string
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
ConnectorType Changes to this property will trigger replacement. string
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
Description string
The description of the Custom Connector Plugin.
DisplayName string
The name of the Custom Connector Plugin.
DocumentationLink string
The documentation link of the Custom Connector Plugin.
Filename Changes to this property will trigger replacement. string
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
SensitiveConfigProperties List<string>
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
Cloud Changes to this property will trigger replacement. string
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
ConnectorClass Changes to this property will trigger replacement. string
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
ConnectorType Changes to this property will trigger replacement. string
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
Description string
The description of the Custom Connector Plugin.
DisplayName string
The name of the Custom Connector Plugin.
DocumentationLink string
The documentation link of the Custom Connector Plugin.
Filename Changes to this property will trigger replacement. string
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
SensitiveConfigProperties []string
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
cloud Changes to this property will trigger replacement. String
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
connectorClass Changes to this property will trigger replacement. String
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connectorType Changes to this property will trigger replacement. String
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
description String
The description of the Custom Connector Plugin.
displayName String
The name of the Custom Connector Plugin.
documentationLink String
The documentation link of the Custom Connector Plugin.
filename Changes to this property will trigger replacement. String
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
sensitiveConfigProperties List<String>
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
cloud Changes to this property will trigger replacement. string
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
connectorClass Changes to this property will trigger replacement. string
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connectorType Changes to this property will trigger replacement. string
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
description string
The description of the Custom Connector Plugin.
displayName string
The name of the Custom Connector Plugin.
documentationLink string
The documentation link of the Custom Connector Plugin.
filename Changes to this property will trigger replacement. string
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
sensitiveConfigProperties string[]
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
cloud Changes to this property will trigger replacement. str
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
connector_class Changes to this property will trigger replacement. str
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connector_type Changes to this property will trigger replacement. str
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
description str
The description of the Custom Connector Plugin.
display_name str
The name of the Custom Connector Plugin.
documentation_link str
The documentation link of the Custom Connector Plugin.
filename Changes to this property will trigger replacement. str
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
sensitive_config_properties Sequence[str]
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.
cloud Changes to this property will trigger replacement. String
Cloud provider where the Custom Connector Plugin archive is uploaded. Defaults to AWS. Accepted values are: AWS, AZURE.
connectorClass Changes to this property will trigger replacement. String
The Java class or alias for the connector. You can get the connector class from the connector documentation provided by the developer.
connectorType Changes to this property will trigger replacement. String
The type of the Custom Connector Plugin. Accepted values are: SOURCE, SINK.
description String
The description of the Custom Connector Plugin.
displayName String
The name of the Custom Connector Plugin.
documentationLink String
The documentation link of the Custom Connector Plugin.
filename Changes to this property will trigger replacement. String
The path to the Custom Connector Plugin archive to be uploaded. Accepted archive formats are: .jar, .zip.
sensitiveConfigProperties List<String>
The list of sensitive properties. A sensitive property is a connector configuration property that must be hidden after a user enters the property value when setting up the connector, for example, passwords, keys, and tokens. Refer to the developer documentation and add all required and optional sensitive properties that a user could potentially configure for the connector. Marking a property as sensitive ensures that these fields are handled appropriately within the Confluent infrastructure. This includes masking fields, for example in exception logging, and encrypting field values in the underlying data store. You must identify all sensitive properties. Failure to identify sensitive properties can result in the sensitive property value being stored in plain text rather than in encrypted format. Only add connector-specific sensitive properties. Kafka keys, passwords, and service account information should not be entered here.

Import

You can import a Custom Connector Plugin by using a Custom Connector Plugin ID, in the format <Custom Connector Plugin>. The following example shows how to import a Custom Connector Plugin:

$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

$ pulumi import confluentcloud:index/customConnectorPlugin:CustomConnectorPlugin main ccp-abc123xyz
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.24.0 published on Saturday, Apr 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud