EventSourceMappingArgs class

The set of arguments for EventSourceMapping. The set of arguments for EventSourceMapping.

Constructors

EventSourceMappingArgs({Input<EventSourceMappingAmazonManagedKafkaEventSourceConfig?>? amazonManagedKafkaEventSourceConfig, Input<int?>? batchSize, Input<bool?>? bisectBatchOnFunctionError, Input<EventSourceMappingDestinationConfig?>? destinationConfig, Input<EventSourceMappingDocumentDbEventSourceConfig?>? documentDbEventSourceConfig, Input<bool?>? enabled, Input<String?>? eventSourceArn, Input<EventSourceMappingFilterCriteria?>? filterCriteria, required Input<String> functionName, Input<List<String>?>? functionResponseTypes, Input<String?>? kmsKeyArn, Input<int?>? maximumBatchingWindowInSeconds, Input<int?>? maximumRecordAgeInSeconds, Input<int?>? maximumRetryAttempts, Input<EventSourceMappingMetricsConfig?>? metricsConfig, Input<int?>? parallelizationFactor, Input<EventSourceMappingProvisionedPollerConfig?>? provisionedPollerConfig, Input<String?>? queues, Input<String?>? region, Input<EventSourceMappingScalingConfig?>? scalingConfig, Input<EventSourceMappingSelfManagedEventSource?>? selfManagedEventSource, Input<EventSourceMappingSelfManagedKafkaEventSourceConfig?>? selfManagedKafkaEventSourceConfig, Input<List<EventSourceMappingSourceAccessConfiguration>?>? sourceAccessConfigurations, Input<String?>? startingPosition, Input<String?>? startingPositionTimestamp, Input<Map<String, String>?>? tags, Input<List<String>?>? topics, Input<int?>? tumblingWindowInSeconds, Input<bool?>? useResourceTimeoutForPropagation})
Creates a new EventSourceMappingArgs. amazonManagedKafkaEventSourceConfig Additional configuration block for Amazon Managed Kafka sources. Incompatible with selfManagedEventSource and selfManagedKafkaEventSourceConfig. See below. batchSize Largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to 100 for DynamoDB, Kinesis, MQ and MSK, 10 for SQS. bisectBatchOnFunctionError Whether to split the batch in two and retry if the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Defaults to false. destinationConfig Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). See below. documentDbEventSourceConfig Configuration settings for a DocumentDB event source. See below. enabled Whether the mapping is enabled. Defaults to true. eventSourceArn Event source ARN - required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. Incompatible with Self Managed Kafka source. filterCriteria Criteria to use for event filtering Kinesis stream, DynamoDB stream, SQS queue event sources. See below. functionName Name or ARN of the Lambda function that will be subscribing to events. functionResponseTypes List of current response type enums applied to the event source mapping for AWS Lambda checkpointing. Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: ReportBatchItemFailures. kmsKeyArn ARN of the KMS customer managed key that Lambda uses to encrypt your function's filter criteria. maximumBatchingWindowInSeconds Maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer until either maximumBatchingWindowInSeconds expires or batchSize has been met. For streaming event sources, defaults to as soon as records are available in the stream. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues. maximumRecordAgeInSeconds Maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive). maximumRetryAttempts Maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000. metricsConfig CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. See below. parallelizationFactor Number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10. provisionedPollerConfig Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. See below. queues Name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. scalingConfig Scaling configuration of the event source. Only available for SQS queues. See below. selfManagedEventSource For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include sourceAccessConfiguration. See below. selfManagedKafkaEventSourceConfig Additional configuration block for Self Managed Kafka sources. Incompatible with eventSourceArn and amazonManagedKafkaEventSourceConfig. See below. sourceAccessConfigurations For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include selfManagedEventSource. See below. startingPosition Position in the stream where AWS Lambda should start reading. Must be one of AT_TIMESTAMP (Kinesis only), LATEST or TRIM_HORIZON if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the AWS DynamoDB Streams API Reference and AWS Kinesis API Reference. startingPositionTimestamp Timestamp in RFC3339 format of the data record which to start reading when using startingPosition set to AT_TIMESTAMP. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen. tags Map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. topics Name of the Kafka topics. Only available for MSK sources. A single topic name must be specified. tumblingWindowInSeconds Duration in seconds of a processing window for AWS Lambda streaming analytics. The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis). useResourceTimeoutForPropagation Whether to apply resource level timeout values while retrying eventually consistent API operations. By default the provider uses a 5 minute timeout to allow for propagation in the Lambda service. When set to true, this default value is replaced with the configurable resource timeouts. Increased timeout values may be useful in highly active accounts, or regions where propagation delays are inconsistent.
const
EventSourceMappingArgs.fromMap(Map<String, dynamic> map)
factory

Properties

amazonManagedKafkaEventSourceConfig → Input<EventSourceMappingAmazonManagedKafkaEventSourceConfig?>?
Additional configuration block for Amazon Managed Kafka sources. Incompatible with selfManagedEventSource and selfManagedKafkaEventSourceConfig. See below.
final
batchSize → Input<int?>?
Largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to 100 for DynamoDB, Kinesis, MQ and MSK, 10 for SQS.
final
bisectBatchOnFunctionError → Input<bool?>?
Whether to split the batch in two and retry if the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Defaults to false.
final
destinationConfig → Input<EventSourceMappingDestinationConfig?>?
Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). See below.
final
documentDbEventSourceConfig → Input<EventSourceMappingDocumentDbEventSourceConfig?>?
Configuration settings for a DocumentDB event source. See below.
final
enabled → Input<bool?>?
Whether the mapping is enabled. Defaults to true.
final
eventSourceArn → Input<String?>?
Event source ARN - required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. Incompatible with Self Managed Kafka source.
final
filterCriteria → Input<EventSourceMappingFilterCriteria?>?
Criteria to use for event filtering Kinesis stream, DynamoDB stream, SQS queue event sources. See below.
final
functionName → Input<String>
Name or ARN of the Lambda function that will be subscribing to events.
final
functionResponseTypes → Input<List<String>?>?
List of current response type enums applied to the event source mapping for AWS Lambda checkpointing. Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: ReportBatchItemFailures.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyArn → Input<String?>?
ARN of the KMS customer managed key that Lambda uses to encrypt your function's filter criteria.
final
maximumBatchingWindowInSeconds → Input<int?>?
Maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer until either maximumBatchingWindowInSeconds expires or batchSize has been met. For streaming event sources, defaults to as soon as records are available in the stream. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues.
final
maximumRecordAgeInSeconds → Input<int?>?
Maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive).
final
maximumRetryAttempts → Input<int?>?
Maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000.
final
metricsConfig → Input<EventSourceMappingMetricsConfig?>?
CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. See below.
final
parallelizationFactor → Input<int?>?
Number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10.
final
provisionedPollerConfig → Input<EventSourceMappingProvisionedPollerConfig?>?
Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. See below.
final
queues → Input<String?>?
Name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scalingConfig → Input<EventSourceMappingScalingConfig?>?
Scaling configuration of the event source. Only available for SQS queues. See below.
final
selfManagedEventSource → Input<EventSourceMappingSelfManagedEventSource?>?
For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include sourceAccessConfiguration. See below.
final
selfManagedKafkaEventSourceConfig → Input<EventSourceMappingSelfManagedKafkaEventSourceConfig?>?
Additional configuration block for Self Managed Kafka sources. Incompatible with eventSourceArn and amazonManagedKafkaEventSourceConfig. See below.
final
sourceAccessConfigurations → Input<List<EventSourceMappingSourceAccessConfiguration>?>?
For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include selfManagedEventSource. See below.
final
startingPosition → Input<String?>?
Position in the stream where AWS Lambda should start reading. Must be one of AT_TIMESTAMP (Kinesis only), LATEST or TRIM_HORIZON if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the AWS DynamoDB Streams API Reference and AWS Kinesis API Reference.
final
startingPositionTimestamp → Input<String?>?
Timestamp in RFC3339 format of the data record which to start reading when using startingPosition set to AT_TIMESTAMP. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the object. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
topics → Input<List<String>?>?
Name of the Kafka topics. Only available for MSK sources. A single topic name must be specified.
final
tumblingWindowInSeconds → Input<int?>?
Duration in seconds of a processing window for AWS Lambda streaming analytics. The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis).
final
useResourceTimeoutForPropagation → Input<bool?>?
Whether to apply resource level timeout values while retrying eventually consistent API operations. By default the provider uses a 5 minute timeout to allow for propagation in the Lambda service. When set to true, this default value is replaced with the configurable resource timeouts. Increased timeout values may be useful in highly active accounts, or regions where propagation delays are inconsistent.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited