Create Connector

kafkaconnect_create_connector

R Documentation

Creates a connector using the specified properties

Description

Creates a connector using the specified properties.

Usage

kafkaconnect_create_connector(capacity, connectorConfiguration,
  connectorDescription, connectorName, kafkaCluster,
  kafkaClusterClientAuthentication, kafkaClusterEncryptionInTransit,
  kafkaConnectVersion, logDelivery, plugins, serviceExecutionRoleArn,
  tags, workerConfiguration)

Arguments

capacity

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

connectorConfiguration

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

connectorDescription

A summary description of the connector.

connectorName

[required] The name of the connector.

kafkaCluster

[required] Specifies which Apache Kafka cluster to connect to.

kafkaClusterClientAuthentication

[required] Details of the client authentication used by the Apache Kafka cluster.

kafkaClusterEncryptionInTransit

[required] Details of encryption in transit to the Apache Kafka cluster.

kafkaConnectVersion

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

logDelivery

Details about log delivery.

plugins

[required] 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.

serviceExecutionRoleArn

[required] 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

The tags you want to attach to the connector.

workerConfiguration

Specifies which worker configuration to use with the connector.

Value

A list with the following syntax:

list(
  connectorArn = "string",
  connectorName = "string",
  connectorState = "RUNNING"|"CREATING"|"UPDATING"|"DELETING"|"FAILED"
)

Request syntax

svc$create_connector(
  capacity = list(
    autoScaling = list(
      maxWorkerCount = 123,
      mcuCount = 123,
      minWorkerCount = 123,
      scaleInPolicy = list(
        cpuUtilizationPercentage = 123
      ),
      scaleOutPolicy = list(
        cpuUtilizationPercentage = 123
      )
    ),
    provisionedCapacity = list(
      mcuCount = 123,
      workerCount = 123
    )
  ),
  connectorConfiguration = list(
    "string"
  ),
  connectorDescription = "string",
  connectorName = "string",
  kafkaCluster = list(
    apacheKafkaCluster = list(
      bootstrapServers = "string",
      vpc = list(
        securityGroups = list(
          "string"
        ),
        subnets = list(
          "string"
        )
      )
    )
  ),
  kafkaClusterClientAuthentication = list(
    authenticationType = "NONE"|"IAM"
  ),
  kafkaClusterEncryptionInTransit = list(
    encryptionType = "PLAINTEXT"|"TLS"
  ),
  kafkaConnectVersion = "string",
  logDelivery = list(
    workerLogDelivery = list(
      cloudWatchLogs = list(
        enabled = TRUE|FALSE,
        logGroup = "string"
      ),
      firehose = list(
        deliveryStream = "string",
        enabled = TRUE|FALSE
      ),
      s3 = list(
        bucket = "string",
        enabled = TRUE|FALSE,
        prefix = "string"
      )
    )
  ),
  plugins = list(
    list(
      customPlugin = list(
        customPluginArn = "string",
        revision = 123
      )
    )
  ),
  serviceExecutionRoleArn = "string",
  tags = list(
    "string"
  ),
  workerConfiguration = list(
    revision = 123,
    workerConfigurationArn = "string"
  )
)