Struct aws_sdk_lambda::operation::update_event_source_mapping::UpdateEventSourceMappingInput

#[non_exhaustive]
pub struct UpdateEventSourceMappingInput {

    pub uuid: Option<String>,
    pub function_name: Option<String>,
    pub enabled: Option<bool>,
    pub batch_size: Option<i32>,
    pub filter_criteria: Option<FilterCriteria>,
    pub maximum_batching_window_in_seconds: Option<i32>,
    pub destination_config: Option<DestinationConfig>,
    pub maximum_record_age_in_seconds: Option<i32>,
    pub bisect_batch_on_function_error: Option<bool>,
    pub maximum_retry_attempts: Option<i32>,
    pub parallelization_factor: Option<i32>,
    pub source_access_configurations: Option<Vec<SourceAccessConfiguration>>,
    pub tumbling_window_in_seconds: Option<i32>,
    pub function_response_types: Option<Vec<FunctionResponseType>>,
    pub scaling_config: Option<ScalingConfig>,
    pub document_db_event_source_config: Option<DocumentDbEventSourceConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

uuid: Option<String>

The identifier of the event source mapping.

function_name: Option<String>

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.

enabled: Option<bool>

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

Default: True

batch_size: Option<i32>

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.

filter_criteria: Option<FilterCriteria>

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

maximum_batching_window_in_seconds: Option<i32>

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, Amazon MQ, and DocumentDB 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.

destination_config: Option<DestinationConfig>

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

maximum_record_age_in_seconds: Option<i32>

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

bisect_batch_on_function_error: Option<bool>

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

maximum_retry_attempts: Option<i32>

(Kinesis and DynamoDB 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.

parallelization_factor: Option<i32>

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

source_access_configurations: Option<Vec<SourceAccessConfiguration>>

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

tumbling_window_in_seconds: Option<i32>

(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.

function_response_types: Option<Vec<FunctionResponseType>>

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

scaling_config: Option<ScalingConfig>

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

document_db_event_source_config: Option<DocumentDbEventSourceConfig>

Specific configuration settings for a DocumentDB event source.

Implementations

impl UpdateEventSourceMappingInput

pub fn uuid(&self) -> Option<&str>

The identifier of the event source mapping.

pub fn function_name(&self) -> Option<&str>

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.

pub fn enabled(&self) -> Option<bool>

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

Default: True

pub fn batch_size(&self) -> Option<i32>

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.

pub fn filter_criteria(&self) -> Option<&FilterCriteria>

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) -> Option<i32>

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, Amazon MQ, and DocumentDB 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 destination_config(&self) -> Option<&DestinationConfig>

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

pub fn maximum_record_age_in_seconds(&self) -> Option<i32>

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

pub fn bisect_batch_on_function_error(&self) -> Option<bool>

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

pub fn maximum_retry_attempts(&self) -> Option<i32>

(Kinesis and DynamoDB 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 parallelization_factor(&self) -> Option<i32>

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

pub fn source_access_configurations(&self) -> &[SourceAccessConfiguration]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .source_access_configurations.is_none().

pub fn tumbling_window_in_seconds(&self) -> Option<i32>

(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.

pub fn function_response_types(&self) -> &[FunctionResponseType]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .function_response_types.is_none().

pub fn scaling_config(&self) -> Option<&ScalingConfig>

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

pub fn document_db_event_source_config( &self ) -> Option<&DocumentDbEventSourceConfig>

Specific configuration settings for a DocumentDB event source.

impl UpdateEventSourceMappingInput

pub fn builder() -> UpdateEventSourceMappingInputBuilder

Creates a new builder-style object to manufacture UpdateEventSourceMappingInput.

Trait Implementations

impl Clone for UpdateEventSourceMappingInput

fn clone(&self) -> UpdateEventSourceMappingInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateEventSourceMappingInput

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

Formats the value using the given formatter.

impl PartialEq for UpdateEventSourceMappingInput

fn eq(&self, other: &UpdateEventSourceMappingInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateEventSourceMappingInput