kafka {paws}R Documentation

Managed Streaming for Kafka

Description

The operations for managing an Amazon MSK cluster.

Usage

kafka(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

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

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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.

Service syntax

svc <- kafka(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  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_cluster_v2 Creates a new MSK cluster
create_configuration Creates a new MSK configuration
create_replicator Creates the replicator
create_vpc_connection Creates a new MSK VPC connection
delete_cluster Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request
delete_cluster_policy Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request
delete_configuration Deletes an MSK Configuration
delete_replicator Deletes a replicator
delete_vpc_connection Deletes a MSK VPC connection
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_cluster_operation_v2 Returns a description of the cluster operation specified by the ARN
describe_cluster_v2 Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request
describe_configuration Returns a description of this MSK configuration
describe_configuration_revision Returns a description of this revision of the configuration
describe_replicator Describes a replicator
describe_vpc_connection Returns a description of this MSK VPC connection
get_bootstrap_brokers A list of brokers that a client application can use to bootstrap
get_cluster_policy Get the MSK cluster policy specified by the Amazon Resource Name (ARN) in the request
get_compatible_kafka_versions Gets the Apache Kafka versions to which you can update the MSK cluster
list_client_vpc_connections Returns a list of all the VPC connections in this Region
list_cluster_operations Returns a list of all the operations that have been performed on the specified MSK cluster
list_cluster_operations_v2 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_clusters_v2 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 Apache Kafka versions
list_nodes Returns a list of the broker nodes in the cluster
list_replicators Lists the replicators
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
list_vpc_connections Returns a list of all the VPC connections in this Region
put_cluster_policy Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request
reboot_broker Reboots brokers
reject_client_vpc_connection Returns empty response
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_broker_type Updates EC2 instance type
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_connectivity Updates the cluster's connectivity configuration
update_monitoring Updates the monitoring settings for the cluster
update_replication_info Updates replication info of a replicator
update_security Updates the security settings for the cluster
update_storage Updates cluster broker volume size (or) sets cluster storage mode to TIERED

Examples

## Not run: 
svc <- kafka()
svc$batch_associate_scram_secret(
  Foo = 123
)

## End(Not run)
[Package paws version 0.6.0 Index]