software.amazon.awscdk.services.lambda

Interface EventSourceMappingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

EventSourceMappingProps

All Known Implementing Classes:

EventSourceMappingOptions.Jsii$Proxy, EventSourceMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:21.513Z")
 @Stability(value=Experimental)
public interface EventSourceMappingOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EventSourceMappingOptions.Builder	builder()
default Number	getBatchSize() (experimental) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
default Boolean	getBisectBatchOnError() (experimental) If the function returns an error, split the batch in two and retry.
default Boolean	getEnabled() (experimental) Set to false to disable the event source upon creation.
default String	getEventSourceArn() (experimental) The Amazon Resource Name (ARN) of the event source.
default List<String>	getKafkaBootstrapServers() (experimental) A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.
default String	getKafkaTopic() (experimental) The name of the Kafka topic.
default Duration	getMaxBatchingWindow() (experimental) The maximum amount of time to gather records before invoking the function.
default Duration	getMaxRecordAge() (experimental) The maximum age of a record that Lambda sends to a function for processing.
default IEventSourceDlq	getOnFailure() (experimental) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
default Number	getParallelizationFactor() (experimental) The number of batches to process from each shard concurrently.
default Number	getRetryAttempts() (experimental) The maximum number of times to retry when the function returns an error.
default List<SourceAccessConfiguration>	getSourceAccessConfigurations() (experimental) Specific settings like the authentication protocol or the VPC components to secure access to your event source.
default StartingPosition	getStartingPosition() (experimental) The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.
default Duration	getTumblingWindow() (experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBatchSize

@Stability(value=Experimental)
 @Nullable
default Number getBatchSize()

(experimental) The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.

Your function receives an event with all the retrieved records.

Valid Range: Minimum value of 1. Maximum value of 10000.

Default: - Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records. Both the default and maximum for Amazon SQS are 10 messages.

getBisectBatchOnError

@Stability(value=Experimental)
 @Nullable
default Boolean getBisectBatchOnError()

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

Default: false

getEnabled

@Stability(value=Experimental)
 @Nullable
default Boolean getEnabled()

(experimental) Set to false to disable the event source upon creation.

Default: true

getEventSourceArn

@Stability(value=Experimental)
 @Nullable
default String getEventSourceArn()

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

Any record added to this stream can invoke the Lambda function.

Default: - not set if using a self managed Kafka cluster, throws an error otherwise

getKafkaBootstrapServers

@Stability(value=Experimental)
 @Nullable
default List<String> getKafkaBootstrapServers()

(experimental) A list of host and port pairs that are the addresses of the Kafka brokers in a self managed "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself.

They are in the format abc.example.com:9096.

Default: - none

getKafkaTopic

@Stability(value=Experimental)
 @Nullable
default String getKafkaTopic()

(experimental) The name of the Kafka topic.

Default: - no topic

getMaxBatchingWindow

@Stability(value=Experimental)
 @Nullable
default Duration getMaxBatchingWindow()

(experimental) The maximum amount of time to gather records before invoking the function.

Maximum of Duration.minutes(5)

Default: Duration.seconds(0)

getMaxRecordAge

@Stability(value=Experimental)
 @Nullable
default Duration getMaxRecordAge()

(experimental) The maximum age of a record that Lambda sends to a function for processing.

Valid Range:

• Minimum value of 60 seconds
• Maximum value of 7 days

Default: - infinite or until the record expires.

getOnFailure

@Stability(value=Experimental)
 @Nullable
default IEventSourceDlq getOnFailure()

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

Default: discarded records are ignored

getParallelizationFactor

@Stability(value=Experimental)
 @Nullable
default Number getParallelizationFactor()

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

Valid Range:

• Minimum value of 1
• Maximum value of 10

Default: 1

getRetryAttempts

@Stability(value=Experimental)
 @Nullable
default Number getRetryAttempts()

(experimental) The maximum number of times to retry when the function returns an error.

Set to undefined if you want lambda to keep retrying infinitely or until the record expires.

Valid Range:

• Minimum value of 0
• Maximum value of 10000

Default: - infinite or until the record expires.

getSourceAccessConfigurations

@Stability(value=Experimental)
 @Nullable
default List<SourceAccessConfiguration> getSourceAccessConfigurations()

(experimental) Specific settings like the authentication protocol or the VPC components to secure access to your event source.

Default: - none

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html

getStartingPosition

@Stability(value=Experimental)
 @Nullable
default StartingPosition getStartingPosition()

(experimental) The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.

Default: - Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources.

See Also:

https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType

getTumblingWindow

@Stability(value=Experimental)
 @Nullable
default Duration getTumblingWindow()

(experimental) The size of the tumbling windows to group records sent to DynamoDB or Kinesis.

Default: - None

See Also:

Valid Range: 0 - 15 minutes

builder

@Stability(value=Experimental)
static EventSourceMappingOptions.Builder builder()

Returns:

a EventSourceMappingOptions.Builder of EventSourceMappingOptions