We announced the upcoming end-of-support for AWS SDK for JavaScript v2.

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

Class: AWS.Kafka

Inherits:

AWS.Service

Object
AWS.Service
AWS.Kafka

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.batchAssociateScramSecret(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

new AWS.Kafka(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

batchAssociateScramSecret(params = {}, callback) ⇒ AWS.Request
Associates one or more Scram Secrets with an Amazon MSK cluster.

.
batchDisassociateScramSecret(params = {}, callback) ⇒ AWS.Request
Disassociates one or more Scram Secrets from an Amazon MSK cluster.

.
createCluster(params = {}, callback) ⇒ AWS.Request
Creates a new MSK cluster.

.
createClusterV2(params = {}, callback) ⇒ AWS.Request
Creates a new MSK cluster.

.
createConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a new MSK configuration.

.
createReplicator(params = {}, callback) ⇒ AWS.Request
Creates the replicator.

.
createVpcConnection(params = {}, callback) ⇒ AWS.Request
Creates a new MSK VPC connection.

.
deleteCluster(params = {}, callback) ⇒ AWS.Request
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

.
deleteClusterPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

.
deleteConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes an MSK Configuration.

.
deleteReplicator(params = {}, callback) ⇒ AWS.Request
Deletes a replicator.

.
deleteVpcConnection(params = {}, callback) ⇒ AWS.Request
Deletes a MSK VPC connection.

.
describeCluster(params = {}, callback) ⇒ AWS.Request
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

.
describeClusterOperation(params = {}, callback) ⇒ AWS.Request
Returns a description of the cluster operation specified by the ARN.

.
describeClusterOperationV2(params = {}, callback) ⇒ AWS.Request
Returns a description of the cluster operation specified by the ARN.

.
describeClusterV2(params = {}, callback) ⇒ AWS.Request
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

.
describeConfiguration(params = {}, callback) ⇒ AWS.Request
Returns a description of this MSK configuration.

.
describeConfigurationRevision(params = {}, callback) ⇒ AWS.Request
Returns a description of this revision of the configuration.

.
describeReplicator(params = {}, callback) ⇒ AWS.Request
Describes a replicator.

.
describeVpcConnection(params = {}, callback) ⇒ AWS.Request
Returns a description of this MSK VPC connection.

.
getBootstrapBrokers(params = {}, callback) ⇒ AWS.Request
A list of brokers that a client application can use to bootstrap.

.
getClusterPolicy(params = {}, callback) ⇒ AWS.Request
Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.

.
getCompatibleKafkaVersions(params = {}, callback) ⇒ AWS.Request
Gets the Apache Kafka versions to which you can update the MSK cluster.

.
listClientVpcConnections(params = {}, callback) ⇒ AWS.Request
Returns a list of all the VPC connections in this Region.

.
listClusterOperations(params = {}, callback) ⇒ AWS.Request
Returns a list of all the operations that have been performed on the specified MSK cluster.

.
listClusterOperationsV2(params = {}, callback) ⇒ AWS.Request
Returns a list of all the operations that have been performed on the specified MSK cluster.

.
listClusters(params = {}, callback) ⇒ AWS.Request
Returns a list of all the MSK clusters in the current Region.

.
listClustersV2(params = {}, callback) ⇒ AWS.Request
Returns a list of all the MSK clusters in the current Region.

.
listConfigurationRevisions(params = {}, callback) ⇒ AWS.Request
Returns a list of all the MSK configurations in this Region.

.
listConfigurations(params = {}, callback) ⇒ AWS.Request
Returns a list of all the MSK configurations in this Region.

.
listKafkaVersions(params = {}, callback) ⇒ AWS.Request
Returns a list of Apache Kafka versions.

.
listNodes(params = {}, callback) ⇒ AWS.Request
Returns a list of the broker nodes in the cluster.

.
listReplicators(params = {}, callback) ⇒ AWS.Request
Lists the replicators.

.
listScramSecrets(params = {}, callback) ⇒ AWS.Request
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns a list of the tags associated with the specified resource.

.
listVpcConnections(params = {}, callback) ⇒ AWS.Request
Returns a list of all the VPC connections in this Region.

.
putClusterPolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

.
rebootBroker(params = {}, callback) ⇒ AWS.Request
Reboots brokers.
rejectClientVpcConnection(params = {}, callback) ⇒ AWS.Request
Returns empty response.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds tags to the specified MSK resource.

.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes the tags associated with the keys that are provided in the query.

.
updateBrokerCount(params = {}, callback) ⇒ AWS.Request
Updates the number of broker nodes in the cluster.

.
updateBrokerStorage(params = {}, callback) ⇒ AWS.Request
Updates the EBS storage associated with MSK brokers.

.
updateBrokerType(params = {}, callback) ⇒ AWS.Request
Updates EC2 instance type.

.
updateClusterConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the cluster with the configuration that is specified in the request body.

.
updateClusterKafkaVersion(params = {}, callback) ⇒ AWS.Request
Updates the Apache Kafka version for the cluster.

.
updateConfiguration(params = {}, callback) ⇒ AWS.Request
Updates an MSK configuration.

.
updateConnectivity(params = {}, callback) ⇒ AWS.Request
Updates the cluster's connectivity configuration.

.
updateMonitoring(params = {}, callback) ⇒ AWS.Request
Updates the monitoring settings for the cluster.
updateReplicationInfo(params = {}, callback) ⇒ AWS.Request
Updates replication info of a replicator.

.
updateSecurity(params = {}, callback) ⇒ AWS.Request
Updates the security settings for the cluster.
updateStorage(params = {}, callback) ⇒ AWS.Request
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

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

endpoint ⇒ `AWS.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

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

Associates one or more Scram Secrets with an Amazon MSK cluster.

Service Reference:

BatchAssociateScramSecret

Examples:

Calling the batchAssociateScramSecret operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  SecretArnList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kafka.batchAssociateScramSecret(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) of the cluster to be updated.
- SecretArnList — (Array<String>)
  List of AWS Secrets Manager secret ARNs.

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.
  - UnprocessedScramSecrets — (Array<map>)
    List of errors when associating secrets to cluster.
    
    ErrorCode — (String)
    Error code for associate/disassociate failure.
    
    ErrorMessage — (String)
    Error message for associate/disassociate failure.
    
    SecretArn — (String)
    AWS Secrets Manager secret ARN.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

Service Reference:

BatchDisassociateScramSecret

Examples:

Calling the batchDisassociateScramSecret operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  SecretArnList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kafka.batchDisassociateScramSecret(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) of the cluster to be updated.
- SecretArnList — (Array<String>)
  List of AWS Secrets Manager secret ARNs.

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.
  - UnprocessedScramSecrets — (Array<map>)
    List of errors when disassociating secrets to cluster.
    
    ErrorCode — (String)
    Error code for associate/disassociate failure.
    
    ErrorMessage — (String)
    Error message for associate/disassociate failure.
    
    SecretArn — (String)
    AWS Secrets Manager secret ARN.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates a new MSK cluster.

Service Reference:

CreateCluster

Examples:

Calling the createCluster operation

var params = {
  BrokerNodeGroupInfo: { /* required */
    ClientSubnets: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    InstanceType: 'STRING_VALUE', /* required */
    BrokerAZDistribution: DEFAULT,
    ConnectivityInfo: {
      PublicAccess: {
        Type: 'STRING_VALUE'
      },
      VpcConnectivity: {
        ClientAuthentication: {
          Sasl: {
            Iam: {
              Enabled: true || false
            },
            Scram: {
              Enabled: true || false
            }
          },
          Tls: {
            Enabled: true || false
          }
        }
      }
    },
    SecurityGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    StorageInfo: {
      EbsStorageInfo: {
        ProvisionedThroughput: {
          Enabled: true || false,
          VolumeThroughput: 'NUMBER_VALUE'
        },
        VolumeSize: 'NUMBER_VALUE'
      }
    },
    ZoneIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ClusterName: 'STRING_VALUE', /* required */
  KafkaVersion: 'STRING_VALUE', /* required */
  NumberOfBrokerNodes: 'NUMBER_VALUE', /* required */
  ClientAuthentication: {
    Sasl: {
      Iam: {
        Enabled: true || false
      },
      Scram: {
        Enabled: true || false
      }
    },
    Tls: {
      CertificateAuthorityArnList: [
        'STRING_VALUE',
        /* more items */
      ],
      Enabled: true || false
    },
    Unauthenticated: {
      Enabled: true || false
    }
  },
  ConfigurationInfo: {
    Arn: 'STRING_VALUE', /* required */
    Revision: 'NUMBER_VALUE' /* required */
  },
  EncryptionInfo: {
    EncryptionAtRest: {
      DataVolumeKMSKeyId: 'STRING_VALUE' /* required */
    },
    EncryptionInTransit: {
      ClientBroker: TLS | TLS_PLAINTEXT | PLAINTEXT,
      InCluster: true || false
    }
  },
  EnhancedMonitoring: DEFAULT | PER_BROKER | PER_TOPIC_PER_BROKER | PER_TOPIC_PER_PARTITION,
  LoggingInfo: {
    BrokerLogs: { /* 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'
      }
    }
  },
  OpenMonitoring: {
    Prometheus: { /* required */
      JmxExporter: {
        EnabledInBroker: true || false /* required */
      },
      NodeExporter: {
        EnabledInBroker: true || false /* required */
      }
    }
  },
  StorageMode: LOCAL | TIERED,
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
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. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    Possible values include:
    - "DEFAULT"
  - ClientSubnets — required — (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 occupy the Availability Zone with ID use use1-az3.
  - InstanceType — required — (String)
    The type of Amazon EC2 instances to use for Apache 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
  - StorageInfo — (map)
    Contains information about storage volumes attached to MSK broker nodes.
    - EbsStorageInfo — (map)
      EBS volume information.
      
      ProvisionedThroughput — (map)
      EBS volume provisioned throughput information.
      
      Enabled — (Boolean)
      Provisioned throughput is enabled or not.
      
      VolumeThroughput — (Integer)
      Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
      
      VolumeSize — (Integer)
      The size in GiB of the EBS volume for the data drive on each broker node.
  - ConnectivityInfo — (map)
    Information about the broker access configuration.
    - PublicAccess — (map)
      Public access control for brokers.
      
      Type — (String)
      The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    - VpcConnectivity — (map)
      VPC connectivity access control for brokers.
      
      ClientAuthentication — (map)
      Includes all client authentication information for VPC connectivity.
      
      Sasl — (map)
      SASL authentication type details for VPC connectivity.
      
      Scram — (map)
      Details for SASL/SCRAM client authentication for VPC connectivity.
      
      Enabled — (Boolean)
      SASL/SCRAM authentication is on or off for VPC connectivity.
      
      Iam — (map)
      Details for SASL/IAM client authentication for VPC connectivity.
      
      Enabled — (Boolean)
      SASL/IAM authentication is on or off for VPC connectivity.
      
      Tls — (map)
      TLS authentication type details for VPC connectivity.
      
      Enabled — (Boolean)
      TLS authentication is on or off for VPC connectivity.
  - ZoneIds — (Array<String>)
    The list of zoneIds for the cluster in the virtual private cloud (VPC).
- ClientAuthentication — (map)
  Includes all client authentication related information.
  - Sasl — (map)
    Details for ClientAuthentication using SASL.
    - Scram — (map)
      Details for SASL/SCRAM client authentication.
      
      Enabled — (Boolean)
      SASL/SCRAM authentication is enabled or not.
    - Iam — (map)
      Indicates whether IAM access control is enabled.
      
      Enabled — (Boolean)
      Indicates whether IAM access control is enabled.
  - Tls — (map)
    Details for ClientAuthentication using TLS.
    - CertificateAuthorityArnList — (Array<String>)
      List of ACM Certificate Authority ARNs.
    - Enabled — (Boolean)
      Specifies whether you want to turn on or turn off TLS authentication.
  - Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    - Enabled — (Boolean)
      Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
- ClusterName — (String)
  The name of the cluster.
- ConfigurationInfo — (map)
  Represents the configuration that you want MSK to use for the brokers in a cluster.
  - Arn — required — (String)
    ARN of the configuration to use.
  - Revision — required — (Integer)
    The revision of the configuration to use.
- EncryptionInfo — (map)
  Includes all encryption-related information.
  - EncryptionAtRest — (map)
    The data-volume encryption details.
    - DataVolumeKMSKeyId — required — (String)
      The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
  - EncryptionInTransit — (map)
    The details for encryption in transit.
    - ClientBroker — (String)
      Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
      
      TLS means that client-broker communication is enabled with TLS only.
      
      TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
      
      PLAINTEXT means that client-broker communication is enabled in plaintext only.
      
      The default value is TLS_PLAINTEXT.
      Possible values include:
      
      "TLS"
      
      "TLS_PLAINTEXT"
      
      "PLAINTEXT"
    - InCluster — (Boolean)
      When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
      
      The default value is true.
- EnhancedMonitoring — (String)
  Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
  Possible values include:
  - "DEFAULT"
  - "PER_BROKER"
  - "PER_TOPIC_PER_BROKER"
  - "PER_TOPIC_PER_PARTITION"
- OpenMonitoring — (map)
  The settings for open monitoring.
  - Prometheus — required — (map)
    Prometheus settings.
    - JmxExporter — (map)
      Indicates whether you want to turn on or turn off the JMX Exporter.
      
      EnabledInBroker — required — (Boolean)
      Indicates whether you want to turn on or turn off the JMX Exporter.
    - NodeExporter — (map)
      Indicates whether you want to turn on or turn off the Node Exporter.
      
      EnabledInBroker — required — (Boolean)
      Indicates whether you want to turn on or turn off the Node Exporter.
- KafkaVersion — (String)
  The version of Apache Kafka.
- LoggingInfo — (map)
  - BrokerLogs — required — (map)
    - CloudWatchLogs — (map)
      
      Enabled — required — (Boolean)
      
      LogGroup — (String)
    - Firehose — (map)
      
      DeliveryStream — (String)
      
      Enabled — required — (Boolean)
    - S3 — (map)
      
      Bucket — (String)
      
      Enabled — required — (Boolean)
      
      Prefix — (String)
- NumberOfBrokerNodes — (Integer)
  The number of broker nodes in the cluster.
- Tags — (map<String>)
  Create tags when creating the cluster.
- StorageMode — (String)
  This controls storage mode for supported storage tiers.
  Possible values include:
  - "LOCAL"
  - "TIERED"

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 ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates a new MSK cluster.

Service Reference:

CreateClusterV2

Examples:

Calling the createClusterV2 operation

var params = {
  ClusterName: 'STRING_VALUE', /* required */
  Provisioned: {
    BrokerNodeGroupInfo: { /* required */
      ClientSubnets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      InstanceType: 'STRING_VALUE', /* required */
      BrokerAZDistribution: DEFAULT,
      ConnectivityInfo: {
        PublicAccess: {
          Type: 'STRING_VALUE'
        },
        VpcConnectivity: {
          ClientAuthentication: {
            Sasl: {
              Iam: {
                Enabled: true || false
              },
              Scram: {
                Enabled: true || false
              }
            },
            Tls: {
              Enabled: true || false
            }
          }
        }
      },
      SecurityGroups: [
        'STRING_VALUE',
        /* more items */
      ],
      StorageInfo: {
        EbsStorageInfo: {
          ProvisionedThroughput: {
            Enabled: true || false,
            VolumeThroughput: 'NUMBER_VALUE'
          },
          VolumeSize: 'NUMBER_VALUE'
        }
      },
      ZoneIds: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    KafkaVersion: 'STRING_VALUE', /* required */
    NumberOfBrokerNodes: 'NUMBER_VALUE', /* required */
    ClientAuthentication: {
      Sasl: {
        Iam: {
          Enabled: true || false
        },
        Scram: {
          Enabled: true || false
        }
      },
      Tls: {
        CertificateAuthorityArnList: [
          'STRING_VALUE',
          /* more items */
        ],
        Enabled: true || false
      },
      Unauthenticated: {
        Enabled: true || false
      }
    },
    ConfigurationInfo: {
      Arn: 'STRING_VALUE', /* required */
      Revision: 'NUMBER_VALUE' /* required */
    },
    EncryptionInfo: {
      EncryptionAtRest: {
        DataVolumeKMSKeyId: 'STRING_VALUE' /* required */
      },
      EncryptionInTransit: {
        ClientBroker: TLS | TLS_PLAINTEXT | PLAINTEXT,
        InCluster: true || false
      }
    },
    EnhancedMonitoring: DEFAULT | PER_BROKER | PER_TOPIC_PER_BROKER | PER_TOPIC_PER_PARTITION,
    LoggingInfo: {
      BrokerLogs: { /* 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'
        }
      }
    },
    OpenMonitoring: {
      Prometheus: { /* required */
        JmxExporter: {
          EnabledInBroker: true || false /* required */
        },
        NodeExporter: {
          EnabledInBroker: true || false /* required */
        }
      }
    },
    StorageMode: LOCAL | TIERED
  },
  Serverless: {
    VpcConfigs: [ /* required */
      {
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SecurityGroupIds: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    ClientAuthentication: {
      Sasl: {
        Iam: {
          Enabled: true || false
        }
      }
    }
  },
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
kafka.createClusterV2(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: {}) —
- ClusterName — (String)
  The name of the cluster.
- Tags — (map<String>)
  A map of tags that you want the cluster to have.
- Provisioned — (map)
  Information about the provisioned cluster.
  - BrokerNodeGroupInfo — required — (map)
    Information about the brokers.
    - BrokerAZDistribution — (String)
      The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
      
      Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
      Possible values include:
      
      "DEFAULT"
    - ClientSubnets — required — (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 occupy the Availability Zone with ID use use1-az3.
    - InstanceType — required — (String)
      The type of Amazon EC2 instances to use for Apache 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
    - StorageInfo — (map)
      Contains information about storage volumes attached to MSK broker nodes.
      
      EbsStorageInfo — (map)
      EBS volume information.
      
      ProvisionedThroughput — (map)
      EBS volume provisioned throughput information.
      
      Enabled — (Boolean)
      Provisioned throughput is enabled or not.
      
      VolumeThroughput — (Integer)
      Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
      
      VolumeSize — (Integer)
      The size in GiB of the EBS volume for the data drive on each broker node.
    - ConnectivityInfo — (map)
      Information about the broker access configuration.
      
      PublicAccess — (map)
      Public access control for brokers.
      
      Type — (String)
      The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
      
      VpcConnectivity — (map)
      VPC connectivity access control for brokers.
      
      ClientAuthentication — (map)
      Includes all client authentication information for VPC connectivity.
      
      Sasl — (map)
      SASL authentication type details for VPC connectivity.
      
      Scram — (map)
      Details for SASL/SCRAM client authentication for VPC connectivity.
      
      Enabled — (Boolean)
      SASL/SCRAM authentication is on or off for VPC connectivity.
      
      Iam — (map)
      Details for SASL/IAM client authentication for VPC connectivity.
      
      Enabled — (Boolean)
      SASL/IAM authentication is on or off for VPC connectivity.
      
      Tls — (map)
      TLS authentication type details for VPC connectivity.
      
      Enabled — (Boolean)
      TLS authentication is on or off for VPC connectivity.
    - ZoneIds — (Array<String>)
      The list of zoneIds for the cluster in the virtual private cloud (VPC).
  - ClientAuthentication — (map)
    Includes all client authentication information.
    - Sasl — (map)
      Details for ClientAuthentication using SASL.
      
      Scram — (map)
      Details for SASL/SCRAM client authentication.
      
      Enabled — (Boolean)
      SASL/SCRAM authentication is enabled or not.
      
      Iam — (map)
      Indicates whether IAM access control is enabled.
      
      Enabled — (Boolean)
      Indicates whether IAM access control is enabled.
    - Tls — (map)
      Details for ClientAuthentication using TLS.
      
      CertificateAuthorityArnList — (Array<String>)
      List of ACM Certificate Authority ARNs.
      
      Enabled — (Boolean)
      Specifies whether you want to turn on or turn off TLS authentication.
    - Unauthenticated — (map)
      Contains information about unauthenticated traffic to the cluster.
      
      Enabled — (Boolean)
      Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
  - ConfigurationInfo — (map)
    Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.
    - Arn — required — (String)
      ARN of the configuration to use.
    - Revision — required — (Integer)
      The revision of the configuration to use.
  - EncryptionInfo — (map)
    Includes all encryption-related information.
    - EncryptionAtRest — (map)
      The data-volume encryption details.
      
      DataVolumeKMSKeyId — required — (String)
      The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    - EncryptionInTransit — (map)
      The details for encryption in transit.
      
      ClientBroker — (String)
      Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
      
      TLS means that client-broker communication is enabled with TLS only.
      
      TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
      
      PLAINTEXT means that client-broker communication is enabled in plaintext only.
      
      The default value is TLS_PLAINTEXT.
      Possible values include:
      
      "TLS"
      
      "TLS_PLAINTEXT"
      
      "PLAINTEXT"
      
      InCluster — (Boolean)
      When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
      
      The default value is true.
  - EnhancedMonitoring — (String)
    Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
    Possible values include:
    - "DEFAULT"
    - "PER_BROKER"
    - "PER_TOPIC_PER_BROKER"
    - "PER_TOPIC_PER_PARTITION"
  - OpenMonitoring — (map)
    The settings for open monitoring.
    - Prometheus — required — (map)
      Prometheus settings.
      
      JmxExporter — (map)
      Indicates whether you want to turn on or turn off the JMX Exporter.
      
      EnabledInBroker — required — (Boolean)
      Indicates whether you want to turn on or turn off the JMX Exporter.
      
      NodeExporter — (map)
      Indicates whether you want to turn on or turn off the Node Exporter.
      
      EnabledInBroker — required — (Boolean)
      Indicates whether you want to turn on or turn off the Node Exporter.
  - KafkaVersion — required — (String)
    The Apache Kafka version that you want for the cluster.
  - LoggingInfo — (map)
    Log delivery information for the cluster.
    - BrokerLogs — required — (map)
      
      CloudWatchLogs — (map)
      
      Enabled — required — (Boolean)
      
      LogGroup — (String)
      
      Firehose — (map)
      
      DeliveryStream — (String)
      
      Enabled — required — (Boolean)
      
      S3 — (map)
      
      Bucket — (String)
      
      Enabled — required — (Boolean)
      
      Prefix — (String)
  - NumberOfBrokerNodes — required — (Integer)
    The number of broker nodes in the cluster.
  - StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    - "LOCAL"
    - "TIERED"
- Serverless — (map)
  Information about the serverless cluster.
  - VpcConfigs — required — (Array<map>)
    The configuration of the Amazon VPCs for the cluster.
    - SubnetIds — required — (Array<String>)
      The IDs of the subnets associated with the cluster.
    - SecurityGroupIds — (Array<String>)
      The IDs of the security groups associated with the cluster.
  - ClientAuthentication — (map)
    Includes all client authentication information.
    - Sasl — (map)
      Details for ClientAuthentication using SASL.
      
      Iam — (map)
      Indicates whether IAM access control is enabled.
      
      Enabled — (Boolean)
      Indicates whether IAM access control is enabled.

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 ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"
  - ClusterType — (String)
    The type of the cluster. The possible states are PROVISIONED or SERVERLESS.
    Possible values include:
    
    "PROVISIONED"
    
    "SERVERLESS"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates a new MSK configuration.

Service Reference:

CreateConfiguration

Examples:

Calling the createConfiguration operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ServerProperties: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  Description: 'STRING_VALUE',
  KafkaVersions: [
    'STRING_VALUE',
    /* more items */
  ]
};
kafka.createConfiguration(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)
  The description of the configuration.
- KafkaVersions — (Array<String>)
  The versions of Apache Kafka with which you can use this MSK configuration.
- Name — (String)
  The name of the configuration.
- ServerProperties — (Buffer, Typed Array, Blob, String)
  Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

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:
  - Arn — (String)
    The Amazon Resource Name (ARN) of the configuration.
  - CreationTime — (Date)
    The time when the configuration was created.
  - LatestRevision — (map)
    Latest revision of the configuration.
    
    CreationTime — required — (Date)
    The time when the configuration revision was created.
    
    Description — (String)
    The description of the configuration revision.
    
    Revision — required — (Integer)
    The revision number.
  - Name — (String)
    The name of the configuration.
  - State — (String)
    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    Possible values include:
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETE_FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates the replicator.

Service Reference:

CreateReplicator

Examples:

Calling the createReplicator operation

var params = {
  KafkaClusters: [ /* required */
    {
      AmazonMskCluster: { /* required */
        MskClusterArn: 'STRING_VALUE' /* required */
      },
      VpcConfig: { /* required */
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SecurityGroupIds: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  ReplicationInfoList: [ /* required */
    {
      ConsumerGroupReplication: { /* required */
        ConsumerGroupsToReplicate: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        ConsumerGroupsToExclude: [
          'STRING_VALUE',
          /* more items */
        ],
        DetectAndCopyNewConsumerGroups: true || false,
        SynchroniseConsumerGroupOffsets: true || false
      },
      SourceKafkaClusterArn: 'STRING_VALUE', /* required */
      TargetCompressionType: NONE | GZIP | SNAPPY | LZ4 | ZSTD, /* required */
      TargetKafkaClusterArn: 'STRING_VALUE', /* required */
      TopicReplication: { /* required */
        TopicsToReplicate: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        CopyAccessControlListsForTopics: true || false,
        CopyTopicConfigurations: true || false,
        DetectAndCopyNewTopics: true || false,
        StartingPosition: {
          Type: LATEST | EARLIEST
        },
        TopicsToExclude: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  ReplicatorName: 'STRING_VALUE', /* required */
  ServiceExecutionRoleArn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
kafka.createReplicator(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 replicator.
- KafkaClusters — (Array<map>)
  Kafka Clusters to use in setting up sources / targets for replication.
  - AmazonMskCluster — required — (map)
    Details of an Amazon MSK Cluster.
    - MskClusterArn — required — (String)
      The Amazon Resource Name (ARN) of an Amazon MSK cluster.
  - VpcConfig — required — (map)
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    - SecurityGroupIds — (Array<String>)
      The security groups to attach to the ENIs for the broker nodes.
    - SubnetIds — required — (Array<String>)
      The list of subnets in the client VPC to connect to.
- ReplicationInfoList — (Array<map>)
  A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
  - ConsumerGroupReplication — required — (map)
    Configuration relating to consumer group replication.
    - ConsumerGroupsToExclude — (Array<String>)
      List of regular expression patterns indicating the consumer groups that should not be replicated.
    - ConsumerGroupsToReplicate — required — (Array<String>)
      List of regular expression patterns indicating the consumer groups to copy.
    - DetectAndCopyNewConsumerGroups — (Boolean)
      Enables synchronization of consumer groups to target cluster.
    - SynchroniseConsumerGroupOffsets — (Boolean)
      Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.
  - SourceKafkaClusterArn — required — (String)
    The ARN of the source Kafka cluster.
  - TargetCompressionType — required — (String)
    The compression type to use when producing records to target cluster.
    Possible values include:
    - "NONE"
    - "GZIP"
    - "SNAPPY"
    - "LZ4"
    - "ZSTD"
  - TargetKafkaClusterArn — required — (String)
    The ARN of the target Kafka cluster.
  - TopicReplication — required — (map)
    Configuration relating to topic replication.
    - CopyAccessControlListsForTopics — (Boolean)
      Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    - CopyTopicConfigurations — (Boolean)
      Whether to periodically configure remote topics to match their corresponding upstream topics.
    - DetectAndCopyNewTopics — (Boolean)
      Whether to periodically check for new topics and partitions.
    - StartingPosition — (map)
      Configuration for specifying the position in the topics to start replicating from.
      
      Type — (String)
      The type of replication starting position.
      Possible values include:
      
      "LATEST"
      
      "EARLIEST"
    - TopicsToExclude — (Array<String>)
      List of regular expression patterns indicating the topics that should not be replicated.
    - TopicsToReplicate — required — (Array<String>)
      List of regular expression patterns indicating the topics to copy.
- ReplicatorName — (String)
  The name of the replicator. Alpha-numeric characters with '-' are allowed.
- ServiceExecutionRoleArn — (String)
  The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)
- Tags — (map<String>)
  List of tags to attach to created Replicator.

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:
  - ReplicatorArn — (String)
    The Amazon Resource Name (ARN) of the replicator.
  - ReplicatorName — (String)
    Name of the replicator provided by the customer.
  - ReplicatorState — (String)
    State of the replicator.
    Possible values include:
    
    "RUNNING"
    
    "CREATING"
    
    "UPDATING"
    
    "DELETING"
    
    "FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates a new MSK VPC connection.

Service Reference:

CreateVpcConnection

Examples:

Calling the createVpcConnection operation

var params = {
  Authentication: 'STRING_VALUE', /* required */
  ClientSubnets: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  SecurityGroups: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TargetClusterArn: 'STRING_VALUE', /* required */
  VpcId: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
kafka.createVpcConnection(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: {}) —
- TargetClusterArn — (String)
  The cluster Amazon Resource Name (ARN) for the VPC connection.
- Authentication — (String)
  The authentication type of VPC connection.
- VpcId — (String)
  The VPC ID of VPC connection.
- ClientSubnets — (Array<String>)
  The list of client subnets.
- SecurityGroups — (Array<String>)
  The list of security groups.
- Tags — (map<String>)
  A map of tags for the VPC connection.

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:
  - VpcConnectionArn — (String)
    The VPC connection ARN.
  - State — (String)
    The State of Vpc Connection.
    Possible values include:
    
    "CREATING"
    
    "AVAILABLE"
    
    "INACTIVE"
    
    "DEACTIVATING"
    
    "DELETING"
    
    "FAILED"
    
    "REJECTED"
    
    "REJECTING"
  - Authentication — (String)
    The authentication type of VPC connection.
  - VpcId — (String)
    The VPC ID of the VPC connection.
  - ClientSubnets — (Array<String>)
    The list of client subnets.
  - SecurityGroups — (Array<String>)
    The list of security groups.
  - CreationTime — (Date)
    The creation time of VPC connection.
  - Tags — (map<String>)
    A map of tags for the VPC connection.

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:

DeleteCluster

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 ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

DeleteClusterPolicy

Examples:

Calling the deleteClusterPolicy operation

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

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Deletes an MSK Configuration.

Service Reference:

DeleteConfiguration

Examples:

Calling the deleteConfiguration operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
kafka.deleteConfiguration(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies an MSK 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:
  - Arn — (String)
    The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
  - State — (String)
    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    Possible values include:
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETE_FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Deletes a replicator.

Service Reference:

DeleteReplicator

Examples:

Calling the deleteReplicator operation

var params = {
  ReplicatorArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE'
};
kafka.deleteReplicator(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: {}) —
- CurrentVersion — (String)
  The current version of the replicator.
- ReplicatorArn — (String)
  The Amazon Resource Name (ARN) of the replicator to be deleted.

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:
  - ReplicatorArn — (String)
    The Amazon Resource Name (ARN) of the replicator.
  - ReplicatorState — (String)
    The state of the replicator.
    Possible values include:
    
    "RUNNING"
    
    "CREATING"
    
    "UPDATING"
    
    "DELETING"
    
    "FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Deletes a MSK VPC connection.

Service Reference:

DeleteVpcConnection

Examples:

Calling the deleteVpcConnection operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
kafka.deleteVpcConnection(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.

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:
  - VpcConnectionArn — (String)
    The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.
  - State — (String)
    The state of the VPC connection.
    Possible values include:
    
    "CREATING"
    
    "AVAILABLE"
    
    "INACTIVE"
    
    "DEACTIVATING"
    
    "DELETING"
    
    "FAILED"
    
    "REJECTED"
    
    "REJECTING"

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:

DescribeCluster

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.
    
    ActiveOperationArn — (String)
    Arn of active cluster operation.
    
    BrokerNodeGroupInfo — (map)
    Information about the broker nodes.
    
    BrokerAZDistribution — (String)
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    Possible values include:
    
    "DEFAULT"
    
    ClientSubnets — required — (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 occupy the Availability Zone with ID use use1-az3.
    
    InstanceType — required — (String)
    The type of Amazon EC2 instances to use for Apache 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
    
    StorageInfo — (map)
    Contains information about storage volumes attached to MSK broker nodes.
    
    EbsStorageInfo — (map)
    EBS volume information.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSize — (Integer)
    The size in GiB of the EBS volume for the data drive on each broker node.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    ZoneIds — (Array<String>)
    The list of zoneIds for the cluster in the virtual private cloud (VPC).
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    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 Apache Kafka brokers in the cluster.
    
    ConfigurationArn — (String)
    The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
    
    ConfigurationRevision — (Integer)
    The revision of the configuration to use. This field isn't visible in this preview release.
    
    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.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    EnhancedMonitoring — (String)
    Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    Settings for open monitoring using Prometheus.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    LoggingInfo — (map)
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    State — (String)
    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"
    
    StateInfo — (map)
    
    Code — (String)
    
    Message — (String)
    
    Tags — (map<String>)
    Tags attached to the cluster.
    
    ZookeeperConnectString — (String)
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    ZookeeperConnectStringTls — (String)
    The connection string to use to connect to zookeeper cluster on Tls port.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    CustomerActionStatus — (String)
    Determines if there is an action required from the customer.
    Possible values include:
    
    "CRITICAL_ACTION_REQUIRED"
    
    "ACTION_RECOMMENDED"
    
    "NONE"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a description of the cluster operation specified by the ARN.

Service Reference:

DescribeClusterOperation

Examples:

Calling the describeClusterOperation operation

var params = {
  ClusterOperationArn: 'STRING_VALUE' /* required */
};
kafka.describeClusterOperation(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: {}) —
- ClusterOperationArn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

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:
  - ClusterOperationInfo — (map)
    Cluster operation information
    
    ClientRequestId — (String)
    The ID of the API request that triggered this operation.
    
    ClusterArn — (String)
    ARN of the cluster.
    
    CreationTime — (Date)
    The time that the operation was created.
    
    EndTime — (Date)
    The time at which the operation finished.
    
    ErrorInfo — (map)
    Describes the error if the operation fails.
    
    ErrorCode — (String)
    A number describing the error programmatically.
    
    ErrorString — (String)
    An optional field to provide more details about the error.
    
    OperationArn — (String)
    ARN of the cluster operation.
    
    OperationState — (String)
    State of the cluster operation.
    
    OperationSteps — (Array<map>)
    Steps completed during the operation.
    
    StepInfo — (map)
    Information about the step and its status.
    
    StepStatus — (String)
    The steps current status.
    
    StepName — (String)
    The name of the step.
    
    OperationType — (String)
    Type of the cluster operation.
    
    SourceClusterInfo — (map)
    Information about cluster attributes before a cluster is updated.
    
    BrokerEBSVolumeInfo — (Array<map>)
    Specifies the size of the EBS volume and the ID of the associated broker.
    
    KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSizeGB — (Integer)
    Size of the EBS volume to update.
    
    ConfigurationInfo — (map)
    Information about the changes in the configuration of the brokers.
    
    Arn — required — (String)
    ARN of the configuration to use.
    
    Revision — required — (Integer)
    The revision of the configuration to use.
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    EnhancedMonitoring — (String)
    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    KafkaVersion — (String)
    The Apache Kafka version.
    
    LoggingInfo — (map)
    You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    InstanceType — (String)
    Information about the Amazon MSK broker type.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    BrokerCountUpdateInfo — (map)
    Describes brokers being changed during a broker count update.
    
    CreatedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being created.
    
    DeletedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being deleted.
    
    TargetClusterInfo — (map)
    Information about cluster attributes after a cluster is updated.
    
    BrokerEBSVolumeInfo — (Array<map>)
    Specifies the size of the EBS volume and the ID of the associated broker.
    
    KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSizeGB — (Integer)
    Size of the EBS volume to update.
    
    ConfigurationInfo — (map)
    Information about the changes in the configuration of the brokers.
    
    Arn — required — (String)
    ARN of the configuration to use.
    
    Revision — required — (Integer)
    The revision of the configuration to use.
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    EnhancedMonitoring — (String)
    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    KafkaVersion — (String)
    The Apache Kafka version.
    
    LoggingInfo — (map)
    You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    InstanceType — (String)
    Information about the Amazon MSK broker type.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    BrokerCountUpdateInfo — (map)
    Describes brokers being changed during a broker count update.
    
    CreatedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being created.
    
    DeletedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being deleted.
    
    VpcConnectionInfo — (map)
    Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
    
    VpcConnectionArn — (String)
    The Amazon Resource Name (ARN) of the VPC connection.
    
    Owner — (String)
    The owner of the VPC Connection.
    
    UserIdentity — (map)
    Description of the requester that calls the API operation.
    
    Type — (String)
    The identity type of the requester that calls the API operation.
    Possible values include:
    
    "AWSACCOUNT"
    
    "AWSSERVICE"
    
    PrincipalId — (String)
    A unique identifier for the requester that calls the API operation.
    
    CreationTime — (Date)
    The time when Amazon MSK creates the VPC Connnection.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a description of the cluster operation specified by the ARN.

Service Reference:

DescribeClusterOperationV2

Examples:

Calling the describeClusterOperationV2 operation

var params = {
  ClusterOperationArn: 'STRING_VALUE' /* required */
};
kafka.describeClusterOperationV2(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: {}) —
- ClusterOperationArn — (String) ARN of the cluster operation 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:
  - ClusterOperationInfo — (map)
    Cluster operation information
    
    ClusterArn — (String)
    ARN of the cluster.
    
    ClusterType — (String)
    Type of the backend cluster.
    Possible values include:
    
    "PROVISIONED"
    
    "SERVERLESS"
    
    StartTime — (Date)
    The time at which operation was started.
    
    EndTime — (Date)
    The time at which the operation finished.
    
    ErrorInfo — (map)
    If cluster operation failed from an error, it describes the error.
    
    ErrorCode — (String)
    A number describing the error programmatically.
    
    ErrorString — (String)
    An optional field to provide more details about the error.
    
    OperationArn — (String)
    ARN of the cluster operation.
    
    OperationState — (String)
    State of the cluster operation.
    
    OperationType — (String)
    Type of the cluster operation.
    
    Provisioned — (map)
    Properties of a provisioned cluster.
    
    OperationSteps — (Array<map>)
    Steps completed during the operation.
    
    StepInfo — (map)
    Information about the step and its status.
    
    StepStatus — (String)
    The steps current status.
    
    StepName — (String)
    The name of the step.
    
    SourceClusterInfo — (map)
    Information about cluster attributes before a cluster is updated.
    
    BrokerEBSVolumeInfo — (Array<map>)
    Specifies the size of the EBS volume and the ID of the associated broker.
    
    KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSizeGB — (Integer)
    Size of the EBS volume to update.
    
    ConfigurationInfo — (map)
    Information about the changes in the configuration of the brokers.
    
    Arn — required — (String)
    ARN of the configuration to use.
    
    Revision — required — (Integer)
    The revision of the configuration to use.
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    EnhancedMonitoring — (String)
    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    KafkaVersion — (String)
    The Apache Kafka version.
    
    LoggingInfo — (map)
    You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    InstanceType — (String)
    Information about the Amazon MSK broker type.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    BrokerCountUpdateInfo — (map)
    Describes brokers being changed during a broker count update.
    
    CreatedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being created.
    
    DeletedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being deleted.
    
    TargetClusterInfo — (map)
    Information about cluster attributes after a cluster is updated.
    
    BrokerEBSVolumeInfo — (Array<map>)
    Specifies the size of the EBS volume and the ID of the associated broker.
    
    KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSizeGB — (Integer)
    Size of the EBS volume to update.
    
    ConfigurationInfo — (map)
    Information about the changes in the configuration of the brokers.
    
    Arn — required — (String)
    ARN of the configuration to use.
    
    Revision — required — (Integer)
    The revision of the configuration to use.
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    EnhancedMonitoring — (String)
    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    KafkaVersion — (String)
    The Apache Kafka version.
    
    LoggingInfo — (map)
    You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    InstanceType — (String)
    Information about the Amazon MSK broker type.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    BrokerCountUpdateInfo — (map)
    Describes brokers being changed during a broker count update.
    
    CreatedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being created.
    
    DeletedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being deleted.
    
    VpcConnectionInfo — (map)
    Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
    
    VpcConnectionArn — (String)
    The Amazon Resource Name (ARN) of the VPC connection.
    
    Owner — (String)
    The owner of the VPC Connection.
    
    UserIdentity — (map)
    Description of the requester that calls the API operation.
    
    Type — (String)
    The identity type of the requester that calls the API operation.
    Possible values include:
    
    "AWSACCOUNT"
    
    "AWSSERVICE"
    
    PrincipalId — (String)
    A unique identifier for the requester that calls the API operation.
    
    CreationTime — (Date)
    The time when Amazon MSK creates the VPC Connnection.
    
    Serverless — (map)
    Properties of a serverless cluster.
    
    VpcConnectionInfo — (map)
    Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
    
    CreationTime — (Date)
    The time when Amazon MSK creates the VPC Connnection.
    
    Owner — (String)
    The owner of the VPC Connection.
    
    UserIdentity — (map)
    Description of the requester that calls the API operation.
    
    Type — (String)
    The identity type of the requester that calls the API operation.
    Possible values include:
    
    "AWSACCOUNT"
    
    "AWSSERVICE"
    
    PrincipalId — (String)
    A unique identifier for the requester that calls the API operation.
    
    VpcConnectionArn — (String)
    The Amazon Resource Name (ARN) of the VPC connection.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

DescribeClusterV2

Examples:

Calling the describeClusterV2 operation

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
kafka.describeClusterV2(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.
    
    ActiveOperationArn — (String)
    The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
    
    ClusterType — (String)
    Cluster Type.
    Possible values include:
    
    "PROVISIONED"
    
    "SERVERLESS"
    
    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.
    
    CurrentVersion — (String)
    The current version of the MSK cluster.
    
    State — (String)
    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"
    
    StateInfo — (map)
    State Info for the Amazon MSK cluster.
    
    Code — (String)
    
    Message — (String)
    
    Tags — (map<String>)
    Tags attached to the cluster.
    
    Provisioned — (map)
    Information about the provisioned cluster.
    
    BrokerNodeGroupInfo — required — (map)
    Information about the brokers.
    
    BrokerAZDistribution — (String)
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    Possible values include:
    
    "DEFAULT"
    
    ClientSubnets — required — (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 occupy the Availability Zone with ID use use1-az3.
    
    InstanceType — required — (String)
    The type of Amazon EC2 instances to use for Apache 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
    
    StorageInfo — (map)
    Contains information about storage volumes attached to MSK broker nodes.
    
    EbsStorageInfo — (map)
    EBS volume information.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSize — (Integer)
    The size in GiB of the EBS volume for the data drive on each broker node.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    ZoneIds — (Array<String>)
    The list of zoneIds for the cluster in the virtual private cloud (VPC).
    
    CurrentBrokerSoftwareInfo — (map)
    Information about the Apache Kafka version deployed on the brokers.
    
    ConfigurationArn — (String)
    The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
    
    ConfigurationRevision — (Integer)
    The revision of the configuration to use. This field isn't visible in this preview release.
    
    KafkaVersion — (String)
    The version of Apache Kafka.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    EnhancedMonitoring — (String)
    Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    LoggingInfo — (map)
    Log delivery information for the cluster.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    NumberOfBrokerNodes — required — (Integer)
    The number of broker nodes in the cluster.
    
    ZookeeperConnectString — (String)
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    ZookeeperConnectStringTls — (String)
    The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    CustomerActionStatus — (String)
    Determines if there is an action required from the customer.
    Possible values include:
    
    "CRITICAL_ACTION_REQUIRED"
    
    "ACTION_RECOMMENDED"
    
    "NONE"
    
    Serverless — (map)
    Information about the serverless cluster.
    
    VpcConfigs — required — (Array<map>)
    The configuration of the Amazon VPCs for the cluster.
    
    SubnetIds — required — (Array<String>)
    The IDs of the subnets associated with the cluster.
    
    SecurityGroupIds — (Array<String>)
    The IDs of the security groups associated with the cluster.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a description of this MSK configuration.

Service Reference:

DescribeConfiguration

Examples:

Calling the describeConfiguration operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
kafka.describeConfiguration(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

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:
  - Arn — (String)
    The Amazon Resource Name (ARN) of the configuration.
  - CreationTime — (Date)
    The time when the configuration was created.
  - Description — (String)
    The description of the configuration.
  - KafkaVersions — (Array<String>)
    The versions of Apache Kafka with which you can use this MSK configuration.
  - LatestRevision — (map)
    Latest revision of the configuration.
    
    CreationTime — required — (Date)
    The time when the configuration revision was created.
    
    Description — (String)
    The description of the configuration revision.
    
    Revision — required — (Integer)
    The revision number.
  - Name — (String)
    The name of the configuration.
  - State — (String)
    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    Possible values include:
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETE_FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a description of this revision of the configuration.

Service Reference:

DescribeConfigurationRevision

Examples:

Calling the describeConfigurationRevision operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  Revision: 'NUMBER_VALUE' /* required */
};
kafka.describeConfigurationRevision(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
- Revision — (Integer)
  A string that uniquely identifies a revision of an MSK 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:
  - Arn — (String)
    The Amazon Resource Name (ARN) of the configuration.
  - CreationTime — (Date)
    The time when the configuration was created.
  - Description — (String)
    The description of the configuration.
  - Revision — (Integer)
    The revision number.
  - ServerProperties — (Buffer(Node.js), Typed Array(Browser))
    Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Describes a replicator.

Service Reference:

DescribeReplicator

Examples:

Calling the describeReplicator operation

var params = {
  ReplicatorArn: 'STRING_VALUE' /* required */
};
kafka.describeReplicator(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: {}) —
- ReplicatorArn — (String)
  The Amazon Resource Name (ARN) of the replicator to be described.

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 when the replicator was created.
  - CurrentVersion — (String)
    The current version number of the replicator.
  - IsReplicatorReference — (Boolean)
    Whether this resource is a replicator reference.
  - KafkaClusters — (Array<map>)
    Kafka Clusters used in setting up sources / targets for replication.
    
    AmazonMskCluster — (map)
    Details of an Amazon MSK Cluster.
    
    MskClusterArn — required — (String)
    The Amazon Resource Name (ARN) of an Amazon MSK cluster.
    
    KafkaClusterAlias — (String)
    The alias of the Kafka cluster. Used to prefix names of replicated topics.
    
    VpcConfig — (map)
    Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
    
    SecurityGroupIds — (Array<String>)
    The security groups to attach to the ENIs for the broker nodes.
    
    SubnetIds — required — (Array<String>)
    The list of subnets in the client VPC to connect to.
  - ReplicationInfoList — (Array<map>)
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    
    ConsumerGroupReplication — (map)
    Configuration relating to consumer group replication.
    
    ConsumerGroupsToExclude — (Array<String>)
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    
    ConsumerGroupsToReplicate — required — (Array<String>)
    List of regular expression patterns indicating the consumer groups to copy.
    
    DetectAndCopyNewConsumerGroups — (Boolean)
    Enables synchronization of consumer groups to target cluster.
    
    SynchroniseConsumerGroupOffsets — (Boolean)
    Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.
    
    SourceKafkaClusterAlias — (String)
    The alias of the source Kafka cluster.
    
    TargetCompressionType — (String)
    The compression type to use when producing records to target cluster.
    Possible values include:
    
    "NONE"
    
    "GZIP"
    
    "SNAPPY"
    
    "LZ4"
    
    "ZSTD"
    
    TargetKafkaClusterAlias — (String)
    The alias of the target Kafka cluster.
    
    TopicReplication — (map)
    Configuration relating to topic replication.
    
    CopyAccessControlListsForTopics — (Boolean)
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    
    CopyTopicConfigurations — (Boolean)
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    
    DetectAndCopyNewTopics — (Boolean)
    Whether to periodically check for new topics and partitions.
    
    StartingPosition — (map)
    Configuration for specifying the position in the topics to start replicating from.
    
    Type — (String)
    The type of replication starting position.
    Possible values include:
    
    "LATEST"
    
    "EARLIEST"
    
    TopicsToExclude — (Array<String>)
    List of regular expression patterns indicating the topics that should not be replicated.
    
    TopicsToReplicate — required — (Array<String>)
    List of regular expression patterns indicating the topics to copy.
  - ReplicatorArn — (String)
    The Amazon Resource Name (ARN) of the replicator.
  - ReplicatorDescription — (String)
    The description of the replicator.
  - ReplicatorName — (String)
    The name of the replicator.
  - ReplicatorResourceArn — (String)
    The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.
  - ReplicatorState — (String)
    State of the replicator.
    Possible values include:
    
    "RUNNING"
    
    "CREATING"
    
    "UPDATING"
    
    "DELETING"
    
    "FAILED"
  - ServiceExecutionRoleArn — (String)
    The Amazon Resource Name (ARN) of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters)
  - StateInfo — (map)
    Details about the state of the replicator.
    
    Code — (String) Code that describes the current state of the replicator.
    
    Message — (String) Message that describes the state of the replicator.
  - Tags — (map<String>)
    List of tags attached to the Replicator.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a description of this MSK VPC connection.

Service Reference:

DescribeVpcConnection

Examples:

Calling the describeVpcConnection operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
kafka.describeVpcConnection(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.

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:
  - VpcConnectionArn — (String)
    The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.
  - TargetClusterArn — (String)
    The Amazon Resource Name (ARN) that uniquely identifies an MSK cluster.
  - State — (String)
    The state of VPC connection.
    Possible values include:
    
    "CREATING"
    
    "AVAILABLE"
    
    "INACTIVE"
    
    "DEACTIVATING"
    
    "DELETING"
    
    "FAILED"
    
    "REJECTED"
    
    "REJECTING"
  - Authentication — (String)
    The authentication type of VPC connection.
  - VpcId — (String)
    The VPC Id for the VPC connection.
  - Subnets — (Array<String>)
    The list of subnets for the VPC connection.
  - SecurityGroups — (Array<String>)
    The list of security groups for the VPC connection.
  - CreationTime — (Date)
    The creation time of the VPC connection.
  - Tags — (map<String>)
    A map of tags for the VPC connection.

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:

GetBootstrapBrokers

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.
  - BootstrapBrokerStringTls — (String)
    A string containing one or more DNS names (or IP) and TLS port pairs.
  - BootstrapBrokerStringSaslScram — (String)
    A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
  - BootstrapBrokerStringSaslIam — (String)
    A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
  - BootstrapBrokerStringPublicTls — (String)
    A string containing one or more DNS names (or IP) and TLS port pairs.
  - BootstrapBrokerStringPublicSaslScram — (String)
    A string containing one or more DNS names (or IP) and Sasl Scram port pairs.
  - BootstrapBrokerStringPublicSaslIam — (String)
    A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.
  - BootstrapBrokerStringVpcConnectivityTls — (String)
    A string containing one or more DNS names (or IP) and TLS port pairs for VPC connectivity.
  - BootstrapBrokerStringVpcConnectivitySaslScram — (String)
    A string containing one or more DNS names (or IP) and SASL/SCRAM port pairs for VPC connectivity.
  - BootstrapBrokerStringVpcConnectivitySaslIam — (String)
    A string containing one or more DNS names (or IP) and SASL/IAM port pairs for VPC connectivity.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

GetClusterPolicy

Examples:

Calling the getClusterPolicy operation

var params = {
  ClusterArn: 'STRING_VALUE' /* required */
};
kafka.getClusterPolicy(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) of 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:
  - CurrentVersion — (String)
    The version of cluster policy.
  - Policy — (String)
    The cluster policy.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Gets the Apache Kafka versions to which you can update the MSK cluster.

Service Reference:

GetCompatibleKafkaVersions

Examples:

Calling the getCompatibleKafkaVersions operation

var params = {
  ClusterArn: 'STRING_VALUE'
};
kafka.getCompatibleKafkaVersions(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) of the cluster check.

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:
  - CompatibleKafkaVersions — (Array<map>)
    A list of CompatibleKafkaVersion objects.
    
    SourceVersion — (String)
    An Apache Kafka version.
    
    TargetVersions — (Array<String>)
    A list of Apache Kafka versions.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all the VPC connections in this Region.

Service Reference:

ListClientVpcConnections

Examples:

Calling the listClientVpcConnections operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listClientVpcConnections(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) of the cluster.
- MaxResults — (Integer)
  The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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:
  - ClientVpcConnections — (Array<map>)
    List of client VPC connections.
    
    Authentication — (String)
    Information about the auth scheme of Vpc Connection.
    
    CreationTime — (Date)
    Creation time of the Vpc Connection.
    
    State — (String)
    State of the Vpc Connection.
    Possible values include:
    
    "CREATING"
    
    "AVAILABLE"
    
    "INACTIVE"
    
    "DEACTIVATING"
    
    "DELETING"
    
    "FAILED"
    
    "REJECTED"
    
    "REJECTING"
    
    VpcConnectionArn — required — (String)
    The ARN that identifies the Vpc Connection.
    
    Owner — (String)
    The Owner of the Vpc Connection.
  - NextToken — (String)
    The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all the operations that have been performed on the specified MSK cluster.

Service Reference:

ListClusterOperations

Examples:

Calling the listClusterOperations operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listClusterOperations(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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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:
  - ClusterOperationInfoList — (Array<map>)
    An array of cluster operation information objects.
    
    ClientRequestId — (String)
    The ID of the API request that triggered this operation.
    
    ClusterArn — (String)
    ARN of the cluster.
    
    CreationTime — (Date)
    The time that the operation was created.
    
    EndTime — (Date)
    The time at which the operation finished.
    
    ErrorInfo — (map)
    Describes the error if the operation fails.
    
    ErrorCode — (String)
    A number describing the error programmatically.
    
    ErrorString — (String)
    An optional field to provide more details about the error.
    
    OperationArn — (String)
    ARN of the cluster operation.
    
    OperationState — (String)
    State of the cluster operation.
    
    OperationSteps — (Array<map>)
    Steps completed during the operation.
    
    StepInfo — (map)
    Information about the step and its status.
    
    StepStatus — (String)
    The steps current status.
    
    StepName — (String)
    The name of the step.
    
    OperationType — (String)
    Type of the cluster operation.
    
    SourceClusterInfo — (map)
    Information about cluster attributes before a cluster is updated.
    
    BrokerEBSVolumeInfo — (Array<map>)
    Specifies the size of the EBS volume and the ID of the associated broker.
    
    KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSizeGB — (Integer)
    Size of the EBS volume to update.
    
    ConfigurationInfo — (map)
    Information about the changes in the configuration of the brokers.
    
    Arn — required — (String)
    ARN of the configuration to use.
    
    Revision — required — (Integer)
    The revision of the configuration to use.
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    EnhancedMonitoring — (String)
    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    KafkaVersion — (String)
    The Apache Kafka version.
    
    LoggingInfo — (map)
    You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    InstanceType — (String)
    Information about the Amazon MSK broker type.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    BrokerCountUpdateInfo — (map)
    Describes brokers being changed during a broker count update.
    
    CreatedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being created.
    
    DeletedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being deleted.
    
    TargetClusterInfo — (map)
    Information about cluster attributes after a cluster is updated.
    
    BrokerEBSVolumeInfo — (Array<map>)
    Specifies the size of the EBS volume and the ID of the associated broker.
    
    KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSizeGB — (Integer)
    Size of the EBS volume to update.
    
    ConfigurationInfo — (map)
    Information about the changes in the configuration of the brokers.
    
    Arn — required — (String)
    ARN of the configuration to use.
    
    Revision — required — (Integer)
    The revision of the configuration to use.
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    EnhancedMonitoring — (String)
    Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    KafkaVersion — (String)
    The Apache Kafka version.
    
    LoggingInfo — (map)
    You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    InstanceType — (String)
    Information about the Amazon MSK broker type.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    BrokerCountUpdateInfo — (map)
    Describes brokers being changed during a broker count update.
    
    CreatedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being created.
    
    DeletedBrokerIds — (Array<Float>)
    Kafka Broker IDs of brokers being deleted.
    
    VpcConnectionInfo — (map)
    Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
    
    VpcConnectionArn — (String)
    The Amazon Resource Name (ARN) of the VPC connection.
    
    Owner — (String)
    The owner of the VPC Connection.
    
    UserIdentity — (map)
    Description of the requester that calls the API operation.
    
    Type — (String)
    The identity type of the requester that calls the API operation.
    Possible values include:
    
    "AWSACCOUNT"
    
    "AWSSERVICE"
    
    PrincipalId — (String)
    A unique identifier for the requester that calls the API operation.
    
    CreationTime — (Date)
    The time when Amazon MSK creates the VPC Connnection.
  - NextToken — (String)
    If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all the operations that have been performed on the specified MSK cluster.

Service Reference:

ListClusterOperationsV2

Examples:

Calling the listClusterOperationsV2 operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listClusterOperationsV2(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 arn of the cluster whose operations are being requested.
- MaxResults — (Integer) The maxResults of the query.
- NextToken — (String) The nextToken of the query.

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:
  - ClusterOperationInfoList — (Array<map>)
    An array of cluster operation information objects.
    
    ClusterArn — (String)
    ARN of the cluster.
    
    ClusterType — (String)
    Type of the backend cluster.
    Possible values include:
    
    "PROVISIONED"
    
    "SERVERLESS"
    
    StartTime — (Date)
    The time at which operation was started.
    
    EndTime — (Date)
    The time at which the operation finished.
    
    OperationArn — (String)
    ARN of the cluster operation.
    
    OperationState — (String)
    State of the cluster operation.
    
    OperationType — (String)
    Type of the cluster operation.
  - NextToken — (String)
    If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all the MSK clusters in the current Region.

Service Reference:

ListClusters

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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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.
    
    ActiveOperationArn — (String)
    Arn of active cluster operation.
    
    BrokerNodeGroupInfo — (map)
    Information about the broker nodes.
    
    BrokerAZDistribution — (String)
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    Possible values include:
    
    "DEFAULT"
    
    ClientSubnets — required — (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 occupy the Availability Zone with ID use use1-az3.
    
    InstanceType — required — (String)
    The type of Amazon EC2 instances to use for Apache 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
    
    StorageInfo — (map)
    Contains information about storage volumes attached to MSK broker nodes.
    
    EbsStorageInfo — (map)
    EBS volume information.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSize — (Integer)
    The size in GiB of the EBS volume for the data drive on each broker node.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    ZoneIds — (Array<String>)
    The list of zoneIds for the cluster in the virtual private cloud (VPC).
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    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 Apache Kafka brokers in the cluster.
    
    ConfigurationArn — (String)
    The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
    
    ConfigurationRevision — (Integer)
    The revision of the configuration to use. This field isn't visible in this preview release.
    
    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.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    EnhancedMonitoring — (String)
    Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    Settings for open monitoring using Prometheus.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    LoggingInfo — (map)
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    NumberOfBrokerNodes — (Integer)
    The number of broker nodes in the cluster.
    
    State — (String)
    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"
    
    StateInfo — (map)
    
    Code — (String)
    
    Message — (String)
    
    Tags — (map<String>)
    Tags attached to the cluster.
    
    ZookeeperConnectString — (String)
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    ZookeeperConnectStringTls — (String)
    The connection string to use to connect to zookeeper cluster on Tls port.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    CustomerActionStatus — (String)
    Determines if there is an action required from the customer.
    Possible values include:
    
    "CRITICAL_ACTION_REQUIRED"
    
    "ACTION_RECOMMENDED"
    
    "NONE"
  - 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.

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

Returns a list of all the MSK clusters in the current Region.

Service Reference:

ListClustersV2

Examples:

Calling the listClustersV2 operation

var params = {
  ClusterNameFilter: 'STRING_VALUE',
  ClusterTypeFilter: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listClustersV2(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 names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
- ClusterTypeFilter — (String)
  Specify either PROVISIONED or SERVERLESS.
- MaxResults — (Integer)
  The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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.
    
    ActiveOperationArn — (String)
    The Amazon Resource Name (ARN) that uniquely identifies a cluster operation.
    
    ClusterType — (String)
    Cluster Type.
    Possible values include:
    
    "PROVISIONED"
    
    "SERVERLESS"
    
    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.
    
    CurrentVersion — (String)
    The current version of the MSK cluster.
    
    State — (String)
    The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.
    Possible values include:
    
    "ACTIVE"
    
    "CREATING"
    
    "DELETING"
    
    "FAILED"
    
    "HEALING"
    
    "MAINTENANCE"
    
    "REBOOTING_BROKER"
    
    "UPDATING"
    
    StateInfo — (map)
    State Info for the Amazon MSK cluster.
    
    Code — (String)
    
    Message — (String)
    
    Tags — (map<String>)
    Tags attached to the cluster.
    
    Provisioned — (map)
    Information about the provisioned cluster.
    
    BrokerNodeGroupInfo — required — (map)
    Information about the brokers.
    
    BrokerAZDistribution — (String)
    The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.
    
    Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.
    Possible values include:
    
    "DEFAULT"
    
    ClientSubnets — required — (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 occupy the Availability Zone with ID use use1-az3.
    
    InstanceType — required — (String)
    The type of Amazon EC2 instances to use for Apache 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. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
    
    StorageInfo — (map)
    Contains information about storage volumes attached to MSK broker nodes.
    
    EbsStorageInfo — (map)
    EBS volume information.
    
    ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    
    Enabled — (Boolean)
    Provisioned throughput is enabled or not.
    
    VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
    
    VolumeSize — (Integer)
    The size in GiB of the EBS volume for the data drive on each broker node.
    
    ConnectivityInfo — (map)
    Information about the broker access configuration.
    
    PublicAccess — (map)
    Public access control for brokers.
    
    Type — (String)
    The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
    
    VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    
    ClientAuthentication — (map)
    Includes all client authentication information for VPC connectivity.
    
    Sasl — (map)
    SASL authentication type details for VPC connectivity.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is on or off for VPC connectivity.
    
    Iam — (map)
    Details for SASL/IAM client authentication for VPC connectivity.
    
    Enabled — (Boolean)
    SASL/IAM authentication is on or off for VPC connectivity.
    
    Tls — (map)
    TLS authentication type details for VPC connectivity.
    
    Enabled — (Boolean)
    TLS authentication is on or off for VPC connectivity.
    
    ZoneIds — (Array<String>)
    The list of zoneIds for the cluster in the virtual private cloud (VPC).
    
    CurrentBrokerSoftwareInfo — (map)
    Information about the Apache Kafka version deployed on the brokers.
    
    ConfigurationArn — (String)
    The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
    
    ConfigurationRevision — (Integer)
    The revision of the configuration to use. This field isn't visible in this preview release.
    
    KafkaVersion — (String)
    The version of Apache Kafka.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Scram — (map)
    Details for SASL/SCRAM client authentication.
    
    Enabled — (Boolean)
    SASL/SCRAM authentication is enabled or not.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
    
    Tls — (map)
    Details for ClientAuthentication using TLS.
    
    CertificateAuthorityArnList — (Array<String>)
    List of ACM Certificate Authority ARNs.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off TLS authentication.
    
    Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    
    Enabled — (Boolean)
    Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
    
    EncryptionInfo — (map)
    Includes all encryption-related information.
    
    EncryptionAtRest — (map)
    The data-volume encryption details.
    
    DataVolumeKMSKeyId — required — (String)
    The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
    
    EncryptionInTransit — (map)
    The details for encryption in transit.
    
    ClientBroker — (String)
    Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
    
    TLS means that client-broker communication is enabled with TLS only.
    
    TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
    
    PLAINTEXT means that client-broker communication is enabled in plaintext only.
    
    The default value is TLS_PLAINTEXT.
    Possible values include:
    
    "TLS"
    
    "TLS_PLAINTEXT"
    
    "PLAINTEXT"
    
    InCluster — (Boolean)
    When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
    
    The default value is true.
    
    EnhancedMonitoring — (String)
    Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
    Possible values include:
    
    "DEFAULT"
    
    "PER_BROKER"
    
    "PER_TOPIC_PER_BROKER"
    
    "PER_TOPIC_PER_PARTITION"
    
    OpenMonitoring — (map)
    The settings for open monitoring.
    
    Prometheus — required — (map)
    Prometheus settings.
    
    JmxExporter — (map)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the JMX Exporter.
    
    NodeExporter — (map)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    EnabledInBroker — required — (Boolean)
    Indicates whether you want to turn on or turn off the Node Exporter.
    
    LoggingInfo — (map)
    Log delivery information for the cluster.
    
    BrokerLogs — required — (map)
    
    CloudWatchLogs — (map)
    
    Enabled — required — (Boolean)
    
    LogGroup — (String)
    
    Firehose — (map)
    
    DeliveryStream — (String)
    
    Enabled — required — (Boolean)
    
    S3 — (map)
    
    Bucket — (String)
    
    Enabled — required — (Boolean)
    
    Prefix — (String)
    
    NumberOfBrokerNodes — required — (Integer)
    The number of broker nodes in the cluster.
    
    ZookeeperConnectString — (String)
    The connection string to use to connect to the Apache ZooKeeper cluster.
    
    ZookeeperConnectStringTls — (String)
    The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.
    
    StorageMode — (String)
    This controls storage mode for supported storage tiers.
    Possible values include:
    
    "LOCAL"
    
    "TIERED"
    
    CustomerActionStatus — (String)
    Determines if there is an action required from the customer.
    Possible values include:
    
    "CRITICAL_ACTION_REQUIRED"
    
    "ACTION_RECOMMENDED"
    
    "NONE"
    
    Serverless — (map)
    Information about the serverless cluster.
    
    VpcConfigs — required — (Array<map>)
    The configuration of the Amazon VPCs for the cluster.
    
    SubnetIds — required — (Array<String>)
    The IDs of the subnets associated with the cluster.
    
    SecurityGroupIds — (Array<String>)
    The IDs of the security groups associated with the cluster.
    
    ClientAuthentication — (map)
    Includes all client authentication information.
    
    Sasl — (map)
    Details for ClientAuthentication using SASL.
    
    Iam — (map)
    Indicates whether IAM access control is enabled.
    
    Enabled — (Boolean)
    Indicates whether IAM access control is enabled.
  - 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.

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

Returns a list of all the MSK configurations in this Region.

Service Reference:

ListConfigurationRevisions

Examples:

Calling the listConfigurationRevisions operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listConfigurationRevisions(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
- MaxResults — (Integer)
  The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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)
    Paginated results marker.
  - Revisions — (Array<map>)
    List of ConfigurationRevision objects.
    
    CreationTime — required — (Date)
    The time when the configuration revision was created.
    
    Description — (String)
    The description of the configuration revision.
    
    Revision — required — (Integer)
    The revision number.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all the MSK configurations in this Region.

Service Reference:

ListConfigurations

Examples:

Calling the listConfigurations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listConfigurations(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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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:
  - Configurations — (Array<map>)
    An array of MSK configurations.
    
    Arn — required — (String)
    The Amazon Resource Name (ARN) of the configuration.
    
    CreationTime — required — (Date)
    The time when the configuration was created.
    
    Description — required — (String)
    The description of the configuration.
    
    KafkaVersions — required — (Array<String>)
    An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.
    
    LatestRevision — required — (map)
    Latest revision of the configuration.
    
    CreationTime — required — (Date)
    The time when the configuration revision was created.
    
    Description — (String)
    The description of the configuration revision.
    
    Revision — required — (Integer)
    The revision number.
    
    Name — required — (String)
    The name of the configuration.
    
    State — required — (String)
    The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
    Possible values include:
    
    "ACTIVE"
    
    "DELETING"
    
    "DELETE_FAILED"
  - NextToken — (String)
    The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of Apache Kafka versions.

Service Reference:

ListKafkaVersions

Examples:

Calling the listKafkaVersions operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listKafkaVersions(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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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:
  - KafkaVersions — (Array<map>)
    
    Version — (String)
    
    Status — (String) Possible values include:
    
    "ACTIVE"
    
    "DEPRECATED"
  - NextToken — (String)

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:

ListNodes

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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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 Apache Kafka brokers in the cluster.
    
    ConfigurationArn — (String)
    The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.
    
    ConfigurationRevision — (Integer)
    The revision of the configuration to use. This field isn't visible in this preview release.
    
    KafkaVersion — (String)
    The version of Apache Kafka.
    
    Endpoints — (Array<String>)
    Endpoints for accessing the broker.
    
    ControllerNodeInfo — (map)
    The ControllerNodeInfo.
    
    Endpoints — (Array<String>)
    Endpoints for accessing the Controller.
    
    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.
    
    Endpoints — (Array<String>)
    Endpoints for accessing the ZooKeeper.
    
    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.

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

Lists the replicators.

Service Reference:

ListReplicators

Examples:

Calling the listReplicators operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ReplicatorNameFilter: 'STRING_VALUE'
};
kafka.listReplicators(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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.
- ReplicatorNameFilter — (String)
  Returns replicators starting with given name.

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 ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.
  - Replicators — (Array<map>)
    List containing information of each of the replicators in the account.
    
    CreationTime — (Date)
    The time the replicator was created.
    
    CurrentVersion — (String)
    The current version of the replicator.
    
    IsReplicatorReference — (Boolean)
    Whether this resource is a replicator reference.
    
    KafkaClustersSummary — (Array<map>)
    Kafka Clusters used in setting up sources / targets for replication.
    
    AmazonMskCluster — (map)
    Details of an Amazon MSK Cluster.
    
    MskClusterArn — required — (String)
    The Amazon Resource Name (ARN) of an Amazon MSK cluster.
    
    KafkaClusterAlias — (String)
    The alias of the Kafka cluster. Used to prefix names of replicated topics.
    
    ReplicationInfoSummaryList — (Array<map>)
    A list of summarized information of replications between clusters.
    
    SourceKafkaClusterAlias — (String)
    The alias of the source Kafka cluster.
    
    TargetKafkaClusterAlias — (String)
    The alias of the target Kafka cluster.
    
    ReplicatorArn — (String)
    The Amazon Resource Name (ARN) of the replicator.
    
    ReplicatorName — (String)
    The name of the replicator.
    
    ReplicatorResourceArn — (String)
    The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.
    
    ReplicatorState — (String)
    State of the replicator.
    Possible values include:
    
    "RUNNING"
    
    "CREATING"
    
    "UPDATING"
    
    "DELETING"
    
    "FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

Service Reference:

ListScramSecrets

Examples:

Calling the listScramSecrets operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listScramSecrets(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 arn of the cluster.
- MaxResults — (Integer)
  The maxResults of the query.
- NextToken — (String)
  The nextToken of the query.

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)
    Paginated results marker.
  - SecretArnList — (Array<String>)
    The list of scram secrets associated with the cluster.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of the tags associated with the specified resource.

Service Reference:

ListTagsForResource

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 that's associated with the 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. The data object has the following properties:
  - Tags — (map<String>)
    The key-value pair for the resource tag.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns a list of all the VPC connections in this Region.

Service Reference:

ListVpcConnections

Examples:

Calling the listVpcConnections operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kafka.listVpcConnections(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 results to return in the response. If there are more results, the response includes a NextToken parameter.
- NextToken — (String)
  The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, 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:
  - VpcConnections — (Array<map>)
    List of VPC connections.
    
    VpcConnectionArn — required — (String)
    The ARN that identifies the Vpc Connection.
    
    TargetClusterArn — required — (String)
    The ARN that identifies the Cluster which the Vpc Connection belongs to.
    
    CreationTime — (Date)
    Creation time of the Vpc Connection.
    
    Authentication — (String)
    Information about the auth scheme of Vpc Connection.
    
    VpcId — (String)
    The vpcId that belongs to the Vpc Connection.
    
    State — (String)
    State of the Vpc Connection.
    Possible values include:
    
    "CREATING"
    
    "AVAILABLE"
    
    "INACTIVE"
    
    "DEACTIVATING"
    
    "DELETING"
    
    "FAILED"
    
    "REJECTED"
    
    "REJECTING"
  - NextToken — (String)
    The paginated results marker. When the result of a ListClientVpcConnections operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

Service Reference:

PutClusterPolicy

Examples:

Calling the putClusterPolicy operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE'
};
kafka.putClusterPolicy(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) of the cluster.
- CurrentVersion — (String)
  The policy version.
- Policy — (String)
  The policy.

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:
  - CurrentVersion — (String)
    The policy version.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Reboots brokers.

Service Reference:

RebootBroker

Examples:

Calling the rebootBroker operation

var params = {
  BrokerIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClusterArn: 'STRING_VALUE' /* required */
};
kafka.rebootBroker(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: {}) —
- BrokerIds — (Array<String>)
  The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
- ClusterArn — (String)
  The Amazon Resource Name (ARN) of the cluster to be updated.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Returns empty response.

Service Reference:

RejectClientVpcConnection

Examples:

Calling the rejectClientVpcConnection operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  VpcConnectionArn: 'STRING_VALUE' /* required */
};
kafka.rejectClientVpcConnection(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) of the cluster.
- VpcConnectionArn — (String)
  The VPC connection ARN.

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.

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

Adds tags to the specified MSK resource.

Service Reference:

TagResource

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 that's associated with the tags.
- Tags — (map<String>)
  The key-value pair for the resource tag.

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`

Removes the tags associated with the keys that are provided in the query.

Service Reference:

UntagResource

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 that's associated with the tags.
- TagKeys — (Array<String>)
  Tag keys must be unique for a given cluster. In addition, the following restrictions apply:
  - Each tag key must be unique. If you add a tag with a key that's already in use, your new tag overwrites the existing key-value pair.
  - You can't start a tag key with aws: because this prefix is reserved for use by AWS. AWS creates tags that begin with this prefix on your behalf, but you can't edit or delete them.
  - Tag keys must be between 1 and 128 Unicode characters in length.
  - Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following special characters: _ . / = + - @.

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.

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

Updates the number of broker nodes in the cluster.

Service Reference:

UpdateBrokerCount

Examples:

Calling the updateBrokerCount operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  TargetNumberOfBrokerNodes: 'NUMBER_VALUE' /* required */
};
kafka.updateBrokerCount(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 version of cluster to update from. A successful operation will then generate a new version.
- TargetNumberOfBrokerNodes — (Integer)
  The number of broker nodes that you want the cluster to have after this operation completes successfully.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates the EBS storage associated with MSK brokers.

Service Reference:

UpdateBrokerStorage

Examples:

Calling the updateBrokerStorage operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  TargetBrokerEBSVolumeInfo: [ /* required */
    {
      KafkaBrokerNodeId: 'STRING_VALUE', /* required */
      ProvisionedThroughput: {
        Enabled: true || false,
        VolumeThroughput: 'NUMBER_VALUE'
      },
      VolumeSizeGB: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
kafka.updateBrokerStorage(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 version of cluster to update from. A successful operation will then generate a new version.
- TargetBrokerEBSVolumeInfo — (Array<map>)
  Describes the target volume size and the ID of the broker to apply the update to.
  - KafkaBrokerNodeId — required — (String)
    The ID of the broker to update.
  - ProvisionedThroughput — (map)
    EBS volume provisioned throughput information.
    - Enabled — (Boolean)
      Provisioned throughput is enabled or not.
    - VolumeThroughput — (Integer)
      Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
  - VolumeSizeGB — (Integer)
    Size of the EBS volume 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:
  - ClusterArn — (String)
    The Amazon Resource Name (ARN) of the cluster.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates EC2 instance type.

Service Reference:

UpdateBrokerType

Examples:

Calling the updateBrokerType operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  TargetInstanceType: 'STRING_VALUE' /* required */
};
kafka.updateBrokerType(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 cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.
- TargetInstanceType — (String)
  The Amazon MSK broker type that you want all of the brokers in this cluster to be.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates the cluster with the configuration that is specified in the request body.

Service Reference:

UpdateClusterConfiguration

Examples:

Calling the updateClusterConfiguration operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  ConfigurationInfo: { /* required */
    Arn: 'STRING_VALUE', /* required */
    Revision: 'NUMBER_VALUE' /* required */
  },
  CurrentVersion: 'STRING_VALUE' /* required */
};
kafka.updateClusterConfiguration(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.
- ConfigurationInfo — (map)
  Represents the configuration that you want MSK to use for the brokers in a cluster.
  - Arn — required — (String)
    ARN of the configuration to use.
  - Revision — required — (Integer)
    The revision of the configuration to use.
- CurrentVersion — (String)
  The version of the cluster that needs to be updated.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates the Apache Kafka version for the cluster.

Service Reference:

UpdateClusterKafkaVersion

Examples:

Calling the updateClusterKafkaVersion operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  TargetKafkaVersion: 'STRING_VALUE', /* required */
  ConfigurationInfo: {
    Arn: 'STRING_VALUE', /* required */
    Revision: 'NUMBER_VALUE' /* required */
  }
};
kafka.updateClusterKafkaVersion(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) of the cluster to be updated.
- ConfigurationInfo — (map)
  The custom configuration that should be applied on the new version of cluster.
  - Arn — required — (String)
    ARN of the configuration to use.
  - Revision — required — (Integer)
    The revision of the configuration to use.
- CurrentVersion — (String)
  Current cluster version.
- TargetKafkaVersion — (String)
  Target Kafka version.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates an MSK configuration.

Service Reference:

UpdateConfiguration

Examples:

Calling the updateConfiguration operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  ServerProperties: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  Description: 'STRING_VALUE'
};
kafka.updateConfiguration(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: {}) —
- Arn — (String)
  The Amazon Resource Name (ARN) of the configuration.
- Description — (String)
  The description of the configuration revision.
- ServerProperties — (Buffer, Typed Array, Blob, String)
  Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

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:
  - Arn — (String)
    The Amazon Resource Name (ARN) of the configuration.
  - LatestRevision — (map)
    Latest revision of the configuration.
    
    CreationTime — required — (Date)
    The time when the configuration revision was created.
    
    Description — (String)
    The description of the configuration revision.
    
    Revision — required — (Integer)
    The revision number.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates the cluster's connectivity configuration.

Service Reference:

UpdateConnectivity

Examples:

Calling the updateConnectivity operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  ConnectivityInfo: { /* required */
    PublicAccess: {
      Type: 'STRING_VALUE'
    },
    VpcConnectivity: {
      ClientAuthentication: {
        Sasl: {
          Iam: {
            Enabled: true || false
          },
          Scram: {
            Enabled: true || false
          }
        },
        Tls: {
          Enabled: true || false
        }
      }
    }
  },
  CurrentVersion: 'STRING_VALUE' /* required */
};
kafka.updateConnectivity(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) of the configuration.
- ConnectivityInfo — (map)
  Information about the broker access configuration.
  - PublicAccess — (map)
    Public access control for brokers.
    - Type — (String)
      The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.
  - VpcConnectivity — (map)
    VPC connectivity access control for brokers.
    - ClientAuthentication — (map)
      Includes all client authentication information for VPC connectivity.
      
      Sasl — (map)
      SASL authentication type details for VPC connectivity.
      
      Scram — (map)
      Details for SASL/SCRAM client authentication for VPC connectivity.
      
      Enabled — (Boolean)
      SASL/SCRAM authentication is on or off for VPC connectivity.
      
      Iam — (map)
      Details for SASL/IAM client authentication for VPC connectivity.
      
      Enabled — (Boolean)
      SASL/IAM authentication is on or off for VPC connectivity.
      
      Tls — (map)
      TLS authentication type details for VPC connectivity.
      
      Enabled — (Boolean)
      TLS authentication is on or off for VPC connectivity.
- CurrentVersion — (String)
  The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

Service Reference:

UpdateMonitoring

Examples:

Calling the updateMonitoring operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  EnhancedMonitoring: DEFAULT | PER_BROKER | PER_TOPIC_PER_BROKER | PER_TOPIC_PER_PARTITION,
  LoggingInfo: {
    BrokerLogs: { /* 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'
      }
    }
  },
  OpenMonitoring: {
    Prometheus: { /* required */
      JmxExporter: {
        EnabledInBroker: true || false /* required */
      },
      NodeExporter: {
        EnabledInBroker: true || false /* required */
      }
    }
  }
};
kafka.updateMonitoring(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 version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
- EnhancedMonitoring — (String)
  Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
  Possible values include:
  - "DEFAULT"
  - "PER_BROKER"
  - "PER_TOPIC_PER_BROKER"
  - "PER_TOPIC_PER_PARTITION"
- OpenMonitoring — (map)
  The settings for open monitoring.
  - Prometheus — required — (map)
    Prometheus settings.
    - JmxExporter — (map)
      Indicates whether you want to turn on or turn off the JMX Exporter.
      
      EnabledInBroker — required — (Boolean)
      Indicates whether you want to turn on or turn off the JMX Exporter.
    - NodeExporter — (map)
      Indicates whether you want to turn on or turn off the Node Exporter.
      
      EnabledInBroker — required — (Boolean)
      Indicates whether you want to turn on or turn off the Node Exporter.
- LoggingInfo — (map)
  - BrokerLogs — required — (map)
    - CloudWatchLogs — (map)
      
      Enabled — required — (Boolean)
      
      LogGroup — (String)
    - Firehose — (map)
      
      DeliveryStream — (String)
      
      Enabled — required — (Boolean)
    - S3 — (map)
      
      Bucket — (String)
      
      Enabled — required — (Boolean)
      
      Prefix — (String)

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates replication info of a replicator.

Service Reference:

UpdateReplicationInfo

Examples:

Calling the updateReplicationInfo operation

var params = {
  CurrentVersion: 'STRING_VALUE', /* required */
  ReplicatorArn: 'STRING_VALUE', /* required */
  SourceKafkaClusterArn: 'STRING_VALUE', /* required */
  TargetKafkaClusterArn: 'STRING_VALUE', /* required */
  ConsumerGroupReplication: {
    ConsumerGroupsToExclude: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    ConsumerGroupsToReplicate: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    DetectAndCopyNewConsumerGroups: true || false, /* required */
    SynchroniseConsumerGroupOffsets: true || false /* required */
  },
  TopicReplication: {
    CopyAccessControlListsForTopics: true || false, /* required */
    CopyTopicConfigurations: true || false, /* required */
    DetectAndCopyNewTopics: true || false, /* required */
    TopicsToExclude: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    TopicsToReplicate: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
kafka.updateReplicationInfo(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: {}) —
- ConsumerGroupReplication — (map)
  Updated consumer group replication information.
  - ConsumerGroupsToExclude — required — (Array<String>)
    List of regular expression patterns indicating the consumer groups that should not be replicated.
  - ConsumerGroupsToReplicate — required — (Array<String>)
    List of regular expression patterns indicating the consumer groups to copy.
  - DetectAndCopyNewConsumerGroups — required — (Boolean)
    Enables synchronization of consumer groups to target cluster.
  - SynchroniseConsumerGroupOffsets — required — (Boolean)
    Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.
- CurrentVersion — (String)
  Current replicator version.
- ReplicatorArn — (String)
  The Amazon Resource Name (ARN) of the replicator to be updated.
- SourceKafkaClusterArn — (String)
  The ARN of the source Kafka cluster.
- TargetKafkaClusterArn — (String)
  The ARN of the target Kafka cluster.
- TopicReplication — (map)
  Updated topic replication information.
  - CopyAccessControlListsForTopics — required — (Boolean)
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
  - CopyTopicConfigurations — required — (Boolean)
    Whether to periodically configure remote topics to match their corresponding upstream topics.
  - DetectAndCopyNewTopics — required — (Boolean)
    Whether to periodically check for new topics and partitions.
  - TopicsToExclude — required — (Array<String>)
    List of regular expression patterns indicating the topics that should not be replicated.
  - TopicsToReplicate — required — (Array<String>)
    List of regular expression patterns indicating the topics to copy.

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:
  - ReplicatorArn — (String)
    The Amazon Resource Name (ARN) of the replicator.
  - ReplicatorState — (String)
    State of the replicator.
    Possible values include:
    
    "RUNNING"
    
    "CREATING"
    
    "UPDATING"
    
    "DELETING"
    
    "FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

Service Reference:

UpdateSecurity

Examples:

Calling the updateSecurity operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  ClientAuthentication: {
    Sasl: {
      Iam: {
        Enabled: true || false
      },
      Scram: {
        Enabled: true || false
      }
    },
    Tls: {
      CertificateAuthorityArnList: [
        'STRING_VALUE',
        /* more items */
      ],
      Enabled: true || false
    },
    Unauthenticated: {
      Enabled: true || false
    }
  },
  EncryptionInfo: {
    EncryptionAtRest: {
      DataVolumeKMSKeyId: 'STRING_VALUE' /* required */
    },
    EncryptionInTransit: {
      ClientBroker: TLS | TLS_PLAINTEXT | PLAINTEXT,
      InCluster: true || false
    }
  }
};
kafka.updateSecurity(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: {}) —
- ClientAuthentication — (map)
  Includes all client authentication related information.
  - Sasl — (map)
    Details for ClientAuthentication using SASL.
    - Scram — (map)
      Details for SASL/SCRAM client authentication.
      
      Enabled — (Boolean)
      SASL/SCRAM authentication is enabled or not.
    - Iam — (map)
      Indicates whether IAM access control is enabled.
      
      Enabled — (Boolean)
      Indicates whether IAM access control is enabled.
  - Tls — (map)
    Details for ClientAuthentication using TLS.
    - CertificateAuthorityArnList — (Array<String>)
      List of ACM Certificate Authority ARNs.
    - Enabled — (Boolean)
      Specifies whether you want to turn on or turn off TLS authentication.
  - Unauthenticated — (map)
    Contains information about unauthenticated traffic to the cluster.
    - Enabled — (Boolean)
      Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
- ClusterArn — (String)
  The Amazon Resource Name (ARN) that uniquely identifies the cluster.
- CurrentVersion — (String)
  The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
- EncryptionInfo — (map)
  Includes all encryption-related information.
  - EncryptionAtRest — (map)
    The data-volume encryption details.
    - DataVolumeKMSKeyId — required — (String)
      The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
  - EncryptionInTransit — (map)
    The details for encryption in transit.
    - ClientBroker — (String)
      Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.
      
      TLS means that client-broker communication is enabled with TLS only.
      
      TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
      
      PLAINTEXT means that client-broker communication is enabled in plaintext only.
      
      The default value is TLS_PLAINTEXT.
      Possible values include:
      
      "TLS"
      
      "TLS_PLAINTEXT"
      
      "PLAINTEXT"
    - InCluster — (Boolean)
      When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
      
      The default value is true.

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.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Updates cluster broker volume size (or) sets cluster storage mode to TIERED.

Service Reference:

UpdateStorage

Examples:

Calling the updateStorage operation

var params = {
  ClusterArn: 'STRING_VALUE', /* required */
  CurrentVersion: 'STRING_VALUE', /* required */
  ProvisionedThroughput: {
    Enabled: true || false,
    VolumeThroughput: 'NUMBER_VALUE'
  },
  StorageMode: LOCAL | TIERED,
  VolumeSizeGB: 'NUMBER_VALUE'
};
kafka.updateStorage(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) of the cluster to be updated.
- CurrentVersion — (String)
  The version of cluster to update from. A successful operation will then generate a new version.
- ProvisionedThroughput — (map)
  EBS volume provisioned throughput information.
  - Enabled — (Boolean)
    Provisioned throughput is enabled or not.
  - VolumeThroughput — (Integer)
    Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.
- StorageMode — (String)
  Controls storage mode for supported storage tiers.
  Possible values include:
  - "LOCAL"
  - "TIERED"
- VolumeSizeGB — (Integer)
  size of the EBS volume 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:
  - ClusterArn — (String)
    The Amazon Resource Name (ARN) of the cluster.
  - ClusterOperationArn — (String)
    The Amazon Resource Name (ARN) of the cluster operation.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.Kafka

Overview

Service Description

Sending a Request Using Kafka

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

new AWS.Kafka(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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