Class EventSourceMappingConfiguration

java.lang.Object
software.amazon.awssdk.services.lambda.model.EventSourceMappingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>

@Generated("software.amazon.awssdk:codegen") public final class EventSourceMappingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

See Also:
  • Method Details

    • uuid

      public final String uuid()

      The identifier of the event source mapping.

      Returns:
      The identifier of the event source mapping.
    • startingPosition

      public final EventSourcePosition startingPosition()

      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

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

      Returns:
      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
      See Also:
    • startingPositionAsString

      public final String startingPositionAsString()

      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

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

      Returns:
      The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.
      See Also:
    • startingPositionTimestamp

      public final Instant startingPositionTimestamp()

      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

      Returns:
      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.
    • batchSize

      public final Integer batchSize()

      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

      Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

      Returns:
      The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

      Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

      Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • maximumBatchingWindowInSeconds

      public final Integer maximumBatchingWindowInSeconds()

      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

      For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

      Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

      Returns:
      The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

      For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, Amazon MQ, and DocumentDB event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

      Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

    • parallelizationFactor

      public final Integer parallelizationFactor()

      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.

      Returns:
      (Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
    • eventSourceArn

      public final String eventSourceArn()

      The Amazon Resource Name (ARN) of the event source.

      Returns:
      The Amazon Resource Name (ARN) of the event source.
    • filterCriteria

      public final FilterCriteria filterCriteria()

      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

      Returns:
      An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
    • functionArn

      public final String functionArn()

      The ARN of the Lambda function.

      Returns:
      The ARN of the Lambda function.
    • lastModified

      public final Instant lastModified()

      The date that the event source mapping was last updated or that its state changed.

      Returns:
      The date that the event source mapping was last updated or that its state changed.
    • lastProcessingResult

      public final String lastProcessingResult()

      The result of the last Lambda invocation of your function.

      Returns:
      The result of the last Lambda invocation of your function.
    • state

      public final String state()

      The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating , or Deleting.

      Returns:
      The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.
    • stateTransitionReason

      public final String stateTransitionReason()

      Indicates whether a user or Lambda made the last change to the event source mapping.

      Returns:
      Indicates whether a user or Lambda made the last change to the event source mapping.
    • destinationConfig

      public final DestinationConfig destinationConfig()

      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

      Returns:
      (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
    • hasTopics

      public final boolean hasTopics()
      For responses, this returns true if the service returned a value for the Topics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • topics

      public final List<String> topics()

      The name of the Kafka topic.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTopics() method.

      Returns:
      The name of the Kafka topic.
    • hasQueues

      public final boolean hasQueues()
      For responses, this returns true if the service returned a value for the Queues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • queues

      public final List<String> queues()

      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueues() method.

      Returns:
      (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
    • hasSourceAccessConfigurations

      public final boolean hasSourceAccessConfigurations()
      For responses, this returns true if the service returned a value for the SourceAccessConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • sourceAccessConfigurations

      public final List<SourceAccessConfiguration> sourceAccessConfigurations()

      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSourceAccessConfigurations() method.

      Returns:
      An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
    • selfManagedEventSource

      public final SelfManagedEventSource selfManagedEventSource()

      The self-managed Apache Kafka cluster for your event source.

      Returns:
      The self-managed Apache Kafka cluster for your event source.
    • maximumRecordAgeInSeconds

      public final Integer maximumRecordAgeInSeconds()

      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

      Returns:
      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

      The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed

    • bisectBatchOnFunctionError

      public final Boolean bisectBatchOnFunctionError()

      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

      Returns:
      (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. The default value is false.
    • maximumRetryAttempts

      public final Integer maximumRetryAttempts()

      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

      Returns:
      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
    • tumblingWindowInSeconds

      public final Integer tumblingWindowInSeconds()

      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.

      Returns:
      (Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources. A value of 0 seconds indicates no tumbling window.
    • functionResponseTypes

      public final List<FunctionResponseType> functionResponseTypes()

      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFunctionResponseTypes() method.

      Returns:
      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
    • hasFunctionResponseTypes

      public final boolean hasFunctionResponseTypes()
      For responses, this returns true if the service returned a value for the FunctionResponseTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • functionResponseTypesAsStrings

      public final List<String> functionResponseTypesAsStrings()

      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFunctionResponseTypes() method.

      Returns:
      (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
    • amazonManagedKafkaEventSourceConfig

      public final AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig()

      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

      Returns:
      Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
    • selfManagedKafkaEventSourceConfig

      public final SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig()

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

      Returns:
      Specific configuration settings for a self-managed Apache Kafka event source.
    • scalingConfig

      public final ScalingConfig scalingConfig()

      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

      Returns:
      (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
    • documentDBEventSourceConfig

      public final DocumentDBEventSourceConfig documentDBEventSourceConfig()

      Specific configuration settings for a DocumentDB event source.

      Returns:
      Specific configuration settings for a DocumentDB event source.
    • 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<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>
      Returns:
      a builder for type T
    • builder

      public static EventSourceMappingConfiguration.Builder builder()
    • serializableBuilderClass

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