View Source AWS.Kafka (aws-elixir v0.14.0)
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 Amazon MSK cluster of either the provisioned or the serverless type.
Creates a new MSK configuration.
Creates a new Kafka Replicator.
Creates a new Amazon 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 your request.
Deletes the specified MSK configuration.
Deletes a replicator.
Deletes the Amazon MSK VPC connection specified in your request.
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 of either the provisioned or the serverless type 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.
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
Displays information about the specified Amazon MSK VPC connection.
A list of brokers that a client application can use to bootstrap.
Retrieves the contents of the specified MSK cluster policy.
Gets the Apache Kafka versions to which you can update the MSK cluster.
Displays a list of client VPC connections.
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 revisions of an MSK configuration.
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.
Displays a list of Amazon MSK VPC connections.
Creates or updates the specified MSK cluster policy.
Executes a reboot on a broker.
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 all the brokers in the cluster to the specified type.
Updates the cluster with the configuration that is specified in the request body.
Updates the Apache Kafka version for the cluster.
Updates an existing MSK configuration.
Updates the connectivity configuration for the MSK cluster.
Updates the monitoring settings for the cluster.
Updates replication info of a replicator.
You can use this operation to update the encrypting and authentication settings for an existing 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 Amazon MSK cluster of either the provisioned or the serverless type.
Creates a new MSK configuration.
Creates a new Kafka Replicator.
Creates a new Amazon 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 your request.
Deletes the specified MSK configuration.
The configuration must be in the ACTIVE or DELETE_FAILED state.
Deletes a replicator.
Deletes the Amazon MSK VPC connection specified in your request.
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 of either the provisioned or the serverless type 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.
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
Displays information about the specified Amazon MSK VPC connection.
A list of brokers that a client application can use to bootstrap.
Retrieves the contents of the specified MSK cluster policy.
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 SourceDisplays a list of client VPC connections.
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 revisions of an MSK configuration.
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 SourceDisplays a list of Amazon MSK VPC connections.
Creates or updates the specified MSK cluster policy.
If updating the policy, the currentVersion field is required in the request payload.
Executes a reboot on a broker.
reject_client_vpc_connection(client, cluster_arn, input, options \\ [])
View SourceAdds 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.
You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers.
Updates the EBS storage associated with MSK brokers.
Updates all the brokers in the cluster to the specified 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 existing MSK configuration.
The configuration must be in the Active state.
Updates the connectivity configuration for the MSK cluster.
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.
You can use this operation to update the encrypting and authentication settings for an existing cluster.
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.