Struct aws_sdk_lambda::input::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 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>>,
}

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.

function_name: Option<String>

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.

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.

filter_criteria: Option<FilterCriteria>

(Streams and Amazon SQS) 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>

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

parallelization_factor: Option<i32>

(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, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

starting_position_timestamp: Option<DateTime>

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

destination_config: Option<DestinationConfig>

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

maximum_record_age_in_seconds: Option<i32>

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

bisect_batch_on_function_error: Option<bool>

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

maximum_retry_attempts: Option<i32>

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

tumbling_window_in_seconds: Option<i32>

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

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 send records.

function_response_types: Option<Vec<FunctionResponseType>>

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

Implementations

impl CreateEventSourceMappingInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateEventSourceMapping, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateEventSourceMapping>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateEventSourceMappingInput.

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.

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

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

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

(Streams and Amazon SQS) 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>

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

(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, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

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

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

pub fn destination_config(&self) -> Option<&DestinationConfig>

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

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

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

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

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

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

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

pub fn topics(&self) -> Option<&[String]>

The name of the Kafka topic.

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

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

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

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

pub fn self_managed_event_source(&self) -> Option<&SelfManagedEventSource>

The Self-Managed Apache Kafka cluster to send records.

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

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

Trait Implementations

impl Clone for CreateEventSourceMappingInput

fn clone(&self) -> CreateEventSourceMappingInput

Returns a copy 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<CreateEventSourceMappingInput> for CreateEventSourceMappingInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for CreateEventSourceMappingInput