Skip to content

CreateConnectorRequest

Source code in docs_src/capo_kafkaconnect/types/create_connector_request.py
class CreateConnectorRequest(TypedDict, closed=True):
    capacity: "capo_kafkaconnect.types.capacity.Capacity"
    """<p>Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.</p>"""
    connector_configuration: (
        "capo_kafkaconnect.types.connector_configuration.ConnectorConfiguration"
    )
    """<p>A map of keys to values that represent the configuration for the connector.</p>"""
    connector_description: NotRequired[
        "capo_kafkaconnect.types.__string_max1024.__stringMax1024"
    ]
    """<p>A summary description of the connector.</p>"""
    connector_name: "capo_kafkaconnect.types.__string_min1_max128.__stringMin1Max128"
    """<p>The name of the connector.</p>"""
    kafka_cluster: "capo_kafkaconnect.types.kafka_cluster.KafkaCluster"
    """<p>Specifies which Apache Kafka cluster to connect to.</p>"""
    kafka_cluster_client_authentication: "capo_kafkaconnect.types.kafka_cluster_client_authentication.KafkaClusterClientAuthentication"
    """<p>Details of the client authentication used by the Apache Kafka cluster.</p>"""
    kafka_cluster_encryption_in_transit: "capo_kafkaconnect.types.kafka_cluster_encryption_in_transit.KafkaClusterEncryptionInTransit"
    """<p>Details of encryption in transit to the Apache Kafka cluster.</p>"""
    kafka_connect_version: "capo_kafkaconnect.types.__string.__string"
    """<p>The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.</p>"""
    log_delivery: NotRequired["capo_kafkaconnect.types.log_delivery.LogDelivery"]
    """<p>Details about log delivery.</p>"""
    network_type: NotRequired["capo_kafkaconnect.types.network_type.NetworkType"]
    """<p>The network type of the connector. It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.</p>"""
    plugins: "capo_kafkaconnect.types.__list_of_plugin.__listOfPlugin"
    """<important> <p>Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.</p> </important> <p>Specifies which plugin to use for the connector. You must specify a single-element list containing one <code>customPlugin</code> object.</p>"""
    service_execution_role_arn: "capo_kafkaconnect.types.__string.__string"
    """<p>The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.</p>"""
    worker_configuration: NotRequired[
        "capo_kafkaconnect.types.worker_configuration.WorkerConfiguration"
    ]
    """<p>Specifies which worker configuration to use with the connector.</p>"""
    tags: NotRequired["capo_kafkaconnect.types.tags.Tags"]
    """<p>The tags you want to attach to the connector.</p>"""

capacity instance-attribute

capacity: Capacity

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

connector_configuration instance-attribute

connector_configuration: ConnectorConfiguration

A map of keys to values that represent the configuration for the connector.

connector_description instance-attribute

connector_description: NotRequired[__stringMax1024]

A summary description of the connector.

connector_name instance-attribute

connector_name: __stringMin1Max128

The name of the connector.

kafka_cluster instance-attribute

kafka_cluster: KafkaCluster

Specifies which Apache Kafka cluster to connect to.

kafka_cluster_client_authentication instance-attribute

kafka_cluster_client_authentication: KafkaClusterClientAuthentication

Details of the client authentication used by the Apache Kafka cluster.

kafka_cluster_encryption_in_transit instance-attribute

kafka_cluster_encryption_in_transit: KafkaClusterEncryptionInTransit

Details of encryption in transit to the Apache Kafka cluster.

kafka_connect_version instance-attribute

kafka_connect_version: __string

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

log_delivery instance-attribute

log_delivery: NotRequired[LogDelivery]

Details about log delivery.

network_type instance-attribute

network_type: NotRequired[NetworkType]

The network type of the connector. It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.

plugins instance-attribute

plugins: __listOfPlugin

Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.

Specifies which plugin to use for the connector. You must specify a single-element list containing one customPlugin object.

service_execution_role_arn instance-attribute

service_execution_role_arn: __string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

tags instance-attribute

tags: NotRequired[Tags]

The tags you want to attach to the connector.

worker_configuration instance-attribute

worker_configuration: NotRequired[WorkerConfiguration]

Specifies which worker configuration to use with the connector.