Skip to content

Update Connectivity

kafka_update_connectivity R Documentation

Updates the cluster's connectivity configuration

Description

Updates the cluster's connectivity configuration.

Usage

kafka_update_connectivity(ClusterArn, ConnectivityInfo, CurrentVersion)

Arguments

ClusterArn

[required] The Amazon Resource Name (ARN) of the configuration.

ConnectivityInfo

[required] Information about the broker access configuration.

CurrentVersion

[required] The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

Value

A list with the following syntax:

list(
  ClusterArn = "string",
  ClusterOperationArn = "string"
)

Request syntax

svc$update_connectivity(
  ClusterArn = "string",
  ConnectivityInfo = list(
    PublicAccess = list(
      Type = "string"
    ),
    VpcConnectivity = list(
      ClientAuthentication = list(
        Sasl = list(
          Scram = list(
            Enabled = TRUE|FALSE
          ),
          Iam = list(
            Enabled = TRUE|FALSE
          )
        ),
        Tls = list(
          Enabled = TRUE|FALSE
        )
      )
    )
  ),
  CurrentVersion = "string"
)