Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141813797.1 KB

Creates a connector using the specified properties.

post/v1/connectors

Request body

connectorConfigurationobject required

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

connectorDescriptionstring

A summary description of the connector.

connectorNamestring required

The name of the connector.

kafkaConnectVersionstring required

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

networkType'IPV4' | 'DUAL'

The network type of a connector.

serviceExecutionRoleArnstring 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.

tagsobject

The tags you want to attach to the connector.

Response

Success

connectorArnstring

The Amazon Resource Name (ARN) that Amazon assigned to the connector.

connectorNamestring

The name of the connector.

connectorState'RUNNING' | 'CREATING' | 'UPDATING' | 'DELETING' | 'FAILED'

The state of the connector.