JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.lambda.model

Class CreateEventSourceMappingRequest

    • Constructor Detail

      • CreateEventSourceMappingRequest

        public CreateEventSourceMappingRequest()

    • Method Detail

      • setEventSourceArn

        public void setEventSourceArn(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.

      • getEventSourceArn

        public String getEventSourceArn()

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

      • withEventSourceArn

        public CreateEventSourceMappingRequest withEventSourceArn(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.

      • setFunctionName

        public void setFunctionName(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.

      • getFunctionName

        public String getFunctionName()

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

      • withFunctionName

        public CreateEventSourceMappingRequest withFunctionName(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.

      • setEnabled

        public void setEnabled(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

      • getEnabled

        public Boolean getEnabled()

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

        Default: True

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

        Default: True

      • withEnabled

        public CreateEventSourceMappingRequest withEnabled(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.

      • isEnabled

        public Boolean isEnabled()

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

        Default: True

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

        Default: True

      • setBatchSize

        public void setBatchSize(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.

      • getBatchSize

        public Integer getBatchSize()

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

      • withBatchSize

        public CreateEventSourceMappingRequest withBatchSize(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.

      • setFilterCriteria

        public void setFilterCriteria(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.

      • getFilterCriteria

        public FilterCriteria getFilterCriteria()

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

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

      • withFilterCriteria

        public CreateEventSourceMappingRequest withFilterCriteria(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.

      • setMaximumBatchingWindowInSeconds

        public void setMaximumBatchingWindowInSeconds(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.

      • getMaximumBatchingWindowInSeconds

        public Integer getMaximumBatchingWindowInSeconds()

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

      • withMaximumBatchingWindowInSeconds

        public CreateEventSourceMappingRequest withMaximumBatchingWindowInSeconds(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.

      • setParallelizationFactor

        public void setParallelizationFactor(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.

      • getParallelizationFactor

        public Integer getParallelizationFactor()

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

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

      • withParallelizationFactor

        public CreateEventSourceMappingRequest withParallelizationFactor(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.

      • setStartingPosition

        public void setStartingPosition(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.
        See Also:
        EventSourcePosition

      • getStartingPosition

        public String getStartingPosition()

        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:
        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.
        See Also:
        EventSourcePosition

      • withStartingPosition

        public CreateEventSourceMappingRequest withStartingPosition(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

      • setStartingPosition

        public void setStartingPosition(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.
        See Also:
        EventSourcePosition

      • withStartingPosition

        public CreateEventSourceMappingRequest withStartingPosition(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

      • setStartingPositionTimestamp

        public void setStartingPositionTimestamp(Date 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.

      • getStartingPositionTimestamp

        public Date getStartingPositionTimestamp()

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

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

      • withStartingPositionTimestamp

        public CreateEventSourceMappingRequest withStartingPositionTimestamp(Date 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.

      • setDestinationConfig

        public void setDestinationConfig(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.

      • getDestinationConfig

        public DestinationConfig getDestinationConfig()

        (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:
        (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

      • withDestinationConfig

        public CreateEventSourceMappingRequest withDestinationConfig(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.

      • setMaximumRecordAgeInSeconds

        public void setMaximumRecordAgeInSeconds(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).

      • getMaximumRecordAgeInSeconds

        public Integer getMaximumRecordAgeInSeconds()

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

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

      • withMaximumRecordAgeInSeconds

        public CreateEventSourceMappingRequest withMaximumRecordAgeInSeconds(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.

      • setBisectBatchOnFunctionError

        public void setBisectBatchOnFunctionError(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.

      • getBisectBatchOnFunctionError

        public Boolean getBisectBatchOnFunctionError()

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

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

      • withBisectBatchOnFunctionError

        public CreateEventSourceMappingRequest withBisectBatchOnFunctionError(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.

      • isBisectBatchOnFunctionError

        public Boolean isBisectBatchOnFunctionError()

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

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

      • setMaximumRetryAttempts

        public void setMaximumRetryAttempts(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.

      • getMaximumRetryAttempts

        public Integer getMaximumRetryAttempts()

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

      • withMaximumRetryAttempts

        public CreateEventSourceMappingRequest withMaximumRetryAttempts(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.

      • setTumblingWindowInSeconds

        public void setTumblingWindowInSeconds(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.

      • getTumblingWindowInSeconds

        public Integer getTumblingWindowInSeconds()

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

      • withTumblingWindowInSeconds

        public CreateEventSourceMappingRequest withTumblingWindowInSeconds(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.

      • getTopics

        public List<String> getTopics()

        The name of the Kafka topic.

        Returns:
        The name of the Kafka topic.

      • setTopics

        public void setTopics(Collection<String> topics)

        The name of the Kafka topic.

        Parameters:
        topics - The name of the Kafka topic.

      • withTopics

        public CreateEventSourceMappingRequest withTopics(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.

      • getQueues

        public List<String> getQueues()

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

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

      • setQueues

        public void setQueues(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.

      • withQueues

        public CreateEventSourceMappingRequest withQueues(String... queues)

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

        NOTE: This method appends the values to the existing list (if any). Use setQueues(java.util.Collection) or withQueues(java.util.Collection) if you want to override the existing values.

        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.

      • withQueues

        public CreateEventSourceMappingRequest withQueues(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.

      • getSourceAccessConfigurations

        public List<SourceAccessConfiguration> getSourceAccessConfigurations()

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

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

      • setSourceAccessConfigurations

        public void setSourceAccessConfigurations(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.

      • withSourceAccessConfigurations

        public CreateEventSourceMappingRequest withSourceAccessConfigurations(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.

      • setSelfManagedEventSource

        public void setSelfManagedEventSource(SelfManagedEventSource selfManagedEventSource)

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

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

      • getSelfManagedEventSource

        public SelfManagedEventSource getSelfManagedEventSource()

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

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

      • withSelfManagedEventSource

        public CreateEventSourceMappingRequest withSelfManagedEventSource(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.

      • getFunctionResponseTypes

        public List<String> getFunctionResponseTypes()

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

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

      • setFunctionResponseTypes

        public void setFunctionResponseTypes(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.
        See Also:
        FunctionResponseType

      • withFunctionResponseTypes

        public CreateEventSourceMappingRequest withFunctionResponseTypes(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.
        See Also:
        FunctionResponseType

      • withFunctionResponseTypes

        public CreateEventSourceMappingRequest withFunctionResponseTypes(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.
        See Also:
        FunctionResponseType

      • setAmazonManagedKafkaEventSourceConfig

        public void setAmazonManagedKafkaEventSourceConfig(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.

      • getAmazonManagedKafkaEventSourceConfig

        public AmazonManagedKafkaEventSourceConfig getAmazonManagedKafkaEventSourceConfig()

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

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

      • withAmazonManagedKafkaEventSourceConfig

        public CreateEventSourceMappingRequest withAmazonManagedKafkaEventSourceConfig(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.

      • setSelfManagedKafkaEventSourceConfig

        public void setSelfManagedKafkaEventSourceConfig(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.

      • getSelfManagedKafkaEventSourceConfig

        public SelfManagedKafkaEventSourceConfig getSelfManagedKafkaEventSourceConfig()

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

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

      • withSelfManagedKafkaEventSourceConfig

        public CreateEventSourceMappingRequest withSelfManagedKafkaEventSourceConfig(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.

      • setDocumentDBEventSourceConfig

        public void setDocumentDBEventSourceConfig(DocumentDBEventSourceConfig documentDBEventSourceConfig)

        Specific configuration settings for a DocumentDB event source.

        Parameters:
        documentDBEventSourceConfig - Specific configuration settings for a DocumentDB event source.

      • getDocumentDBEventSourceConfig

        public DocumentDBEventSourceConfig getDocumentDBEventSourceConfig()

        Specific configuration settings for a DocumentDB event source.

        Returns:
        Specific configuration settings for a DocumentDB event source.

      • withDocumentDBEventSourceConfig

        public CreateEventSourceMappingRequest withDocumentDBEventSourceConfig(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.

      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /