paws (version 0.1.12)

kafka: Managed Streaming for Kafka

Description

The operations for managing an Amazon MSK cluster.

Usage

kafka(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- kafka(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

batch_associate_scram_secret	Associates one or more Scram Secrets with an Amazon MSK cluster
batch_disassociate_scram_secret	Disassociates one or more Scram Secrets from an Amazon MSK cluster
create_cluster	Creates a new MSK cluster
create_configuration	Creates a new MSK configuration
delete_cluster	Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request
delete_configuration	Deletes an MSK Configuration
describe_cluster	Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request
describe_cluster_operation	Returns a description of the cluster operation specified by the ARN
describe_configuration	Returns a description of this MSK configuration
describe_configuration_revision	Returns a description of this revision of the configuration
get_bootstrap_brokers	A list of brokers that a client application can use to bootstrap
get_compatible_kafka_versions	Gets the Apache Kafka versions to which you can update the MSK cluster
list_cluster_operations	Returns a list of all the operations that have been performed on the specified MSK cluster
list_clusters	Returns a list of all the MSK clusters in the current Region
list_configuration_revisions	Returns a list of all the MSK configurations in this Region
list_configurations	Returns a list of all the MSK configurations in this Region
list_kafka_versions	Returns a list of Kafka versions
list_nodes	Returns a list of the broker nodes in the cluster
list_scram_secrets	Returns a list of the Scram Secrets associated with an Amazon MSK cluster
list_tags_for_resource	Returns a list of the tags associated with the specified resource
reboot_broker	Reboots brokers
tag_resource	Adds tags to the specified MSK resource
untag_resource	Removes the tags associated with the keys that are provided in the query
update_broker_count	Updates the number of broker nodes in the cluster
update_broker_storage	Updates the EBS storage associated with MSK brokers
update_cluster_configuration	Updates the cluster with the configuration that is specified in the request body
update_cluster_kafka_version	Updates the Apache Kafka version for the cluster
update_configuration	Updates an MSK configuration
update_monitoring	Updates the monitoring settings for the cluster

Examples

if (FALSE) {
svc <- kafka()
svc$batch_associate_scram_secret(
  Foo = 123
)
}