Package software.amazon.awscdk.cfnpropertymixins.services.lambda

Class CfnEventSourceMappingPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.lambda.CfnEventSourceMappingPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventSourceMappingPropsMixin>

Enclosing class:

CfnEventSourceMappingPropsMixin

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

A fluent builder for CfnEventSourceMappingPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnEventSourceMappingPropsMixin.Builder	amazonManagedKafkaEventSourceConfig(CfnEventSourceMappingPropsMixin.AmazonManagedKafkaEventSourceConfigProperty amazonManagedKafkaEventSourceConfig)	Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
CfnEventSourceMappingPropsMixin.Builder	amazonManagedKafkaEventSourceConfig(IResolvable amazonManagedKafkaEventSourceConfig)	Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
CfnEventSourceMappingPropsMixin.Builder	batchSize(Number batchSize)	The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
CfnEventSourceMappingPropsMixin.Builder	bisectBatchOnFunctionError(Boolean bisectBatchOnFunctionError)	(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
CfnEventSourceMappingPropsMixin.Builder	bisectBatchOnFunctionError(IResolvable bisectBatchOnFunctionError)	(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
CfnEventSourceMappingPropsMixin	build()
static CfnEventSourceMappingPropsMixin.Builder	create()
static CfnEventSourceMappingPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnEventSourceMappingPropsMixin.Builder	destinationConfig(CfnEventSourceMappingPropsMixin.DestinationConfigProperty destinationConfig)	(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
CfnEventSourceMappingPropsMixin.Builder	destinationConfig(IResolvable destinationConfig)	(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) A configuration object that specifies the destination of an event after Lambda processes it.
CfnEventSourceMappingPropsMixin.Builder	documentDbEventSourceConfig(CfnEventSourceMappingPropsMixin.DocumentDBEventSourceConfigProperty documentDbEventSourceConfig)	Specific configuration settings for a DocumentDB event source.
CfnEventSourceMappingPropsMixin.Builder	documentDbEventSourceConfig(IResolvable documentDbEventSourceConfig)	Specific configuration settings for a DocumentDB event source.
CfnEventSourceMappingPropsMixin.Builder	enabled(Boolean enabled)	When true, the event source mapping is active.
CfnEventSourceMappingPropsMixin.Builder	enabled(IResolvable enabled)	When true, the event source mapping is active.
CfnEventSourceMappingPropsMixin.Builder	eventSourceArn(String eventSourceArn)	The Amazon Resource Name (ARN) of the event source.
CfnEventSourceMappingPropsMixin.Builder	eventSourceArn(IStreamRef eventSourceArn)	The Amazon Resource Name (ARN) of the event source.
CfnEventSourceMappingPropsMixin.Builder	eventSourceArn(IClusterRef eventSourceArn)	The Amazon Resource Name (ARN) of the event source.
CfnEventSourceMappingPropsMixin.Builder	eventSourceArn(IQueueRef eventSourceArn)	The Amazon Resource Name (ARN) of the event source.
CfnEventSourceMappingPropsMixin.Builder	filterCriteria(CfnEventSourceMappingPropsMixin.FilterCriteriaProperty filterCriteria)	An object that defines the filter criteria that determine whether Lambda should process an event.
CfnEventSourceMappingPropsMixin.Builder	filterCriteria(IResolvable filterCriteria)	An object that defines the filter criteria that determine whether Lambda should process an event.
CfnEventSourceMappingPropsMixin.Builder	functionName(String functionName)	The name or ARN of the Lambda function.
CfnEventSourceMappingPropsMixin.Builder	functionName(IFunctionRef functionName)	The name or ARN of the Lambda function.
CfnEventSourceMappingPropsMixin.Builder	functionName(IVersionRef functionName)	The name or ARN of the Lambda function.
CfnEventSourceMappingPropsMixin.Builder	functionResponseTypes(List<String> functionResponseTypes)	(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.
CfnEventSourceMappingPropsMixin.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the AWS Key Management Service ( AWS ) customer managed key that Lambda uses to encrypt your function's filter criteria .
CfnEventSourceMappingPropsMixin.Builder	loggingConfig(CfnEventSourceMappingPropsMixin.LoggingConfigProperty loggingConfig)	The function's Amazon CloudWatch Logs configuration settings.
CfnEventSourceMappingPropsMixin.Builder	loggingConfig(IResolvable loggingConfig)	The function's Amazon CloudWatch Logs configuration settings.
CfnEventSourceMappingPropsMixin.Builder	maximumBatchingWindowInSeconds(Number maximumBatchingWindowInSeconds)	The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
CfnEventSourceMappingPropsMixin.Builder	maximumRecordAgeInSeconds(Number maximumRecordAgeInSeconds)	(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age.
CfnEventSourceMappingPropsMixin.Builder	maximumRetryAttempts(Number maximumRetryAttempts)	(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries.
CfnEventSourceMappingPropsMixin.Builder	metricsConfig(CfnEventSourceMappingPropsMixin.MetricsConfigProperty metricsConfig)	The metrics configuration for your event source.
CfnEventSourceMappingPropsMixin.Builder	metricsConfig(IResolvable metricsConfig)	The metrics configuration for your event source.
CfnEventSourceMappingPropsMixin.Builder	parallelizationFactor(Number parallelizationFactor)	(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.
CfnEventSourceMappingPropsMixin.Builder	provisionedPollerConfig(CfnEventSourceMappingPropsMixin.ProvisionedPollerConfigProperty provisionedPollerConfig)	(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source.
CfnEventSourceMappingPropsMixin.Builder	provisionedPollerConfig(IResolvable provisionedPollerConfig)	(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source.
CfnEventSourceMappingPropsMixin.Builder	queues(List<String> queues)	(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
CfnEventSourceMappingPropsMixin.Builder	scalingConfig(CfnEventSourceMappingPropsMixin.ScalingConfigProperty scalingConfig)	This property is for Amazon SQS event sources only.
CfnEventSourceMappingPropsMixin.Builder	scalingConfig(IResolvable scalingConfig)	This property is for Amazon SQS event sources only.
CfnEventSourceMappingPropsMixin.Builder	selfManagedEventSource(CfnEventSourceMappingPropsMixin.SelfManagedEventSourceProperty selfManagedEventSource)	The self-managed Apache Kafka cluster for your event source.
CfnEventSourceMappingPropsMixin.Builder	selfManagedEventSource(IResolvable selfManagedEventSource)	The self-managed Apache Kafka cluster for your event source.
CfnEventSourceMappingPropsMixin.Builder	selfManagedKafkaEventSourceConfig(CfnEventSourceMappingPropsMixin.SelfManagedKafkaEventSourceConfigProperty selfManagedKafkaEventSourceConfig)	Specific configuration settings for a self-managed Apache Kafka event source.
CfnEventSourceMappingPropsMixin.Builder	selfManagedKafkaEventSourceConfig(IResolvable selfManagedKafkaEventSourceConfig)	Specific configuration settings for a self-managed Apache Kafka event source.
CfnEventSourceMappingPropsMixin.Builder	sourceAccessConfigurations(List<? extends Object> sourceAccessConfigurations)	An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
CfnEventSourceMappingPropsMixin.Builder	sourceAccessConfigurations(IResolvable sourceAccessConfigurations)	An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
CfnEventSourceMappingPropsMixin.Builder	startingPosition(String startingPosition)	The position in a stream from which to start reading.
CfnEventSourceMappingPropsMixin.Builder	startingPositionTimestamp(Number startingPositionTimestamp)	With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.
CfnEventSourceMappingPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of tags to add to the event source mapping.
CfnEventSourceMappingPropsMixin.Builder	topics(List<String> topics)	The name of the Kafka topic.
CfnEventSourceMappingPropsMixin.Builder	tumblingWindowInSeconds(Number tumblingWindowInSeconds)	(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEventSourceMappingPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnEventSourceMappingPropsMixin.Builder.

create

@Stability(Stable)
public static CfnEventSourceMappingPropsMixin.Builder create()

Returns:

a new instance of CfnEventSourceMappingPropsMixin.Builder.

amazonManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder amazonManagedKafkaEventSourceConfig(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig

amazonManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder amazonManagedKafkaEventSourceConfig(CfnEventSourceMappingPropsMixin.AmazonManagedKafkaEventSourceConfigProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig

batchSize

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder batchSize(Number 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize

bisectBatchOnFunctionError

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

When using BisectBatchOnFunctionError , check the BatchSize parameter in the OnFailure destination message's metadata. The BatchSize could be greater than 1 since Lambda consolidates failed messages metadata when writing to the OnFailure destination.

Parameters:

bisectBatchOnFunctionError - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror

bisectBatchOnFunctionError

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

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

The default value is false.

When using BisectBatchOnFunctionError , check the BatchSize parameter in the OnFailure destination message's metadata. The BatchSize could be greater than 1 since Lambda consolidates failed messages metadata when writing to the OnFailure destination.

Parameters:

bisectBatchOnFunctionError - (Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror

destinationConfig

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig

destinationConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder destinationConfig(CfnEventSourceMappingPropsMixin.DestinationConfigProperty destinationConfig)

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig

documentDbEventSourceConfig

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

Specific configuration settings for a DocumentDB event source.

Parameters:

documentDbEventSourceConfig - Specific configuration settings for a DocumentDB event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig

documentDbEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder documentDbEventSourceConfig(CfnEventSourceMappingPropsMixin.DocumentDBEventSourceConfigProperty documentDbEventSourceConfig)

Specific configuration settings for a DocumentDB event source.

Parameters:

documentDbEventSourceConfig - Specific configuration settings for a DocumentDB event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-documentdbeventsourceconfig

enabled

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder enabled(Boolean enabled)

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

Default: True

Parameters:

enabled - When true, the event source mapping is active. When false, Lambda pauses polling and invocation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled

enabled

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder enabled(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled

eventSourceArn

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder eventSourceArn(String eventSourceArn)

The Amazon Resource Name (ARN) of the event source.

• Amazon Kinesis – The ARN of the data stream or a stream consumer.
• Amazon DynamoDB Streams – The ARN of the stream.
• Amazon Simple Queue Service – The ARN of the queue.
• Amazon Managed Streaming for Apache Kafka – The ARN of the cluster or the ARN of the VPC connection (for cross-account event source mappings ).
• Amazon MQ – The ARN of the broker.
• Amazon DocumentDB – The ARN of the DocumentDB change stream.

Parameters:

eventSourceArn - The Amazon Resource Name (ARN) of the event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

eventSourceArn

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder eventSourceArn(IStreamRef 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

eventSourceArn

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder eventSourceArn(IClusterRef 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

eventSourceArn

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder eventSourceArn(IQueueRef 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

filterCriteria

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder filterCriteria(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria

filterCriteria

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder filterCriteria(CfnEventSourceMappingPropsMixin.FilterCriteriaProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria

functionName

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

The name or ARN of the Lambda function.

Name formats - Function name – MyFunction .

• Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction .
• Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD .
• Partial ARN – 123456789012:function:MyFunction .

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

Parameters:

functionName - The name or ARN of the Lambda function. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname

functionName

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder functionName(IFunctionRef 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname

functionName

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder functionName(IVersionRef 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname

functionResponseTypes

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

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

Valid Values: ReportBatchItemFailures

Parameters:

functionResponseTypes - (Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes

kmsKeyArn

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn

loggingConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder loggingConfig(IResolvable loggingConfig)

The function's Amazon CloudWatch Logs configuration settings.

Parameters:

loggingConfig - The function's Amazon CloudWatch Logs configuration settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig

loggingConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder loggingConfig(CfnEventSourceMappingPropsMixin.LoggingConfigProperty loggingConfig)

The function's Amazon CloudWatch Logs configuration settings.

Parameters:

loggingConfig - The function's Amazon CloudWatch Logs configuration settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-loggingconfig

maximumBatchingWindowInSeconds

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder maximumBatchingWindowInSeconds(Number 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.

Parameters:

maximumBatchingWindowInSeconds - The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds

maximumRecordAgeInSeconds

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

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) 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, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds

maximumRetryAttempts

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

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) 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, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records after the specified number of retries. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts

metricsConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder metricsConfig(IResolvable metricsConfig)

The metrics configuration for your event source.

For more information, see Event source mapping metrics .

Parameters:

metricsConfig - The metrics configuration for your event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig

metricsConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder metricsConfig(CfnEventSourceMappingPropsMixin.MetricsConfigProperty metricsConfig)

The metrics configuration for your event source.

For more information, see Event source mapping metrics .

Parameters:

metricsConfig - The metrics configuration for your event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-metricsconfig

parallelizationFactor

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder parallelizationFactor(Number 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor

provisionedPollerConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder provisionedPollerConfig(IResolvable provisionedPollerConfig)

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source.

For more information, see provisioned mode .

Parameters:

provisionedPollerConfig - (Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig

provisionedPollerConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder provisionedPollerConfig(CfnEventSourceMappingPropsMixin.ProvisionedPollerConfigProperty provisionedPollerConfig)

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source.

For more information, see provisioned mode .

Parameters:

provisionedPollerConfig - (Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-provisionedpollerconfig

queues

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder queues(List<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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues

scalingConfig

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

This property is for Amazon SQS event sources only.

You cannot use ProvisionedPollerConfig while using ScalingConfig . These options are mutually exclusive. To remove the scaling configuration, pass an empty value.

Parameters:

scalingConfig - This property is for Amazon SQS event sources only. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig

scalingConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder scalingConfig(CfnEventSourceMappingPropsMixin.ScalingConfigProperty scalingConfig)

This property is for Amazon SQS event sources only.

You cannot use ProvisionedPollerConfig while using ScalingConfig . These options are mutually exclusive. To remove the scaling configuration, pass an empty value.

Parameters:

scalingConfig - This property is for Amazon SQS event sources only. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig

selfManagedEventSource

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder selfManagedEventSource(IResolvable selfManagedEventSource)

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

Parameters:

selfManagedEventSource - The self-managed Apache Kafka cluster for your event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource

selfManagedEventSource

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder selfManagedEventSource(CfnEventSourceMappingPropsMixin.SelfManagedEventSourceProperty selfManagedEventSource)

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

Parameters:

selfManagedEventSource - The self-managed Apache Kafka cluster for your event source. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource

selfManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder selfManagedKafkaEventSourceConfig(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig

selfManagedKafkaEventSourceConfig

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder selfManagedKafkaEventSourceConfig(CfnEventSourceMappingPropsMixin.SelfManagedKafkaEventSourceConfigProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig

sourceAccessConfigurations

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder sourceAccessConfigurations(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations

sourceAccessConfigurations

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder sourceAccessConfigurations(List<? extends Object> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations

startingPosition

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition

startingPositionTimestamp

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder startingPositionTimestamp(Number startingPositionTimestamp)

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

StartingPositionTimestamp cannot be in the future.

Parameters:

startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp

tags

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder tags(List<? extends CfnTag> 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 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.

Parameters:

tags - A list of tags to add to the event source mapping. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tags

topics

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

The name of the Kafka topic.

Parameters:

topics - The name of the Kafka topic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics

tumblingWindowInSeconds

@Stability(Stable)
public CfnEventSourceMappingPropsMixin.Builder tumblingWindowInSeconds(Number 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds

build

@Stability(Stable)
public CfnEventSourceMappingPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnEventSourceMappingPropsMixin.