software.amazon.awscdk.services.lambda

Interface CfnEventSourceMappingProps

All Known Implementing Classes:

CfnEventSourceMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-06T20:02:51.791Z")
public interface CfnEventSourceMappingProps

Properties for defining a `CfnEventSourceMapping`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnEventSourceMappingProps cfnEventSourceMappingProps = CfnEventSourceMappingProps.builder()
         .functionName("functionName")
         // the properties below are optional
         .batchSize(123)
         .bisectBatchOnFunctionError(false)
         .destinationConfig(DestinationConfigProperty.builder()
                 .onFailure(OnFailureProperty.builder()
                         .destination("destination")
                         .build())
                 .build())
         .enabled(false)
         .eventSourceArn("eventSourceArn")
         .filterCriteria(FilterCriteriaProperty.builder()
                 .filters(List.of(FilterProperty.builder()
                         .pattern("pattern")
                         .build()))
                 .build())
         .functionResponseTypes(List.of("functionResponseTypes"))
         .maximumBatchingWindowInSeconds(123)
         .maximumRecordAgeInSeconds(123)
         .maximumRetryAttempts(123)
         .parallelizationFactor(123)
         .queues(List.of("queues"))
         .selfManagedEventSource(SelfManagedEventSourceProperty.builder()
                 .endpoints(EndpointsProperty.builder()
                         .kafkaBootstrapServers(List.of("kafkaBootstrapServers"))
                         .build())
                 .build())
         .sourceAccessConfigurations(List.of(SourceAccessConfigurationProperty.builder()
                 .type("type")
                 .uri("uri")
                 .build()))
         .startingPosition("startingPosition")
         .startingPositionTimestamp(123)
         .topics(List.of("topics"))
         .tumblingWindowInSeconds(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEventSourceMappingProps.Builder A builder for CfnEventSourceMappingProps
static class	CfnEventSourceMappingProps.Jsii$Proxy An implementation for CfnEventSourceMappingProps

Method Summary

Modifier and Type	Method and Description
static CfnEventSourceMappingProps.Builder	builder()
default java.lang.Number	getBatchSize() The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
default java.lang.Object	getBisectBatchOnFunctionError() (Streams only) If the function returns an error, split the batch in two and retry.
default java.lang.Object	getDestinationConfig() (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
default java.lang.Object	getEnabled() When true, the event source mapping is active.
default java.lang.String	getEventSourceArn() The Amazon Resource Name (ARN) of the event source.
default java.lang.Object	getFilterCriteria() (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event.
java.lang.String	getFunctionName() The name of the Lambda function.
default java.util.List<java.lang.String>	getFunctionResponseTypes() (Streams and SQS) A list of current response type enums applied to the event source mapping.
default java.lang.Number	getMaximumBatchingWindowInSeconds() The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
default java.lang.Number	getMaximumRecordAgeInSeconds() (Streams only) Discard records older than the specified age.
default java.lang.Number	getMaximumRetryAttempts() (Streams only) Discard records after the specified number of retries.
default java.lang.Number	getParallelizationFactor() (Streams only) The number of batches to process concurrently from each shard.
default java.util.List<java.lang.String>	getQueues() (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
default java.lang.Object	getSelfManagedEventSource() The self-managed Apache Kafka cluster for your event source.
default java.lang.Object	getSourceAccessConfigurations() An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
default java.lang.String	getStartingPosition() The position in a stream from which to start reading.
default java.lang.Number	getStartingPositionTimestamp() With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.
default java.util.List<java.lang.String>	getTopics() The name of the Kafka topic.
default java.lang.Number	getTumblingWindowInSeconds() (Streams only) The duration in seconds of a processing window.

Method Detail

getFunctionName

java.lang.String getFunctionName()

The name 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.

getBatchSize

default java.lang.Number 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.

getBisectBatchOnFunctionError

default java.lang.Object getBisectBatchOnFunctionError()

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

The default value is false.

getDestinationConfig

default java.lang.Object getDestinationConfig()

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

getEnabled

default java.lang.Object getEnabled()

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

Default: True

getEventSourceArn

default java.lang.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.

getFilterCriteria

default java.lang.Object getFilterCriteria()

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

getFunctionResponseTypes

default java.util.List<java.lang.String> getFunctionResponseTypes()

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

Valid Values: ReportBatchItemFailures

getMaximumBatchingWindowInSeconds

default java.lang.Number getMaximumBatchingWindowInSeconds()

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

getMaximumRecordAgeInSeconds

default java.lang.Number getMaximumRecordAgeInSeconds()

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

getMaximumRetryAttempts

default java.lang.Number getMaximumRetryAttempts()

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

getParallelizationFactor

default java.lang.Number getParallelizationFactor()

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

The default value is 1.

getQueues

default java.util.List<java.lang.String> getQueues()

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

getSelfManagedEventSource

default java.lang.Object getSelfManagedEventSource()

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

getSourceAccessConfigurations

default java.lang.Object getSourceAccessConfigurations()

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

getStartingPosition

default java.lang.String getStartingPosition()

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.

getStartingPositionTimestamp

default java.lang.Number getStartingPositionTimestamp()

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

getTopics

default java.util.List<java.lang.String> getTopics()

The name of the Kafka topic.

getTumblingWindowInSeconds

default java.lang.Number getTumblingWindowInSeconds()

(Streams only) The duration in seconds of a processing window.

The range is between 1 second up to 900 seconds.

builder

static CfnEventSourceMappingProps.Builder builder()

Returns:

a CfnEventSourceMappingProps.Builder of CfnEventSourceMappingProps