Struct CreateEventSourceMappingInput

#[non_exhaustive]
pub struct CreateEventSourceMappingInput {

    pub event_source_arn: 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 parallelization_factor: Option<i32>,
    pub starting_position: Option<EventSourcePosition>,
    pub starting_position_timestamp: Option<DateTime>,
    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 tags: Option<HashMap<String, String>>,
    pub tumbling_window_in_seconds: Option<i32>,
    pub topics: Option<Vec<String>>,
    pub queues: Option<Vec<String>>,
    pub source_access_configurations: Option<Vec<SourceAccessConfiguration>>,
    pub self_managed_event_source: Option<SelfManagedEventSource>,
    pub function_response_types: Option<Vec<FunctionResponseType>>,
    pub amazon_managed_kafka_event_source_config: Option<AmazonManagedKafkaEventSourceConfig>,
    pub self_managed_kafka_event_source_config: Option<SelfManagedKafkaEventSourceConfig>,
    pub scaling_config: Option<ScalingConfig>,
    pub document_db_event_source_config: Option<DocumentDbEventSourceConfig>,
    pub kms_key_arn: Option<String>,
    pub metrics_config: Option<EventSourceMappingMetricsConfig>,
    pub provisioned_poller_config: Option<ProvisionedPollerConfig>,
}

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.

event_source_arn: Option<String>

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 or the ARN of the VPC connection (for cross-account event source mappings).

• Amazon MQ – The ARN of the broker.

• Amazon DocumentDB – The ARN of the DocumentDB change stream.

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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, and Amazon SQS event sources, when you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

parallelization_factor: Option<i32>

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

starting_position: Option<EventSourcePosition>

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

starting_position_timestamp: Option<DateTime>

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

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.

tags: Option<HashMap<String, String>>

A list of tags to apply to the event source mapping.

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.

topics: Option<Vec<String>>

The name of the Kafka topic.

queues: Option<Vec<String>>

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

source_access_configurations: Option<Vec<SourceAccessConfiguration>>

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

self_managed_event_source: Option<SelfManagedEventSource>

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

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.

amazon_managed_kafka_event_source_config: Option<AmazonManagedKafkaEventSourceConfig>

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

self_managed_kafka_event_source_config: Option<SelfManagedKafkaEventSourceConfig>

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

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.

kms_key_arn: Option<String>

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

metrics_config: Option<EventSourceMappingMetricsConfig>

The metrics configuration for your event source. For more information, see Event source mapping metrics.

provisioned_poller_config: Option<ProvisionedPollerConfig>

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

Implementations

impl CreateEventSourceMappingInput

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

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 or the ARN of the VPC connection (for cross-account event source mappings).

• Amazon MQ – The ARN of the broker.

• Amazon DocumentDB – The ARN of the DocumentDB change stream.

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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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) -> Option<i32>

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

pub fn starting_position(&self) -> Option<&EventSourcePosition>

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Stream event sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams, Amazon DocumentDB, Amazon MSK, and self-managed Apache Kafka.

pub fn starting_position_timestamp(&self) -> Option<&DateTime>

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading. StartingPositionTimestamp cannot be in the future.

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 tags(&self) -> Option<&HashMap<String, String>>

A list of tags to apply to the event source mapping.

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 topics(&self) -> &[String]

The name of the Kafka topic.

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

pub fn queues(&self) -> &[String]

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

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

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 self_managed_event_source(&self) -> Option<&SelfManagedEventSource>

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

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 amazon_managed_kafka_event_source_config( &self, ) -> Option<&AmazonManagedKafkaEventSourceConfig>

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

pub fn self_managed_kafka_event_source_config( &self, ) -> Option<&SelfManagedKafkaEventSourceConfig>

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

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.

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

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

pub fn metrics_config(&self) -> Option<&EventSourceMappingMetricsConfig>

The metrics configuration for your event source. For more information, see Event source mapping metrics.

pub fn provisioned_poller_config(&self) -> Option<&ProvisionedPollerConfig>

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.

impl CreateEventSourceMappingInput

pub fn builder() -> CreateEventSourceMappingInputBuilder

Creates a new builder-style object to manufacture CreateEventSourceMappingInput.

Trait Implementations

impl Clone for CreateEventSourceMappingInput

fn clone(&self) -> CreateEventSourceMappingInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEventSourceMappingInput

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

Formats the value using the given formatter.

impl PartialEq for CreateEventSourceMappingInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateEventSourceMappingInput