Docs Packages
  1. Packages
  2. Confluent Cloud (Deprecated)
  3. API Docs
  4. Connector

This package is deprecated. We recommend using the new Confluent Cloud package.

Confluent Cloud v0.2.2 published on Friday, Dec 10, 2021 by Pulumi
pulumi/pulumi-confluent

confluent.Connector

Explore with Pulumi AI

confluent logo

This package is deprecated. We recommend using the new Confluent Cloud package.

Confluent Cloud v0.2.2 published on Friday, Dec 10, 2021 by Pulumi
pulumi/pulumi-confluent

    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,
              cluster_id: Optional[str] = None,
              config: Optional[Mapping[str, Any]] = None,
              environment_id: Optional[str] = None,
              config_sensitive: Optional[Mapping[str, Any]] = None,
              name: Optional[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: confluent: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 Confluent.Connector("connectorResource", new()
{
    ClusterId = "string",
    Config = 
    {
        { "string", "any" },
    },
    EnvironmentId = "string",
    ConfigSensitive = 
    {
        { "string", "any" },
    },
    Name = "string",
});

    example, err := confluent.NewConnector(ctx, "connectorResource", &confluent.ConnectorArgs{
	ClusterId: pulumi.String("string"),
	Config: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	EnvironmentId: pulumi.String("string"),
	ConfigSensitive: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	Name: pulumi.String("string"),
})

    var connectorResource = new Connector("connectorResource", ConnectorArgs.builder()
    .clusterId("string")
    .config(Map.of("string", "any"))
    .environmentId("string")
    .configSensitive(Map.of("string", "any"))
    .name("string")
    .build());

    connector_resource = confluent.Connector("connectorResource",
    cluster_id="string",
    config={
        "string": "any",
    },
    environment_id="string",
    config_sensitive={
        "string": "any",
    },
    name="string")

    const connectorResource = new confluent.Connector("connectorResource", {
    clusterId: "string",
    config: {
        string: "any",
    },
    environmentId: "string",
    configSensitive: {
        string: "any",
    },
    name: "string",
});

    type: confluent:Connector
properties:
    clusterId: string
    config:
        string: any
    configSensitive:
        string: any
    environmentId: string
    name: 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

    The Connector resource accepts the following input properties:

    ClusterId string
    ID of containing cluster, e.g. lkc-abc123
    Config Dictionary<string, object>
    Type-specific Configuration of connector. String keys and values
    EnvironmentId string
    ID of containing environment, e.g. env-abc123
    ConfigSensitive Dictionary<string, object>
    Sensitive part of connector configuration. String keys and values
    Name string
    The name of the connector
    ClusterId string
    ID of containing cluster, e.g. lkc-abc123
    Config map[string]interface{}
    Type-specific Configuration of connector. String keys and values
    EnvironmentId string
    ID of containing environment, e.g. env-abc123
    ConfigSensitive map[string]interface{}
    Sensitive part of connector configuration. String keys and values
    Name string
    The name of the connector
    clusterId String
    ID of containing cluster, e.g. lkc-abc123
    config Map<String,Object>
    Type-specific Configuration of connector. String keys and values
    environmentId String
    ID of containing environment, e.g. env-abc123
    configSensitive Map<String,Object>
    Sensitive part of connector configuration. String keys and values
    name String
    The name of the connector
    clusterId string
    ID of containing cluster, e.g. lkc-abc123
    config {[key: string]: any}
    Type-specific Configuration of connector. String keys and values
    environmentId string
    ID of containing environment, e.g. env-abc123
    configSensitive {[key: string]: any}
    Sensitive part of connector configuration. String keys and values
    name string
    The name of the connector
    cluster_id str
    ID of containing cluster, e.g. lkc-abc123
    config Mapping[str, Any]
    Type-specific Configuration of connector. String keys and values
    environment_id str
    ID of containing environment, e.g. env-abc123
    config_sensitive Mapping[str, Any]
    Sensitive part of connector configuration. String keys and values
    name str
    The name of the connector
    clusterId String
    ID of containing cluster, e.g. lkc-abc123
    config Map<Any>
    Type-specific Configuration of connector. String keys and values
    environmentId String
    ID of containing environment, e.g. env-abc123
    configSensitive Map<Any>
    Sensitive part of connector configuration. String keys and values
    name String
    The name of the connector

    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,
        cluster_id: Optional[str] = None,
        config: Optional[Mapping[str, Any]] = None,
        config_sensitive: Optional[Mapping[str, Any]] = None,
        environment_id: Optional[str] = None,
        name: Optional[str] = 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)
    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:
    ClusterId string
    ID of containing cluster, e.g. lkc-abc123
    Config Dictionary<string, object>
    Type-specific Configuration of connector. String keys and values
    ConfigSensitive Dictionary<string, object>
    Sensitive part of connector configuration. String keys and values
    EnvironmentId string
    ID of containing environment, e.g. env-abc123
    Name string
    The name of the connector
    ClusterId string
    ID of containing cluster, e.g. lkc-abc123
    Config map[string]interface{}
    Type-specific Configuration of connector. String keys and values
    ConfigSensitive map[string]interface{}
    Sensitive part of connector configuration. String keys and values
    EnvironmentId string
    ID of containing environment, e.g. env-abc123
    Name string
    The name of the connector
    clusterId String
    ID of containing cluster, e.g. lkc-abc123
    config Map<String,Object>
    Type-specific Configuration of connector. String keys and values
    configSensitive Map<String,Object>
    Sensitive part of connector configuration. String keys and values
    environmentId String
    ID of containing environment, e.g. env-abc123
    name String
    The name of the connector
    clusterId string
    ID of containing cluster, e.g. lkc-abc123
    config {[key: string]: any}
    Type-specific Configuration of connector. String keys and values
    configSensitive {[key: string]: any}
    Sensitive part of connector configuration. String keys and values
    environmentId string
    ID of containing environment, e.g. env-abc123
    name string
    The name of the connector
    cluster_id str
    ID of containing cluster, e.g. lkc-abc123
    config Mapping[str, Any]
    Type-specific Configuration of connector. String keys and values
    config_sensitive Mapping[str, Any]
    Sensitive part of connector configuration. String keys and values
    environment_id str
    ID of containing environment, e.g. env-abc123
    name str
    The name of the connector
    clusterId String
    ID of containing cluster, e.g. lkc-abc123
    config Map<Any>
    Type-specific Configuration of connector. String keys and values
    configSensitive Map<Any>
    Sensitive part of connector configuration. String keys and values
    environmentId String
    ID of containing environment, e.g. env-abc123
    name String
    The name of the connector

    Package Details

    Repository
    Confluent Cloud (Deprecated) pulumi/pulumi-confluent
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluent logo

    This package is deprecated. We recommend using the new Confluent Cloud package.

    Confluent Cloud v0.2.2 published on Friday, Dec 10, 2021 by Pulumi
    pulumi/pulumi-confluent