Struct aws_sdk_lambda::client::fluent_builders::CreateEventSourceMapping

pub struct CreateEventSourceMapping { /* private fields */ }

Fluent builder constructing a request to CreateEventSourceMapping.

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function.

For details about how to configure different event sources, see the following topics.

• Amazon DynamoDB Streams

• Amazon Kinesis

• Amazon SQS

• Amazon MQ and RabbitMQ

• Amazon MSK

• Apache Kafka

The following error handling options are available only for stream sources (DynamoDB and Kinesis):

• BisectBatchOnFunctionError – If the function returns an error, split the batch in two and retry.

• DestinationConfig – Send discarded records to an Amazon SQS queue or Amazon SNS topic.

• MaximumRecordAgeInSeconds – Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires

• MaximumRetryAttempts – Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

• ParallelizationFactor – Process multiple batches from each shard concurrently.

For information about which configuration parameters apply to each event source, see the following topics.

• Amazon DynamoDB Streams

• Amazon Kinesis

• Amazon SQS

• Amazon MQ and RabbitMQ

• Amazon MSK

• Apache Kafka

Implementations

impl CreateEventSourceMapping

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateEventSourceMapping, AwsResponseRetryClassifier>, SdkError<CreateEventSourceMappingError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateEventSourceMappingOutput, SdkError<CreateEventSourceMappingError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn event_source_arn(self, input: impl Into<String>) -> Self

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.

• Amazon MQ – The ARN of the broker.

pub fn set_event_source_arn(self, input: Option<String>) -> Self

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.

• Amazon MQ – The ARN of the broker.

pub fn function_name(self, input: impl Into<String>) -> Self

The name 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.

pub fn set_function_name(self, input: Option<String>) -> Self

The name 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.

pub fn enabled(self, input: bool) -> Self

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

pub fn set_enabled(self, input: Option<bool>) -> Self

When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

Default: True

pub fn batch_size(self, input: i32) -> Self

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.

pub fn set_batch_size(self, input: Option<i32>) -> Self

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.

pub fn filter_criteria(self, input: FilterCriteria) -> Self

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

pub fn set_filter_criteria(self, input: Option<FilterCriteria>) -> Self

An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see Lambda event filtering.

pub fn maximum_batching_window_in_seconds(self, input: i32) -> Self

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

pub fn set_maximum_batching_window_in_seconds(self, input: Option<i32>) -> Self

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function. You can configure MaximumBatchingWindowInSeconds to any value from 0 seconds to 300 seconds in increments of seconds.

For streams and Amazon SQS event sources, the default batching window is 0 seconds. For Amazon MSK, Self-managed Apache Kafka, and Amazon MQ event sources, the default batching window is 500 ms. Note that because you can only change MaximumBatchingWindowInSeconds in increments of seconds, you cannot revert back to the 500 ms default batching window after you have changed it. To restore the default batching window, you must create a new event source mapping.

Related setting: For streams and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

pub fn parallelization_factor(self, input: i32) -> Self

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

pub fn set_parallelization_factor(self, input: Option<i32>) -> Self

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

pub fn starting_position(self, input: EventSourcePosition) -> Self

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.

pub fn set_starting_position(self, input: Option<EventSourcePosition>) -> Self

The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.

pub fn starting_position_timestamp(self, input: DateTime) -> Self

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

pub fn set_starting_position_timestamp(self, input: Option<DateTime>) -> Self

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

pub fn destination_config(self, input: DestinationConfig) -> Self

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

pub fn set_destination_config(self, input: Option<DestinationConfig>) -> Self

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

pub fn maximum_record_age_in_seconds(self, input: i32) -> Self

(Streams only) Discard records older than the specified age. The default value is infinite (-1).

pub fn set_maximum_record_age_in_seconds(self, input: Option<i32>) -> Self

(Streams only) Discard records older than the specified age. The default value is infinite (-1).

pub fn bisect_batch_on_function_error(self, input: bool) -> Self

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

pub fn set_bisect_batch_on_function_error(self, input: Option<bool>) -> Self

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

pub fn maximum_retry_attempts(self, input: i32) -> Self

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

pub fn set_maximum_retry_attempts(self, input: Option<i32>) -> Self

(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

pub fn tumbling_window_in_seconds(self, input: i32) -> Self

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

pub fn set_tumbling_window_in_seconds(self, input: Option<i32>) -> Self

(Streams only) The duration in seconds of a processing window. The range is between 1 second and 900 seconds.

pub fn topics(self, input: impl Into<String>) -> Self

Appends an item to Topics.

To override the contents of this collection use set_topics.

The name of the Kafka topic.

pub fn set_topics(self, input: Option<Vec<String>>) -> Self

The name of the Kafka topic.

pub fn queues(self, input: impl Into<String>) -> Self

Appends an item to Queues.

To override the contents of this collection use set_queues.

(MQ) The name of the Amazon MQ broker destination queue to consume.

pub fn set_queues(self, input: Option<Vec<String>>) -> Self

(MQ) The name of the Amazon MQ broker destination queue to consume.

pub fn source_access_configurations(
    self,
    input: SourceAccessConfiguration
) -> Self

Appends an item to SourceAccessConfigurations.

To override the contents of this collection use set_source_access_configurations.

An array of authentication protocols or VPC components required to secure your event source.

pub fn set_source_access_configurations(
    self,
    input: Option<Vec<SourceAccessConfiguration>>
) -> Self

An array of authentication protocols or VPC components required to secure your event source.

pub fn self_managed_event_source(self, input: SelfManagedEventSource) -> Self

The self-managed Apache Kafka cluster to receive records from.

pub fn set_self_managed_event_source(
    self,
    input: Option<SelfManagedEventSource>
) -> Self

The self-managed Apache Kafka cluster to receive records from.

pub fn function_response_types(self, input: FunctionResponseType) -> Self

Appends an item to FunctionResponseTypes.

To override the contents of this collection use set_function_response_types.

(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.

pub fn set_function_response_types(
    self,
    input: Option<Vec<FunctionResponseType>>
) -> Self

(Streams and Amazon SQS) A list of current response type enums applied to the event source mapping.

pub fn amazon_managed_kafka_event_source_config(
    self,
    input: AmazonManagedKafkaEventSourceConfig
) -> Self

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

pub fn set_amazon_managed_kafka_event_source_config(
    self,
    input: Option<AmazonManagedKafkaEventSourceConfig>
) -> Self

Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.

pub fn self_managed_kafka_event_source_config(
    self,
    input: SelfManagedKafkaEventSourceConfig
) -> Self

Specific configuration settings for a self-managed Apache Kafka event source.

pub fn set_self_managed_kafka_event_source_config(
    self,
    input: Option<SelfManagedKafkaEventSourceConfig>
) -> Self

Specific configuration settings for a self-managed Apache Kafka event source.

pub fn scaling_config(self, input: ScalingConfig) -> Self

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

pub fn set_scaling_config(self, input: Option<ScalingConfig>) -> Self

(Amazon SQS only) The scaling configuration for the event source. For more information, see Configuring maximum concurrency for Amazon SQS event sources.

Trait Implementations

impl Clone for CreateEventSourceMapping

fn clone(&self) -> CreateEventSourceMapping

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateEventSourceMapping

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.