Interface CreateEventSourceMappingRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>, LambdaRequest.Builder, SdkBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateEventSourceMappingRequest

public static interface CreateEventSourceMappingRequest.Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder<CreateEventSourceMappingRequest.Builder,CreateEventSourceMappingRequest>
  • Method Details

    • eventSourceArn

      CreateEventSourceMappingRequest.Builder eventSourceArn(String eventSourceArn)

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

      • Amazon Kinesis – The ARN of the data stream or a stream consumer.

      • Amazon DynamoDB Streams – The ARN of the stream.

      • Amazon Simple Queue Service – The ARN of the queue.

      • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

      • Amazon MQ – The ARN of the broker.

      • Amazon DocumentDB – The ARN of the DocumentDB change stream.

      Parameters:
      eventSourceArn - The Amazon Resource Name (ARN) of the event source.

      • Amazon Kinesis – The ARN of the data stream or a stream consumer.

      • Amazon DynamoDB Streams – The ARN of the stream.

      • Amazon Simple Queue Service – The ARN of the queue.

      • Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings).

      • Amazon MQ – The ARN of the broker.

      • Amazon DocumentDB – The ARN of the DocumentDB change stream.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • functionName

      CreateEventSourceMappingRequest.Builder functionName(String functionName)

      The name or ARN of the Lambda function.

      Name formats

      • Function nameMyFunction.

      • Function ARNarn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARNarn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

      • Partial ARN123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

      Parameters:
      functionName - The name or ARN of the Lambda function.

      Name formats

      • Function nameMyFunction.

      • Function ARNarn:aws:lambda:us-west-2:123456789012:function:MyFunction.

      • Version or Alias ARNarn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

      • Partial ARN123456789012:function:MyFunction.

      The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • enabled

      When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

      Parameters:
      enabled - When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

      Default: True

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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).

      • Amazon Kinesis – Default 100. Max 10,000.

      • Amazon DynamoDB Streams – Default 100. Max 10,000.

      • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

      • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

      • Self-managed Apache Kafka – Default 100. Max 10,000.

      • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

      • DocumentDB – Default 100. Max 10,000.

      Parameters:
      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).

      • Amazon Kinesis – Default 100. Max 10,000.

      • Amazon DynamoDB Streams – Default 100. Max 10,000.

      • Amazon Simple Queue Service – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.

      • Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.

      • Self-managed Apache Kafka – Default 100. Max 10,000.

      • Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.

      • DocumentDB – Default 100. Max 10,000.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterCriteria

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

      Parameters:
      filterCriteria - An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filterCriteria

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

      This is a convenience method that creates an instance of the FilterCriteria.Builder avoiding the need to create one manually via FilterCriteria.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterCriteria(FilterCriteria).

      Parameters:
      filterCriteria - a consumer that will call methods on FilterCriteria.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • maximumBatchingWindowInSeconds

      CreateEventSourceMappingRequest.Builder maximumBatchingWindowInSeconds(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • parallelizationFactor

      CreateEventSourceMappingRequest.Builder parallelizationFactor(Integer parallelizationFactor)

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

      Parameters:
      parallelizationFactor - (Kinesis and DynamoDB Streams only) The number of batches to process from each shard concurrently.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startingPosition

      CreateEventSourceMappingRequest.Builder startingPosition(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startingPositionTimestamp

      CreateEventSourceMappingRequest.Builder startingPositionTimestamp(Instant startingPositionTimestamp)

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

      Parameters:
      startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • destinationConfig

      CreateEventSourceMappingRequest.Builder destinationConfig(DestinationConfig destinationConfig)

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

      Parameters:
      destinationConfig - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • destinationConfig

      default CreateEventSourceMappingRequest.Builder destinationConfig(Consumer<DestinationConfig.Builder> destinationConfig)

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

      This is a convenience method that creates an instance of the DestinationConfig.Builder avoiding the need to create one manually via DestinationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationConfig(DestinationConfig).

      Parameters:
      destinationConfig - a consumer that will call methods on DestinationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • maximumRecordAgeInSeconds

      CreateEventSourceMappingRequest.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)

      (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).

      Parameters:
      maximumRecordAgeInSeconds - (Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is infinite (-1).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • bisectBatchOnFunctionError

      CreateEventSourceMappingRequest.Builder bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)

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

      Parameters:
      bisectBatchOnFunctionError - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maximumRetryAttempts

      CreateEventSourceMappingRequest.Builder maximumRetryAttempts(Integer maximumRetryAttempts)

      (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

      Parameters:
      maximumRetryAttempts - (Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tumblingWindowInSeconds

      CreateEventSourceMappingRequest.Builder tumblingWindowInSeconds(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • topics

      The name of the Kafka topic.

      Parameters:
      topics - The name of the Kafka topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • topics

      The name of the Kafka topic.

      Parameters:
      topics - The name of the Kafka topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • queues

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

      Parameters:
      queues - (MQ) The name of the Amazon MQ broker destination queue to consume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • queues

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

      Parameters:
      queues - (MQ) The name of the Amazon MQ broker destination queue to consume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sourceAccessConfigurations

      CreateEventSourceMappingRequest.Builder sourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations)

      An array of authentication protocols or VPC components required to secure your event source.

      Parameters:
      sourceAccessConfigurations - An array of authentication protocols or VPC components required to secure your event source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sourceAccessConfigurations

      CreateEventSourceMappingRequest.Builder sourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations)

      An array of authentication protocols or VPC components required to secure your event source.

      Parameters:
      sourceAccessConfigurations - An array of authentication protocols or VPC components required to secure your event source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sourceAccessConfigurations

      CreateEventSourceMappingRequest.Builder sourceAccessConfigurations(Consumer<SourceAccessConfiguration.Builder>... sourceAccessConfigurations)

      An array of authentication protocols or VPC components required to secure your event source.

      This is a convenience method that creates an instance of the SourceAccessConfiguration.Builder avoiding the need to create one manually via SourceAccessConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceAccessConfigurations(List<SourceAccessConfiguration>).

      Parameters:
      sourceAccessConfigurations - a consumer that will call methods on SourceAccessConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • selfManagedEventSource

      CreateEventSourceMappingRequest.Builder selfManagedEventSource(SelfManagedEventSource selfManagedEventSource)

      The self-managed Apache Kafka cluster to receive records from.

      Parameters:
      selfManagedEventSource - The self-managed Apache Kafka cluster to receive records from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • selfManagedEventSource

      default CreateEventSourceMappingRequest.Builder selfManagedEventSource(Consumer<SelfManagedEventSource.Builder> selfManagedEventSource)

      The self-managed Apache Kafka cluster to receive records from.

      This is a convenience method that creates an instance of the SelfManagedEventSource.Builder avoiding the need to create one manually via SelfManagedEventSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selfManagedEventSource(SelfManagedEventSource).

      Parameters:
      selfManagedEventSource - a consumer that will call methods on SelfManagedEventSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • functionResponseTypesWithStrings

      CreateEventSourceMappingRequest.Builder functionResponseTypesWithStrings(Collection<String> functionResponseTypes)

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

      Parameters:
      functionResponseTypes - (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • functionResponseTypesWithStrings

      CreateEventSourceMappingRequest.Builder functionResponseTypesWithStrings(String... functionResponseTypes)

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

      Parameters:
      functionResponseTypes - (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • functionResponseTypes

      CreateEventSourceMappingRequest.Builder functionResponseTypes(Collection<FunctionResponseType> functionResponseTypes)

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

      Parameters:
      functionResponseTypes - (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • functionResponseTypes

      CreateEventSourceMappingRequest.Builder functionResponseTypes(FunctionResponseType... functionResponseTypes)

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

      Parameters:
      functionResponseTypes - (Kinesis, DynamoDB Streams, and Amazon SQS) A list of current response type enums applied to the event source mapping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • amazonManagedKafkaEventSourceConfig

      CreateEventSourceMappingRequest.Builder amazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfig amazonManagedKafkaEventSourceConfig)

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

      Parameters:
      amazonManagedKafkaEventSourceConfig - Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • amazonManagedKafkaEventSourceConfig

      default CreateEventSourceMappingRequest.Builder amazonManagedKafkaEventSourceConfig(Consumer<AmazonManagedKafkaEventSourceConfig.Builder> amazonManagedKafkaEventSourceConfig)

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

      This is a convenience method that creates an instance of the AmazonManagedKafkaEventSourceConfig.Builder avoiding the need to create one manually via AmazonManagedKafkaEventSourceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to amazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfig).

      Parameters:
      amazonManagedKafkaEventSourceConfig - a consumer that will call methods on AmazonManagedKafkaEventSourceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • selfManagedKafkaEventSourceConfig

      CreateEventSourceMappingRequest.Builder selfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfig selfManagedKafkaEventSourceConfig)

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

      Parameters:
      selfManagedKafkaEventSourceConfig - Specific configuration settings for a self-managed Apache Kafka event source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • selfManagedKafkaEventSourceConfig

      default CreateEventSourceMappingRequest.Builder selfManagedKafkaEventSourceConfig(Consumer<SelfManagedKafkaEventSourceConfig.Builder> selfManagedKafkaEventSourceConfig)

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

      This is a convenience method that creates an instance of the SelfManagedKafkaEventSourceConfig.Builder avoiding the need to create one manually via SelfManagedKafkaEventSourceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfig).

      Parameters:
      selfManagedKafkaEventSourceConfig - a consumer that will call methods on SelfManagedKafkaEventSourceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • scalingConfig

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

      Parameters:
      scalingConfig - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scalingConfig

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

      This is a convenience method that creates an instance of the ScalingConfig.Builder avoiding the need to create one manually via ScalingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfig(ScalingConfig).

      Parameters:
      scalingConfig - a consumer that will call methods on ScalingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • documentDBEventSourceConfig

      CreateEventSourceMappingRequest.Builder documentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig)

      Specific configuration settings for a DocumentDB event source.

      Parameters:
      documentDBEventSourceConfig - Specific configuration settings for a DocumentDB event source.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • documentDBEventSourceConfig

      default CreateEventSourceMappingRequest.Builder documentDBEventSourceConfig(Consumer<DocumentDBEventSourceConfig.Builder> documentDBEventSourceConfig)

      Specific configuration settings for a DocumentDB event source.

      This is a convenience method that creates an instance of the DocumentDBEventSourceConfig.Builder avoiding the need to create one manually via DocumentDBEventSourceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentDBEventSourceConfig(DocumentDBEventSourceConfig).

      Parameters:
      documentDBEventSourceConfig - a consumer that will call methods on DocumentDBEventSourceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

      CreateEventSourceMappingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.