@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:54.435Z")
public interface CfnEventSourceMappingProps
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()) .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")) .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) .topics(List.of("topics")) .tumblingWindowInSeconds(123) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnEventSourceMappingProps.Builder
A builder for
CfnEventSourceMappingProps |
static class |
CfnEventSourceMappingProps.Jsii$Proxy
An implementation for
CfnEventSourceMappingProps |
Modifier and Type | Method and Description |
---|---|
static CfnEventSourceMappingProps.Builder |
builder() |
default java.lang.Object |
getAmazonManagedKafkaEventSourceConfig()
Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.
|
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()
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 |
getScalingConfig()
( Amazon Simple Queue Service only) The scaling configuration for the event source.
|
default java.lang.Object |
getSelfManagedEventSource()
The self-managed Apache Kafka cluster for your event source.
|
default java.lang.Object |
getSelfManagedKafkaEventSourceConfig()
Specific configuration settings for a self-managed Apache Kafka 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.
|
java.lang.String getFunctionName()
Name formats - Function name – MyFunction
.
arn:aws:lambda:us-west-2:123456789012:function:MyFunction
.arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD
.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.
default java.lang.Object getAmazonManagedKafkaEventSourceConfig()
default java.lang.Number getBatchSize()
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).
default java.lang.Object getBisectBatchOnFunctionError()
The default value is false.
default java.lang.Object getDestinationConfig()
default java.lang.Object getEnabled()
Default: True
default java.lang.String getEventSourceArn()
default java.lang.Object getFilterCriteria()
For more information, see Lambda event filtering .
default java.util.List<java.lang.String> getFunctionResponseTypes()
Valid Values: ReportBatchItemFailures
default java.lang.Number getMaximumBatchingWindowInSeconds()
Default ( Kinesis , DynamoDB , Amazon SQS event sources) : 0
Default ( Amazon MSK , Kafka, Amazon MQ event sources) : 500 ms
Related setting: When you set BatchSize
to a value greater than 10, you must set MaximumBatchingWindowInSeconds
to at least 1.
default java.lang.Number getMaximumRecordAgeInSeconds()
The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
default java.lang.Number getMaximumRetryAttempts()
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.
default java.lang.Number getParallelizationFactor()
The default value is 1.
default java.util.List<java.lang.String> getQueues()
default java.lang.Object getScalingConfig()
For more information, see Configuring maximum concurrency for Amazon SQS event sources .
default java.lang.Object getSelfManagedEventSource()
default java.lang.Object getSelfManagedKafkaEventSourceConfig()
default java.lang.Object getSourceAccessConfigurations()
default java.lang.String getStartingPosition()
default java.lang.Number getStartingPositionTimestamp()
default java.util.List<java.lang.String> getTopics()
default java.lang.Number getTumblingWindowInSeconds()
The range is between 1 second and 900 seconds.
static CfnEventSourceMappingProps.Builder builder()
CfnEventSourceMappingProps.Builder
of CfnEventSourceMappingProps