software.amazon.awscdk.services.lambda

Class CfnEventSourceMappingProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.CfnEventSourceMappingProps.Builder

Enclosing interface:

CfnEventSourceMappingProps

public static final class CfnEventSourceMappingProps.Builder
extends java.lang.Object

A builder for CfnEventSourceMappingProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnEventSourceMappingProps.Builder	batchSize(java.lang.Number batchSize) Sets the value of CfnEventSourceMappingProps.getBatchSize()
CfnEventSourceMappingProps.Builder	bisectBatchOnFunctionError(java.lang.Boolean bisectBatchOnFunctionError) Sets the value of CfnEventSourceMappingProps.getBisectBatchOnFunctionError()
CfnEventSourceMappingProps.Builder	bisectBatchOnFunctionError(IResolvable bisectBatchOnFunctionError) Sets the value of CfnEventSourceMappingProps.getBisectBatchOnFunctionError()
CfnEventSourceMappingProps	build() Builds the configured instance.
CfnEventSourceMappingProps.Builder	destinationConfig(CfnEventSourceMapping.DestinationConfigProperty destinationConfig) Sets the value of CfnEventSourceMappingProps.getDestinationConfig()
CfnEventSourceMappingProps.Builder	destinationConfig(IResolvable destinationConfig) Sets the value of CfnEventSourceMappingProps.getDestinationConfig()
CfnEventSourceMappingProps.Builder	enabled(java.lang.Boolean enabled) Sets the value of CfnEventSourceMappingProps.getEnabled()
CfnEventSourceMappingProps.Builder	enabled(IResolvable enabled) Sets the value of CfnEventSourceMappingProps.getEnabled()
CfnEventSourceMappingProps.Builder	eventSourceArn(java.lang.String eventSourceArn) Sets the value of CfnEventSourceMappingProps.getEventSourceArn()
CfnEventSourceMappingProps.Builder	filterCriteria(CfnEventSourceMapping.FilterCriteriaProperty filterCriteria) Sets the value of CfnEventSourceMappingProps.getFilterCriteria()
CfnEventSourceMappingProps.Builder	filterCriteria(IResolvable filterCriteria) Sets the value of CfnEventSourceMappingProps.getFilterCriteria()
CfnEventSourceMappingProps.Builder	functionName(java.lang.String functionName) Sets the value of CfnEventSourceMappingProps.getFunctionName()
CfnEventSourceMappingProps.Builder	functionResponseTypes(java.util.List<java.lang.String> functionResponseTypes) Sets the value of CfnEventSourceMappingProps.getFunctionResponseTypes()
CfnEventSourceMappingProps.Builder	maximumBatchingWindowInSeconds(java.lang.Number maximumBatchingWindowInSeconds) Sets the value of CfnEventSourceMappingProps.getMaximumBatchingWindowInSeconds()
CfnEventSourceMappingProps.Builder	maximumRecordAgeInSeconds(java.lang.Number maximumRecordAgeInSeconds) Sets the value of CfnEventSourceMappingProps.getMaximumRecordAgeInSeconds()
CfnEventSourceMappingProps.Builder	maximumRetryAttempts(java.lang.Number maximumRetryAttempts) Sets the value of CfnEventSourceMappingProps.getMaximumRetryAttempts()
CfnEventSourceMappingProps.Builder	parallelizationFactor(java.lang.Number parallelizationFactor) Sets the value of CfnEventSourceMappingProps.getParallelizationFactor()
CfnEventSourceMappingProps.Builder	queues(java.util.List<java.lang.String> queues) Sets the value of CfnEventSourceMappingProps.getQueues()
CfnEventSourceMappingProps.Builder	selfManagedEventSource(CfnEventSourceMapping.SelfManagedEventSourceProperty selfManagedEventSource) Sets the value of CfnEventSourceMappingProps.getSelfManagedEventSource()
CfnEventSourceMappingProps.Builder	selfManagedEventSource(IResolvable selfManagedEventSource) Sets the value of CfnEventSourceMappingProps.getSelfManagedEventSource()
CfnEventSourceMappingProps.Builder	sourceAccessConfigurations(IResolvable sourceAccessConfigurations) Sets the value of CfnEventSourceMappingProps.getSourceAccessConfigurations()
CfnEventSourceMappingProps.Builder	sourceAccessConfigurations(java.util.List<? extends java.lang.Object> sourceAccessConfigurations) Sets the value of CfnEventSourceMappingProps.getSourceAccessConfigurations()
CfnEventSourceMappingProps.Builder	startingPosition(java.lang.String startingPosition) Sets the value of CfnEventSourceMappingProps.getStartingPosition()
CfnEventSourceMappingProps.Builder	startingPositionTimestamp(java.lang.Number startingPositionTimestamp) Sets the value of CfnEventSourceMappingProps.getStartingPositionTimestamp()
CfnEventSourceMappingProps.Builder	topics(java.util.List<java.lang.String> topics) Sets the value of CfnEventSourceMappingProps.getTopics()
CfnEventSourceMappingProps.Builder	tumblingWindowInSeconds(java.lang.Number tumblingWindowInSeconds) Sets the value of CfnEventSourceMappingProps.getTumblingWindowInSeconds()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

functionName

public CfnEventSourceMappingProps.Builder functionName(java.lang.String functionName)

Sets the value of CfnEventSourceMappingProps.getFunctionName()

Parameters:

functionName - The name of the Lambda function. This parameter is required. 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:

this

batchSize

public CfnEventSourceMappingProps.Builder batchSize(java.lang.Number batchSize)

Sets the value of CfnEventSourceMappingProps.getBatchSize()

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.

Returns:

this

bisectBatchOnFunctionError

public CfnEventSourceMappingProps.Builder bisectBatchOnFunctionError(java.lang.Boolean bisectBatchOnFunctionError)

Sets the value of CfnEventSourceMappingProps.getBisectBatchOnFunctionError()

Parameters:

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

Returns:

this

bisectBatchOnFunctionError

public CfnEventSourceMappingProps.Builder bisectBatchOnFunctionError(IResolvable bisectBatchOnFunctionError)

Sets the value of CfnEventSourceMappingProps.getBisectBatchOnFunctionError()

Parameters:

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

Returns:

this

destinationConfig

public CfnEventSourceMappingProps.Builder destinationConfig(IResolvable destinationConfig)

Sets the value of CfnEventSourceMappingProps.getDestinationConfig()

Parameters:

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

Returns:

this

destinationConfig

public CfnEventSourceMappingProps.Builder destinationConfig(CfnEventSourceMapping.DestinationConfigProperty destinationConfig)

Sets the value of CfnEventSourceMappingProps.getDestinationConfig()

Parameters:

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

Returns:

this

enabled

public CfnEventSourceMappingProps.Builder enabled(java.lang.Boolean enabled)

Sets the value of CfnEventSourceMappingProps.getEnabled()

Parameters:

enabled - When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True

Returns:

this

enabled

public CfnEventSourceMappingProps.Builder enabled(IResolvable enabled)

Sets the value of CfnEventSourceMappingProps.getEnabled()

Parameters:

enabled - When true, the event source mapping is active. When false, Lambda pauses polling and invocation. Default: True

Returns:

this

eventSourceArn

public CfnEventSourceMappingProps.Builder eventSourceArn(java.lang.String eventSourceArn)

Sets the value of CfnEventSourceMappingProps.getEventSourceArn()

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:

this

filterCriteria

public CfnEventSourceMappingProps.Builder filterCriteria(IResolvable filterCriteria)

Sets the value of CfnEventSourceMappingProps.getFilterCriteria()

Parameters:

filterCriteria - (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering .

Returns:

this

filterCriteria

public CfnEventSourceMappingProps.Builder filterCriteria(CfnEventSourceMapping.FilterCriteriaProperty filterCriteria)

Sets the value of CfnEventSourceMappingProps.getFilterCriteria()

Parameters:

filterCriteria - (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering .

Returns:

this

functionResponseTypes

public CfnEventSourceMappingProps.Builder functionResponseTypes(java.util.List<java.lang.String> functionResponseTypes)

Sets the value of CfnEventSourceMappingProps.getFunctionResponseTypes()

Parameters:

functionResponseTypes - (Streams and SQS) A list of current response type enums applied to the event source mapping. Valid Values: ReportBatchItemFailures

Returns:

this

maximumBatchingWindowInSeconds

public CfnEventSourceMappingProps.Builder maximumBatchingWindowInSeconds(java.lang.Number maximumBatchingWindowInSeconds)

Sets the value of CfnEventSourceMappingProps.getMaximumBatchingWindowInSeconds()

Parameters:

maximumBatchingWindowInSeconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. Default ( Kinesis , DynamoDB , Amazon SQS event sources) : 0

Default ( Amazon MSK , Kafka, Amazon MQ event sources) : 500 ms

Returns:

this

maximumRecordAgeInSeconds

public CfnEventSourceMappingProps.Builder maximumRecordAgeInSeconds(java.lang.Number maximumRecordAgeInSeconds)

Sets the value of CfnEventSourceMappingProps.getMaximumRecordAgeInSeconds()

Parameters:

maximumRecordAgeInSeconds - (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

Returns:

this

maximumRetryAttempts

public CfnEventSourceMappingProps.Builder maximumRetryAttempts(java.lang.Number maximumRetryAttempts)

Sets the value of CfnEventSourceMappingProps.getMaximumRetryAttempts()

Parameters:

maximumRetryAttempts - (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

Returns:

this

parallelizationFactor

public CfnEventSourceMappingProps.Builder parallelizationFactor(java.lang.Number parallelizationFactor)

Sets the value of CfnEventSourceMappingProps.getParallelizationFactor()

Parameters:

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

Returns:

this

queues

public CfnEventSourceMappingProps.Builder queues(java.util.List<java.lang.String> queues)

Sets the value of CfnEventSourceMappingProps.getQueues()

Parameters:

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

Returns:

this

selfManagedEventSource

public CfnEventSourceMappingProps.Builder selfManagedEventSource(IResolvable selfManagedEventSource)

Sets the value of CfnEventSourceMappingProps.getSelfManagedEventSource()

Parameters:

selfManagedEventSource - The self-managed Apache Kafka cluster for your event source.

Returns:

this

selfManagedEventSource

public CfnEventSourceMappingProps.Builder selfManagedEventSource(CfnEventSourceMapping.SelfManagedEventSourceProperty selfManagedEventSource)

Sets the value of CfnEventSourceMappingProps.getSelfManagedEventSource()

Parameters:

selfManagedEventSource - The self-managed Apache Kafka cluster for your event source.

Returns:

this

sourceAccessConfigurations

public CfnEventSourceMappingProps.Builder sourceAccessConfigurations(IResolvable sourceAccessConfigurations)

Sets the value of CfnEventSourceMappingProps.getSourceAccessConfigurations()

Parameters:

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

Returns:

this

sourceAccessConfigurations

public CfnEventSourceMappingProps.Builder sourceAccessConfigurations(java.util.List<? extends java.lang.Object> sourceAccessConfigurations)

Sets the value of CfnEventSourceMappingProps.getSourceAccessConfigurations()

Parameters:

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

Returns:

this

startingPosition

public CfnEventSourceMappingProps.Builder startingPosition(java.lang.String startingPosition)

Sets the value of CfnEventSourceMappingProps.getStartingPosition()

Parameters:

startingPosition - The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

• LATEST - Read only new records.
• TRIM_HORIZON - Process all available records.
• AT_TIMESTAMP - Specify a time from which to start reading records.

Returns:

this

startingPositionTimestamp

public CfnEventSourceMappingProps.Builder startingPositionTimestamp(java.lang.Number startingPositionTimestamp)

Sets the value of CfnEventSourceMappingProps.getStartingPositionTimestamp()

Parameters:

startingPositionTimestamp - With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.

Returns:

this

topics

public CfnEventSourceMappingProps.Builder topics(java.util.List<java.lang.String> topics)

Sets the value of CfnEventSourceMappingProps.getTopics()

Parameters:

topics - The name of the Kafka topic.

Returns:

this

tumblingWindowInSeconds

public CfnEventSourceMappingProps.Builder tumblingWindowInSeconds(java.lang.Number tumblingWindowInSeconds)

Sets the value of CfnEventSourceMappingProps.getTumblingWindowInSeconds()

Parameters:

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

Returns:

this

build

public CfnEventSourceMappingProps build()

Builds the configured instance.

Returns:

a new instance of CfnEventSourceMappingProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided