[ aws . kafka ]

update-monitoring

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-monitoring
--cluster-arn <value>
--current-version <value>
[--enhanced-monitoring <value>]
[--open-monitoring <value>]
[--logging-info <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cluster-arn (string)

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

--current-version (string)

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.

--enhanced-monitoring (string)

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

Possible values:

• DEFAULT

• PER_BROKER

• PER_TOPIC_PER_BROKER

• PER_TOPIC_PER_PARTITION

--open-monitoring (structure)

The settings for open monitoring.

Prometheus -> (structure)

Prometheus settings.

JmxExporter -> (structure)

Indicates whether you want to turn on or turn off the JMX Exporter.

EnabledInBroker -> (boolean)

Indicates whether you want to turn on or turn off the JMX Exporter.

NodeExporter -> (structure)

Indicates whether you want to turn on or turn off the Node Exporter.

EnabledInBroker -> (boolean)

Indicates whether you want to turn on or turn off the Node Exporter.

Shorthand Syntax:

Prometheus={JmxExporter={EnabledInBroker=boolean},NodeExporter={EnabledInBroker=boolean}}

JSON Syntax:

{
  "Prometheus": {
    "JmxExporter": {
      "EnabledInBroker": true|false
    },
    "NodeExporter": {
      "EnabledInBroker": true|false
    }
  }
}

--logging-info (structure) BrokerLogs -> (structure)

CloudWatchLogs -> (structure)

Enabled -> (boolean)

LogGroup -> (string)

Firehose -> (structure)

DeliveryStream -> (string)

Enabled -> (boolean)

S3 -> (structure)

Bucket -> (string)

Enabled -> (boolean)

Prefix -> (string)

Shorthand Syntax:

BrokerLogs={CloudWatchLogs={Enabled=boolean,LogGroup=string},Firehose={DeliveryStream=string,Enabled=boolean},S3={Bucket=string,Enabled=boolean,Prefix=string}}

JSON Syntax:

{
  "BrokerLogs": {
    "CloudWatchLogs": {
      "Enabled": true|false,
      "LogGroup": "string"
    },
    "Firehose": {
      "DeliveryStream": "string",
      "Enabled": true|false
    },
    "S3": {
      "Bucket": "string",
      "Enabled": true|false,
      "Prefix": "string"
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ClusterArn -> (string)

The Amazon Resource Name (ARN) of the cluster.

ClusterOperationArn -> (string)

The Amazon Resource Name (ARN) of the cluster operation.