Skip to content

ConnectorSummary

Source code in docs_src/capo_kafkaconnect/types/connector_summary.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
class ConnectorSummary(TypedDict, closed=True):
    capacity: NotRequired[
        "capo_kafkaconnect.types.capacity_description.CapacityDescription"
    ]
    """<p>The connector's compute capacity settings.</p>"""
    connector_arn: NotRequired["capo_kafkaconnect.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the connector.</p>"""
    connector_description: NotRequired["capo_kafkaconnect.types.__string.__string"]
    """<p>The description of the connector.</p>"""
    connector_name: NotRequired["capo_kafkaconnect.types.__string.__string"]
    """<p>The name of the connector.</p>"""
    connector_state: NotRequired[
        "capo_kafkaconnect.types.connector_state.ConnectorState"
    ]
    """<p>The state of the connector.</p>"""
    creation_time: NotRequired[
        "capo_kafkaconnect.types.__timestamp_iso8601.__timestampIso8601"
    ]
    """<p>The time that the connector was created.</p>"""
    current_version: NotRequired["capo_kafkaconnect.types.__string.__string"]
    """<p>The current version of the connector.</p>"""
    kafka_cluster: NotRequired[
        "capo_kafkaconnect.types.kafka_cluster_description.KafkaClusterDescription"
    ]
    """<p>The details of the Apache Kafka cluster to which the connector is connected.</p>"""
    kafka_cluster_client_authentication: NotRequired[
        "capo_kafkaconnect.types.kafka_cluster_client_authentication_description.KafkaClusterClientAuthenticationDescription"
    ]
    """<p>The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.</p>"""
    kafka_cluster_encryption_in_transit: NotRequired[
        "capo_kafkaconnect.types.kafka_cluster_encryption_in_transit_description.KafkaClusterEncryptionInTransitDescription"
    ]
    """<p>Details of encryption in transit to the Apache Kafka cluster.</p>"""
    kafka_connect_version: NotRequired["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_description.LogDeliveryDescription"
    ]
    """<p>The settings for delivering connector logs to Amazon CloudWatch Logs.</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: NotRequired[
        "capo_kafkaconnect.types.__list_of_plugin_description.__listOfPluginDescription"
    ]
    """<p>Specifies which plugins were used for this connector.</p>"""
    service_execution_role_arn: NotRequired["capo_kafkaconnect.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.</p>"""
    worker_configuration: NotRequired[
        "capo_kafkaconnect.types.worker_configuration_description.WorkerConfigurationDescription"
    ]
    """<p>The worker configurations that are in use with the connector.</p>"""

capacity instance-attribute 

capacity: NotRequired[CapacityDescription]

The connector's compute capacity settings.

connector_arn instance-attribute 

connector_arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the connector.

connector_description instance-attribute 

connector_description: NotRequired[__string]

The description of the connector.

connector_name instance-attribute 

connector_name: NotRequired[__string]

The name of the connector.

connector_state instance-attribute 

connector_state: NotRequired[ConnectorState]

The state of the connector.

creation_time instance-attribute 

creation_time: NotRequired[__timestampIso8601]

The time that the connector was created.

current_version instance-attribute 

current_version: NotRequired[__string]

The current version of the connector.

kafka_cluster instance-attribute 

kafka_cluster: NotRequired[KafkaClusterDescription]

The details of the Apache Kafka cluster to which the connector is connected.

kafka_cluster_client_authentication instance-attribute 

kafka_cluster_client_authentication: NotRequired[
    KafkaClusterClientAuthenticationDescription
]

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

kafka_cluster_encryption_in_transit instance-attribute 

kafka_cluster_encryption_in_transit: NotRequired[
    KafkaClusterEncryptionInTransitDescription
]

Details of encryption in transit to the Apache Kafka cluster.

kafka_connect_version instance-attribute 

kafka_connect_version: NotRequired[__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[LogDeliveryDescription]

The settings for delivering connector logs to Amazon CloudWatch Logs.

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: NotRequired[__listOfPluginDescription]

Specifies which plugins were used for this connector.

service_execution_role_arn instance-attribute 

service_execution_role_arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

worker_configuration instance-attribute 

worker_configuration: NotRequired[WorkerConfigurationDescription]

The worker configurations that are in use with the connector.