KafkaClient

The operations for managing an Amazon MSK cluster.

Installation

NPM
npm install @aws-sdk/client-kafka
Yarn
yarn add @aws-sdk/client-kafka
pnpm
pnpm add @aws-sdk/client-kafka

KafkaClient Operations

Command
Summary
BatchAssociateScramSecretCommand

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

BatchDisassociateScramSecretCommand

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

CreateClusterCommand

Creates a new MSK cluster.

CreateClusterV2Command

Creates a new MSK cluster.

CreateConfigurationCommand

Creates a new MSK configuration.

CreateReplicatorCommand

Creates the replicator.

CreateVpcConnectionCommand

Creates a new MSK VPC connection.

DeleteClusterCommand

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

DeleteClusterPolicyCommand

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

DeleteConfigurationCommand

Deletes an MSK Configuration.

DeleteReplicatorCommand

Deletes a replicator.

DeleteVpcConnectionCommand

Deletes a MSK VPC connection.

DescribeClusterCommand

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

DescribeClusterOperationCommand

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

DescribeClusterOperationV2Command

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

DescribeClusterV2Command

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

DescribeConfigurationCommand

Returns a description of this MSK configuration.

DescribeConfigurationRevisionCommand

Returns a description of this revision of the configuration.

DescribeReplicatorCommand

Describes a replicator.

DescribeVpcConnectionCommand

Returns a description of this MSK VPC connection.

GetBootstrapBrokersCommand

A list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name (ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.

GetClusterPolicyCommand

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

GetCompatibleKafkaVersionsCommand

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

ListClientVpcConnectionsCommand

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

ListClusterOperationsCommand

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

ListClusterOperationsV2Command

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

ListClustersCommand

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

ListClustersV2Command

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

ListConfigurationRevisionsCommand

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

ListConfigurationsCommand

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

ListKafkaVersionsCommand

Returns a list of Apache Kafka versions.

ListNodesCommand

Returns a list of the broker nodes in the cluster.

ListReplicatorsCommand

Lists the replicators.

ListScramSecretsCommand

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

ListTagsForResourceCommand

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

ListVpcConnectionsCommand

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

PutClusterPolicyCommand

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

RebootBrokerCommand
Reboots brokers.
RejectClientVpcConnectionCommand

Returns empty response.

TagResourceCommand

Adds tags to the specified MSK resource.

UntagResourceCommand

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

UpdateBrokerCountCommand

Updates the number of broker nodes in the cluster.

UpdateBrokerStorageCommand

Updates the EBS storage associated with MSK brokers.

UpdateBrokerTypeCommand

Updates EC2 instance type.

UpdateClusterConfigurationCommand

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

UpdateClusterKafkaVersionCommand

Updates the Apache Kafka version for the cluster.

UpdateConfigurationCommand

Updates an MSK configuration.

UpdateConnectivityCommand

Updates the cluster's connectivity configuration.

UpdateMonitoringCommand

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.

UpdateReplicationInfoCommand

Updates replication info of a replicator.

UpdateSecurityCommand

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

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

KafkaClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: KafkaClientConfig