software.amazon.awssdk.services.lambda.model

Interface EventSourceMappingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>, SdkBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>, SdkPojo

Enclosing class:

EventSourceMappingConfiguration

public static interface EventSourceMappingConfiguration.Builder
extends SdkPojo, CopyableBuilder<EventSourceMappingConfiguration.Builder,EventSourceMappingConfiguration>

Method Summary

Modifier and Type	Method and Description
EventSourceMappingConfiguration.Builder	batchSize(Integer batchSize) The maximum number of items to retrieve in a single batch.
EventSourceMappingConfiguration.Builder	bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError) (Streams only) If the function returns an error, split the batch in two and retry.
default EventSourceMappingConfiguration.Builder	destinationConfig(Consumer<DestinationConfig.Builder> destinationConfig) (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
EventSourceMappingConfiguration.Builder	destinationConfig(DestinationConfig destinationConfig) (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
EventSourceMappingConfiguration.Builder	eventSourceArn(String eventSourceArn) The Amazon Resource Name (ARN) of the event source.
EventSourceMappingConfiguration.Builder	functionArn(String functionArn) The ARN of the Lambda function.
EventSourceMappingConfiguration.Builder	functionResponseTypes(Collection<FunctionResponseType> functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
EventSourceMappingConfiguration.Builder	functionResponseTypes(FunctionResponseType... functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
EventSourceMappingConfiguration.Builder	functionResponseTypesWithStrings(Collection<String> functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
EventSourceMappingConfiguration.Builder	functionResponseTypesWithStrings(String... functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
EventSourceMappingConfiguration.Builder	lastModified(Instant lastModified) The date that the event source mapping was last updated, or its state changed.
EventSourceMappingConfiguration.Builder	lastProcessingResult(String lastProcessingResult) The result of the last Lambda invocation of your Lambda function.
EventSourceMappingConfiguration.Builder	maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds) (Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.
EventSourceMappingConfiguration.Builder	maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) (Streams only) Discard records older than the specified age.
EventSourceMappingConfiguration.Builder	maximumRetryAttempts(Integer maximumRetryAttempts) (Streams only) Discard records after the specified number of retries.
EventSourceMappingConfiguration.Builder	parallelizationFactor(Integer parallelizationFactor) (Streams only) The number of batches to process from each shard concurrently.
EventSourceMappingConfiguration.Builder	queues(Collection<String> queues) (MQ) The name of the Amazon MQ broker destination queue to consume.
EventSourceMappingConfiguration.Builder	queues(String... queues) (MQ) The name of the Amazon MQ broker destination queue to consume.
default EventSourceMappingConfiguration.Builder	selfManagedEventSource(Consumer<SelfManagedEventSource.Builder> selfManagedEventSource) The Self-Managed Apache Kafka cluster for your event source.
EventSourceMappingConfiguration.Builder	selfManagedEventSource(SelfManagedEventSource selfManagedEventSource) The Self-Managed Apache Kafka cluster for your event source.
EventSourceMappingConfiguration.Builder	sourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations) An array of the authentication protocol, or the VPC components to secure your event source.
EventSourceMappingConfiguration.Builder	sourceAccessConfigurations(Consumer<SourceAccessConfiguration.Builder>... sourceAccessConfigurations) An array of the authentication protocol, or the VPC components to secure your event source.
EventSourceMappingConfiguration.Builder	sourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations) An array of the authentication protocol, or the VPC components to secure your event source.
EventSourceMappingConfiguration.Builder	startingPosition(EventSourcePosition startingPosition) The position in a stream from which to start reading.
EventSourceMappingConfiguration.Builder	startingPosition(String startingPosition) The position in a stream from which to start reading.
EventSourceMappingConfiguration.Builder	startingPositionTimestamp(Instant startingPositionTimestamp) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
EventSourceMappingConfiguration.Builder	state(String state) The state of the event source mapping.
EventSourceMappingConfiguration.Builder	stateTransitionReason(String stateTransitionReason) Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
EventSourceMappingConfiguration.Builder	topics(Collection<String> topics) The name of the Kafka topic.
EventSourceMappingConfiguration.Builder	topics(String... topics) The name of the Kafka topic.
EventSourceMappingConfiguration.Builder	tumblingWindowInSeconds(Integer tumblingWindowInSeconds) (Streams only) The duration in seconds of a processing window.
EventSourceMappingConfiguration.Builder	uuid(String uuid) The identifier of the event source mapping.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

uuid

EventSourceMappingConfiguration.Builder uuid(String uuid)

The identifier of the event source mapping.

Parameters:

uuid - The identifier of the event source mapping.

Returns:

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

startingPosition

EventSourceMappingConfiguration.Builder startingPosition(String startingPosition)

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

Parameters:

startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

Returns:

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

See Also:

EventSourcePosition, EventSourcePosition

startingPosition

EventSourceMappingConfiguration.Builder startingPosition(EventSourcePosition startingPosition)

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

Parameters:

startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

Returns:

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

See Also:

EventSourcePosition, EventSourcePosition

startingPositionTimestamp

EventSourceMappingConfiguration.Builder startingPositionTimestamp(Instant startingPositionTimestamp)

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

Parameters:

startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

Returns:

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

batchSize

EventSourceMappingConfiguration.Builder batchSize(Integer batchSize)

The maximum number of items to retrieve in a single batch.

Parameters:

batchSize - The maximum number of items to retrieve in a single batch.

Returns:

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

maximumBatchingWindowInSeconds

EventSourceMappingConfiguration.Builder maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

Parameters:

maximumBatchingWindowInSeconds - (Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

Returns:

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

parallelizationFactor

EventSourceMappingConfiguration.Builder parallelizationFactor(Integer parallelizationFactor)

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

Parameters:

parallelizationFactor - (Streams only) The number of batches to process from each shard concurrently. The default value is 1.

Returns:

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

eventSourceArn

EventSourceMappingConfiguration.Builder eventSourceArn(String eventSourceArn)

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

Parameters:

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

Returns:

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

functionArn

EventSourceMappingConfiguration.Builder functionArn(String functionArn)

The ARN of the Lambda function.

Parameters:

functionArn - The ARN of the Lambda function.

Returns:

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

lastModified

EventSourceMappingConfiguration.Builder lastModified(Instant lastModified)

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

Parameters:

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

Returns:

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

lastProcessingResult

EventSourceMappingConfiguration.Builder lastProcessingResult(String lastProcessingResult)

The result of the last Lambda invocation of your Lambda function.

Parameters:

lastProcessingResult - The result of the last Lambda invocation of your Lambda function.

Returns:

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

state

EventSourceMappingConfiguration.Builder state(String state)

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

Parameters:

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

Returns:

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

stateTransitionReason

EventSourceMappingConfiguration.Builder stateTransitionReason(String stateTransitionReason)

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

Parameters:

stateTransitionReason - Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

Returns:

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

destinationConfig

EventSourceMappingConfiguration.Builder destinationConfig(DestinationConfig destinationConfig)

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Parameters:

destinationConfig - (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Returns:

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

destinationConfig

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

(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

This is a convenience 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:

destinationConfig(DestinationConfig)

topics

EventSourceMappingConfiguration.Builder topics(Collection<String> 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

EventSourceMappingConfiguration.Builder topics(String... 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

EventSourceMappingConfiguration.Builder queues(Collection<String> 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

EventSourceMappingConfiguration.Builder queues(String... 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

EventSourceMappingConfiguration.Builder sourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations)

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

Parameters:

sourceAccessConfigurations - An array of the authentication protocol, or the VPC components to secure your event source.

Returns:

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

sourceAccessConfigurations

EventSourceMappingConfiguration.Builder sourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations)

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

Parameters:

sourceAccessConfigurations - An array of the authentication protocol, or the VPC components to secure your event source.

Returns:

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

sourceAccessConfigurations

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

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #sourceAccessConfigurations(List).

Parameters:

sourceAccessConfigurations - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#sourceAccessConfigurations(List)

selfManagedEventSource

EventSourceMappingConfiguration.Builder selfManagedEventSource(SelfManagedEventSource selfManagedEventSource)

The Self-Managed Apache Kafka cluster for your event source.

Parameters:

selfManagedEventSource - The Self-Managed Apache Kafka cluster for your event source.

Returns:

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

selfManagedEventSource

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

The Self-Managed Apache Kafka cluster for your event source.

This is a convenience 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:

selfManagedEventSource(SelfManagedEventSource)

maximumRecordAgeInSeconds

EventSourceMappingConfiguration.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)

(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.

Parameters:

maximumRecordAgeInSeconds - (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.

Returns:

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

bisectBatchOnFunctionError

EventSourceMappingConfiguration.Builder bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)

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

Parameters:

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

Returns:

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

maximumRetryAttempts

EventSourceMappingConfiguration.Builder maximumRetryAttempts(Integer maximumRetryAttempts)

(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.

Parameters:

maximumRetryAttempts - (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:

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

tumblingWindowInSeconds

EventSourceMappingConfiguration.Builder tumblingWindowInSeconds(Integer tumblingWindowInSeconds)

(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

Parameters:

tumblingWindowInSeconds - (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

Returns:

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

functionResponseTypesWithStrings

EventSourceMappingConfiguration.Builder functionResponseTypesWithStrings(Collection<String> functionResponseTypes)

(Streams only) A list of current response type enums applied to the event source mapping.

Parameters:

functionResponseTypes - (Streams only) 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

EventSourceMappingConfiguration.Builder functionResponseTypesWithStrings(String... functionResponseTypes)

(Streams only) A list of current response type enums applied to the event source mapping.

Parameters:

functionResponseTypes - (Streams only) 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

EventSourceMappingConfiguration.Builder functionResponseTypes(Collection<FunctionResponseType> functionResponseTypes)

(Streams only) A list of current response type enums applied to the event source mapping.

Parameters:

functionResponseTypes - (Streams only) 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

EventSourceMappingConfiguration.Builder functionResponseTypes(FunctionResponseType... functionResponseTypes)

(Streams only) A list of current response type enums applied to the event source mapping.

Parameters:

functionResponseTypes - (Streams only) 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.