Interface CfnEventSourceMappingProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEventSourceMappingProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:03.842Z")
@Stability(Stable)
public interface CfnEventSourceMappingProps
extends software.amazon.jsii.JsiiSerializable
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 .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
Modifier 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 MSK event source.default Number
The maximum number of items to retrieve in a single batch.default Object
(Streams) If the function returns an error, split the batch in two and retry.default Object
A configuration object that specifies the destination of an event after Lambda processes it.default Object
Document db event source config.default Object
Disables the event source mapping to pause polling and invocation.default String
The Amazon Resource Name (ARN) of the event source.default Object
The filter criteria to control event filtering.The name of the Lambda function.(Streams) A list of response types supported by the function.default String
The Amazon Resource Name (ARN) of the KMS key.default Number
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.default Number
(Streams) The maximum age of a record that Lambda sends to a function for processing.default Number
(Streams) The maximum number of times to retry when the function returns an error.default Object
Metrics config for Event Source Mapping Metrics.default Number
(Streams) The number of batches to process from each shard concurrently.default Object
ProvisionedPollerConfig.(ActiveMQ) A list of ActiveMQ queues.default Object
The scaling configuration for the event source.default Object
The configuration used by AWS Lambda to access a self-managed event source.default Object
Specific configuration settings for a Self-Managed Apache Kafka event source.default Object
A list of SourceAccessConfiguration.default String
The position in a stream from which to start reading.default Number
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.getTags()
A list of tags to apply to event source mapping resource.(Kafka) A list of Kafka topics.default Number
(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getFunctionName
The name of the Lambda function.- See Also:
-
getAmazonManagedKafkaEventSourceConfig
Specific configuration settings for an MSK event source.- See Also:
-
getBatchSize
The maximum number of items to retrieve in a single batch.- See Also:
-
getBisectBatchOnFunctionError
(Streams) If the function returns an error, split the batch in two and retry.- See Also:
-
getDestinationConfig
A configuration object that specifies the destination of an event after Lambda processes it.- See Also:
-
getDocumentDbEventSourceConfig
Document db event source config.- See Also:
-
getEnabled
Disables the event source mapping to pause polling and invocation.- See Also:
-
getEventSourceArn
The Amazon Resource Name (ARN) of the event source.- See Also:
-
getFilterCriteria
The filter criteria to control event filtering.- See Also:
-
getFunctionResponseTypes
(Streams) A list of response types supported by the function.- See Also:
-
getKmsKeyArn
The Amazon Resource Name (ARN) of the KMS key.- See Also:
-
getMaximumBatchingWindowInSeconds
(Streams) The maximum amount of time to gather records before invoking the function, in seconds.- See Also:
-
getMaximumRecordAgeInSeconds
(Streams) The maximum age of a record that Lambda sends to a function for processing.- See Also:
-
getMaximumRetryAttempts
(Streams) The maximum number of times to retry when the function returns an error.- See Also:
-
getMetricsConfig
Metrics config for Event Source Mapping Metrics.- See Also:
-
getParallelizationFactor
(Streams) The number of batches to process from each shard concurrently.- See Also:
-
getProvisionedPollerConfig
ProvisionedPollerConfig.- See Also:
-
getQueues
(ActiveMQ) A list of ActiveMQ queues.- See Also:
-
getScalingConfig
The scaling configuration for the event source.- See Also:
-
getSelfManagedEventSource
The configuration used by AWS Lambda to access a self-managed event source.- See Also:
-
getSelfManagedKafkaEventSourceConfig
Specific configuration settings for a Self-Managed Apache Kafka event source.- See Also:
-
getSourceAccessConfigurations
A list of SourceAccessConfiguration.- See Also:
-
getStartingPosition
The position in a stream from which to start reading.Required for Amazon Kinesis and Amazon DynamoDB Streams sources.
- See Also:
-
getStartingPositionTimestamp
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.- See Also:
-
getTags
A list of tags to apply to event source mapping resource.- See Also:
-
getTopics
(Kafka) A list of Kafka topics.- See Also:
-
getTumblingWindowInSeconds
(Streams) Tumbling window (non-overlapping time window) duration to perform aggregations.- See Also:
-
builder
- Returns:
- a
CfnEventSourceMappingProps.Builder
ofCfnEventSourceMappingProps
-