Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436168166.7 KB

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

put/v1/clusters/{clusterArn}/monitoring

Path parameters

clusterArnstring required
        <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>

Request body

currentVersionstring required
        <p>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.</p>
enhancedMonitoring'DEFAULT' | 'PER_BROKER' | 'PER_TOPIC_PER_BROKER' | 'PER_TOPIC_PER_PARTITION'
        <p>Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see <a href="https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html">Monitoring</a>.</p>

Response

Success

ClusterArnstring
        <p>The Amazon Resource Name (ARN) of the cluster.</p>
ClusterOperationArnstring
        <p>The Amazon Resource Name (ARN) of the cluster operation.</p>