software.amazon.awssdk.services.lambda.model

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 Summary

Modifier and Type	Method and Description
CreateEventSourceMappingRequest.Builder	batchSize(Integer batchSize) The maximum number of items to retrieve in a single batch.
CreateEventSourceMappingRequest.Builder	bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError) (Streams only) If the function returns an error, split the batch in two and retry.
default CreateEventSourceMappingRequest.Builder	destinationConfig(Consumer<DestinationConfig.Builder> destinationConfig) (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
CreateEventSourceMappingRequest.Builder	destinationConfig(DestinationConfig destinationConfig) (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
CreateEventSourceMappingRequest.Builder	enabled(Boolean enabled) If true, the event source mapping is active.
CreateEventSourceMappingRequest.Builder	eventSourceArn(String eventSourceArn) The Amazon Resource Name (ARN) of the event source.
CreateEventSourceMappingRequest.Builder	functionName(String functionName) The name of the Lambda function.
CreateEventSourceMappingRequest.Builder	functionResponseTypes(Collection<FunctionResponseType> functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
CreateEventSourceMappingRequest.Builder	functionResponseTypes(FunctionResponseType... functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
CreateEventSourceMappingRequest.Builder	functionResponseTypesWithStrings(Collection<String> functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
CreateEventSourceMappingRequest.Builder	functionResponseTypesWithStrings(String... functionResponseTypes) (Streams only) A list of current response type enums applied to the event source mapping.
CreateEventSourceMappingRequest.Builder	maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds) (Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.
CreateEventSourceMappingRequest.Builder	maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds) (Streams only) Discard records older than the specified age.
CreateEventSourceMappingRequest.Builder	maximumRetryAttempts(Integer maximumRetryAttempts) (Streams only) Discard records after the specified number of retries.
CreateEventSourceMappingRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEventSourceMappingRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEventSourceMappingRequest.Builder	parallelizationFactor(Integer parallelizationFactor) (Streams only) The number of batches to process from each shard concurrently.
CreateEventSourceMappingRequest.Builder	queues(Collection<String> queues) (MQ) The name of the Amazon MQ broker destination queue to consume.
CreateEventSourceMappingRequest.Builder	queues(String... queues) (MQ) The name of the Amazon MQ broker destination queue to consume.
default CreateEventSourceMappingRequest.Builder	selfManagedEventSource(Consumer<SelfManagedEventSource.Builder> selfManagedEventSource) The Self-Managed Apache Kafka cluster to send records.
CreateEventSourceMappingRequest.Builder	selfManagedEventSource(SelfManagedEventSource selfManagedEventSource) The Self-Managed Apache Kafka cluster to send records.
CreateEventSourceMappingRequest.Builder	sourceAccessConfigurations(Collection<SourceAccessConfiguration> sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.
CreateEventSourceMappingRequest.Builder	sourceAccessConfigurations(Consumer<SourceAccessConfiguration.Builder>... sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.
CreateEventSourceMappingRequest.Builder	sourceAccessConfigurations(SourceAccessConfiguration... sourceAccessConfigurations) An array of authentication protocols or VPC components required to secure your event source.
CreateEventSourceMappingRequest.Builder	startingPosition(EventSourcePosition startingPosition) The position in a stream from which to start reading.
CreateEventSourceMappingRequest.Builder	startingPosition(String startingPosition) The position in a stream from which to start reading.
CreateEventSourceMappingRequest.Builder	startingPositionTimestamp(Instant startingPositionTimestamp) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
CreateEventSourceMappingRequest.Builder	topics(Collection<String> topics) The name of the Kafka topic.
CreateEventSourceMappingRequest.Builder	topics(String... topics) The name of the Kafka topic.
CreateEventSourceMappingRequest.Builder	tumblingWindowInSeconds(Integer tumblingWindowInSeconds) (Streams only) The duration in seconds of a processing window.

Methods inherited from interface software.amazon.awssdk.services.lambda.model.LambdaRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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.

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.

Returns:

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

functionName

CreateEventSourceMappingRequest.Builder functionName(String functionName)

The name of the Lambda function.

Name formats

• Function name - MyFunction.

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

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

• Partial ARN - 123456789012: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 of the Lambda function.

Name formats

• Function name - MyFunction.

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

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

• Partial ARN - 123456789012: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

CreateEventSourceMappingRequest.Builder enabled(Boolean enabled)

If true, the event source mapping is active. Set to false to pause polling and invocation.

Parameters:

enabled - If true, the event source mapping is active. Set to false to pause polling and invocation.

Returns:

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

batchSize

CreateEventSourceMappingRequest.Builder batchSize(Integer batchSize)

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

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

• Amazon DynamoDB Streams - Default 100. Max 1,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.

Parameters:

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

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

• Amazon DynamoDB Streams - Default 100. Max 1,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.

Returns:

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

maximumBatchingWindowInSeconds

CreateEventSourceMappingRequest.Builder maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

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

Parameters:

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

Returns:

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

parallelizationFactor

CreateEventSourceMappingRequest.Builder parallelizationFactor(Integer parallelizationFactor)

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

Parameters:

parallelizationFactor - (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, 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

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

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

destinationConfig

CreateEventSourceMappingRequest.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 CreateEventSourceMappingRequest.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)

maximumRecordAgeInSeconds

CreateEventSourceMappingRequest.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)

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

Parameters:

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

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

Parameters:

bisectBatchOnFunctionError - (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)

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

Parameters:

maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be 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)

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

topics

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

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

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

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

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

CreateEventSourceMappingRequest.Builder selfManagedEventSource(SelfManagedEventSource selfManagedEventSource)

The Self-Managed Apache Kafka cluster to send records.

Parameters:

selfManagedEventSource - The Self-Managed Apache Kafka cluster to send records.

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 send records.

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)

functionResponseTypesWithStrings

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

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

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

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

overrideConfiguration

CreateEventSourceMappingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateEventSourceMappingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder