Class SelfManagedKafkaEventSourceConfig

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

Specific configuration settings for a self-managed Apache Kafka event source.

See Also:

  • Method Details

    • consumerGroupId

      public final String consumerGroupId()

      The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

      Returns:
      The identifier for the Kafka consumer group to join. The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see Customizable consumer group ID.

    • schemaRegistryConfig

      public final KafkaSchemaRegistryConfig schemaRegistryConfig()

      Specific configuration settings for a Kafka schema registry.

      Returns:
      Specific configuration settings for a Kafka schema registry.

    • consumptionMode

      public final KafkaEventSourceMappingConsumptionMode consumptionMode()

      The mode that Lambda uses to consume records from your self-managed Apache Kafka topic. The default is Stream.

      • Stream – Lambda consumes records using a Kafka consumer group and preserves the order of records within each partition. This is the default when you omit ConsumptionMode.

      • Queue – Lambda consumes records using a Kafka share group. Multiple consumers can process records from the same partitions concurrently. Queue mode does not preserve per-partition order. Queue mode requires an Apache Kafka cluster running version 4.2 or later with share groups enabled.

      You cannot change ConsumptionMode after you create the event source mapping. To use a different consumption mode, create a new event source mapping.

      When ConsumptionMode is Queue, the StartingPosition, StartingPositionTimestamp, and MaximumBatchingWindowInSeconds parameters are not supported.

      If the service returns an enum value that is not available in the current SDK version, consumptionMode will return KafkaEventSourceMappingConsumptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consumptionModeAsString().

      Returns:
      The mode that Lambda uses to consume records from your self-managed Apache Kafka topic. The default is Stream.

      • Stream – Lambda consumes records using a Kafka consumer group and preserves the order of records within each partition. This is the default when you omit ConsumptionMode.

      • Queue – Lambda consumes records using a Kafka share group. Multiple consumers can process records from the same partitions concurrently. Queue mode does not preserve per-partition order. Queue mode requires an Apache Kafka cluster running version 4.2 or later with share groups enabled.

      You cannot change ConsumptionMode after you create the event source mapping. To use a different consumption mode, create a new event source mapping.

      When ConsumptionMode is Queue, the StartingPosition, StartingPositionTimestamp, and MaximumBatchingWindowInSeconds parameters are not supported.

      See Also:

    • consumptionModeAsString

      public final String consumptionModeAsString()

      The mode that Lambda uses to consume records from your self-managed Apache Kafka topic. The default is Stream.

      • Stream – Lambda consumes records using a Kafka consumer group and preserves the order of records within each partition. This is the default when you omit ConsumptionMode.

      • Queue – Lambda consumes records using a Kafka share group. Multiple consumers can process records from the same partitions concurrently. Queue mode does not preserve per-partition order. Queue mode requires an Apache Kafka cluster running version 4.2 or later with share groups enabled.

      You cannot change ConsumptionMode after you create the event source mapping. To use a different consumption mode, create a new event source mapping.

      When ConsumptionMode is Queue, the StartingPosition, StartingPositionTimestamp, and MaximumBatchingWindowInSeconds parameters are not supported.

      If the service returns an enum value that is not available in the current SDK version, consumptionMode will return KafkaEventSourceMappingConsumptionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consumptionModeAsString().

      Returns:
      The mode that Lambda uses to consume records from your self-managed Apache Kafka topic. The default is Stream.

      • Stream – Lambda consumes records using a Kafka consumer group and preserves the order of records within each partition. This is the default when you omit ConsumptionMode.

      • Queue – Lambda consumes records using a Kafka share group. Multiple consumers can process records from the same partitions concurrently. Queue mode does not preserve per-partition order. Queue mode requires an Apache Kafka cluster running version 4.2 or later with share groups enabled.

      You cannot change ConsumptionMode after you create the event source mapping. To use a different consumption mode, create a new event source mapping.

      When ConsumptionMode is Queue, the StartingPosition, StartingPositionTimestamp, and MaximumBatchingWindowInSeconds parameters are not supported.

      See Also:

    • toBuilder

      public SelfManagedKafkaEventSourceConfig.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<SelfManagedKafkaEventSourceConfig.Builder,SelfManagedKafkaEventSourceConfig>
      Returns:
      a builder for type T

    • builder

      public static SelfManagedKafkaEventSourceConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SelfManagedKafkaEventSourceConfig.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.