Kafka class

The operations for managing an Amazon MSK cluster.

Constructors

Kafka({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchAssociateScramSecret({required String clusterArn, required List<String> secretArnList}) Future<BatchAssociateScramSecretResponse>
Associates one or more Scram Secrets with an Amazon MSK cluster.
batchDisassociateScramSecret({required String clusterArn, required List<String> secretArnList}) Future<BatchDisassociateScramSecretResponse>
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createCluster({required BrokerNodeGroupInfo brokerNodeGroupInfo, required String clusterName, required String kafkaVersion, required int numberOfBrokerNodes, ClientAuthentication? clientAuthentication, ConfigurationInfo? configurationInfo, EncryptionInfo? encryptionInfo, EnhancedMonitoring? enhancedMonitoring, LoggingInfo? loggingInfo, OpenMonitoringInfo? openMonitoring, Map<String, String>? tags}) Future<CreateClusterResponse>
Creates a new MSK cluster.
createConfiguration({required String name, required Uint8List serverProperties, String? description, List<String>? kafkaVersions}) Future<CreateConfigurationResponse>
Creates a new MSK configuration.
deleteCluster({required String clusterArn, String? currentVersion}) Future<DeleteClusterResponse>
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
deleteConfiguration({required String arn}) Future<DeleteConfigurationResponse>
Deletes an MSK Configuration.
describeCluster({required String clusterArn}) Future<DescribeClusterResponse>
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
describeClusterOperation({required String clusterOperationArn}) Future<DescribeClusterOperationResponse>
Returns a description of the cluster operation specified by the ARN.
describeConfiguration({required String arn}) Future<DescribeConfigurationResponse>
Returns a description of this MSK configuration.
describeConfigurationRevision({required String arn, required int revision}) Future<DescribeConfigurationRevisionResponse>
Returns a description of this revision of the configuration.
getBootstrapBrokers({required String clusterArn}) Future<GetBootstrapBrokersResponse>
A list of brokers that a client application can use to bootstrap.
getCompatibleKafkaVersions({String? clusterArn}) Future<GetCompatibleKafkaVersionsResponse>
Gets the Apache Kafka versions to which you can update the MSK cluster.
listClusterOperations({required String clusterArn, int? maxResults, String? nextToken}) Future<ListClusterOperationsResponse>
Returns a list of all the operations that have been performed on the specified MSK cluster.
listClusters({String? clusterNameFilter, int? maxResults, String? nextToken}) Future<ListClustersResponse>
Returns a list of all the MSK clusters in the current Region.
listConfigurationRevisions({required String arn, int? maxResults, String? nextToken}) Future<ListConfigurationRevisionsResponse>
Returns a list of all the MSK configurations in this Region.
listConfigurations({int? maxResults, String? nextToken}) Future<ListConfigurationsResponse>
Returns a list of all the MSK configurations in this Region.
listKafkaVersions({int? maxResults, String? nextToken}) Future<ListKafkaVersionsResponse>
Returns a list of Kafka versions.
listNodes({required String clusterArn, int? maxResults, String? nextToken}) Future<ListNodesResponse>
Returns a list of the broker nodes in the cluster.
listScramSecrets({required String clusterArn, int? maxResults, String? nextToken}) Future<ListScramSecretsResponse>
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
listTagsForResource({required String resourceArn}) Future<ListTagsForResourceResponse>
Returns a list of the tags associated with the specified resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebootBroker({required List<String> brokerIds, required String clusterArn}) Future<RebootBrokerResponse>
Reboots brokers.
tagResource({required String resourceArn, required Map<String, String> tags}) Future<void>
Adds tags to the specified MSK resource.
toString() String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) Future<void>
Removes the tags associated with the keys that are provided in the query.
updateBrokerCount({required String clusterArn, required String currentVersion, required int targetNumberOfBrokerNodes}) Future<UpdateBrokerCountResponse>
Updates the number of broker nodes in the cluster.
updateBrokerStorage({required String clusterArn, required String currentVersion, required List<BrokerEBSVolumeInfo> targetBrokerEBSVolumeInfo}) Future<UpdateBrokerStorageResponse>
Updates the EBS storage associated with MSK brokers.
updateClusterConfiguration({required String clusterArn, required ConfigurationInfo configurationInfo, required String currentVersion}) Future<UpdateClusterConfigurationResponse>
Updates the cluster with the configuration that is specified in the request body.
updateClusterKafkaVersion({required String clusterArn, required String currentVersion, required String targetKafkaVersion, ConfigurationInfo? configurationInfo}) Future<UpdateClusterKafkaVersionResponse>
Updates the Apache Kafka version for the cluster.
updateConfiguration({required String arn, required Uint8List serverProperties, String? description}) Future<UpdateConfigurationResponse>
Updates an MSK configuration.
updateMonitoring({required String clusterArn, required String currentVersion, EnhancedMonitoring? enhancedMonitoring, LoggingInfo? loggingInfo, OpenMonitoringInfo? openMonitoring}) Future<UpdateMonitoringResponse>
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.

Operators

operator ==(Object other) bool
The equality operator.
inherited