Confluent Cloud

v1.6.0 published on Wednesday, Nov 23, 2022 by Pulumi

Connector

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

new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);

@overload
def Connector(resource_name: 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,
              status: Optional[str] = None)
@overload
def Connector(resource_name: str,
              args: ConnectorArgs,
              opts: Optional[ResourceOptions] = 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.

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.

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:

ConfigNonsensitive Dictionary<string, string>: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
Environment Pulumi.ConfluentCloud.Inputs.ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
KafkaCluster Pulumi.ConfluentCloud.Inputs.ConnectorKafkaClusterArgs
ConfigSensitive Dictionary<string, string>: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
Status string: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

ConfigNonsensitive map[string]string: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
Environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
KafkaCluster ConnectorKafkaClusterArgs
ConfigSensitive map[string]string: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
Status string: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

configNonsensitive Map<String,String>: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafkaCluster ConnectorKafkaClusterArgs
configSensitive Map<String,String>: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
status String: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

configNonsensitive {[key: string]: string}: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafkaCluster ConnectorKafkaClusterArgs
configSensitive {[key: string]: string}: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
status string: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

config_nonsensitive Mapping[str, str]: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafka_cluster ConnectorKafkaClusterArgs
config_sensitive Mapping[str, str]: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
status str: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

configNonsensitive Map<String>: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
environment Property Map: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafkaCluster Property Map
configSensitive Map<String>: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
status String: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

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,
        status: 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:

ConfigNonsensitive Dictionary<string, string>: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
ConfigSensitive Dictionary<string, string>: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
Environment Pulumi.ConfluentCloud.Inputs.ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
KafkaCluster Pulumi.ConfluentCloud.Inputs.ConnectorKafkaClusterArgs
Status string: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

ConfigNonsensitive map[string]string: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
ConfigSensitive map[string]string: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
Environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
KafkaCluster ConnectorKafkaClusterArgs
Status string: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

configNonsensitive Map<String,String>: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
configSensitive Map<String,String>: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafkaCluster ConnectorKafkaClusterArgs
status String: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

configNonsensitive {[key: string]: string}: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
configSensitive {[key: string]: string}: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafkaCluster ConnectorKafkaClusterArgs
status string: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

config_nonsensitive Mapping[str, str]: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
config_sensitive Mapping[str, str]: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
environment ConnectorEnvironmentArgs: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafka_cluster ConnectorKafkaClusterArgs
status str: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

configNonsensitive Map<String>: Block for custom nonsensitive configuration properties that are not labelled with "Type: password" under "Configuration Properties" section in the docs:
configSensitive Map<String>: Block for custom sensitive configuration properties that are labelled with "Type: password" under "Configuration Properties" section in the docs:
environment Property Map: Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
kafkaCluster Property Map
status String: The status of the connector (one of "NONE", "PROVISIONING", "RUNNING", "DEGRADED", "FAILED", "PAUSED", "DELETED"). Pausing ("RUNNING" > "PAUSED") and resuming ("PAUSED" > "RUNNING") a connector is supported via an update operation.

Supporting Types

ConnectorEnvironment

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

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: https://github.com/pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.