AWS.KafkaConnect — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Sending a Request Using KafkaConnect

var kafkaconnect = new AWS.KafkaConnect();
kafkaconnect.createConnector(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the KafkaConnect object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kafkaconnect = new AWS.KafkaConnect({apiVersion: '2021-09-14'});

You can also set the API version globally in AWS.config.apiVersions using the kafkaconnect service identifier:

AWS.config.apiVersions = {
  kafkaconnect: '2021-09-14',
  // other service API versions
};

var kafkaconnect = new AWS.KafkaConnect();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.KafkaConnect(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createConnector(params = {}, callback) ⇒ AWS.Request

Creates a connector using the specified properties.

createCustomPlugin(params = {}, callback) ⇒ AWS.Request

Creates a custom plugin using the specified properties.

createWorkerConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a worker configuration using the specified properties.

deleteConnector(params = {}, callback) ⇒ AWS.Request

Deletes the specified connector.

deleteCustomPlugin(params = {}, callback) ⇒ AWS.Request

deleteWorkerConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the specified worker configuration.

describeConnector(params = {}, callback) ⇒ AWS.Request

Returns summary information about the connector.

describeCustomPlugin(params = {}, callback) ⇒ AWS.Request

A summary description of the custom plugin.

describeWorkerConfiguration(params = {}, callback) ⇒ AWS.Request

Returns information about a worker configuration.

listConnectors(params = {}, callback) ⇒ AWS.Request

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

listCustomPlugins(params = {}, callback) ⇒ AWS.Request

Returns a list of all of the custom plugins in this account and Region.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all the tags attached to the specified resource.

listWorkerConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of all of the worker configurations in this account and Region.

tagResource(params = {}, callback) ⇒ AWS.Request

Attaches tags to the specified resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified resource.

updateConnector(params = {}, callback) ⇒ AWS.Request

Updates the specified connector.