View Source AWS.Kafka (aws-elixir v1.0.4)
The operations for managing an Amazon MSK cluster.
Link to this section Summary
Functions
Associates one or more Scram Secrets with an Amazon MSK cluster.
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
Creates a new MSK cluster.
Creates a new MSK cluster.
Creates a new MSK configuration.
Creates the replicator.
Creates a new MSK VPC connection.
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
Deletes an MSK Configuration.
Deletes a replicator.
Deletes a MSK VPC connection.
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Returns a description of the cluster operation specified by the ARN.
Returns a description of the cluster operation specified by the ARN.
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Returns a description of this MSK configuration.
Returns a description of this revision of the configuration.
Describes a replicator.
Returns a description of this MSK VPC connection.
A list of brokers that a client application can use to bootstrap.
Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
Gets the Apache Kafka versions to which you can update the MSK cluster.
Returns a list of all the VPC connections in this Region.
Returns a list of all the operations that have been performed on the specified MSK cluster.
Returns a list of all the operations that have been performed on the specified MSK cluster.
Returns a list of all the MSK clusters in the current Region.
Returns a list of all the MSK clusters in the current Region.
Returns a list of all the MSK configurations in this Region.
Returns a list of all the MSK configurations in this Region.
Returns a list of Apache Kafka versions.
Returns a list of the broker nodes in the cluster.
Lists the replicators.
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
Returns a list of the tags associated with the specified resource.
Returns a list of all the VPC connections in this Region.
Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
Reboots brokers.
Returns empty response.
Adds tags to the specified MSK resource.
Removes the tags associated with the keys that are provided in the query.
Updates the number of broker nodes in the cluster.
Updates the EBS storage associated with MSK brokers.
Updates EC2 instance type.
Updates the cluster with the configuration that is specified in the request body.
Updates the Apache Kafka version for the cluster.
Updates an MSK configuration.
Updates the cluster's connectivity configuration.
Updates the monitoring settings for the cluster.
Updates replication info of a replicator.
Updates the security settings for the cluster.
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
Link to this section Functions
batch_associate_scram_secret(client, cluster_arn, input, options \\ [])
View SourceAssociates one or more Scram Secrets with an Amazon MSK cluster.
batch_disassociate_scram_secret(client, cluster_arn, input, options \\ [])
View SourceDisassociates one or more Scram Secrets from an Amazon MSK cluster.
Creates a new MSK cluster.
Creates a new MSK cluster.
Creates a new MSK configuration.
Creates the replicator.
Creates a new MSK VPC connection.
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
Deletes an MSK Configuration.
Deletes a replicator.
Deletes a MSK VPC connection.
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
describe_cluster_operation(client, cluster_operation_arn, options \\ [])
View SourceReturns a description of the cluster operation specified by the ARN.
describe_cluster_operation_v2(client, cluster_operation_arn, options \\ [])
View SourceReturns a description of the cluster operation specified by the ARN.
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
Returns a description of this MSK configuration.
describe_configuration_revision(client, arn, revision, options \\ [])
View SourceReturns a description of this revision of the configuration.
Describes a replicator.
Returns a description of this MSK VPC connection.
A list of brokers that a client application can use to bootstrap.
This list doesn't necessarily include all of the brokers in the cluster. The
following Python 3.6 example shows how you can use the Amazon Resource Name
(ARN) of a cluster to get its bootstrap brokers. If you don't know the ARN of
your cluster, you can use the ListClusters
operation to get the ARNs of all
the clusters in this account and Region.
Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request.
get_compatible_kafka_versions(client, cluster_arn \\ nil, options \\ [])
View SourceGets the Apache Kafka versions to which you can update the MSK cluster.
list_client_vpc_connections(client, cluster_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the VPC connections in this Region.
list_cluster_operations(client, cluster_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the operations that have been performed on the specified MSK cluster.
list_cluster_operations_v2(client, cluster_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the operations that have been performed on the specified MSK cluster.
list_clusters(client, cluster_name_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the MSK clusters in the current Region.
list_clusters_v2(client, cluster_name_filter \\ nil, cluster_type_filter \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the MSK clusters in the current Region.
list_configuration_revisions(client, arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the MSK configurations in this Region.
list_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the MSK configurations in this Region.
list_kafka_versions(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of Apache Kafka versions.
list_nodes(client, cluster_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the broker nodes in the cluster.
list_replicators(client, max_results \\ nil, next_token \\ nil, replicator_name_filter \\ nil, options \\ [])
View SourceLists the replicators.
list_scram_secrets(client, cluster_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of the Scram Secrets associated with an Amazon MSK cluster.
Returns a list of the tags associated with the specified resource.
list_vpc_connections(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns a list of all the VPC connections in this Region.
Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.
Reboots brokers.
reject_client_vpc_connection(client, cluster_arn, input, options \\ [])
View SourceReturns empty response.
Adds tags to the specified MSK resource.
Removes the tags associated with the keys that are provided in the query.
Updates the number of broker nodes in the cluster.
Updates the EBS storage associated with MSK brokers.
Updates EC2 instance type.
update_cluster_configuration(client, cluster_arn, input, options \\ [])
View SourceUpdates the cluster with the configuration that is specified in the request body.
update_cluster_kafka_version(client, cluster_arn, input, options \\ [])
View SourceUpdates the Apache Kafka version for the cluster.
Updates an MSK configuration.
Updates the cluster's connectivity configuration.
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.
update_replication_info(client, replicator_arn, input, options \\ [])
View SourceUpdates replication info of a replicator.
Updates the security settings for the cluster.
You can use this operation to specify encryption and authentication on existing clusters.
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.