Kafka

This page documents function available when using the Kafka module, created with @service Kafka.

Index

Documentation

Main.Kafka.batch_associate_scram_secretMethod
batch_associate_scram_secret(cluster_arn, secret_arn_list)
batch_associate_scram_secret(cluster_arn, secret_arn_list, params::Dict{String,<:Any})


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

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster to be updated.
  • secret_arn_list: List of AWS Secrets Manager secret ARNs.
Main.Kafka.batch_disassociate_scram_secretMethod
batch_disassociate_scram_secret(cluster_arn, secret_arn_list)
batch_disassociate_scram_secret(cluster_arn, secret_arn_list, params::Dict{String,<:Any})


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

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster to be updated.
  • secret_arn_list: List of AWS Secrets Manager secret ARNs.
Main.Kafka.create_clusterMethod
create_cluster(broker_node_group_info, cluster_name, kafka_version, number_of_broker_nodes)
create_cluster(broker_node_group_info, cluster_name, kafka_version, number_of_broker_nodes, params::Dict{String,<:Any})


        Creates a new MSK cluster.

Arguments

  • broker_node_group_info: Information about the broker nodes in the cluster.
  • cluster_name: The name of the cluster.
  • kafka_version: The version of Apache Kafka.
  • number_of_broker_nodes: The number of broker nodes in the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientAuthentication": Includes all client authentication related information.
  • "configurationInfo": Represents the configuration that you want MSK to use for the brokers in a cluster.
  • "encryptionInfo": Includes all encryption-related information.
  • "enhancedMonitoring": Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PERBROKER, PERTOPICPERBROKER, and PERTOPICPER_PARTITION.
  • "loggingInfo":
  • "openMonitoring": The settings for open monitoring.
  • "storageMode": This controls storage mode for supported storage tiers.
  • "tags": Create tags when creating the cluster.
Main.Kafka.create_cluster_v2Method
create_cluster_v2(cluster_name)
create_cluster_v2(cluster_name, params::Dict{String,<:Any})


        Creates a new MSK cluster.

Arguments

  • cluster_name: The name of the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "provisioned": Information about the provisioned cluster.
  • "serverless": Information about the serverless cluster.
  • "tags": A map of tags that you want the cluster to have.
Main.Kafka.create_configurationMethod
create_configuration(name, server_properties)
create_configuration(name, server_properties, params::Dict{String,<:Any})


        Creates a new MSK configuration.

Arguments

  • name: The name of the configuration.
  • server_properties: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the configuration.
  • "kafkaVersions": The versions of Apache Kafka with which you can use this MSK configuration.
Main.Kafka.create_vpc_connectionMethod
create_vpc_connection(authentication, client_subnets, security_groups, target_cluster_arn, vpc_id)
create_vpc_connection(authentication, client_subnets, security_groups, target_cluster_arn, vpc_id, params::Dict{String,<:Any})


        Creates a new MSK VPC connection.

Arguments

  • authentication: The authentication type of VPC connection.
  • client_subnets: The list of client subnets.
  • security_groups: The list of security groups.
  • target_cluster_arn: The cluster Amazon Resource Name (ARN) for the VPC connection.
  • vpc_id: The VPC ID of VPC connection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": A map of tags for the VPC connection.
Main.Kafka.delete_clusterMethod
delete_cluster(cluster_arn)
delete_cluster(cluster_arn, params::Dict{String,<:Any})


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

request.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "currentVersion": The current version of the MSK cluster.
Main.Kafka.delete_cluster_policyMethod
delete_cluster_policy(cluster_arn)
delete_cluster_policy(cluster_arn, params::Dict{String,<:Any})


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

the request.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster.
Main.Kafka.delete_configurationMethod
delete_configuration(arn)
delete_configuration(arn, params::Dict{String,<:Any})


        Deletes an MSK Configuration.

Arguments

  • arn: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.
Main.Kafka.delete_vpc_connectionMethod
delete_vpc_connection(arn)
delete_vpc_connection(arn, params::Dict{String,<:Any})


        Deletes a MSK VPC connection.

Arguments

  • arn: The Amazon Resource Name (ARN) that uniquely identifies an MSK VPC connection.
Main.Kafka.describe_clusterMethod
describe_cluster(cluster_arn)
describe_cluster(cluster_arn, params::Dict{String,<:Any})


        Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is

specified in the request.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Main.Kafka.describe_cluster_operationMethod
describe_cluster_operation(cluster_operation_arn)
describe_cluster_operation(cluster_operation_arn, params::Dict{String,<:Any})


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

Arguments

  • cluster_operation_arn: The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
Main.Kafka.describe_cluster_v2Method
describe_cluster_v2(cluster_arn)
describe_cluster_v2(cluster_arn, params::Dict{String,<:Any})


        Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is

specified in the request.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Main.Kafka.describe_configurationMethod
describe_configuration(arn)
describe_configuration(arn, params::Dict{String,<:Any})


        Returns a description of this MSK configuration.

Arguments

  • arn: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
Main.Kafka.describe_configuration_revisionMethod
describe_configuration_revision(arn, revision)
describe_configuration_revision(arn, revision, params::Dict{String,<:Any})


        Returns a description of this revision of the configuration.

Arguments

  • arn: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
  • revision: A string that uniquely identifies a revision of an MSK configuration.
Main.Kafka.describe_vpc_connectionMethod
describe_vpc_connection(arn)
describe_vpc_connection(arn, params::Dict{String,<:Any})


        Returns a description of this MSK VPC connection.

Arguments

  • arn: The Amazon Resource Name (ARN) that uniquely identifies a MSK VPC connection.
Main.Kafka.get_bootstrap_brokersMethod
get_bootstrap_brokers(cluster_arn)
get_bootstrap_brokers(cluster_arn, params::Dict{String,<:Any})


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

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Main.Kafka.get_cluster_policyMethod
get_cluster_policy(cluster_arn)
get_cluster_policy(cluster_arn, params::Dict{String,<:Any})


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

request.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster.
Main.Kafka.get_compatible_kafka_versionsMethod
get_compatible_kafka_versions()
get_compatible_kafka_versions(params::Dict{String,<:Any})


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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clusterArn": The Amazon Resource Name (ARN) of the cluster check.
Main.Kafka.list_client_vpc_connectionsMethod
list_client_vpc_connections(cluster_arn)
list_client_vpc_connections(cluster_arn, params::Dict{String,<:Any})


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

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_cluster_operationsMethod
list_cluster_operations(cluster_arn)
list_cluster_operations(cluster_arn, params::Dict{String,<:Any})


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

MSK cluster.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_clustersMethod
list_clusters()
list_clusters(params::Dict{String,<:Any})


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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clusterNameFilter": 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": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_clusters_v2Method
list_clusters_v2()
list_clusters_v2(params::Dict{String,<:Any})


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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clusterNameFilter": 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": Specify either PROVISIONED or SERVERLESS.
  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_configuration_revisionsMethod
list_configuration_revisions(arn)
list_configuration_revisions(arn, params::Dict{String,<:Any})


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

Arguments

  • arn: The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_configurationsMethod
list_configurations()
list_configurations(params::Dict{String,<:Any})


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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_kafka_versionsMethod
list_kafka_versions()
list_kafka_versions(params::Dict{String,<:Any})


        Returns a list of Apache Kafka versions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_nodesMethod
list_nodes(cluster_arn)
list_nodes(cluster_arn, params::Dict{String,<:Any})


        Returns a list of the broker nodes in the cluster.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.list_scram_secretsMethod
list_scram_secrets(cluster_arn)
list_scram_secrets(cluster_arn, params::Dict{String,<:Any})


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

Arguments

  • cluster_arn: The arn of the cluster.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maxResults of the query.
  • "nextToken": The nextToken of the query.
Main.Kafka.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})


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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
Main.Kafka.list_vpc_connectionsMethod
list_vpc_connections()
list_vpc_connections(params::Dict{String,<:Any})


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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
  • "nextToken": 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.
Main.Kafka.put_cluster_policyMethod
put_cluster_policy(cluster_arn, policy)
put_cluster_policy(cluster_arn, policy, params::Dict{String,<:Any})


        Creates or updates the MSK cluster policy specified by the cluster Amazon

Resource Name (ARN) in the request.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster.
  • policy: The policy.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "currentVersion": The policy version.
Main.Kafka.reboot_brokerMethod
reboot_broker(broker_ids, cluster_arn)
reboot_broker(broker_ids, cluster_arn, params::Dict{String,<:Any})

Reboots brokers.

Arguments

  • broker_ids: The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.
  • cluster_arn: The Amazon Resource Name (ARN) of the cluster to be updated.
Main.Kafka.reject_client_vpc_connectionMethod
reject_client_vpc_connection(cluster_arn, vpc_connection_arn)
reject_client_vpc_connection(cluster_arn, vpc_connection_arn, params::Dict{String,<:Any})


        Returns empty response.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster.
  • vpc_connection_arn: The VPC connection ARN.
Main.Kafka.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})


        Adds tags to the specified MSK resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
  • tags: The key-value pair for the resource tag.
Main.Kafka.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})


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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
  • tag_keys: 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: _ . / = + - @.
Main.Kafka.update_broker_countMethod
update_broker_count(cluster_arn, current_version, target_number_of_broker_nodes)
update_broker_count(cluster_arn, current_version, target_number_of_broker_nodes, params::Dict{String,<:Any})


        Updates the number of broker nodes in the cluster.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  • current_version: The version of cluster to update from. A successful operation will then generate a new version.
  • target_number_of_broker_nodes: The number of broker nodes that you want the cluster to have after this operation completes successfully.
Main.Kafka.update_broker_storageMethod
update_broker_storage(cluster_arn, current_version, target_broker_ebsvolume_info)
update_broker_storage(cluster_arn, current_version, target_broker_ebsvolume_info, params::Dict{String,<:Any})


        Updates the EBS storage associated with MSK brokers.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  • current_version: The version of cluster to update from. A successful operation will then generate a new version.
  • target_broker_ebsvolume_info: Describes the target volume size and the ID of the broker to apply the update to.
Main.Kafka.update_broker_typeMethod
update_broker_type(cluster_arn, current_version, target_instance_type)
update_broker_type(cluster_arn, current_version, target_instance_type, params::Dict{String,<:Any})


        Updates EC2 instance type.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  • current_version: The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.
  • target_instance_type: The Amazon MSK broker type that you want all of the brokers in this cluster to be.
Main.Kafka.update_cluster_configurationMethod
update_cluster_configuration(cluster_arn, configuration_info, current_version)
update_cluster_configuration(cluster_arn, configuration_info, current_version, params::Dict{String,<:Any})


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

body.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  • configuration_info: Represents the configuration that you want MSK to use for the brokers in a cluster.
  • current_version: The version of the cluster that needs to be updated.
Main.Kafka.update_cluster_kafka_versionMethod
update_cluster_kafka_version(cluster_arn, current_version, target_kafka_version)
update_cluster_kafka_version(cluster_arn, current_version, target_kafka_version, params::Dict{String,<:Any})


        Updates the Apache Kafka version for the cluster.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster to be updated.
  • current_version: Current cluster version.
  • target_kafka_version: Target Kafka version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "configurationInfo": The custom configuration that should be applied on the new version of cluster.
Main.Kafka.update_configurationMethod
update_configuration(arn, server_properties)
update_configuration(arn, server_properties, params::Dict{String,<:Any})


        Updates an MSK configuration.

Arguments

  • arn: The Amazon Resource Name (ARN) of the configuration.
  • server_properties: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the configuration revision.
Main.Kafka.update_connectivityMethod
update_connectivity(cluster_arn, connectivity_info, current_version)
update_connectivity(cluster_arn, connectivity_info, current_version, params::Dict{String,<:Any})


        Updates the cluster's connectivity configuration.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the configuration.
  • connectivity_info: Information about the broker access configuration.
  • current_version: 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.
Main.Kafka.update_monitoringMethod
update_monitoring(cluster_arn, current_version)
update_monitoring(cluster_arn, current_version, params::Dict{String,<:Any})


        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.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  • current_version: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "enhancedMonitoring": Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
  • "loggingInfo":
  • "openMonitoring": The settings for open monitoring.
Main.Kafka.update_securityMethod
update_security(cluster_arn, current_version)
update_security(cluster_arn, current_version, params::Dict{String,<:Any})


        Updates the security settings for the cluster. You can use this operation to

specify encryption and authentication on existing clusters.

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) that uniquely identifies the cluster.
  • current_version: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientAuthentication": Includes all client authentication related information.
  • "encryptionInfo": Includes all encryption-related information.
Main.Kafka.update_storageMethod
update_storage(cluster_arn, current_version)
update_storage(cluster_arn, current_version, params::Dict{String,<:Any})

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

Arguments

  • cluster_arn: The Amazon Resource Name (ARN) of the cluster to be updated.
  • current_version: The version of cluster to update from. A successful operation will then generate a new version.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "provisionedThroughput": EBS volume provisioned throughput information.
  • "storageMode": Controls storage mode for supported storage tiers.
  • "volumeSizeGB": size of the EBS volume to update.