AbstractAWSKafka (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kafka.AbstractAWSKafka

All Implemented Interfaces:

AWSKafka

Direct Known Subclasses:

AbstractAWSKafkaAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSKafka
extends Object
implements AWSKafka
```
Abstract implementation of AWSKafka. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.kafka.AWSKafka
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchAssociateScramSecretResult`	`batchAssociateScramSecret(BatchAssociateScramSecretRequest request)` Associates one or more Scram Secrets with an Amazon MSK cluster.
`BatchDisassociateScramSecretResult`	`batchDisassociateScramSecret(BatchDisassociateScramSecretRequest request)` Disassociates one or more Scram Secrets from an Amazon MSK cluster.
`CreateClusterResult`	`createCluster(CreateClusterRequest request)` Creates a new MSK cluster.
`CreateConfigurationResult`	`createConfiguration(CreateConfigurationRequest request)` Creates a new MSK configuration.
`DeleteClusterResult`	`deleteCluster(DeleteClusterRequest request)` Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
`DeleteConfigurationResult`	`deleteConfiguration(DeleteConfigurationRequest request)` Deletes an MSK Configuration.
`DescribeClusterResult`	`describeCluster(DescribeClusterRequest request)` Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
`DescribeClusterOperationResult`	`describeClusterOperation(DescribeClusterOperationRequest request)` Returns a description of the cluster operation specified by the ARN.
`DescribeConfigurationResult`	`describeConfiguration(DescribeConfigurationRequest request)` Returns a description of this MSK configuration.
`DescribeConfigurationRevisionResult`	`describeConfigurationRevision(DescribeConfigurationRevisionRequest request)` Returns a description of this revision of the configuration.
`GetBootstrapBrokersResult`	`getBootstrapBrokers(GetBootstrapBrokersRequest request)` A list of brokers that a client application can use to bootstrap.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCompatibleKafkaVersionsResult`	`getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest request)` Gets the Apache Kafka versions to which you can update the MSK cluster.
`ListClusterOperationsResult`	`listClusterOperations(ListClusterOperationsRequest request)` Returns a list of all the operations that have been performed on the specified MSK cluster.
`ListClustersResult`	`listClusters(ListClustersRequest request)` Returns a list of all the MSK clusters in the current Region.
`ListConfigurationRevisionsResult`	`listConfigurationRevisions(ListConfigurationRevisionsRequest request)` Returns a list of all the MSK configurations in this Region.
`ListConfigurationsResult`	`listConfigurations(ListConfigurationsRequest request)` Returns a list of all the MSK configurations in this Region.
`ListKafkaVersionsResult`	`listKafkaVersions(ListKafkaVersionsRequest request)` Returns a list of Kafka versions.
`ListNodesResult`	`listNodes(ListNodesRequest request)` Returns a list of the broker nodes in the cluster.
`ListScramSecretsResult`	`listScramSecrets(ListScramSecretsRequest request)` Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of the tags associated with the specified resource.
`RebootBrokerResult`	`rebootBroker(RebootBrokerRequest request)` Reboots brokers.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds tags to the specified MSK resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the tags associated with the keys that are provided in the query.
`UpdateBrokerCountResult`	`updateBrokerCount(UpdateBrokerCountRequest request)` Updates the number of broker nodes in the cluster.
`UpdateBrokerStorageResult`	`updateBrokerStorage(UpdateBrokerStorageRequest request)` Updates the EBS storage associated with MSK brokers.
`UpdateBrokerTypeResult`	`updateBrokerType(UpdateBrokerTypeRequest request)` Updates EC2 instance type.
`UpdateClusterConfigurationResult`	`updateClusterConfiguration(UpdateClusterConfigurationRequest request)` Updates the cluster with the configuration that is specified in the request body.
`UpdateClusterKafkaVersionResult`	`updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest request)` Updates the Apache Kafka version for the cluster.
`UpdateConfigurationResult`	`updateConfiguration(UpdateConfigurationRequest request)` Updates an MSK configuration.
`UpdateMonitoringResult`	`updateMonitoring(UpdateMonitoringRequest request)` Updates the monitoring settings for the cluster.
`UpdateSecurityResult`	`updateSecurity(UpdateSecurityRequest request)` Updates the security settings for the cluster.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchAssociateScramSecret
```
public BatchAssociateScramSecretResult batchAssociateScramSecret(BatchAssociateScramSecretRequest request)
```
    Description copied from interface: AWSKafka
    
    Associates one or more Scram Secrets with an Amazon MSK cluster.
    
    Specified by:
    
    batchAssociateScramSecret in interface AWSKafka
    
    Parameters:
    
    request -
    Associates sasl scram secrets to cluster.
    
    Returns:
    
    Result of the BatchAssociateScramSecret operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateScramSecret
```
public BatchDisassociateScramSecretResult batchDisassociateScramSecret(BatchDisassociateScramSecretRequest request)
```
    Description copied from interface: AWSKafka
    
    Disassociates one or more Scram Secrets from an Amazon MSK cluster.
    
    Specified by:
    
    batchDisassociateScramSecret in interface AWSKafka
    
    Parameters:
    
    request -
    Disassociates sasl scram secrets to cluster.
    
    Returns:
    
    Result of the BatchDisassociateScramSecret operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AWSKafka
    
    Creates a new MSK cluster.
    
    Specified by:
    
    createCluster in interface AWSKafka
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConfiguration
```
public CreateConfigurationResult createConfiguration(CreateConfigurationRequest request)
```
    Description copied from interface: AWSKafka
    
    Creates a new MSK configuration.
    
    Specified by:
    
    createConfiguration in interface AWSKafka
    
    Returns:
    
    Result of the CreateConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Description copied from interface: AWSKafka
    
    Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
    
    Specified by:
    
    deleteCluster in interface AWSKafka
    
    Returns:
    
    Result of the DeleteCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConfiguration
```
public DeleteConfigurationResult deleteConfiguration(DeleteConfigurationRequest request)
```
    Description copied from interface: AWSKafka
    
    Deletes an MSK Configuration.
    
    Specified by:
    
    deleteConfiguration in interface AWSKafka
    
    Returns:
    
    Result of the DeleteConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCluster
```
public DescribeClusterResult describeCluster(DescribeClusterRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
    
    Specified by:
    
    describeCluster in interface AWSKafka
    
    Returns:
    
    Result of the DescribeCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeClusterOperation
```
public DescribeClusterOperationResult describeClusterOperation(DescribeClusterOperationRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a description of the cluster operation specified by the ARN.
    
    Specified by:
    
    describeClusterOperation in interface AWSKafka
    
    Returns:
    
    Result of the DescribeClusterOperation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConfiguration
```
public DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a description of this MSK configuration.
    
    Specified by:
    
    describeConfiguration in interface AWSKafka
    
    Returns:
    
    Result of the DescribeConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConfigurationRevision
```
public DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a description of this revision of the configuration.
    
    Specified by:
    
    describeConfigurationRevision in interface AWSKafka
    
    Returns:
    
    Result of the DescribeConfigurationRevision operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBootstrapBrokers
```
public GetBootstrapBrokersResult getBootstrapBrokers(GetBootstrapBrokersRequest request)
```
    Description copied from interface: AWSKafka
    
    A list of brokers that a client application can use to bootstrap.
    
    Specified by:
    
    getBootstrapBrokers in interface AWSKafka
    
    Returns:
    
    Result of the GetBootstrapBrokers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCompatibleKafkaVersions
```
public GetCompatibleKafkaVersionsResult getCompatibleKafkaVersions(GetCompatibleKafkaVersionsRequest request)
```
    Description copied from interface: AWSKafka
    
    Gets the Apache Kafka versions to which you can update the MSK cluster.
    
    Specified by:
    
    getCompatibleKafkaVersions in interface AWSKafka
    
    Returns:
    
    Result of the GetCompatibleKafkaVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listClusterOperations
```
public ListClusterOperationsResult listClusterOperations(ListClusterOperationsRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of all the operations that have been performed on the specified MSK cluster.
    
    Specified by:
    
    listClusterOperations in interface AWSKafka
    
    Returns:
    
    Result of the ListClusterOperations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listClusters
```
public ListClustersResult listClusters(ListClustersRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of all the MSK clusters in the current Region.
    
    Specified by:
    
    listClusters in interface AWSKafka
    
    Returns:
    
    Result of the ListClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConfigurationRevisions
```
public ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of all the MSK configurations in this Region.
    
    Specified by:
    
    listConfigurationRevisions in interface AWSKafka
    
    Returns:
    
    Result of the ListConfigurationRevisions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConfigurations
```
public ListConfigurationsResult listConfigurations(ListConfigurationsRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of all the MSK configurations in this Region.
    
    Specified by:
    
    listConfigurations in interface AWSKafka
    
    Returns:
    
    Result of the ListConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKafkaVersions
```
public ListKafkaVersionsResult listKafkaVersions(ListKafkaVersionsRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of Kafka versions.
    
    Specified by:
    
    listKafkaVersions in interface AWSKafka
    
    Returns:
    
    Result of the ListKafkaVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listNodes
```
public ListNodesResult listNodes(ListNodesRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of the broker nodes in the cluster.
    
    Specified by:
    
    listNodes in interface AWSKafka
    
    Returns:
    
    Result of the ListNodes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listScramSecrets
```
public ListScramSecretsResult listScramSecrets(ListScramSecretsRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
    
    Specified by:
    
    listScramSecrets in interface AWSKafka
    
    Returns:
    
    Result of the ListScramSecrets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns a list of the tags associated with the specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSKafka
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebootBroker
```
public RebootBrokerResult rebootBroker(RebootBrokerRequest request)
```
    Description copied from interface: AWSKafka
    
    Reboots brokers.
    
    Specified by:
    
    rebootBroker in interface AWSKafka
    
    Parameters:
    
    request - Reboots a node.
    
    Returns:
    
    Result of the RebootBroker operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSKafka
    
    Adds tags to the specified MSK resource.
    
    Specified by:
    
    tagResource in interface AWSKafka
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSKafka
    
    Removes the tags associated with the keys that are provided in the query.
    
    Specified by:
    
    untagResource in interface AWSKafka
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBrokerCount
```
public UpdateBrokerCountResult updateBrokerCount(UpdateBrokerCountRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates the number of broker nodes in the cluster.
    
    Specified by:
    
    updateBrokerCount in interface AWSKafka
    
    Returns:
    
    Result of the UpdateBrokerCount operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBrokerStorage
```
public UpdateBrokerStorageResult updateBrokerStorage(UpdateBrokerStorageRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates the EBS storage associated with MSK brokers.
    
    Specified by:
    
    updateBrokerStorage in interface AWSKafka
    
    Returns:
    
    Result of the UpdateBrokerStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBrokerType
```
public UpdateBrokerTypeResult updateBrokerType(UpdateBrokerTypeRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates EC2 instance type.
    
    Specified by:
    
    updateBrokerType in interface AWSKafka
    
    Returns:
    
    Result of the UpdateBrokerType operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateClusterConfiguration
```
public UpdateClusterConfigurationResult updateClusterConfiguration(UpdateClusterConfigurationRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates the cluster with the configuration that is specified in the request body.
    
    Specified by:
    
    updateClusterConfiguration in interface AWSKafka
    
    Returns:
    
    Result of the UpdateClusterConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateClusterKafkaVersion
```
public UpdateClusterKafkaVersionResult updateClusterKafkaVersion(UpdateClusterKafkaVersionRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates the Apache Kafka version for the cluster.
    
    Specified by:
    
    updateClusterKafkaVersion in interface AWSKafka
    
    Returns:
    
    Result of the UpdateClusterKafkaVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateConfiguration
```
public UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates an MSK configuration.
    
    Specified by:
    
    updateConfiguration in interface AWSKafka
    
    Returns:
    
    Result of the UpdateConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateMonitoring
```
public UpdateMonitoringResult updateMonitoring(UpdateMonitoringRequest request)
```
    Description copied from interface: AWSKafka
    
    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.
    
    Specified by:
    
    updateMonitoring in interface AWSKafka
    
    Parameters:
    
    request - Request body for UpdateMonitoring.
    
    Returns:
    
    Result of the UpdateMonitoring operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateSecurity
```
public UpdateSecurityResult updateSecurity(UpdateSecurityRequest request)
```
    Description copied from interface: AWSKafka
    
    Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.
    
    Specified by:
    
    updateSecurity in interface AWSKafka
    
    Returns:
    
    Result of the UpdateSecurity operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSKafka
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSKafka
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSKafka
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSKafka
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSKafka

Field Summary

Fields inherited from interface com.amazonaws.services.kafka.AWSKafka

Method Summary

Methods inherited from class java.lang.Object

Method Detail

batchAssociateScramSecret

batchDisassociateScramSecret

createCluster

createConfiguration

deleteCluster

deleteConfiguration

describeCluster

describeClusterOperation

describeConfiguration

describeConfigurationRevision

getBootstrapBrokers

getCompatibleKafkaVersions

listClusterOperations

listClusters

listConfigurationRevisions

listConfigurations

listKafkaVersions

listNodes

listScramSecrets

listTagsForResource

rebootBroker

tagResource

untagResource

updateBrokerCount

updateBrokerStorage

updateBrokerType

updateClusterConfiguration

updateClusterKafkaVersion

updateConfiguration

updateMonitoring

updateSecurity

shutdown

getCachedResponseMetadata