You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.KafkaConnect

Inherits:
AWS.Service show all
Identifier:
kafkaconnect
API Version:
2021-09-14
Defined in:
(unknown)

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();

Version:

  • 2021-09-14

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a KafkaConnect object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.KafkaConnect.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.KafkaConnect.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.KafkaConnect.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a connector using the specified properties.

Service Reference:

Examples:

Calling the createConnector operation

var params = {
  capacity: { /* required */
    autoScaling: {
      maxWorkerCount: 'NUMBER_VALUE', /* required */
      mcuCount: 'NUMBER_VALUE', /* required */
      minWorkerCount: 'NUMBER_VALUE', /* required */
      scaleInPolicy: {
        cpuUtilizationPercentage: 'NUMBER_VALUE' /* required */
      },
      scaleOutPolicy: {
        cpuUtilizationPercentage: 'NUMBER_VALUE' /* required */
      }
    },
    provisionedCapacity: {
      mcuCount: 'NUMBER_VALUE', /* required */
      workerCount: 'NUMBER_VALUE' /* required */
    }
  },
  connectorConfiguration: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  connectorName: 'STRING_VALUE', /* required */
  kafkaCluster: { /* required */
    apacheKafkaCluster: { /* required */
      bootstrapServers: 'STRING_VALUE', /* required */
      vpc: { /* required */
        subnets: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        securityGroups: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  kafkaClusterClientAuthentication: { /* required */
    authenticationType: NONE | IAM /* required */
  },
  kafkaClusterEncryptionInTransit: { /* required */
    encryptionType: PLAINTEXT | TLS /* required */
  },
  kafkaConnectVersion: 'STRING_VALUE', /* required */
  plugins: [ /* required */
    {
      customPlugin: { /* required */
        customPluginArn: 'STRING_VALUE', /* required */
        revision: 'NUMBER_VALUE' /* required */
      }
    },
    /* more items */
  ],
  serviceExecutionRoleArn: 'STRING_VALUE', /* required */
  connectorDescription: 'STRING_VALUE',
  logDelivery: {
    workerLogDelivery: { /* required */
      cloudWatchLogs: {
        enabled: true || false, /* required */
        logGroup: 'STRING_VALUE'
      },
      firehose: {
        enabled: true || false, /* required */
        deliveryStream: 'STRING_VALUE'
      },
      s3: {
        enabled: true || false, /* required */
        bucket: 'STRING_VALUE',
        prefix: 'STRING_VALUE'
      }
    }
  },
  workerConfiguration: {
    revision: 'NUMBER_VALUE', /* required */
    workerConfigurationArn: 'STRING_VALUE' /* required */
  }
};
kafkaconnect.createConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • capacity — (map)

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

      • autoScaling — (map)

        Information about the auto scaling parameters for the connector.

        • maxWorkerCountrequired — (Integer)

          The maximum number of workers allocated to the connector.

        • mcuCountrequired — (Integer)

          The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

        • minWorkerCountrequired — (Integer)

          The minimum number of workers allocated to the connector.

        • scaleInPolicy — (map)

          The sacle-in policy for the connector.

          • cpuUtilizationPercentagerequired — (Integer)

            Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

        • scaleOutPolicy — (map)

          The sacle-out policy for the connector.

          • cpuUtilizationPercentagerequired — (Integer)

            The CPU utilization percentage threshold at which you want connector scale out to be triggered.

      • provisionedCapacity — (map)

        Details about a fixed capacity allocated to a connector.

        • mcuCountrequired — (Integer)

          The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

        • workerCountrequired — (Integer)

          The number of workers that are allocated to the connector.

    • connectorConfiguration — (map<String>)

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

    • connectorDescription — (String)

      A summary description of the connector.

    • connectorName — (String)

      The name of the connector.

    • kafkaCluster — (map)

      Specifies which Apache Kafka cluster to connect to.

      • apacheKafkaClusterrequired — (map)

        The Apache Kafka cluster to which the connector is connected.

        • bootstrapServersrequired — (String)

          The bootstrap servers of the cluster.

        • vpcrequired — (map)

          Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

          • securityGroups — (Array<String>)

            The security groups for the connector.

          • subnetsrequired — (Array<String>)

            The subnets for the connector.

    • kafkaClusterClientAuthentication — (map)

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

      • authenticationTyperequired — (String)

        The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

        Possible values include:
        • "NONE"
        • "IAM"
    • kafkaClusterEncryptionInTransit — (map)

      Details of encryption in transit to the Apache Kafka cluster.

      • encryptionTyperequired — (String)

        The type of encryption in transit to the Apache Kafka cluster.

        Possible values include:
        • "PLAINTEXT"
        • "TLS"
    • kafkaConnectVersion — (String)

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

    • logDelivery — (map)

      Details about log delivery.

      • workerLogDeliveryrequired — (map)

        The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

        • cloudWatchLogs — (map)

          Details about delivering logs to Amazon CloudWatch Logs.

          • enabledrequired — (Boolean)

            Whether log delivery to Amazon CloudWatch Logs is enabled.

          • logGroup — (String)

            The name of the CloudWatch log group that is the destination for log delivery.

        • firehose — (map)

          Details about delivering logs to Amazon Kinesis Data Firehose.

          • deliveryStream — (String)

            The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

          • enabledrequired — (Boolean)

            Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

        • s3 — (map)

          Details about delivering logs to Amazon S3.

          • bucket — (String)

            The name of the S3 bucket that is the destination for log delivery.

          • enabledrequired — (Boolean)

            Specifies whether connector logs get sent to the specified Amazon S3 destination.

          • prefix — (String)

            The S3 prefix that is the destination for log delivery.

    • plugins — (Array<map>)

      Specifies which plugins to use for the connector.

      • customPluginrequired — (map)

        Details about a custom plugin.

        • customPluginArnrequired — (String)

          The Amazon Resource Name (ARN) of the custom plugin.

        • revisionrequired — (Integer)

          The revision of the custom plugin.

    • serviceExecutionRoleArn — (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.

    • workerConfiguration — (map)

      Specifies which worker configuration to use with the connector.

      • revisionrequired — (Integer)

        The revision of the worker configuration.

      • workerConfigurationArnrequired — (String)

        The Amazon Resource Name (ARN) of the worker configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectorArn — (String)

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

      • connectorName — (String)

        The name of the connector.

      • connectorState — (String)

        The state of the connector.

        Possible values include:
        • "RUNNING"
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a custom plugin using the specified properties.

Service Reference:

Examples:

Calling the createCustomPlugin operation

var params = {
  contentType: JAR | ZIP, /* required */
  location: { /* required */
    s3Location: { /* required */
      bucketArn: 'STRING_VALUE', /* required */
      fileKey: 'STRING_VALUE', /* required */
      objectVersion: 'STRING_VALUE'
    }
  },
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
kafkaconnect.createCustomPlugin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • contentType — (String)

      The type of the plugin file.

      Possible values include:
      • "JAR"
      • "ZIP"
    • description — (String)

      A summary description of the custom plugin.

    • location — (map)

      Information about the location of a custom plugin.

      • s3Locationrequired — (map)

        The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

        • bucketArnrequired — (String)

          The Amazon Resource Name (ARN) of an S3 bucket.

        • fileKeyrequired — (String)

          The file key for an object in an S3 bucket.

        • objectVersion — (String)

          The version of an object in an S3 bucket.

    • name — (String)

      The name of the custom plugin.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • customPluginArn — (String)

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

      • customPluginState — (String)

        The state of the custom plugin.

        Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "UPDATING"
        • "UPDATE_FAILED"
        • "DELETING"
      • name — (String)

        The name of the custom plugin.

      • revision — (Integer)

        The revision of the custom plugin.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates a worker configuration using the specified properties.

Service Reference:

Examples:

Calling the createWorkerConfiguration operation

var params = {
  name: 'STRING_VALUE', /* required */
  propertiesFileContent: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
kafkaconnect.createWorkerConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • description — (String)

      A summary description of the worker configuration.

    • name — (String)

      The name of the worker configuration.

    • propertiesFileContent — (String)

      Base64 encoded contents of connect-distributed.properties file.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • creationTime — (Date)

        The time that the worker configuration was created.

      • latestRevision — (map)

        The latest revision of the worker configuration.

        • creationTime — (Date)

          The time that a worker configuration revision was created.

        • description — (String)

          The description of a worker configuration revision.

        • revision — (Integer)

          The revision of a worker configuration.

      • name — (String)

        The name of the worker configuration.

      • workerConfigurationArn — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes the specified connector.

Service Reference:

Examples:

Calling the deleteConnector operation

var params = {
  connectorArn: 'STRING_VALUE', /* required */
  currentVersion: 'STRING_VALUE'
};
kafkaconnect.deleteConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectorArn — (String)

      The Amazon Resource Name (ARN) of the connector that you want to delete.

    • currentVersion — (String)

      The current version of the connector that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectorArn — (String)

        The Amazon Resource Name (ARN) of the connector that you requested to delete.

      • connectorState — (String)

        The state of the connector that you requested to delete.

        Possible values include:
        • "RUNNING"
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns summary information about the connector.

Service Reference:

Examples:

Calling the describeConnector operation

var params = {
  connectorArn: 'STRING_VALUE' /* required */
};
kafkaconnect.describeConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectorArn — (String)

      The Amazon Resource Name (ARN) of the connector that you want to describe.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • capacity — (map)

        Information about the capacity of the connector, whether it is auto scaled or provisioned.

        • autoScaling — (map)

          Describes the connector's auto scaling capacity.

          • maxWorkerCount — (Integer)

            The maximum number of workers allocated to the connector.

          • mcuCount — (Integer)

            The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

          • minWorkerCount — (Integer)

            The minimum number of workers allocated to the connector.

          • scaleInPolicy — (map)

            The sacle-in policy for the connector.

            • cpuUtilizationPercentage — (Integer)

              Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

          • scaleOutPolicy — (map)

            The sacle-out policy for the connector.>

            • cpuUtilizationPercentage — (Integer)

              The CPU utilization percentage threshold at which you want connector scale out to be triggered.

        • provisionedCapacity — (map)

          Describes a connector's provisioned capacity.

          • mcuCount — (Integer)

            The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

          • workerCount — (Integer)

            The number of workers that are allocated to the connector.

      • connectorArn — (String)

        The Amazon Resource Name (ARN) of the connector.

      • connectorConfiguration — (map<String>)

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

      • connectorDescription — (String)

        A summary description of the connector.

      • connectorName — (String)

        The name of the connector.

      • connectorState — (String)

        The state of the connector.

        Possible values include:
        • "RUNNING"
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "FAILED"
      • creationTime — (Date)

        The time the connector was created.

      • currentVersion — (String)

        The current version of the connector.

      • kafkaCluster — (map)

        The Apache Kafka cluster that the connector is connected to.

        • apacheKafkaCluster — (map)

          The Apache Kafka cluster to which the connector is connected.

          • bootstrapServers — (String)

            The bootstrap servers of the cluster.

          • vpc — (map)

            Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

            • securityGroups — (Array<String>)

              The security groups for the connector.

            • subnets — (Array<String>)

              The subnets for the connector.

      • kafkaClusterClientAuthentication — (map)

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

        • authenticationType — (String)

          The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

          Possible values include:
          • "NONE"
          • "IAM"
      • kafkaClusterEncryptionInTransit — (map)

        Details of encryption in transit to the Apache Kafka cluster.

        • encryptionType — (String)

          The type of encryption in transit to the Apache Kafka cluster.

          Possible values include:
          • "PLAINTEXT"
          • "TLS"
      • kafkaConnectVersion — (String)

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

      • logDelivery — (map)

        Details about delivering logs to Amazon CloudWatch Logs.

        • workerLogDelivery — (map)

          The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

          • cloudWatchLogs — (map)

            Details about delivering logs to Amazon CloudWatch Logs.

            • enabled — (Boolean)

              Whether log delivery to Amazon CloudWatch Logs is enabled.

            • logGroup — (String)

              The name of the CloudWatch log group that is the destination for log delivery.

          • firehose — (map)

            Details about delivering logs to Amazon Kinesis Data Firehose.

            • deliveryStream — (String)

              The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

            • enabled — (Boolean)

              Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

          • s3 — (map)

            Details about delivering logs to Amazon S3.

            • bucket — (String)

              The name of the S3 bucket that is the destination for log delivery.

            • enabled — (Boolean)

              Specifies whether connector logs get sent to the specified Amazon S3 destination.

            • prefix — (String)

              The S3 prefix that is the destination for log delivery.

      • plugins — (Array<map>)

        Specifies which plugins were used for this connector.

        • customPlugin — (map)

          Details about a custom plugin.

          • customPluginArn — (String)

            The Amazon Resource Name (ARN) of the custom plugin.

          • revision — (Integer)

            The revision of the custom plugin.

      • serviceExecutionRoleArn — (String)

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

      • workerConfiguration — (map)

        Specifies which worker configuration was used for the connector.

        • revision — (Integer)

          The revision of the worker configuration.

        • workerConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the worker configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

A summary description of the custom plugin.

Service Reference:

Examples:

Calling the describeCustomPlugin operation

var params = {
  customPluginArn: 'STRING_VALUE' /* required */
};
kafkaconnect.describeCustomPlugin(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • customPluginArn — (String)

      Returns information about a custom plugin.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • creationTime — (Date)

        The time that the custom plugin was created.

      • customPluginArn — (String)

        The Amazon Resource Name (ARN) of the custom plugin.

      • customPluginState — (String)

        The state of the custom plugin.

        Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "UPDATING"
        • "UPDATE_FAILED"
        • "DELETING"
      • description — (String)

        The description of the custom plugin.

      • latestRevision — (map)

        The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.

        • contentType — (String)

          The format of the plugin file.

          Possible values include:
          • "JAR"
          • "ZIP"
        • creationTime — (Date)

          The time that the custom plugin was created.

        • description — (String)

          The description of the custom plugin.

        • fileDescription — (map)

          Details about the custom plugin file.

          • fileMd5 — (String)

            The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

          • fileSize — (Integer)

            The size in bytes of the custom plugin file. You can use it to validate the file.

        • location — (map)

          Information about the location of the custom plugin.

          • s3Location — (map)

            The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

            • bucketArn — (String)

              The Amazon Resource Name (ARN) of an S3 bucket.

            • fileKey — (String)

              The file key for an object in an S3 bucket.

            • objectVersion — (String)

              The version of an object in an S3 bucket.

        • revision — (Integer)

          The revision of the custom plugin.

      • name — (String)

        The name of the custom plugin.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns information about a worker configuration.

Service Reference:

Examples:

Calling the describeWorkerConfiguration operation

var params = {
  workerConfigurationArn: 'STRING_VALUE' /* required */
};
kafkaconnect.describeWorkerConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workerConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • creationTime — (Date)

        The time that the worker configuration was created.

      • description — (String)

        The description of the worker configuration.

      • latestRevision — (map)

        The latest revision of the custom configuration.

        • creationTime — (Date)

          The time that the worker configuration was created.

        • description — (String)

          The description of the worker configuration revision.

        • propertiesFileContent — (String)

          Base64 encoded contents of the connect-distributed.properties file.

        • revision — (Integer)

          The description of a revision of the worker configuration.

      • name — (String)

        The name of the worker configuration.

      • workerConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the custom configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the listConnectors operation

var params = {
  connectorNamePrefix: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
kafkaconnect.listConnectors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • connectorNamePrefix — (String)

      The name prefix that you want to use to search for and list connectors.

    • maxResults — (Integer)

      The maximum number of connectors to list in one response.

    • nextToken — (String)

      If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectors — (Array<map>)

        An array of connector descriptions.

        • capacity — (map)

          The connector's compute capacity settings.

          • autoScaling — (map)

            Describes the connector's auto scaling capacity.

            • maxWorkerCount — (Integer)

              The maximum number of workers allocated to the connector.

            • mcuCount — (Integer)

              The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

            • minWorkerCount — (Integer)

              The minimum number of workers allocated to the connector.

            • scaleInPolicy — (map)

              The sacle-in policy for the connector.

              • cpuUtilizationPercentage — (Integer)

                Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

            • scaleOutPolicy — (map)

              The sacle-out policy for the connector.>

              • cpuUtilizationPercentage — (Integer)

                The CPU utilization percentage threshold at which you want connector scale out to be triggered.

          • provisionedCapacity — (map)

            Describes a connector's provisioned capacity.

            • mcuCount — (Integer)

              The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

            • workerCount — (Integer)

              The number of workers that are allocated to the connector.

        • connectorArn — (String)

          The Amazon Resource Name (ARN) of the connector.

        • connectorDescription — (String)

          The description of the connector.

        • connectorName — (String)

          The name of the connector.

        • connectorState — (String)

          The state of the connector.

          Possible values include:
          • "RUNNING"
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • creationTime — (Date)

          The time that the connector was created.

        • currentVersion — (String)

          The current version of the connector.

        • kafkaCluster — (map)

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

          • apacheKafkaCluster — (map)

            The Apache Kafka cluster to which the connector is connected.

            • bootstrapServers — (String)

              The bootstrap servers of the cluster.

            • vpc — (map)

              Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

              • securityGroups — (Array<String>)

                The security groups for the connector.

              • subnets — (Array<String>)

                The subnets for the connector.

        • kafkaClusterClientAuthentication — (map)

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

          • authenticationType — (String)

            The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

            Possible values include:
            • "NONE"
            • "IAM"
        • kafkaClusterEncryptionInTransit — (map)

          Details of encryption in transit to the Apache Kafka cluster.

          • encryptionType — (String)

            The type of encryption in transit to the Apache Kafka cluster.

            Possible values include:
            • "PLAINTEXT"
            • "TLS"
        • kafkaConnectVersion — (String)

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

        • logDelivery — (map)

          The settings for delivering connector logs to Amazon CloudWatch Logs.

          • workerLogDelivery — (map)

            The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

            • cloudWatchLogs — (map)

              Details about delivering logs to Amazon CloudWatch Logs.

              • enabled — (Boolean)

                Whether log delivery to Amazon CloudWatch Logs is enabled.

              • logGroup — (String)

                The name of the CloudWatch log group that is the destination for log delivery.

            • firehose — (map)

              Details about delivering logs to Amazon Kinesis Data Firehose.

              • deliveryStream — (String)

                The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

              • enabled — (Boolean)

                Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

            • s3 — (map)

              Details about delivering logs to Amazon S3.

              • bucket — (String)

                The name of the S3 bucket that is the destination for log delivery.

              • enabled — (Boolean)

                Specifies whether connector logs get sent to the specified Amazon S3 destination.

              • prefix — (String)

                The S3 prefix that is the destination for log delivery.

        • plugins — (Array<map>)

          Specifies which plugins were used for this connector.

          • customPlugin — (map)

            Details about a custom plugin.

            • customPluginArn — (String)

              The Amazon Resource Name (ARN) of the custom plugin.

            • revision — (Integer)

              The revision of the custom plugin.

        • serviceExecutionRoleArn — (String)

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

        • workerConfiguration — (map)

          The worker configurations that are in use with the connector.

          • revision — (Integer)

            The revision of the worker configuration.

          • workerConfigurationArn — (String)

            The Amazon Resource Name (ARN) of the worker configuration.

      • nextToken — (String)

        If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listCustomPlugins operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
kafkaconnect.listCustomPlugins(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of custom plugins to list in one response.

    • nextToken — (String)

      If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • customPlugins — (Array<map>)

        An array of custom plugin descriptions.

        • creationTime — (Date)

          The time that the custom plugin was created.

        • customPluginArn — (String)

          The Amazon Resource Name (ARN) of the custom plugin.

        • customPluginState — (String)

          The state of the custom plugin.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
        • description — (String)

          A description of the custom plugin.

        • latestRevision — (map)

          The latest revision of the custom plugin.

          • contentType — (String)

            The format of the plugin file.

            Possible values include:
            • "JAR"
            • "ZIP"
          • creationTime — (Date)

            The time that the custom plugin was created.

          • description — (String)

            The description of the custom plugin.

          • fileDescription — (map)

            Details about the custom plugin file.

            • fileMd5 — (String)

              The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

            • fileSize — (Integer)

              The size in bytes of the custom plugin file. You can use it to validate the file.

          • location — (map)

            Information about the location of the custom plugin.

            • s3Location — (map)

              The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

              • bucketArn — (String)

                The Amazon Resource Name (ARN) of an S3 bucket.

              • fileKey — (String)

                The file key for an object in an S3 bucket.

              • objectVersion — (String)

                The version of an object in an S3 bucket.

          • revision — (Integer)

            The revision of the custom plugin.

        • name — (String)

          The name of the custom plugin.

      • nextToken — (String)

        If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the listWorkerConfigurations operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
kafkaconnect.listWorkerConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

      The maximum number of worker configurations to list in one response.

    • nextToken — (String)

      If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

      • workerConfigurations — (Array<map>)

        An array of worker configuration descriptions.

        • creationTime — (Date)

          The time that a worker configuration was created.

        • description — (String)

          The description of a worker configuration.

        • latestRevision — (map)

          The latest revision of a worker configuration.

          • creationTime — (Date)

            The time that a worker configuration revision was created.

          • description — (String)

            The description of a worker configuration revision.

          • revision — (Integer)

            The revision of a worker configuration.

        • name — (String)

          The name of the worker configuration.

        • workerConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the worker configuration.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates the specified connector.

Service Reference:

Examples:

Calling the updateConnector operation

var params = {
  capacity: { /* required */
    autoScaling: {
      maxWorkerCount: 'NUMBER_VALUE', /* required */
      mcuCount: 'NUMBER_VALUE', /* required */
      minWorkerCount: 'NUMBER_VALUE', /* required */
      scaleInPolicy: { /* required */
        cpuUtilizationPercentage: 'NUMBER_VALUE' /* required */
      },
      scaleOutPolicy: { /* required */
        cpuUtilizationPercentage: 'NUMBER_VALUE' /* required */
      }
    },
    provisionedCapacity: {
      mcuCount: 'NUMBER_VALUE', /* required */
      workerCount: 'NUMBER_VALUE' /* required */
    }
  },
  connectorArn: 'STRING_VALUE', /* required */
  currentVersion: 'STRING_VALUE' /* required */
};
kafkaconnect.updateConnector(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • capacity — (map)

      The target capacity.

      • autoScaling — (map)

        The target auto scaling setting.

        • maxWorkerCountrequired — (Integer)

          The target maximum number of workers allocated to the connector.

        • mcuCountrequired — (Integer)

          The target number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

        • minWorkerCountrequired — (Integer)

          The target minimum number of workers allocated to the connector.

        • scaleInPolicyrequired — (map)

          The target sacle-in policy for the connector.

          • cpuUtilizationPercentagerequired — (Integer)

            The target CPU utilization percentage threshold at which you want connector scale in to be triggered.

        • scaleOutPolicyrequired — (map)

          The target sacle-out policy for the connector.

          • cpuUtilizationPercentagerequired — (Integer)

            The target CPU utilization percentage threshold at which you want connector scale out to be triggered.

      • provisionedCapacity — (map)

        The target settings for provisioned capacity.

        • mcuCountrequired — (Integer)

          The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

        • workerCountrequired — (Integer)

          The number of workers that are allocated to the connector.

    • connectorArn — (String)

      The Amazon Resource Name (ARN) of the connector that you want to update.

    • currentVersion — (String)

      The current version of the connector that you want to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • connectorArn — (String)

        The Amazon Resource Name (ARN) of the connector.

      • connectorState — (String)

        The state of the connector.

        Possible values include:
        • "RUNNING"
        • "CREATING"
        • "UPDATING"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.