Interface CfnEventSourceMappingProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEventSourceMappingProps.Jsii$Proxy
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 .amazonManagedKafkaEventSourceConfig(AmazonManagedKafkaEventSourceConfigProperty.builder() .consumerGroupId("consumerGroupId") .build()) .batchSize(123) .bisectBatchOnFunctionError(false) .destinationConfig(DestinationConfigProperty.builder() .onFailure(OnFailureProperty.builder() .destination("destination") .build()) .build()) .documentDbEventSourceConfig(DocumentDBEventSourceConfigProperty.builder() .collectionName("collectionName") .databaseName("databaseName") .fullDocument("fullDocument") .build()) .enabled(false) .eventSourceArn("eventSourceArn") .filterCriteria(FilterCriteriaProperty.builder() .filters(List.of(FilterProperty.builder() .pattern("pattern") .build())) .build()) .functionResponseTypes(List.of("functionResponseTypes")) .kmsKeyArn("kmsKeyArn") .maximumBatchingWindowInSeconds(123) .maximumRecordAgeInSeconds(123) .maximumRetryAttempts(123) .metricsConfig(MetricsConfigProperty.builder() .metrics(List.of("metrics")) .build()) .parallelizationFactor(123) .provisionedPollerConfig(ProvisionedPollerConfigProperty.builder() .maximumPollers(123) .minimumPollers(123) .build()) .queues(List.of("queues")) .scalingConfig(ScalingConfigProperty.builder() .maximumConcurrency(123) .build()) .selfManagedEventSource(SelfManagedEventSourceProperty.builder() .endpoints(EndpointsProperty.builder() .kafkaBootstrapServers(List.of("kafkaBootstrapServers")) .build()) .build()) .selfManagedKafkaEventSourceConfig(SelfManagedKafkaEventSourceConfigProperty.builder() .consumerGroupId("consumerGroupId") .build()) .sourceAccessConfigurations(List.of(SourceAccessConfigurationProperty.builder() .type("type") .uri("uri") .build())) .startingPosition("startingPosition") .startingPositionTimestamp(123) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .topics(List.of("topics")) .tumblingWindowInSeconds(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEventSourceMappingProps
static final class
An implementation forCfnEventSourceMappingProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.default Number
The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.default Object
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.default Object
(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.default Object
Specific configuration settings for a DocumentDB event source.default Object
When true, the event source mapping is active.default String
The Amazon Resource Name (ARN) of the event source.default Object
An object that defines the filter criteria that determine whether Lambda should process an event.The name or ARN of the Lambda function.(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.default String
The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .default Number
The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.default Number
(Kinesis and DynamoDB Streams only) Discard records older than the specified age.default Number
(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.default Object
The metrics configuration for your event source.default Number
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.default Object
(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.default Object
(Amazon SQS only) The scaling configuration for the event source.default Object
The self-managed Apache Kafka cluster for your event source.default Object
Specific configuration settings for a self-managed Apache Kafka event source.default Object
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.default String
The position in a stream from which to start reading.default Number
WithStartingPosition
set toAT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.getTags()
A list of tags to add to the event source mapping.The name of the Kafka topic.default Number
(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFunctionName
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.
- See Also:
- Function ARN –
-
getAmazonManagedKafkaEventSourceConfig
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.- See Also:
-
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.
- DocumentDB – Default 100. Max 10,000.
- See Also:
-
getBisectBatchOnFunctionError
(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.The default value is false.
- See Also:
-
getDestinationConfig
(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.- See Also:
-
getDocumentDbEventSourceConfig
Specific configuration settings for a DocumentDB event source.- See Also:
-
getEnabled
When true, the event source mapping is active. When false, Lambda pauses polling and invocation.Default: True
- See Also:
-
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 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.
- See Also:
-
getFilterCriteria
An object that defines the filter criteria that determine whether Lambda should process an event.For more information, see Lambda event filtering .
- See Also:
-
getFunctionResponseTypes
(Kinesis, DynamoDB Streams, and SQS) A list of current response type enums applied to the event source mapping.Valid Values:
ReportBatchItemFailures
- See Also:
-
getKmsKeyArn
The ARN of the AWS Key Management Service ( AWS KMS ) customer managed key that Lambda uses to encrypt your function's filter criteria .- See Also:
-
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 , 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 setMaximumBatchingWindowInSeconds
to at least 1.- See Also:
-
getMaximumRecordAgeInSeconds
(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
- See Also:
-
getMaximumRetryAttempts
(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.
- See Also:
-
getMetricsConfig
The metrics configuration for your event source.For more information, see Event source mapping metrics .
- See Also:
-
getParallelizationFactor
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.The default value is 1.
- See Also:
-
getProvisionedPollerConfig
(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.For more information, see provisioned mode .
- See Also:
-
getQueues
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.- See Also:
-
getScalingConfig
(Amazon SQS only) The scaling configuration for the event source.For more information, see Configuring maximum concurrency for Amazon SQS event sources .
- See Also:
-
getSelfManagedEventSource
The self-managed Apache Kafka cluster for your event source.- See Also:
-
getSelfManagedKafkaEventSourceConfig
Specific configuration settings for a self-managed Apache Kafka event source.- See Also:
-
getSourceAccessConfigurations
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.- See Also:
-
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.
- See Also:
-
getStartingPositionTimestamp
WithStartingPosition
set toAT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.StartingPositionTimestamp
cannot be in the future.- See Also:
-
getTags
A list of tags to add to the event source mapping.You must have the
lambda:TagResource
,lambda:UntagResource
, andlambda: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.- See Also:
-
getTopics
The name of the Kafka topic.- See Also:
-
getTumblingWindowInSeconds
(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.
- See Also:
-
builder
- Returns:
- a
CfnEventSourceMappingProps.Builder
ofCfnEventSourceMappingProps
-