Class: AWS.Kafka

Inherits:
AWS.Service show all
Identifier:
kafka
API Version:
2018-11-14
Defined in:
(unknown)

Overview

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

Service Description

The operations for managing an Amazon MSK cluster.

Sending a Request Using Kafka

var kafka = new AWS.Kafka();
kafka.createCluster(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 Kafka object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kafka = new AWS.Kafka({apiVersion: '2018-11-14'});

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

AWS.config.apiVersions = {
  kafka: '2018-11-14',
  // other service API versions
};

var kafka = new AWS.Kafka();

Version:

  • 2018-11-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.Kafka(options = {}) ⇒ Object

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

Examples:

Constructing a Kafka object

var kafka = new AWS.Kafka({apiVersion: '2018-11-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)

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

  • 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.Kafka.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Kafka.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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

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

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

Creates a new MSK cluster.

Service Reference:

Examples:

Calling the createCluster operation

var params = {
  BrokerNodeGroupInfo: { /* required */
    ClientSubnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    InstanceType: 'STRING_VALUE', /* required */
    BrokerAZDistribution: DEFAULT,
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    StorageInfo: {
      EbsStorageInfo: {
        VolumeSize: 'NUMBER_VALUE'
      }
    }
  },
  ClusterName: 'STRING_VALUE', /* required */
  KafkaVersion: 'STRING_VALUE', /* required */
  NumberOfBrokerNodes: 'NUMBER_VALUE', /* required */
  EncryptionInfo: {
    EncryptionAtRest: {
      DataVolumeKMSKeyId: 'STRING_VALUE' /* required */
    }
  },
  EnhancedMonitoring: DEFAULT | PER_BROKER | PER_TOPIC_PER_BROKER
};
kafka.createCluster(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: {})
    • BrokerNodeGroupInfo — (map)

      Information about the broker nodes in the cluster.

      • BrokerAZDistribution — (String)

        The distribution of broker nodes across Availability Zones.

        Possible values include:
        • "DEFAULT"
      • ClientSubnetsrequired — (Array<String>)

        The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

      • InstanceTyperequired — (String)

        The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

      • SecurityGroups — (Array<String>)

        The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.

      • StorageInfo — (map)

        Contains information about storage volumes attached to MSK broker nodes.

        • EbsStorageInfo — (map)

          EBS volume information.

          • VolumeSize — (Integer)

            The size in GiB of the EBS volume for the data drive on each broker node.

    • ClusterName — (String)

      The name of the cluster.

    • EncryptionInfo — (map)

      Includes all encryption-related information.

      • EncryptionAtRest — (map)

        The data volume encryption details.

        • DataVolumeKMSKeyIdrequired — (String)

          The AWS KMS key used for data encryption.

    • EnhancedMonitoring — (String)

      Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

      Possible values include:
      • "DEFAULT"
      • "PER_BROKER"
      • "PER_TOPIC_PER_BROKER"
    • KafkaVersion — (String)

      The version of Apache Kafka.

    • NumberOfBrokerNodes — (Integer)

      The number of Kafka broker nodes in the Amazon MSK cluster.

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:

      • ClusterArn — (String)

        The Amazon Resource Name (ARN) of the cluster.

      • ClusterName — (String)

        The name of the MSK cluster.

      • State — (String)

        The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

Service Reference:

Examples:

Calling the deleteCluster operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE'
};
kafka.deleteCluster(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: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    • CurrentVersion — (String)

      The current version of the MSK cluster.

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:

      • ClusterArn — (String)

        The Amazon Resource Name (ARN) of the cluster.

      • State — (String)

        The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

        Possible values include:
        • "ACTIVE"
        • "CREATING"
        • "DELETING"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

Service Reference:

Examples:

Calling the describeCluster operation

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
kafka.describeCluster(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: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

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:

      • ClusterInfo — (map)

        The cluster information.

        • BrokerNodeGroupInfo — (map)

          Information about the broker nodes.

          • BrokerAZDistribution — (String)

            The distribution of broker nodes across Availability Zones.

            Possible values include:
            • "DEFAULT"
          • ClientSubnetsrequired — (Array<String>)

            The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

          • InstanceTyperequired — (String)

            The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

          • SecurityGroups — (Array<String>)

            The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.

          • StorageInfo — (map)

            Contains information about storage volumes attached to MSK broker nodes.

            • EbsStorageInfo — (map)

              EBS volume information.

              • VolumeSize — (Integer)

                The size in GiB of the EBS volume for the data drive on each broker node.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • ClusterName — (String)

          The name of the cluster.

        • CreationTime — (Date)

          The time when the cluster was created.

        • CurrentBrokerSoftwareInfo — (map)

          Information about the version of software currently deployed on the Kafka brokers in the cluster.

          • ConfigurationArn — (String)

            The Amazon Resource Name (ARN) of the configuration used for the cluster.

          • ConfigurationRevision — (String)

            The revision of the configuration to use.

          • KafkaVersion — (String)

            The version of Apache Kafka.

        • CurrentVersion — (String)

          The current version of the MSK cluster.

        • EncryptionInfo — (map)

          Includes all encryption-related information.

          • EncryptionAtRest — (map)

            The data volume encryption details.

            • DataVolumeKMSKeyIdrequired — (String)

              The AWS KMS key used for data encryption.

        • EnhancedMonitoring — (String)

          Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

          Possible values include:
          • "DEFAULT"
          • "PER_BROKER"
          • "PER_TOPIC_PER_BROKER"
        • NumberOfBrokerNodes — (Integer)

          The number of Kafka broker nodes in the cluster.

        • State — (String)

          The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

          Possible values include:
          • "ACTIVE"
          • "CREATING"
          • "DELETING"
          • "FAILED"
        • ZookeeperConnectString — (String)

          The connection string to use to connect to the Apache ZooKeeper cluster.

Returns:

  • (AWS.Request)

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

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

A list of brokers that a client application can use to bootstrap.

Service Reference:

Examples:

Calling the getBootstrapBrokers operation

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
kafka.getBootstrapBrokers(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: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

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:

      • BootstrapBrokerString — (String)

        A string containing one or more hostname:port pairs.

Returns:

  • (AWS.Request)

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

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

Returns a list of clusters in an account.

Service Reference:

Examples:

Calling the listClusters operation

var params = {
  ClusterNameFilter: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listClusters(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: {})
    • ClusterNameFilter — (String)

      Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

    • MaxResults — (Integer)

      The maximum number of clusters to return in the response. If there are more clusters, the response includes a NextToken parameter.

    • NextToken — (String)

      The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

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:

      • ClusterInfoList — (Array<map>)

        Information on each of the MSK clusters in the response.

        • BrokerNodeGroupInfo — (map)

          Information about the broker nodes.

          • BrokerAZDistribution — (String)

            The distribution of broker nodes across Availability Zones.

            Possible values include:
            • "DEFAULT"
          • ClientSubnetsrequired — (Array<String>)

            The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

          • InstanceTyperequired — (String)

            The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

          • SecurityGroups — (Array<String>)

            The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster.

          • StorageInfo — (map)

            Contains information about storage volumes attached to MSK broker nodes.

            • EbsStorageInfo — (map)

              EBS volume information.

              • VolumeSize — (Integer)

                The size in GiB of the EBS volume for the data drive on each broker node.

        • ClusterArn — (String)

          The Amazon Resource Name (ARN) that uniquely identifies the cluster.

        • ClusterName — (String)

          The name of the cluster.

        • CreationTime — (Date)

          The time when the cluster was created.

        • CurrentBrokerSoftwareInfo — (map)

          Information about the version of software currently deployed on the Kafka brokers in the cluster.

          • ConfigurationArn — (String)

            The Amazon Resource Name (ARN) of the configuration used for the cluster.

          • ConfigurationRevision — (String)

            The revision of the configuration to use.

          • KafkaVersion — (String)

            The version of Apache Kafka.

        • CurrentVersion — (String)

          The current version of the MSK cluster.

        • EncryptionInfo — (map)

          Includes all encryption-related information.

          • EncryptionAtRest — (map)

            The data volume encryption details.

            • DataVolumeKMSKeyIdrequired — (String)

              The AWS KMS key used for data encryption.

        • EnhancedMonitoring — (String)

          Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

          Possible values include:
          • "DEFAULT"
          • "PER_BROKER"
          • "PER_TOPIC_PER_BROKER"
        • NumberOfBrokerNodes — (Integer)

          The number of Kafka broker nodes in the cluster.

        • State — (String)

          The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

          Possible values include:
          • "ACTIVE"
          • "CREATING"
          • "DELETING"
          • "FAILED"
        • ZookeeperConnectString — (String)

          The connection string to use to connect to the Apache ZooKeeper cluster.

      • NextToken — (String)

        The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

Returns:

  • (AWS.Request)

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

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

Returns a list of the broker nodes in the cluster.

Service Reference:

Examples:

Calling the listNodes operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listNodes(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: {})
    • ClusterArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the cluster.

    • MaxResults — (Integer)

      The maximum number of clusters to return in the response. If there are more clusters, the response includes a NextToken parameter.

    • NextToken — (String)

      The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

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)

        The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request.

      • NodeInfoList — (Array<map>)

        List containing a NodeInfo object.

        • AddedToClusterTime — (String)

          The start time.

        • BrokerNodeInfo — (map)

          The broker node info.

          • AttachedENIId — (String)

            The attached elastic network interface of the broker.

          • BrokerId — (Float)

            The ID of the broker.

          • ClientSubnet — (String)

            The client subnet to which this broker node belongs.

          • ClientVpcIpAddress — (String)

            The virtual private cloud (VPC) of the client.

          • CurrentBrokerSoftwareInfo — (map)

            Information about the version of software currently deployed on the Kafka brokers in the cluster.

            • ConfigurationArn — (String)

              The Amazon Resource Name (ARN) of the configuration used for the cluster.

            • ConfigurationRevision — (String)

              The revision of the configuration to use.

            • KafkaVersion — (String)

              The version of Apache Kafka.

        • InstanceType — (String)

          The instance type.

        • NodeARN — (String)

          The Amazon Resource Name (ARN) of the node.

        • NodeType — (String)

          The node type.

          Possible values include:
          • "BROKER"
        • ZookeeperNodeInfo — (map)

          The ZookeeperNodeInfo.

          • AttachedENIId — (String)

            The attached elastic network interface of the broker.

          • ClientVpcIpAddress — (String)

            The virtual private cloud (VPC) IP address of the client.

          • ZookeeperId — (Float)

            The role-specific ID for Zookeeper.

          • ZookeeperVersion — (String)

            The version of Zookeeper.

Returns:

  • (AWS.Request)

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

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

Returns a list of tags attached to a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
kafka.listTagsForResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the resource.

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:

      • Tags — (map<String>)

        The key-value pairs for the resource tags

Returns:

  • (AWS.Request)

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

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

Tag a resource with given tags.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
kafka.tagResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the resource.

    • Tags — (map<String>)

      The key-value pairs for the resource tags

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.

Returns:

  • (AWS.Request)

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

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

Remove tags of a resource by given tag keys.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kafka.untagResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that uniquely identifies the resource.

    • TagKeys — (Array<String>)

      The list of tag keys.

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.

Returns:

  • (AWS.Request)

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