Skip to content

/AWS1/IF_KFC=>CREATECONNECTOR()

About CreateConnector

Creates a connector using the specified properties.

Method Signature

METHODS /AWS1/IF_KFC~CREATECONNECTOR
  IMPORTING
    !IO_CAPACITY TYPE REF TO /AWS1/CL_KFCCAPACITY OPTIONAL
    !IT_CONNECTORCONFIGURATION TYPE /AWS1/CL_KFCCONNECTORCONF_W=>TT_CONNECTORCONFIGURATION OPTIONAL
    !IV_CONNECTORDESCRIPTION TYPE /AWS1/KFC__STRINGMAX1024 OPTIONAL
    !IV_CONNECTORNAME TYPE /AWS1/KFC__STRINGMIN1MAX128 OPTIONAL
    !IO_KAFKACLUSTER TYPE REF TO /AWS1/CL_KFCKAFKACLUSTER OPTIONAL
    !IO_KAFKACLUSTCLIENTAUTHNTCTN TYPE REF TO /AWS1/CL_KFCKAFKACLSTCLIAUTHN OPTIONAL
    !IO_KAFKACLUSTERENCINTRANSIT TYPE REF TO /AWS1/CL_KFCKAFKACLSTENCINTR00 OPTIONAL
    !IV_KAFKACONNECTVERSION TYPE /AWS1/KFC__STRING OPTIONAL
    !IO_LOGDELIVERY TYPE REF TO /AWS1/CL_KFCLOGDELIVERY OPTIONAL
    !IT_PLUGINS TYPE /AWS1/CL_KFCPLUGIN=>TT___LISTOFPLUGIN OPTIONAL
    !IV_SERVICEEXECUTIONROLEARN TYPE /AWS1/KFC__STRING OPTIONAL
    !IO_WORKERCONFIGURATION TYPE REF TO /AWS1/CL_KFCWORKERCONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_KFCTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_kfccreateconnectorrsp
  RAISING
    /AWS1/CX_KFCBADREQUESTEX
    /AWS1/CX_KFCCONFLICTEXCEPTION
    /AWS1/CX_KFCFORBIDDENEXCEPTION
    /AWS1/CX_KFCINTERNALSERVERER00
    /AWS1/CX_KFCNOTFOUNDEXCEPTION
    /AWS1/CX_KFCSERVICEUNAVAILEX
    /AWS1/CX_KFCTOOMANYREQUESTSEX
    /AWS1/CX_KFCUNAUTHORIZEDEX
    /AWS1/CX_KFCCLIENTEXC
    /AWS1/CX_KFCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_capacity TYPE REF TO /AWS1/CL_KFCCAPACITY /AWS1/CL_KFCCAPACITY

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

it_connectorconfiguration TYPE /AWS1/CL_KFCCONNECTORCONF_W=>TT_CONNECTORCONFIGURATION TT_CONNECTORCONFIGURATION

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

iv_connectorname TYPE /AWS1/KFC__STRINGMIN1MAX128 /AWS1/KFC__STRINGMIN1MAX128

The name of the connector.

io_kafkacluster TYPE REF TO /AWS1/CL_KFCKAFKACLUSTER /AWS1/CL_KFCKAFKACLUSTER

Specifies which Apache Kafka cluster to connect to.

io_kafkaclustclientauthntctn TYPE REF TO /AWS1/CL_KFCKAFKACLSTCLIAUTHN /AWS1/CL_KFCKAFKACLSTCLIAUTHN

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

io_kafkaclusterencintransit TYPE REF TO /AWS1/CL_KFCKAFKACLSTENCINTR00 /AWS1/CL_KFCKAFKACLSTENCINTR00

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.

it_plugins TYPE /AWS1/CL_KFCPLUGIN=>TT___LISTOFPLUGIN TT___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.

iv_serviceexecutionrolearn TYPE /AWS1/KFC__STRING /AWS1/KFC__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.

Optional arguments:

iv_connectordescription TYPE /AWS1/KFC__STRINGMAX1024 /AWS1/KFC__STRINGMAX1024

A summary description of the connector.

io_logdelivery TYPE REF TO /AWS1/CL_KFCLOGDELIVERY /AWS1/CL_KFCLOGDELIVERY

Details about log delivery.

io_workerconfiguration TYPE REF TO /AWS1/CL_KFCWORKERCONF /AWS1/CL_KFCWORKERCONF

Specifies which worker configuration to use with the connector.

it_tags TYPE /AWS1/CL_KFCTAGS_W=>TT_TAGS TT_TAGS

The tags you want to attach to the connector.

RETURNING

oo_output TYPE REF TO /aws1/cl_kfccreateconnectorrsp /AWS1/CL_KFCCREATECONNECTORRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createconnector(
  io_capacity = new /aws1/cl_kfccapacity(
    io_autoscaling = new /aws1/cl_kfcautoscaling(
      io_scaleinpolicy = new /aws1/cl_kfcscaleinpolicy( 123 )
      io_scaleoutpolicy = new /aws1/cl_kfcscaleoutpolicy( 123 )
      iv_maxworkercount = 123
      iv_mcucount = 123
      iv_minworkercount = 123
    )
    io_provisionedcapacity = new /aws1/cl_kfcprovcapacity(
      iv_mcucount = 123
      iv_workercount = 123
    )
  )
  io_kafkaclustclientauthntctn = new /aws1/cl_kfckafkaclstcliauthn( |string| )
  io_kafkacluster = new /aws1/cl_kfckafkacluster(
    io_apachekafkacluster = new /aws1/cl_kfcapachekafkacluster(
      io_vpc = new /aws1/cl_kfcvpc(
        it_securitygroups = VALUE /aws1/cl_kfc__listof__string_w=>tt___listof__string(
          ( new /aws1/cl_kfc__listof__string_w( |string| ) )
        )
        it_subnets = VALUE /aws1/cl_kfc__listof__string_w=>tt___listof__string(
          ( new /aws1/cl_kfc__listof__string_w( |string| ) )
        )
      )
      iv_bootstrapservers = |string|
    )
  )
  io_kafkaclusterencintransit = new /aws1/cl_kfckafkaclstencintr00( |string| )
  io_logdelivery = new /aws1/cl_kfclogdelivery(
    io_workerlogdelivery = new /aws1/cl_kfcworkerlogdelivery(
      io_cloudwatchlogs = new /aws1/cl_kfccloudwatchlogslo00(
        iv_enabled = ABAP_TRUE
        iv_loggroup = |string|
      )
      io_firehose = new /aws1/cl_kfcfirehoselogdeliv00(
        iv_deliverystream = |string|
        iv_enabled = ABAP_TRUE
      )
      io_s3 = new /aws1/cl_kfcs3logdelivery(
        iv_bucket = |string|
        iv_enabled = ABAP_TRUE
        iv_prefix = |string|
      )
    )
  )
  io_workerconfiguration = new /aws1/cl_kfcworkerconf(
    iv_revision = 123
    iv_workerconfigurationarn = |string|
  )
  it_connectorconfiguration = VALUE /aws1/cl_kfcconnectorconf_w=>tt_connectorconfiguration(
    (
      VALUE /aws1/cl_kfcconnectorconf_w=>ts_connectorconf_maprow(
        key = |string|
        value = new /aws1/cl_kfcconnectorconf_w( |string| )
      )
    )
  )
  it_plugins = VALUE /aws1/cl_kfcplugin=>tt___listofplugin(
    (
      new /aws1/cl_kfcplugin(
        io_customplugin = new /aws1/cl_kfccustomplugin(
          iv_custompluginarn = |string|
          iv_revision = 123
        )
      )
    )
  )
  it_tags = VALUE /aws1/cl_kfctags_w=>tt_tags(
    (
      VALUE /aws1/cl_kfctags_w=>ts_tags_maprow(
        value = new /aws1/cl_kfctags_w( |string| )
        key = |string|
      )
    )
  )
  iv_connectordescription = |string|
  iv_connectorname = |string|
  iv_kafkaconnectversion = |string|
  iv_serviceexecutionrolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv___string = lo_result->get_connectorarn( ).
  lv___string = lo_result->get_connectorname( ).
  lv_connectorstate = lo_result->get_connectorstate( ).
ENDIF.