Package software.amazon.awssdk.services.lambda.model

Interface CreateEventSourceMappingRequest.Builder

    • 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 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 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 or ARN 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)

        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

        CreateEventSourceMappingRequest.Builder batchSize​(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).

        • 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

        CreateEventSourceMappingRequest.Builder filterCriteria​(FilterCriteria 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.

      • 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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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:
        EventSourcePosition, EventSourcePosition

      • startingPosition

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

        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:
        EventSourcePosition, EventSourcePosition

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

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

      • tags

        CreateEventSourceMappingRequest.Builder tags​(Map<String,​String> tags)

        A list of tags to apply to the event source mapping.

        Parameters:
        tags - A list of tags to apply to the event source mapping.
        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

        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.

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

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

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

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

      • kmsKeyArn

        CreateEventSourceMappingRequest.Builder kmsKeyArn​(String kmsKeyArn)

        The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

        Parameters:
        kmsKeyArn - The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • provisionedPollerConfig

        CreateEventSourceMappingRequest.Builder provisionedPollerConfig​(ProvisionedPollerConfig provisionedPollerConfig)

        (Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source. For more information, see Provisioned Mode.

        Parameters:
        provisionedPollerConfig - (Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source. For more information, see Provisioned Mode.
        Returns:
        Returns a reference to this object so that method calls can be chained together.