Skip to content

Update Security

kafka_update_security R Documentation

Updates the security settings for the cluster

Description

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

Usage

kafka_update_security(ClientAuthentication, ClusterArn, CurrentVersion,
  EncryptionInfo)

Arguments

ClientAuthentication

Includes all client authentication related information.

ClusterArn

[required] The Amazon Resource Name (ARN) that uniquely identifies the cluster.

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.

EncryptionInfo

Includes all encryption-related information.

Value

A list with the following syntax:

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

Request syntax

svc$update_security(
  ClientAuthentication = list(
    Sasl = list(
      Scram = list(
        Enabled = TRUE|FALSE
      ),
      Iam = list(
        Enabled = TRUE|FALSE
      )
    ),
    Tls = list(
      CertificateAuthorityArnList = list(
        "string"
      ),
      Enabled = TRUE|FALSE
    ),
    Unauthenticated = list(
      Enabled = TRUE|FALSE
    )
  ),
  ClusterArn = "string",
  CurrentVersion = "string",
  EncryptionInfo = list(
    EncryptionAtRest = list(
      DataVolumeKMSKeyId = "string"
    ),
    EncryptionInTransit = list(
      ClientBroker = "TLS"|"TLS_PLAINTEXT"|"PLAINTEXT",
      InCluster = TRUE|FALSE
    )
  )
)