Kafkaconnect
This page documents function available when using the Kafkaconnect module, created with @service Kafkaconnect.
Index
Main.Kafkaconnect.create_connectorMain.Kafkaconnect.create_custom_pluginMain.Kafkaconnect.create_worker_configurationMain.Kafkaconnect.delete_connectorMain.Kafkaconnect.delete_custom_pluginMain.Kafkaconnect.delete_worker_configurationMain.Kafkaconnect.describe_connectorMain.Kafkaconnect.describe_custom_pluginMain.Kafkaconnect.describe_worker_configurationMain.Kafkaconnect.list_connectorsMain.Kafkaconnect.list_custom_pluginsMain.Kafkaconnect.list_tags_for_resourceMain.Kafkaconnect.list_worker_configurationsMain.Kafkaconnect.tag_resourceMain.Kafkaconnect.untag_resourceMain.Kafkaconnect.update_connector
Documentation
Main.Kafkaconnect.create_connector — Methodcreate_connector(capacity, connector_configuration, connector_name, kafka_cluster, kafka_cluster_client_authentication, kafka_cluster_encryption_in_transit, kafka_connect_version, plugins, service_execution_role_arn)
create_connector(capacity, connector_configuration, connector_name, kafka_cluster, kafka_cluster_client_authentication, kafka_cluster_encryption_in_transit, kafka_connect_version, plugins, service_execution_role_arn, params::Dict{String,<:Any})Creates a connector using the specified properties.
Arguments
capacity: Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.connector_configuration: A map of keys to values that represent the configuration for the connector.connector_name: The name of the connector.kafka_cluster: Specifies which Apache Kafka cluster to connect to.kafka_cluster_client_authentication: Details of the client authentication used by the Apache Kafka cluster.kafka_cluster_encryption_in_transit: Details of encryption in transit to the Apache Kafka cluster.kafka_connect_version: The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.plugins: Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together. Specifies which plugin to use for the connector. You must specify a single-element list containing one customPlugin object.service_execution_role_arn: The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"connectorDescription": A summary description of the connector."logDelivery": Details about log delivery."tags": The tags you want to attach to the connector."workerConfiguration": Specifies which worker configuration to use with the connector.
Main.Kafkaconnect.create_custom_plugin — Methodcreate_custom_plugin(content_type, location, name)
create_custom_plugin(content_type, location, name, params::Dict{String,<:Any})Creates a custom plugin using the specified properties.
Arguments
content_type: The type of the plugin file.location: Information about the location of a custom plugin.name: The name of the custom plugin.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": A summary description of the custom plugin."tags": The tags you want to attach to the custom plugin.
Main.Kafkaconnect.create_worker_configuration — Methodcreate_worker_configuration(name, properties_file_content)
create_worker_configuration(name, properties_file_content, params::Dict{String,<:Any})Creates a worker configuration using the specified properties.
Arguments
name: The name of the worker configuration.properties_file_content: Base64 encoded contents of connect-distributed.properties file.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"description": A summary description of the worker configuration."tags": The tags you want to attach to the worker configuration.
Main.Kafkaconnect.delete_connector — Methoddelete_connector(connector_arn)
delete_connector(connector_arn, params::Dict{String,<:Any})Deletes the specified connector.
Arguments
connector_arn: The Amazon Resource Name (ARN) of the connector that you want to delete.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"currentVersion": The current version of the connector that you want to delete.
Main.Kafkaconnect.delete_custom_plugin — Methoddelete_custom_plugin(custom_plugin_arn)
delete_custom_plugin(custom_plugin_arn, params::Dict{String,<:Any})Deletes a custom plugin.
Arguments
custom_plugin_arn: The Amazon Resource Name (ARN) of the custom plugin that you want to delete.
Main.Kafkaconnect.delete_worker_configuration — Methoddelete_worker_configuration(worker_configuration_arn)
delete_worker_configuration(worker_configuration_arn, params::Dict{String,<:Any})Deletes the specified worker configuration.
Arguments
worker_configuration_arn: The Amazon Resource Name (ARN) of the worker configuration that you want to delete.
Main.Kafkaconnect.describe_connector — Methoddescribe_connector(connector_arn)
describe_connector(connector_arn, params::Dict{String,<:Any})Returns summary information about the connector.
Arguments
connector_arn: The Amazon Resource Name (ARN) of the connector that you want to describe.
Main.Kafkaconnect.describe_custom_plugin — Methoddescribe_custom_plugin(custom_plugin_arn)
describe_custom_plugin(custom_plugin_arn, params::Dict{String,<:Any})A summary description of the custom plugin.
Arguments
custom_plugin_arn: Returns information about a custom plugin.
Main.Kafkaconnect.describe_worker_configuration — Methoddescribe_worker_configuration(worker_configuration_arn)
describe_worker_configuration(worker_configuration_arn, params::Dict{String,<:Any})Returns information about a worker configuration.
Arguments
worker_configuration_arn: The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.
Main.Kafkaconnect.list_connectors — Methodlist_connectors()
list_connectors(params::Dict{String,<:Any})Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"connectorNamePrefix": The name prefix that you want to use to search for and list connectors."maxResults": The maximum number of connectors to list in one response."nextToken": If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
Main.Kafkaconnect.list_custom_plugins — Methodlist_custom_plugins()
list_custom_plugins(params::Dict{String,<:Any})Returns a list of all of the custom plugins in this account and Region.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of custom plugins to list in one response."namePrefix": Lists custom plugin names that start with the specified text string."nextToken": If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
Main.Kafkaconnect.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists all the tags attached to the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource for which you want to list all attached tags.
Main.Kafkaconnect.list_worker_configurations — Methodlist_worker_configurations()
list_worker_configurations(params::Dict{String,<:Any})Returns a list of all of the worker configurations in this account and Region.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of worker configurations to list in one response."namePrefix": Lists worker configuration names that start with the specified text string."nextToken": If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
Main.Kafkaconnect.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Attaches tags to the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource to which you want to attach tags.tags: The tags that you want to attach to the resource.
Main.Kafkaconnect.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes tags from the specified resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource from which you want to remove tags.tag_keys: The keys of the tags that you want to remove from the resource.
Main.Kafkaconnect.update_connector — Methodupdate_connector(capacity, connector_arn, current_version)
update_connector(capacity, connector_arn, current_version, params::Dict{String,<:Any})Updates the specified connector.
Arguments
capacity: The target capacity.connector_arn: The Amazon Resource Name (ARN) of the connector that you want to update.current_version: The current version of the connector that you want to update.