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

Interface CreateEventSourceMappingResponse.Builder

    • Method Detail

      • uuid

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

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

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

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

      • batchSize

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

        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.

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

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

      • maximumBatchingWindowInSeconds

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

        CreateEventSourceMappingResponse.Builder parallelizationFactor​(Integer parallelizationFactor)

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

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

      • eventSourceArn

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

      • filterCriteria

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

      • functionArn

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

        CreateEventSourceMappingResponse.Builder lastModified​(Instant lastModified)

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

        Parameters:
        lastModified - The date that the event source mapping was last updated or that its state changed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastProcessingResult

        CreateEventSourceMappingResponse.Builder lastProcessingResult​(String lastProcessingResult)

        The result of the last Lambda invocation of your function.

        Parameters:
        lastProcessingResult - The result of the last Lambda invocation of your function.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

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

        CreateEventSourceMappingResponse.Builder stateTransitionReason​(String stateTransitionReason)

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

        Parameters:
        stateTransitionReason - Indicates whether a user or Lambda made the last change to the event source mapping.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationConfig

        CreateEventSourceMappingResponse.Builder destinationConfig​(DestinationConfig destinationConfig)

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

        Parameters:
        destinationConfig - (Kinesis and DynamoDB 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.

      • topics

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

        CreateEventSourceMappingResponse.Builder queues​(Collection<String> queues)

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

        Parameters:
        queues - (Amazon 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

        CreateEventSourceMappingResponse.Builder queues​(String... queues)

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

        Parameters:
        queues - (Amazon 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

        CreateEventSourceMappingResponse.Builder sourceAccessConfigurations​(Collection<SourceAccessConfiguration> sourceAccessConfigurations)

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

        Parameters:
        sourceAccessConfigurations - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceAccessConfigurations

        CreateEventSourceMappingResponse.Builder sourceAccessConfigurations​(SourceAccessConfiguration... sourceAccessConfigurations)

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

        Parameters:
        sourceAccessConfigurations - An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selfManagedEventSource

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

      • maximumRecordAgeInSeconds

        CreateEventSourceMappingResponse.Builder maximumRecordAgeInSeconds​(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

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

      • bisectBatchOnFunctionError

        CreateEventSourceMappingResponse.Builder bisectBatchOnFunctionError​(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.

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

      • maximumRetryAttempts

        CreateEventSourceMappingResponse.Builder maximumRetryAttempts​(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.

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

      • tumblingWindowInSeconds

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

      • functionResponseTypesWithStrings

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

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

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

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

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

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

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