Class KafkaExporterConfiguration

java.lang.Object
software.amazon.awssdk.services.amp.model.KafkaExporterConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KafkaExporterConfiguration.Builder,KafkaExporterConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class KafkaExporterConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KafkaExporterConfiguration.Builder,KafkaExporterConfiguration>

The configuration for collecting broker, topic, and consumer-group metrics from an Amazon MSK cluster through a managed Kafka exporter. The cluster must be active, have IAM authentication enabled, and be in the same account and Region as the scraper. Provisioned clusters with Standard brokers are supported. MSK Serverless clusters are not supported.

Use a VPC source that can connect to the cluster's IAM bootstrap brokers. The exporter authenticates with the scraper's service-linked role. Metrics can be sent to an Amazon Managed Service for Prometheus workspace or a CloudWatch dataset.

You must have an Amazon MSK cluster policy that grants the scraper's service-linked role access to the cluster. Without this policy, the scraper collects no Kafka metrics. For the required actions and example policies, see Grant the scraper access to the cluster in the Amazon Managed Service for Prometheus User Guide.

See Also:

  • Method Details

    • clusterArn

      public final String clusterArn()

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

      Returns:
      The Amazon Resource Name (ARN) of the Amazon MSK cluster.

    • topicFilter

      public final String topicFilter()

      An anchored RE2 regular expression that selects the Kafka topics to monitor. The expression must start with ^ and end with $. If omitted, the default is ^.*$, which selects all topics.

      Returns:
      An anchored RE2 regular expression that selects the Kafka topics to monitor. The expression must start with ^ and end with $. If omitted, the default is ^.*$, which selects all topics.

    • consumerGroupFilter

      public final String consumerGroupFilter()

      An anchored RE2 regular expression that selects the Kafka consumer groups to monitor. The expression must start with ^ and end with $. If omitted, the default is ^.*$, which selects all consumer groups.

      Returns:
      An anchored RE2 regular expression that selects the Kafka consumer groups to monitor. The expression must start with ^ and end with $. If omitted, the default is ^.*$, which selects all consumer groups.

    • toBuilder

      public KafkaExporterConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KafkaExporterConfiguration.Builder,KafkaExporterConfiguration>
      Returns:
      a builder for type T

    • builder

      public static KafkaExporterConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KafkaExporterConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.