Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. Plugin
Confluent v2.33.0 published on Friday, Jul 18, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.Plugin

Explore with Pulumi AI

confluentcloud logo
Confluent v2.33.0 published on Friday, Jul 18, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    Example Usage

    Create Plugin Resource

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

    Constructor syntax

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

@overload
def Plugin(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cloud: Optional[str] = None,
           display_name: Optional[str] = None,
           environment: Optional[PluginEnvironmentArgs] = None,
           description: Optional[str] = None,
           runtime_language: Optional[str] = None)
    func NewPlugin(ctx *Context, name string, args PluginArgs, opts ...ResourceOption) (*Plugin, error)
    public Plugin(string name, PluginArgs args, CustomResourceOptions? opts = null)
    public Plugin(String name, PluginArgs args)
public Plugin(String name, PluginArgs args, CustomResourceOptions options)

    type: confluentcloud:Plugin
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 PluginArgs
    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 PluginArgs
    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 PluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PluginArgs
    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 pluginResource = new ConfluentCloud.Plugin("pluginResource", new()
{
    Cloud = "string",
    DisplayName = "string",
    Environment = new ConfluentCloud.Inputs.PluginEnvironmentArgs
    {
        Id = "string",
    },
    Description = "string",
    RuntimeLanguage = "string",
});

    example, err := confluentcloud.NewPlugin(ctx, "pluginResource", &confluentcloud.PluginArgs{
	Cloud:       pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Environment: &confluentcloud.PluginEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	Description:     pulumi.String("string"),
	RuntimeLanguage: pulumi.String("string"),
})

    var pluginResource = new Plugin("pluginResource", PluginArgs.builder()
    .cloud("string")
    .displayName("string")
    .environment(PluginEnvironmentArgs.builder()
        .id("string")
        .build())
    .description("string")
    .runtimeLanguage("string")
    .build());

    plugin_resource = confluentcloud.Plugin("pluginResource",
    cloud="string",
    display_name="string",
    environment={
        "id": "string",
    },
    description="string",
    runtime_language="string")

    const pluginResource = new confluentcloud.Plugin("pluginResource", {
    cloud: "string",
    displayName: "string",
    environment: {
        id: "string",
    },
    description: "string",
    runtimeLanguage: "string",
});

    type: confluentcloud:Plugin
properties:
    cloud: string
    description: string
    displayName: string
    environment:
        id: string
    runtimeLanguage: string

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

    Cloud string
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    DisplayName string
    The name of the Plugin.
    Environment Pulumi.ConfluentCloud.Inputs.PluginEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Description string
    The description of the Plugin.
    RuntimeLanguage string
    (Optional String) Runtime language of the plugin.
    Cloud string
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    DisplayName string
    The name of the Plugin.
    Environment PluginEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Description string
    The description of the Plugin.
    RuntimeLanguage string
    (Optional String) Runtime language of the plugin.
    cloud String
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    displayName String
    The name of the Plugin.
    environment PluginEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    description String
    The description of the Plugin.
    runtimeLanguage String
    (Optional String) Runtime language of the plugin.
    cloud string
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    displayName string
    The name of the Plugin.
    environment PluginEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    description string
    The description of the Plugin.
    runtimeLanguage string
    (Optional String) Runtime language of the plugin.
    cloud str
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    display_name str
    The name of the Plugin.
    environment PluginEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    description str
    The description of the Plugin.
    runtime_language str
    (Optional String) Runtime language of the plugin.
    cloud String
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    displayName String
    The name of the Plugin.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    description String
    The description of the Plugin.
    runtimeLanguage String
    (Optional String) Runtime language of the plugin.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Plugin resource produces the following output properties:

    ApiVersion string
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    ApiVersion string
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    apiVersion String
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    apiVersion string
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    api_version str
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    apiVersion String
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.

    Look up Existing Plugin Resource

    Get an existing Plugin 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?: PluginState, opts?: CustomResourceOptions): Plugin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_version: Optional[str] = None,
        cloud: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        environment: Optional[PluginEnvironmentArgs] = None,
        kind: Optional[str] = None,
        runtime_language: Optional[str] = None) -> Plugin
    func GetPlugin(ctx *Context, name string, id IDInput, state *PluginState, opts ...ResourceOption) (*Plugin, error)
    public static Plugin Get(string name, Input<string> id, PluginState? state, CustomResourceOptions? opts = null)
    public static Plugin get(String name, Output<String> id, PluginState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:Plugin    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:
    ApiVersion string
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    Cloud string
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    Description string
    The description of the Plugin.
    DisplayName string
    The name of the Plugin.
    Environment Pulumi.ConfluentCloud.Inputs.PluginEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Kind string
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    RuntimeLanguage string
    (Optional String) Runtime language of the plugin.
    ApiVersion string
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    Cloud string
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    Description string
    The description of the Plugin.
    DisplayName string
    The name of the Plugin.
    Environment PluginEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Kind string
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    RuntimeLanguage string
    (Optional String) Runtime language of the plugin.
    apiVersion String
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    cloud String
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    description String
    The description of the Plugin.
    displayName String
    The name of the Plugin.
    environment PluginEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind String
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    runtimeLanguage String
    (Optional String) Runtime language of the plugin.
    apiVersion string
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    cloud string
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    description string
    The description of the Plugin.
    displayName string
    The name of the Plugin.
    environment PluginEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind string
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    runtimeLanguage string
    (Optional String) Runtime language of the plugin.
    api_version str
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    cloud str
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    description str
    The description of the Plugin.
    display_name str
    The name of the Plugin.
    environment PluginEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind str
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    runtime_language str
    (Optional String) Runtime language of the plugin.
    apiVersion String
    (Required String) The API Version of the schema version of the plugin, for example, ccpm/v1.
    cloud String
    Cloud provider where the Custom Connector Plugin archive is uploaded. Accepted values are: AWS, AZURE, GCP.
    description String
    The description of the Plugin.
    displayName String
    The name of the Plugin.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind String
    (Required String) The kind of the Plugin, for example, CustomConnectPlugin.
    runtimeLanguage String
    (Optional String) Runtime language of the plugin.

    Supporting Types

    PluginEnvironment, PluginEnvironmentArgs

    Id string
    The ID of the Environment, for example, env-abc123.
    Id string
    The ID of the Environment, for example, env-abc123.
    id String
    The ID of the Environment, for example, env-abc123.
    id string
    The ID of the Environment, for example, env-abc123.
    id str
    The ID of the Environment, for example, env-abc123.
    id String
    The ID of the Environment, for example, env-abc123.

    Import

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

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/plugin:Plugin main env-123/ccpm-abc123xyz

    !> 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.
    confluentcloud logo
    Confluent v2.33.0 published on Friday, Jul 18, 2025 by Pulumi
    pulumi/pulumi-confluentcloud