@aws-cdk/aws-msk-alpha.MonitoringConfiguration

Experimental

@aws-cdk/aws-msk-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

MonitoringConfiguration Struct

Monitoring Configuration.

Stability

Experimental

Source

lib/cluster.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as msk_alpha from '@aws-cdk/aws-msk-alpha';
const monitoringConfiguration: msk_alpha.MonitoringConfiguration = {
  clusterMonitoringLevel: msk_alpha.ClusterMonitoringLevel.DEFAULT,
  enablePrometheusJmxExporter: false,
  enablePrometheusNodeExporter: false,
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_msk_alpha as msk_alpha

monitoring_configuration = msk_alpha.MonitoringConfiguration(
    cluster_monitoring_level=msk_alpha.ClusterMonitoringLevel.DEFAULT,
    enable_prometheus_jmx_exporter=False,
    enable_prometheus_node_exporter=False
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.msk.alpha.*;

MonitoringConfiguration monitoringConfiguration = MonitoringConfiguration.builder()
        .clusterMonitoringLevel(ClusterMonitoringLevel.DEFAULT)
        .enablePrometheusJmxExporter(false)
        .enablePrometheusNodeExporter(false)
        .build();

// Install: dotnet add package Amazon.CDK.AWS.MSK.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MSK.Alpha;

var monitoringConfiguration = new MonitoringConfiguration {
    ClusterMonitoringLevel = ClusterMonitoringLevel.DEFAULT,
    EnablePrometheusJmxExporter = false,
    EnablePrometheusNodeExporter = false
};

// Install: go get github.com/aws/aws-cdk-go/awscdkmskalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import msk_alpha "github.com/aws/aws-cdk-go/awscdkmskalpha"

monitoringConfiguration := &MonitoringConfiguration{
	ClusterMonitoringLevel: msk_alpha.ClusterMonitoringLevel_DEFAULT,
	EnablePrometheusJmxExporter: jsii.Boolean(false),
	EnablePrometheusNodeExporter: jsii.Boolean(false),
}

Properties

clusterMonitoringLevel?optionalClusterMonitoringLevelcluster_monitoring_level?optionalClusterMonitoringLevelclusterMonitoringLevel?optionalClusterMonitoringLevelClusterMonitoringLevel?optionalClusterMonitoringLevelClusterMonitoringLevel?optionalClusterMonitoringLevel= DEFAULT#

Specifies the level of monitoring for the MSK cluster.

enablePrometheusJmxExporter?optionalbooleanenable_prometheus_jmx_exporter?optionalboolenablePrometheusJmxExporter?optionalBooleanEnablePrometheusJmxExporter?optionalboolEnablePrometheusJmxExporter?optional*bool= false#

Indicates whether you want to enable or disable the JMX Exporter.

enablePrometheusNodeExporter?optionalbooleanenable_prometheus_node_exporter?optionalboolenablePrometheusNodeExporter?optionalBooleanEnablePrometheusNodeExporter?optionalboolEnablePrometheusNodeExporter?optional*bool= false#

Indicates whether you want to enable or disable the Prometheus Node Exporter.

You can use the Prometheus Node Exporter to get CPU and disk metrics for the broker nodes.