Class: Aws::Kafka::Types::UpdateMonitoringRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb

Overview

Note:

When making an API call, you may pass UpdateMonitoringRequest data as a hash:

{
  cluster_arn: "__string", # required
  current_version: "__string", # required
  enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER
  open_monitoring: {
    prometheus: { # required
      jmx_exporter: {
        enabled_in_broker: false, # required
      },
      node_exporter: {
        enabled_in_broker: false, # required
      },
    },
  },
  logging_info: {
    broker_logs: { # required
      cloud_watch_logs: {
        enabled: false, # required
        log_group: "__string",
      },
      firehose: {
        delivery_stream: "__string",
        enabled: false, # required
      },
      s3: {
        bucket: "__string",
        enabled: false, # required
        prefix: "__string",
      },
    },
  },
}

Request body for UpdateMonitoring.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_arnString

Returns:

  • (String)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2294

class UpdateMonitoringRequest < Struct.new(
  :cluster_arn,
  :current_version,
  :enhanced_monitoring,
  :open_monitoring,
  :logging_info)
  SENSITIVE = []
  include Aws::Structure
end

#current_versionString

The version of cluster to update from. A successful operation will then generate a new version.

Returns:

  • (String)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2294

class UpdateMonitoringRequest < Struct.new(
  :cluster_arn,
  :current_version,
  :enhanced_monitoring,
  :open_monitoring,
  :logging_info)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_monitoringString

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

Returns:

  • (String)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2294

class UpdateMonitoringRequest < Struct.new(
  :cluster_arn,
  :current_version,
  :enhanced_monitoring,
  :open_monitoring,
  :logging_info)
  SENSITIVE = []
  include Aws::Structure
end

#logging_infoTypes::LoggingInfo

LoggingInfo details.

Returns:



2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2294

class UpdateMonitoringRequest < Struct.new(
  :cluster_arn,
  :current_version,
  :enhanced_monitoring,
  :open_monitoring,
  :logging_info)
  SENSITIVE = []
  include Aws::Structure
end

#open_monitoringTypes::OpenMonitoringInfo

The settings for open monitoring.



2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/types.rb', line 2294

class UpdateMonitoringRequest < Struct.new(
  :cluster_arn,
  :current_version,
  :enhanced_monitoring,
  :open_monitoring,
  :logging_info)
  SENSITIVE = []
  include Aws::Structure
end