Update the configuration of an Amazon MSK cluster
To update the configuration of a cluster, make sure that the cluster is in the
ACTIVE
state. You must also ensure that the number of partitions per
broker on your MSK cluster is under the limits described in Right-size your cluster: Number of
partitions per broker. You can't update the configuration of a cluster
that exceeds these limits.
For information about MSK configuration, including how to create a custom configuration, which properties you can update, and what happens when you update the configuration of an existing cluster, see Amazon MSK configuration.
Updating the configuration of a cluster using the Amazon CLI
-
Copy the following JSON and save it to a file. Name the file
configuration-info.json
. ReplaceConfigurationArn
with the Amazon Resource Name (ARN) of the configuration that you want to use to update the cluster. The ARN string must be in quotes in the following JSON.Replace
Configuration-Revision
with the revision of the configuration that you want to use. Configuration revisions are integers (whole numbers) that start at1
. This integer mustn't be in quotes in the following JSON.{ "Arn":
ConfigurationArn
, "Revision":Configuration-Revision
} -
Run the following command, replacing
ClusterArn
with the ARN that you obtained when you created your cluster. If you don't have the ARN for your cluster, you can find it by listing all clusters. For more information, see List Amazon MSK clusters.Replace
Path-to-Config-Info-File
with the path to your configuration info file. If you named the file that you created in the previous stepconfiguration-info.json
and saved it in the current directory, thenPath-to-Config-Info-File
isconfiguration-info.json
.Replace
Current-Cluster-Version
with the current version of the cluster.Important
Cluster versions aren't simple integers. To find the current version of the cluster, use the DescribeCluster
operation or the describe-cluster Amazon CLI command. An example version is KTVPDKIKX0DER
.aws kafka update-cluster-configuration --cluster-arn
ClusterArn
--configuration-info file://Path-to-Config-Info-File
--current-versionCurrent-Cluster-Version
The following is an example of how to use this command:
aws kafka update-cluster-configuration --cluster-arn "arn:aws:kafka:us-east-1:0123456789012:cluster/exampleName/abcd1234-0123-abcd-5678-1234abcd-1" --configuration-info file://c:\users\tester\msk\configuration-info.json --current-version "K1X5R6FKA87"
The output of this
update-cluster-configuration
command looks like the following JSON example.{ "ClusterArn": "arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2", "ClusterOperationArn": "arn:aws:kafka:us-east-1:012345678012:cluster-operation/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2/0123abcd-abcd-4f7f-1234-9876543210ef" }
-
To get the result of the
update-cluster-configuration
operation, run the following command, replacingClusterOperationArn
with the ARN that you obtained in the output of theupdate-cluster-configuration
command.aws kafka describe-cluster-operation --cluster-operation-arn
ClusterOperationArn
The output of this
describe-cluster-operation
command looks like the following JSON example.{ "ClusterOperationInfo": { "ClientRequestId": "982168a3-939f-11e9-8a62-538df00285db", "ClusterArn": "arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2", "CreationTime": "2019-06-20T21:08:57.735Z", "OperationArn": "arn:aws:kafka:us-east-1:012345678012:cluster-operation/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2/0123abcd-abcd-4f7f-1234-9876543210ef", "OperationState": "UPDATE_COMPLETE", "OperationType": "UPDATE_CLUSTER_CONFIGURATION", "SourceClusterInfo": {}, "TargetClusterInfo": { "ConfigurationInfo": { "Arn": "arn:aws:kafka:us-east-1:123456789012:configuration/ExampleConfigurationName/abcdabcd-abcd-1234-abcd-abcd123e8e8e-1", "Revision": 1 } } } }
In this output,
OperationType
isUPDATE_CLUSTER_CONFIGURATION
. IfOperationState
has the valueUPDATE_IN_PROGRESS
, wait a while, then run thedescribe-cluster-operation
command again.
Update the configuration of a Amazon MSK cluster using the API
To use the API to update the configuration of a Amazon MSK cluster, see UpdateClusterConfiguration.