Struct aws_sdk_lambda::client::fluent_builders::CreateEventSourceMapping

pub struct CreateEventSourceMapping<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

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 triggers the function.

For details about each event source type, see the following topics.

• Configuring a Dynamo DB stream as an event source

• Configuring a Kinesis stream as an event source

• Configuring an Amazon SQS queue as an event source

• Configuring an MQ broker as an event source

• Configuring MSK as an event source

• Configuring Self-Managed Apache Kafka as an event source

The following error handling options are only available 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.

Implementations

impl<C, M, R> CreateEventSourceMapping<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateEventSourceMappingOutput, SdkError<CreateEventSourceMappingError>> where
    R::Policy: SmithyRetryPolicy<CreateEventSourceMappingInputOperationOutputAlias, CreateEventSourceMappingOutput, CreateEventSourceMappingError, CreateEventSourceMappingInputOperationRetryAlias>, 

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, inp: 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.

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.

pub fn function_name(self, inp: 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, inp: 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, inp: 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 1,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.

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 1,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.

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

(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Default: 0

Related setting: 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

(Streams and Amazon SQS standard queues) The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

Default: 0

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

pub fn parallelization_factor(self, inp: 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, inp: 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 only supported 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 only supported for Amazon Kinesis streams.

pub fn starting_position_timestamp(self, inp: Instant) -> Self

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

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

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

pub fn destination_config(self, inp: 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, inp: 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, inp: 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, inp: 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 will be 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 will be retried until the record expires.

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

(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 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 up to 900 seconds.

pub fn topics(self, inp: 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, inp: 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,
    inp: impl Into<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, inp: SelfManagedEventSource) -> Self

The Self-Managed Apache Kafka cluster to send records.

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

The Self-Managed Apache Kafka cluster to send records.

pub fn function_response_types(
    self,
    inp: impl Into<FunctionResponseType>
) -> Self

Appends an item to FunctionResponseTypes.

To override the contents of this collection use set_function_response_types.

(Streams only) 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 only) A list of current response type enums applied to the event source mapping.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateEventSourceMapping<C, M, R>

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

Formats the value using the given formatter.