Struct aws_sdk_lambda::input::create_event_source_mapping_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateEventSourceMappingInput.

Implementations

impl Builder

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.

Examples found in repository

src/client.rs (line 1990)

        pub fn event_source_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.event_source_arn(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2004)

        pub fn set_event_source_arn(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_event_source_arn(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2017)

        pub fn function_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.function_name(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 2033)

        pub fn set_function_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_function_name(input);
            self
        }

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

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

Default: True

Examples found in repository

src/client.rs (line 2039)

        pub fn enabled(mut self, input: bool) -> Self {
            self.inner = self.inner.enabled(input);
            self
        }

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

Examples found in repository

src/client.rs (line 2045)

        pub fn set_enabled(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_enabled(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2058)

        pub fn batch_size(mut self, input: i32) -> Self {
            self.inner = self.inner.batch_size(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2071)

        pub fn set_batch_size(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_batch_size(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2076)

        pub fn filter_criteria(mut self, input: crate::model::FilterCriteria) -> Self {
            self.inner = self.inner.filter_criteria(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2084)

        pub fn set_filter_criteria(
            mut self,
            input: std::option::Option<crate::model::FilterCriteria>,
        ) -> Self {
            self.inner = self.inner.set_filter_criteria(input);
            self
        }

pub fn maximum_batching_window_in_seconds(self, input: 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.

Examples found in repository

src/client.rs (line 2091)

        pub fn maximum_batching_window_in_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.maximum_batching_window_in_seconds(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2101)

        pub fn set_maximum_batching_window_in_seconds(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_maximum_batching_window_in_seconds(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2106)

        pub fn parallelization_factor(mut self, input: i32) -> Self {
            self.inner = self.inner.parallelization_factor(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2111)

        pub fn set_parallelization_factor(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_parallelization_factor(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2116)

        pub fn starting_position(mut self, input: crate::model::EventSourcePosition) -> Self {
            self.inner = self.inner.starting_position(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2124)

        pub fn set_starting_position(
            mut self,
            input: std::option::Option<crate::model::EventSourcePosition>,
        ) -> Self {
            self.inner = self.inner.set_starting_position(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2129)

        pub fn starting_position_timestamp(mut self, input: aws_smithy_types::DateTime) -> Self {
            self.inner = self.inner.starting_position_timestamp(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2137)

        pub fn set_starting_position_timestamp(
            mut self,
            input: std::option::Option<aws_smithy_types::DateTime>,
        ) -> Self {
            self.inner = self.inner.set_starting_position_timestamp(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2142)

        pub fn destination_config(mut self, input: crate::model::DestinationConfig) -> Self {
            self.inner = self.inner.destination_config(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2150)

        pub fn set_destination_config(
            mut self,
            input: std::option::Option<crate::model::DestinationConfig>,
        ) -> Self {
            self.inner = self.inner.set_destination_config(input);
            self
        }

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

Examples found in repository

src/client.rs (line 2155)

        pub fn maximum_record_age_in_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.maximum_record_age_in_seconds(input);
            self
        }

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

Examples found in repository

src/client.rs (line 2163)

        pub fn set_maximum_record_age_in_seconds(
            mut self,
            input: std::option::Option<i32>,
        ) -> Self {
            self.inner = self.inner.set_maximum_record_age_in_seconds(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2168)

        pub fn bisect_batch_on_function_error(mut self, input: bool) -> Self {
            self.inner = self.inner.bisect_batch_on_function_error(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2176)

        pub fn set_bisect_batch_on_function_error(
            mut self,
            input: std::option::Option<bool>,
        ) -> Self {
            self.inner = self.inner.set_bisect_batch_on_function_error(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2181)

        pub fn maximum_retry_attempts(mut self, input: i32) -> Self {
            self.inner = self.inner.maximum_retry_attempts(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2186)

        pub fn set_maximum_retry_attempts(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_maximum_retry_attempts(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2191)

        pub fn tumbling_window_in_seconds(mut self, input: i32) -> Self {
            self.inner = self.inner.tumbling_window_in_seconds(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2196)

        pub fn set_tumbling_window_in_seconds(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_tumbling_window_in_seconds(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2205)

        pub fn topics(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.topics(input.into());
            self
        }

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

The name of the Kafka topic.

Examples found in repository

src/client.rs (line 2213)

        pub fn set_topics(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_topics(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2222)

        pub fn queues(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.queues(input.into());
            self
        }

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

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

Examples found in repository

src/client.rs (line 2230)

        pub fn set_queues(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_queues(input);
            self
        }

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

Appends an item to source_access_configurations.

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.

Examples found in repository

src/client.rs (line 2242)

        pub fn source_access_configurations(
            mut self,
            input: crate::model::SourceAccessConfiguration,
        ) -> Self {
            self.inner = self.inner.source_access_configurations(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2250)

        pub fn set_source_access_configurations(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::SourceAccessConfiguration>>,
        ) -> Self {
            self.inner = self.inner.set_source_access_configurations(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2258)

        pub fn self_managed_event_source(
            mut self,
            input: crate::model::SelfManagedEventSource,
        ) -> Self {
            self.inner = self.inner.self_managed_event_source(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2266)

        pub fn set_self_managed_event_source(
            mut self,
            input: std::option::Option<crate::model::SelfManagedEventSource>,
        ) -> Self {
            self.inner = self.inner.set_self_managed_event_source(input);
            self
        }

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

Appends an item to function_response_types.

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.

Examples found in repository

src/client.rs (line 2278)

        pub fn function_response_types(
            mut self,
            input: crate::model::FunctionResponseType,
        ) -> Self {
            self.inner = self.inner.function_response_types(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2286)

        pub fn set_function_response_types(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::FunctionResponseType>>,
        ) -> Self {
            self.inner = self.inner.set_function_response_types(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2294)

        pub fn amazon_managed_kafka_event_source_config(
            mut self,
            input: crate::model::AmazonManagedKafkaEventSourceConfig,
        ) -> Self {
            self.inner = self.inner.amazon_managed_kafka_event_source_config(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2304)

        pub fn set_amazon_managed_kafka_event_source_config(
            mut self,
            input: std::option::Option<crate::model::AmazonManagedKafkaEventSourceConfig>,
        ) -> Self {
            self.inner = self
                .inner
                .set_amazon_managed_kafka_event_source_config(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 2312)

        pub fn self_managed_kafka_event_source_config(
            mut self,
            input: crate::model::SelfManagedKafkaEventSourceConfig,
        ) -> Self {
            self.inner = self.inner.self_managed_kafka_event_source_config(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 2320)

        pub fn set_self_managed_kafka_event_source_config(
            mut self,
            input: std::option::Option<crate::model::SelfManagedKafkaEventSourceConfig>,
        ) -> Self {
            self.inner = self.inner.set_self_managed_kafka_event_source_config(input);
            self
        }

pub fn build(self) -> Result<CreateEventSourceMappingInput, BuildError>

Consumes the builder and constructs a CreateEventSourceMappingInput.

Examples found in repository

src/client.rs (line 1951)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateEventSourceMapping,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateEventSourceMappingError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateEventSourceMappingOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateEventSourceMappingError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> 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 Builder