PATCH

/v1/clusters/{clusterArn}/security

http://kafka.{region}.amazonaws.com/v1/clusters/{clusterArn}/security

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

Access Token Required: API Key

Path Parameters

clusterArnstringrequired

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

Body Params

currentVersionstringrequired

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.

encryptionInfoobject

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

clientAuthenticationobject

Includes all client authentication information.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://kafka.{region}.amazonaws.com/v1/clusters/{clusterArn}/security' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}