Skip to content

/AWS1/CL_KFCCONNECTORSUMMARY

Summary of a connector.

CONSTRUCTOR

IMPORTING

Optional arguments:

IO_CAPACITY TYPE REF TO /AWS1/CL_KFCCAPACITYDESC /AWS1/CL_KFCCAPACITYDESC

The connector's compute capacity settings.

IV_CONNECTORARN TYPE /AWS1/KFC__STRING /AWS1/KFC__STRING

The Amazon Resource Name (ARN) of the connector.

IV_CONNECTORDESCRIPTION TYPE /AWS1/KFC__STRING /AWS1/KFC__STRING

The description of the connector.

IV_CONNECTORNAME TYPE /AWS1/KFC__STRING /AWS1/KFC__STRING

The name of the connector.

IV_CONNECTORSTATE TYPE /AWS1/KFCCONNECTORSTATE /AWS1/KFCCONNECTORSTATE

The state of the connector.

IV_CREATIONTIME TYPE /AWS1/KFC__TIMESTAMPISO8601 /AWS1/KFC__TIMESTAMPISO8601

The time that the connector was created.

IV_CURRENTVERSION TYPE /AWS1/KFC__STRING /AWS1/KFC__STRING

The current version of the connector.

IO_KAFKACLUSTER TYPE REF TO /AWS1/CL_KFCKAFKACLUSTERDESC /AWS1/CL_KFCKAFKACLUSTERDESC

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

IO_KAFKACLUSTCLIENTAUTHNTCTN TYPE REF TO /AWS1/CL_KFCKAFKACLSTCLIAUTH00 /AWS1/CL_KFCKAFKACLSTCLIAUTH00

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

IO_KAFKACLUSTERENCINTRANSIT TYPE REF TO /AWS1/CL_KFCKAFKACLSTENCINTR01 /AWS1/CL_KFCKAFKACLSTENCINTR01

Details of encryption in transit to the Apache Kafka cluster.

IV_KAFKACONNECTVERSION TYPE /AWS1/KFC__STRING /AWS1/KFC__STRING

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

IO_LOGDELIVERY TYPE REF TO /AWS1/CL_KFCLOGDELIVERYDESC /AWS1/CL_KFCLOGDELIVERYDESC

The settings for delivering connector logs to Amazon CloudWatch Logs.

IT_PLUGINS TYPE /AWS1/CL_KFCPLUGINDESCRIPTION=>TT___LISTOFPLUGINDESCRIPTION TT___LISTOFPLUGINDESCRIPTION

Specifies which plugins were used for this connector.

IV_SERVICEEXECUTIONROLEARN TYPE /AWS1/KFC__STRING /AWS1/KFC__STRING

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

IO_WORKERCONFIGURATION TYPE REF TO /AWS1/CL_KFCWORKERCONFDESC /AWS1/CL_KFCWORKERCONFDESC

The worker configurations that are in use with the connector.


Queryable Attributes

capacity

The connector's compute capacity settings.

Accessible with the following methods

Method Description
GET_CAPACITY() Getter for CAPACITY

connectorArn

The Amazon Resource Name (ARN) of the connector.

Accessible with the following methods

Method Description
GET_CONNECTORARN() Getter for CONNECTORARN, with configurable default
ASK_CONNECTORARN() Getter for CONNECTORARN w/ exceptions if field has no value
HAS_CONNECTORARN() Determine if CONNECTORARN has a value

connectorDescription

The description of the connector.

Accessible with the following methods

Method Description
GET_CONNECTORDESCRIPTION() Getter for CONNECTORDESCRIPTION, with configurable default
ASK_CONNECTORDESCRIPTION() Getter for CONNECTORDESCRIPTION w/ exceptions if field has n
HAS_CONNECTORDESCRIPTION() Determine if CONNECTORDESCRIPTION has a value

connectorName

The name of the connector.

Accessible with the following methods

Method Description
GET_CONNECTORNAME() Getter for CONNECTORNAME, with configurable default
ASK_CONNECTORNAME() Getter for CONNECTORNAME w/ exceptions if field has no value
HAS_CONNECTORNAME() Determine if CONNECTORNAME has a value

connectorState

The state of the connector.

Accessible with the following methods

Method Description
GET_CONNECTORSTATE() Getter for CONNECTORSTATE, with configurable default
ASK_CONNECTORSTATE() Getter for CONNECTORSTATE w/ exceptions if field has no valu
HAS_CONNECTORSTATE() Determine if CONNECTORSTATE has a value

creationTime

The time that the connector was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

currentVersion

The current version of the connector.

Accessible with the following methods

Method Description
GET_CURRENTVERSION() Getter for CURRENTVERSION, with configurable default
ASK_CURRENTVERSION() Getter for CURRENTVERSION w/ exceptions if field has no valu
HAS_CURRENTVERSION() Determine if CURRENTVERSION has a value

kafkaCluster

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

Accessible with the following methods

Method Description
GET_KAFKACLUSTER() Getter for KAFKACLUSTER

kafkaClusterClientAuthentication

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

Accessible with the following methods

Method Description
GET_KAFKACLUSTCLIAUTHNTCTN() Getter for KAFKACLUSTERCLIENTAUTHNTCTN

kafkaClusterEncryptionInTransit

Details of encryption in transit to the Apache Kafka cluster.

Accessible with the following methods

Method Description
GET_KAFKACLUSTERENCINTRANSIT() Getter for KAFKACLUSTERENCINTRANSIT

kafkaConnectVersion

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

Accessible with the following methods

Method Description
GET_KAFKACONNECTVERSION() Getter for KAFKACONNECTVERSION, with configurable default
ASK_KAFKACONNECTVERSION() Getter for KAFKACONNECTVERSION w/ exceptions if field has no
HAS_KAFKACONNECTVERSION() Determine if KAFKACONNECTVERSION has a value

logDelivery

The settings for delivering connector logs to Amazon CloudWatch Logs.

Accessible with the following methods

Method Description
GET_LOGDELIVERY() Getter for LOGDELIVERY

plugins

Specifies which plugins were used for this connector.

Accessible with the following methods

Method Description
GET_PLUGINS() Getter for PLUGINS, with configurable default
ASK_PLUGINS() Getter for PLUGINS w/ exceptions if field has no value
HAS_PLUGINS() Determine if PLUGINS has a value

serviceExecutionRoleArn

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

Accessible with the following methods

Method Description
GET_SERVICEEXECUTIONROLEARN() Getter for SERVICEEXECUTIONROLEARN, with configurable defaul
ASK_SERVICEEXECUTIONROLEARN() Getter for SERVICEEXECUTIONROLEARN w/ exceptions if field ha
HAS_SERVICEEXECUTIONROLEARN() Determine if SERVICEEXECUTIONROLEARN has a value

workerConfiguration

The worker configurations that are in use with the connector.

Accessible with the following methods

Method Description
GET_WORKERCONFIGURATION() Getter for WORKERCONFIGURATION

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT___LISTOFCONNECTORSUMMARY

TYPES TT___LISTOFCONNECTORSUMMARY TYPE STANDARD TABLE OF REF TO /AWS1/CL_KFCCONNECTORSUMMARY WITH DEFAULT KEY
.