Kafka

public struct Kafka

Client object for interacting with AWS Kafka service.

The operations for managing an Amazon MSK cluster.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the Kafka client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    createCluster(_:)

Creates a new MSK cluster.

Declaration

Swift

public func createCluster(_ input: CreateClusterRequest) -> EventLoopFuture<CreateClusterResponse>


                    
                    
                    createConfiguration(_:)

Creates a new MSK configuration.

Declaration

Swift

public func createConfiguration(_ input: CreateConfigurationRequest) -> EventLoopFuture<CreateConfigurationResponse>

deleteCluster(_:)
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Declaration
Swift

public func deleteCluster(_ input: DeleteClusterRequest) -> EventLoopFuture<DeleteClusterResponse>
deleteConfiguration(_:)
Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.
Declaration
Swift

public func deleteConfiguration(_ input: DeleteConfigurationRequest) -> EventLoopFuture<DeleteConfigurationResponse>
describeCluster(_:)
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Declaration
Swift

public func describeCluster(_ input: DescribeClusterRequest) -> EventLoopFuture<DescribeClusterResponse>


                    
                    
                    describeClusterOperation(_:)

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

Declaration

Swift

public func describeClusterOperation(_ input: DescribeClusterOperationRequest) -> EventLoopFuture<DescribeClusterOperationResponse>


                    
                    
                    describeConfiguration(_:)

Returns a description of this MSK configuration.

Declaration

Swift

public func describeConfiguration(_ input: DescribeConfigurationRequest) -> EventLoopFuture<DescribeConfigurationResponse>


                    
                    
                    describeConfigurationRevision(_:)

Returns a description of this revision of the configuration.

Declaration

Swift

public func describeConfigurationRevision(_ input: DescribeConfigurationRevisionRequest) -> EventLoopFuture<DescribeConfigurationRevisionResponse>


                    
                    
                    getBootstrapBrokers(_:)

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

Declaration

Swift

public func getBootstrapBrokers(_ input: GetBootstrapBrokersRequest) -> EventLoopFuture<GetBootstrapBrokersResponse>


                    
                    
                    getCompatibleKafkaVersions(_:)

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

Declaration

Swift

public func getCompatibleKafkaVersions(_ input: GetCompatibleKafkaVersionsRequest) -> EventLoopFuture<GetCompatibleKafkaVersionsResponse>

listClusterOperations(_:)
Returns a list of all the operations that have been performed on the specified MSK cluster.
Declaration
Swift

public func listClusterOperations(_ input: ListClusterOperationsRequest) -> EventLoopFuture<ListClusterOperationsResponse>


                    
                    
                    listClusters(_:)

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

Declaration

Swift

public func listClusters(_ input: ListClustersRequest) -> EventLoopFuture<ListClustersResponse>


                    
                    
                    listConfigurationRevisions(_:)

Returns a list of all the revisions of an MSK configuration.

Declaration

Swift

public func listConfigurationRevisions(_ input: ListConfigurationRevisionsRequest) -> EventLoopFuture<ListConfigurationRevisionsResponse>


                    
                    
                    listConfigurations(_:)

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

Declaration

Swift

public func listConfigurations(_ input: ListConfigurationsRequest) -> EventLoopFuture<ListConfigurationsResponse>


                    
                    
                    listKafkaVersions(_:)

Returns a list of Kafka versions.

Declaration

Swift

public func listKafkaVersions(_ input: ListKafkaVersionsRequest) -> EventLoopFuture<ListKafkaVersionsResponse>


                    
                    
                    listNodes(_:)

Returns a list of the broker nodes in the cluster.

Declaration

Swift

public func listNodes(_ input: ListNodesRequest) -> EventLoopFuture<ListNodesResponse>


                    
                    
                    listTagsForResource(_:)

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

Declaration

Swift

public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>


                    
                    
                    rebootBroker(_:)

Executes a reboot on a broker.

Declaration

Swift

public func rebootBroker(_ input: RebootBrokerRequest) -> EventLoopFuture<RebootBrokerResponse>


                    
                    
                    tagResource(_:)

Adds tags to the specified MSK resource.

Declaration

Swift

@discardableResult
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>


                    
                    
                    untagResource(_:)

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

Declaration

Swift

@discardableResult
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>

updateBrokerCount(_:)
Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can’t decrease the number of brokers.
Declaration
Swift

public func updateBrokerCount(_ input: UpdateBrokerCountRequest) -> EventLoopFuture<UpdateBrokerCountResponse>


                    
                    
                    updateBrokerStorage(_:)

Updates the EBS storage associated with MSK brokers.

Declaration

Swift

public func updateBrokerStorage(_ input: UpdateBrokerStorageRequest) -> EventLoopFuture<UpdateBrokerStorageResponse>


                    
                    
                    updateClusterConfiguration(_:)

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

Declaration

Swift

public func updateClusterConfiguration(_ input: UpdateClusterConfigurationRequest) -> EventLoopFuture<UpdateClusterConfigurationResponse>


                    
                    
                    updateClusterKafkaVersion(_:)

Updates the Apache Kafka version for the cluster.

Declaration

Swift

public func updateClusterKafkaVersion(_ input: UpdateClusterKafkaVersionRequest) -> EventLoopFuture<UpdateClusterKafkaVersionResponse>

updateConfiguration(_:)
Updates an existing MSK configuration. The configuration must be in the Active state.
Declaration
Swift

public func updateConfiguration(_ input: UpdateConfigurationRequest) -> EventLoopFuture<UpdateConfigurationResponse>
updateMonitoring(_:)
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.
Declaration
Swift

public func updateMonitoring(_ input: UpdateMonitoringRequest) -> EventLoopFuture<UpdateMonitoringResponse>

Paginators


                    
                    
                    listClusterOperationsPaginator(_:onPage:)

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

Declaration

Swift

public func listClusterOperationsPaginator(_ input: ListClusterOperationsRequest, onPage: @escaping (ListClusterOperationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listClustersPaginator(_:onPage:)

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

Declaration

Swift

public func listClustersPaginator(_ input: ListClustersRequest, onPage: @escaping (ListClustersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listConfigurationRevisionsPaginator(_:onPage:)

Returns a list of all the revisions of an MSK configuration.

Declaration

Swift

public func listConfigurationRevisionsPaginator(_ input: ListConfigurationRevisionsRequest, onPage: @escaping (ListConfigurationRevisionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listConfigurationsPaginator(_:onPage:)

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

Declaration

Swift

public func listConfigurationsPaginator(_ input: ListConfigurationsRequest, onPage: @escaping (ListConfigurationsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listKafkaVersionsPaginator(_:onPage:)

Returns a list of Kafka versions.

Declaration

Swift

public func listKafkaVersionsPaginator(_ input: ListKafkaVersionsRequest, onPage: @escaping (ListKafkaVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>


                    
                    
                    listNodesPaginator(_:onPage:)

Returns a list of the broker nodes in the cluster.

Declaration

Swift

public func listNodesPaginator(_ input: ListNodesRequest, onPage: @escaping (ListNodesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    ListClusterOperationsRequest

Undocumented

Declaration

Swift

public struct ListClusterOperationsRequest : AWSShape

extension Kafka.ListClusterOperationsRequest: AWSPaginateStringToken


                    
                    
                    ListClustersRequest

Undocumented

Declaration

Swift

public struct ListClustersRequest : AWSShape

extension Kafka.ListClustersRequest: AWSPaginateStringToken


                    
                    
                    ListConfigurationRevisionsRequest

Undocumented

Declaration

Swift

public struct ListConfigurationRevisionsRequest : AWSShape

extension Kafka.ListConfigurationRevisionsRequest: AWSPaginateStringToken


                    
                    
                    ListConfigurationsRequest

Undocumented

Declaration

Swift

public struct ListConfigurationsRequest : AWSShape

extension Kafka.ListConfigurationsRequest: AWSPaginateStringToken


                    
                    
                    ListKafkaVersionsRequest

Undocumented

Declaration

Swift

public struct ListKafkaVersionsRequest : AWSShape

extension Kafka.ListKafkaVersionsRequest: AWSPaginateStringToken


                    
                    
                    ListNodesRequest

Undocumented

Declaration

Swift

public struct ListNodesRequest : AWSShape

extension Kafka.ListNodesRequest: AWSPaginateStringToken

BrokerEBSVolumeInfo
Undocumented
See more
Declaration
Swift

public struct BrokerEBSVolumeInfo : AWSShape
BrokerLogs
Undocumented
See more
Declaration
Swift

public struct BrokerLogs : AWSShape
BrokerNodeGroupInfo
Undocumented
See more
Declaration
Swift

public struct BrokerNodeGroupInfo : AWSShape
BrokerNodeInfo
Undocumented
See more
Declaration
Swift

public struct BrokerNodeInfo : AWSShape
BrokerSoftwareInfo
Undocumented
See more
Declaration
Swift

public struct BrokerSoftwareInfo : AWSShape
ClientAuthentication
Undocumented
See more
Declaration
Swift

public struct ClientAuthentication : AWSShape
CloudWatchLogs
Undocumented
See more
Declaration
Swift

public struct CloudWatchLogs : AWSShape
ClusterInfo
Undocumented
See more
Declaration
Swift

public struct ClusterInfo : AWSShape
ClusterOperationInfo
Undocumented
See more
Declaration
Swift

public struct ClusterOperationInfo : AWSShape
ClusterOperationStep
Undocumented
See more
Declaration
Swift

public struct ClusterOperationStep : AWSShape
ClusterOperationStepInfo
Undocumented
See more
Declaration
Swift

public struct ClusterOperationStepInfo : AWSShape
CompatibleKafkaVersion
Undocumented
See more
Declaration
Swift

public struct CompatibleKafkaVersion : AWSShape
Configuration
Undocumented
See more
Declaration
Swift

public struct Configuration : AWSShape
ConfigurationInfo
Undocumented
See more
Declaration
Swift

public struct ConfigurationInfo : AWSShape
ConfigurationRevision
Undocumented
See more
Declaration
Swift

public struct ConfigurationRevision : AWSShape
CreateClusterRequest
Undocumented
See more
Declaration
Swift

public struct CreateClusterRequest : AWSShape
CreateClusterResponse
Undocumented
See more
Declaration
Swift

public struct CreateClusterResponse : AWSShape
CreateConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct CreateConfigurationRequest : AWSShape
CreateConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct CreateConfigurationResponse : AWSShape
DeleteClusterRequest
Undocumented
See more
Declaration
Swift

public struct DeleteClusterRequest : AWSShape
DeleteClusterResponse
Undocumented
See more
Declaration
Swift

public struct DeleteClusterResponse : AWSShape
DeleteConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DeleteConfigurationRequest : AWSShape
DeleteConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DeleteConfigurationResponse : AWSShape
DescribeClusterOperationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeClusterOperationRequest : AWSShape
DescribeClusterOperationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeClusterOperationResponse : AWSShape
DescribeClusterRequest
Undocumented
See more
Declaration
Swift

public struct DescribeClusterRequest : AWSShape
DescribeClusterResponse
Undocumented
See more
Declaration
Swift

public struct DescribeClusterResponse : AWSShape
DescribeConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationRequest : AWSShape
DescribeConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationResponse : AWSShape
DescribeConfigurationRevisionRequest
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationRevisionRequest : AWSShape
DescribeConfigurationRevisionResponse
Undocumented
See more
Declaration
Swift

public struct DescribeConfigurationRevisionResponse : AWSShape
EBSStorageInfo
Undocumented
See more
Declaration
Swift

public struct EBSStorageInfo : AWSShape
EncryptionAtRest
Undocumented
See more
Declaration
Swift

public struct EncryptionAtRest : AWSShape
EncryptionInTransit
Undocumented
See more
Declaration
Swift

public struct EncryptionInTransit : AWSShape
EncryptionInfo
Undocumented
See more
Declaration
Swift

public struct EncryptionInfo : AWSShape
ErrorInfo
Undocumented
See more
Declaration
Swift

public struct ErrorInfo : AWSShape
Firehose
Undocumented
See more
Declaration
Swift

public struct Firehose : AWSShape
GetBootstrapBrokersRequest
Undocumented
See more
Declaration
Swift

public struct GetBootstrapBrokersRequest : AWSShape
GetBootstrapBrokersResponse
Undocumented
See more
Declaration
Swift

public struct GetBootstrapBrokersResponse : AWSShape
GetCompatibleKafkaVersionsRequest
Undocumented
See more
Declaration
Swift

public struct GetCompatibleKafkaVersionsRequest : AWSShape
GetCompatibleKafkaVersionsResponse
Undocumented
See more
Declaration
Swift

public struct GetCompatibleKafkaVersionsResponse : AWSShape
JmxExporter
Undocumented
See more
Declaration
Swift

public struct JmxExporter : AWSShape
JmxExporterInfo
Undocumented
See more
Declaration
Swift

public struct JmxExporterInfo : AWSShape
KafkaVersion
Undocumented
See more
Declaration
Swift

public struct KafkaVersion : AWSShape
ListClusterOperationsResponse
Undocumented
See more
Declaration
Swift

public struct ListClusterOperationsResponse : AWSShape
ListClustersResponse
Undocumented
See more
Declaration
Swift

public struct ListClustersResponse : AWSShape
ListConfigurationRevisionsResponse
Undocumented
See more
Declaration
Swift

public struct ListConfigurationRevisionsResponse : AWSShape
ListConfigurationsResponse
Undocumented
See more
Declaration
Swift

public struct ListConfigurationsResponse : AWSShape
ListKafkaVersionsResponse
Undocumented
See more
Declaration
Swift

public struct ListKafkaVersionsResponse : AWSShape
ListNodesResponse
Undocumented
See more
Declaration
Swift

public struct ListNodesResponse : AWSShape
ListTagsForResourceRequest
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceRequest : AWSShape
ListTagsForResourceResponse
Undocumented
See more
Declaration
Swift

public struct ListTagsForResourceResponse : AWSShape
LoggingInfo
Undocumented
See more
Declaration
Swift

public struct LoggingInfo : AWSShape
MutableClusterInfo
Undocumented
See more
Declaration
Swift

public struct MutableClusterInfo : AWSShape
NodeExporter
Undocumented
See more
Declaration
Swift

public struct NodeExporter : AWSShape
NodeExporterInfo
Undocumented
See more
Declaration
Swift

public struct NodeExporterInfo : AWSShape
NodeInfo
Undocumented
See more
Declaration
Swift

public struct NodeInfo : AWSShape
OpenMonitoring
Undocumented
See more
Declaration
Swift

public struct OpenMonitoring : AWSShape
OpenMonitoringInfo
Undocumented
See more
Declaration
Swift

public struct OpenMonitoringInfo : AWSShape
Prometheus
Undocumented
See more
Declaration
Swift

public struct Prometheus : AWSShape
PrometheusInfo
Undocumented
See more
Declaration
Swift

public struct PrometheusInfo : AWSShape
RebootBrokerRequest
Undocumented
See more
Declaration
Swift

public struct RebootBrokerRequest : AWSShape
RebootBrokerResponse
Undocumented
See more
Declaration
Swift

public struct RebootBrokerResponse : AWSShape
S3
Undocumented
See more
Declaration
Swift

public struct S3 : AWSShape
StorageInfo
Undocumented
See more
Declaration
Swift

public struct StorageInfo : AWSShape
TagResourceRequest
Undocumented
See more
Declaration
Swift

public struct TagResourceRequest : AWSShape
Tls
Undocumented
See more
Declaration
Swift

public struct Tls : AWSShape
UntagResourceRequest
Undocumented
See more
Declaration
Swift

public struct UntagResourceRequest : AWSShape
UpdateBrokerCountRequest
Undocumented
See more
Declaration
Swift

public struct UpdateBrokerCountRequest : AWSShape
UpdateBrokerCountResponse
Undocumented
See more
Declaration
Swift

public struct UpdateBrokerCountResponse : AWSShape
UpdateBrokerStorageRequest
Undocumented
See more
Declaration
Swift

public struct UpdateBrokerStorageRequest : AWSShape
UpdateBrokerStorageResponse
Undocumented
See more
Declaration
Swift

public struct UpdateBrokerStorageResponse : AWSShape
UpdateClusterConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateClusterConfigurationRequest : AWSShape
UpdateClusterConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateClusterConfigurationResponse : AWSShape
UpdateClusterKafkaVersionRequest
Undocumented
See more
Declaration
Swift

public struct UpdateClusterKafkaVersionRequest : AWSShape
UpdateClusterKafkaVersionResponse
Undocumented
See more
Declaration
Swift

public struct UpdateClusterKafkaVersionResponse : AWSShape
UpdateConfigurationRequest
Undocumented
See more
Declaration
Swift

public struct UpdateConfigurationRequest : AWSShape
UpdateConfigurationResponse
Undocumented
See more
Declaration
Swift

public struct UpdateConfigurationResponse : AWSShape
UpdateMonitoringRequest
Undocumented
See more
Declaration
Swift

public struct UpdateMonitoringRequest : AWSShape
UpdateMonitoringResponse
Undocumented
See more
Declaration
Swift

public struct UpdateMonitoringResponse : AWSShape
ZookeeperNodeInfo
Undocumented
See more
Declaration
Swift

public struct ZookeeperNodeInfo : AWSShape

Enums


                    
                    
                    BrokerAZDistribution

Undocumented

Declaration

Swift

public enum BrokerAZDistribution : String, CustomStringConvertible, Codable


                    
                    
                    ClientBroker

Undocumented

Declaration

Swift

public enum ClientBroker : String, CustomStringConvertible, Codable


                    
                    
                    ClusterState

Undocumented

Declaration

Swift

public enum ClusterState : String, CustomStringConvertible, Codable


                    
                    
                    ConfigurationState

Undocumented

Declaration

Swift

public enum ConfigurationState : String, CustomStringConvertible, Codable


                    
                    
                    EnhancedMonitoring

Undocumented

Declaration

Swift

public enum EnhancedMonitoring : String, CustomStringConvertible, Codable


                    
                    
                    KafkaVersionStatus

Undocumented

Declaration

Swift

public enum KafkaVersionStatus : String, CustomStringConvertible, Codable


                    
                    
                    NodeType

Undocumented

Declaration

Swift

public enum NodeType : String, CustomStringConvertible, Codable