Package software.amazon.awscdk.services.lambda

Class CfnEventSourceMappingProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventSourceMappingProps>

Enclosing interface:

CfnEventSourceMappingProps

@Stability(Stable)
public static final class CfnEventSourceMappingProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEventSourceMappingProps>

A builder for CfnEventSourceMappingProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEventSourceMappingProps.Builder	amazonManagedKafkaEventSourceConfig(IResolvable amazonManagedKafkaEventSourceConfig)	Sets the value of CfnEventSourceMappingProps.getAmazonManagedKafkaEventSourceConfig()
CfnEventSourceMappingProps.Builder	amazonManagedKafkaEventSourceConfig(CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty amazonManagedKafkaEventSourceConfig)	Sets the value of CfnEventSourceMappingProps.getAmazonManagedKafkaEventSourceConfig()
CfnEventSourceMappingProps.Builder	batchSize(Number batchSize)	Sets the value of CfnEventSourceMappingProps.getBatchSize()
CfnEventSourceMappingProps.Builder	bisectBatchOnFunctionError(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(IResolvable destinationConfig)	Sets the value of CfnEventSourceMappingProps.getDestinationConfig()
CfnEventSourceMappingProps.Builder	destinationConfig(CfnEventSourceMapping.DestinationConfigProperty destinationConfig)	Sets the value of CfnEventSourceMappingProps.getDestinationConfig()
CfnEventSourceMappingProps.Builder	documentDbEventSourceConfig(IResolvable documentDbEventSourceConfig)	Sets the value of CfnEventSourceMappingProps.getDocumentDbEventSourceConfig()
CfnEventSourceMappingProps.Builder	documentDbEventSourceConfig(CfnEventSourceMapping.DocumentDBEventSourceConfigProperty documentDbEventSourceConfig)	Sets the value of CfnEventSourceMappingProps.getDocumentDbEventSourceConfig()
CfnEventSourceMappingProps.Builder	enabled(Boolean enabled)	Sets the value of CfnEventSourceMappingProps.getEnabled()
CfnEventSourceMappingProps.Builder	enabled(IResolvable enabled)	Sets the value of CfnEventSourceMappingProps.getEnabled()
CfnEventSourceMappingProps.Builder	eventSourceArn(String eventSourceArn)	Sets the value of CfnEventSourceMappingProps.getEventSourceArn()
CfnEventSourceMappingProps.Builder	filterCriteria(IResolvable filterCriteria)	Sets the value of CfnEventSourceMappingProps.getFilterCriteria()
CfnEventSourceMappingProps.Builder	filterCriteria(CfnEventSourceMapping.FilterCriteriaProperty filterCriteria)	Sets the value of CfnEventSourceMappingProps.getFilterCriteria()
CfnEventSourceMappingProps.Builder	functionName(String functionName)	Sets the value of CfnEventSourceMappingProps.getFunctionName()
CfnEventSourceMappingProps.Builder	functionResponseTypes(List<String> functionResponseTypes)	Sets the value of CfnEventSourceMappingProps.getFunctionResponseTypes()
CfnEventSourceMappingProps.Builder	kmsKeyArn(String kmsKeyArn)	Sets the value of CfnEventSourceMappingProps.getKmsKeyArn()
CfnEventSourceMappingProps.Builder	maximumBatchingWindowInSeconds(Number maximumBatchingWindowInSeconds)	Sets the value of CfnEventSourceMappingProps.getMaximumBatchingWindowInSeconds()
CfnEventSourceMappingProps.Builder	maximumRecordAgeInSeconds(Number maximumRecordAgeInSeconds)	Sets the value of CfnEventSourceMappingProps.getMaximumRecordAgeInSeconds()
CfnEventSourceMappingProps.Builder	maximumRetryAttempts(Number maximumRetryAttempts)	Sets the value of CfnEventSourceMappingProps.getMaximumRetryAttempts()
CfnEventSourceMappingProps.Builder	parallelizationFactor(Number parallelizationFactor)	Sets the value of CfnEventSourceMappingProps.getParallelizationFactor()
CfnEventSourceMappingProps.Builder	queues(List<String> queues)	Sets the value of CfnEventSourceMappingProps.getQueues()
CfnEventSourceMappingProps.Builder	scalingConfig(IResolvable scalingConfig)	Sets the value of CfnEventSourceMappingProps.getScalingConfig()
CfnEventSourceMappingProps.Builder	scalingConfig(CfnEventSourceMapping.ScalingConfigProperty scalingConfig)	Sets the value of CfnEventSourceMappingProps.getScalingConfig()
CfnEventSourceMappingProps.Builder	selfManagedEventSource(IResolvable selfManagedEventSource)	Sets the value of CfnEventSourceMappingProps.getSelfManagedEventSource()
CfnEventSourceMappingProps.Builder	selfManagedEventSource(CfnEventSourceMapping.SelfManagedEventSourceProperty selfManagedEventSource)	Sets the value of CfnEventSourceMappingProps.getSelfManagedEventSource()
CfnEventSourceMappingProps.Builder	selfManagedKafkaEventSourceConfig(IResolvable selfManagedKafkaEventSourceConfig)	Sets the value of CfnEventSourceMappingProps.getSelfManagedKafkaEventSourceConfig()
CfnEventSourceMappingProps.Builder	selfManagedKafkaEventSourceConfig(CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty selfManagedKafkaEventSourceConfig)	Sets the value of CfnEventSourceMappingProps.getSelfManagedKafkaEventSourceConfig()
CfnEventSourceMappingProps.Builder	sourceAccessConfigurations(List<? extends Object> sourceAccessConfigurations)	Sets the value of CfnEventSourceMappingProps.getSourceAccessConfigurations()
CfnEventSourceMappingProps.Builder	sourceAccessConfigurations(IResolvable sourceAccessConfigurations)	Sets the value of CfnEventSourceMappingProps.getSourceAccessConfigurations()
CfnEventSourceMappingProps.Builder	startingPosition(String startingPosition)	Sets the value of CfnEventSourceMappingProps.getStartingPosition()
CfnEventSourceMappingProps.Builder	startingPositionTimestamp(Number startingPositionTimestamp)	Sets the value of CfnEventSourceMappingProps.getStartingPositionTimestamp()
CfnEventSourceMappingProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnEventSourceMappingProps.getTags()
CfnEventSourceMappingProps.Builder	topics(List<String> topics)	Sets the value of CfnEventSourceMappingProps.getTopics()
CfnEventSourceMappingProps.Builder	tumblingWindowInSeconds(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 Details

Builder

public Builder()

Method Details

functionName

@Stability(Stable)
public CfnEventSourceMappingProps.Builder functionName(String functionName)

Sets the value of CfnEventSourceMappingProps.getFunctionName()

Parameters:

functionName - The name or ARN 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

amazonManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder amazonManagedKafkaEventSourceConfig(IResolvable amazonManagedKafkaEventSourceConfig)

Sets the value of CfnEventSourceMappingProps.getAmazonManagedKafkaEventSourceConfig()

Parameters:

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

Returns:

this

amazonManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder amazonManagedKafkaEventSourceConfig(CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty amazonManagedKafkaEventSourceConfig)

Sets the value of CfnEventSourceMappingProps.getAmazonManagedKafkaEventSourceConfig()

Parameters:

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

Returns:

this

batchSize

@Stability(Stable)
public CfnEventSourceMappingProps.Builder batchSize(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.
• DocumentDB – Default 100. Max 10,000.

Returns:

this

bisectBatchOnFunctionError

@Stability(Stable)
public CfnEventSourceMappingProps.Builder bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)

Sets the value of CfnEventSourceMappingProps.getBisectBatchOnFunctionError()

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:

this

bisectBatchOnFunctionError

@Stability(Stable)
public CfnEventSourceMappingProps.Builder bisectBatchOnFunctionError(IResolvable bisectBatchOnFunctionError)

Sets the value of CfnEventSourceMappingProps.getBisectBatchOnFunctionError()

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:

this

destinationConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder destinationConfig(IResolvable destinationConfig)

Sets the value of CfnEventSourceMappingProps.getDestinationConfig()

Parameters:

destinationConfig - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

Returns:

this

destinationConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder destinationConfig(CfnEventSourceMapping.DestinationConfigProperty destinationConfig)

Sets the value of CfnEventSourceMappingProps.getDestinationConfig()

Parameters:

destinationConfig - (Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.

Returns:

this

documentDbEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder documentDbEventSourceConfig(IResolvable documentDbEventSourceConfig)

Sets the value of CfnEventSourceMappingProps.getDocumentDbEventSourceConfig()

Parameters:

documentDbEventSourceConfig - Specific configuration settings for a DocumentDB event source.

Returns:

this

documentDbEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder documentDbEventSourceConfig(CfnEventSourceMapping.DocumentDBEventSourceConfigProperty documentDbEventSourceConfig)

Sets the value of CfnEventSourceMappingProps.getDocumentDbEventSourceConfig()

Parameters:

documentDbEventSourceConfig - Specific configuration settings for a DocumentDB event source.

Returns:

this

enabled

@Stability(Stable)
public CfnEventSourceMappingProps.Builder enabled(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

@Stability(Stable)
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

@Stability(Stable)
public CfnEventSourceMappingProps.Builder eventSourceArn(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 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:

this

filterCriteria

@Stability(Stable)
public CfnEventSourceMappingProps.Builder filterCriteria(IResolvable filterCriteria)

Sets the value of CfnEventSourceMappingProps.getFilterCriteria()

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:

this

filterCriteria

@Stability(Stable)
public CfnEventSourceMappingProps.Builder filterCriteria(CfnEventSourceMapping.FilterCriteriaProperty filterCriteria)

Sets the value of CfnEventSourceMappingProps.getFilterCriteria()

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:

this

functionResponseTypes

@Stability(Stable)
public CfnEventSourceMappingProps.Builder functionResponseTypes(List<String> functionResponseTypes)

Sets the value of CfnEventSourceMappingProps.getFunctionResponseTypes()

Parameters:

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

Returns:

this

kmsKeyArn

@Stability(Stable)
public CfnEventSourceMappingProps.Builder kmsKeyArn(String kmsKeyArn)

Sets the value of CfnEventSourceMappingProps.getKmsKeyArn()

Parameters:

kmsKeyArn - The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .

Returns:

this

maximumBatchingWindowInSeconds

@Stability(Stable)
public CfnEventSourceMappingProps.Builder maximumBatchingWindowInSeconds(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 , Amazon DocumentDB event sources) : 500 ms

Related setting: For Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

Returns:

this

maximumRecordAgeInSeconds

@Stability(Stable)
public CfnEventSourceMappingProps.Builder maximumRecordAgeInSeconds(Number maximumRecordAgeInSeconds)

Sets the value of CfnEventSourceMappingProps.getMaximumRecordAgeInSeconds()

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:

this

maximumRetryAttempts

@Stability(Stable)
public CfnEventSourceMappingProps.Builder maximumRetryAttempts(Number maximumRetryAttempts)

Sets the value of CfnEventSourceMappingProps.getMaximumRetryAttempts()

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:

this

parallelizationFactor

@Stability(Stable)
public CfnEventSourceMappingProps.Builder parallelizationFactor(Number parallelizationFactor)

Sets the value of CfnEventSourceMappingProps.getParallelizationFactor()

Parameters:

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

Returns:

this

queues

@Stability(Stable)
public CfnEventSourceMappingProps.Builder queues(List<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

scalingConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder scalingConfig(IResolvable scalingConfig)

Sets the value of CfnEventSourceMappingProps.getScalingConfig()

Parameters:

scalingConfig - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources .

Returns:

this

scalingConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder scalingConfig(CfnEventSourceMapping.ScalingConfigProperty scalingConfig)

Sets the value of CfnEventSourceMappingProps.getScalingConfig()

Parameters:

scalingConfig - (Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources .

Returns:

this

selfManagedEventSource

@Stability(Stable)
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

@Stability(Stable)
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

selfManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder selfManagedKafkaEventSourceConfig(IResolvable selfManagedKafkaEventSourceConfig)

Sets the value of CfnEventSourceMappingProps.getSelfManagedKafkaEventSourceConfig()

Parameters:

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

Returns:

this

selfManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingProps.Builder selfManagedKafkaEventSourceConfig(CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty selfManagedKafkaEventSourceConfig)

Sets the value of CfnEventSourceMappingProps.getSelfManagedKafkaEventSourceConfig()

Parameters:

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

Returns:

this

sourceAccessConfigurations

@Stability(Stable)
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

@Stability(Stable)
public CfnEventSourceMappingProps.Builder sourceAccessConfigurations(List<? extends 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

@Stability(Stable)
public CfnEventSourceMappingProps.Builder startingPosition(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

@Stability(Stable)
public CfnEventSourceMappingProps.Builder startingPositionTimestamp(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. StartingPositionTimestamp cannot be in the future.

Returns:

this

tags

@Stability(Stable)
public CfnEventSourceMappingProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnEventSourceMappingProps.getTags()

Parameters:

tags - A list of tags to add to the event source mapping.

You must have the lambda:TagResource , lambda:UntagResource , and lambda:ListTags permissions for your IAM principal to manage the AWS CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.

Returns:

this

topics

@Stability(Stable)
public CfnEventSourceMappingProps.Builder topics(List<String> topics)

Sets the value of CfnEventSourceMappingProps.getTopics()

Parameters:

topics - The name of the Kafka topic.

Returns:

this

tumblingWindowInSeconds

@Stability(Stable)
public CfnEventSourceMappingProps.Builder tumblingWindowInSeconds(Number tumblingWindowInSeconds)

Sets the value of CfnEventSourceMappingProps.getTumblingWindowInSeconds()

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:

this

build

@Stability(Stable)
public CfnEventSourceMappingProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEventSourceMappingProps>

Returns:

a new instance of CfnEventSourceMappingProps

Throws:

NullPointerException - if any required attribute was not provided