Struct aws_sdk_lambda::operation::update_event_source_mapping::UpdateEventSourceMappingOutput
source · #[non_exhaustive]pub struct UpdateEventSourceMappingOutput {Show 27 fields
pub uuid: Option<String>,
pub starting_position: Option<EventSourcePosition>,
pub starting_position_timestamp: Option<DateTime>,
pub batch_size: Option<i32>,
pub maximum_batching_window_in_seconds: Option<i32>,
pub parallelization_factor: Option<i32>,
pub event_source_arn: Option<String>,
pub filter_criteria: Option<FilterCriteria>,
pub function_arn: Option<String>,
pub last_modified: Option<DateTime>,
pub last_processing_result: Option<String>,
pub state: Option<String>,
pub state_transition_reason: Option<String>,
pub destination_config: Option<DestinationConfig>,
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 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 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>,
/* private fields */
}
Expand description
A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping
.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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.
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.
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).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set MaximumBatchingWindowInSeconds
to at least 1.
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.
parallelization_factor: Option<i32>
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
event_source_arn: Option<String>
The Amazon Resource Name (ARN) of the event source.
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.
function_arn: Option<String>
The ARN of the Lambda function.
last_modified: Option<DateTime>
The date that the event source mapping was last updated or that its state changed.
last_processing_result: Option<String>
The result of the last Lambda invocation of your function.
state: Option<String>
The state of the event source mapping. It can be one of the following: Creating
, Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
state_transition_reason: Option<String>
Indicates whether a user or Lambda made the last change to the event source mapping.
destination_config: Option<DestinationConfig>
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
topics: Option<Vec<String>>
The name of the Kafka topic.
queues: Option<Vec<String>>
(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
source_access_configurations: Option<Vec<SourceAccessConfiguration>>
An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
self_managed_event_source: Option<SelfManagedEventSource>
The self-managed Apache Kafka cluster for your event source.
maximum_record_age_in_seconds: Option<i32>
(Kinesis and DynamoDB Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
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. The default value is false.
maximum_retry_attempts: Option<i32>
(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the 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.
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.
Implementations§
source§impl UpdateEventSourceMappingOutput
impl UpdateEventSourceMappingOutput
sourcepub fn starting_position(&self) -> Option<&EventSourcePosition>
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.
sourcepub fn starting_position_timestamp(&self) -> Option<&DateTime>
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.
sourcepub fn batch_size(&self) -> Option<i32>
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).
Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.
Related setting: When you set BatchSize
to a value greater than 10, you must set MaximumBatchingWindowInSeconds
to at least 1.
sourcepub fn maximum_batching_window_in_seconds(&self) -> Option<i32>
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.
sourcepub fn parallelization_factor(&self) -> Option<i32>
pub fn parallelization_factor(&self) -> Option<i32>
(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard. The default value is 1.
sourcepub fn event_source_arn(&self) -> Option<&str>
pub fn event_source_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the event source.
sourcepub fn filter_criteria(&self) -> Option<&FilterCriteria>
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.
sourcepub fn function_arn(&self) -> Option<&str>
pub fn function_arn(&self) -> Option<&str>
The ARN of the Lambda function.
sourcepub fn last_modified(&self) -> Option<&DateTime>
pub fn last_modified(&self) -> Option<&DateTime>
The date that the event source mapping was last updated or that its state changed.
sourcepub fn last_processing_result(&self) -> Option<&str>
pub fn last_processing_result(&self) -> Option<&str>
The result of the last Lambda invocation of your function.
sourcepub fn state(&self) -> Option<&str>
pub fn state(&self) -> Option<&str>
The state of the event source mapping. It can be one of the following: Creating
, Enabling
, Enabled
, Disabling
, Disabled
, Updating
, or Deleting
.
sourcepub fn state_transition_reason(&self) -> Option<&str>
pub fn state_transition_reason(&self) -> Option<&str>
Indicates whether a user or Lambda made the last change to the event source mapping.
sourcepub fn destination_config(&self) -> Option<&DestinationConfig>
pub fn destination_config(&self) -> Option<&DestinationConfig>
(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka event sources only) A configuration object that specifies the destination of an event after Lambda processes it.
sourcepub fn topics(&self) -> &[String]
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()
.
sourcepub fn queues(&self) -> &[String]
pub fn queues(&self) -> &[String]
(Amazon 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()
.
sourcepub fn source_access_configurations(&self) -> &[SourceAccessConfiguration]
pub fn source_access_configurations(&self) -> &[SourceAccessConfiguration]
An array of the authentication protocol, VPC components, or virtual host to secure and define 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()
.
sourcepub fn self_managed_event_source(&self) -> Option<&SelfManagedEventSource>
pub fn self_managed_event_source(&self) -> Option<&SelfManagedEventSource>
The self-managed Apache Kafka cluster for your event source.
sourcepub fn maximum_record_age_in_seconds(&self) -> Option<i32>
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 -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.
The minimum valid value for maximum record age is 60s. Although values less than 60 and greater than -1 fall within the parameter's absolute range, they are not allowed
sourcepub fn bisect_batch_on_function_error(&self) -> Option<bool>
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. The default value is false.
sourcepub fn maximum_retry_attempts(&self) -> Option<i32>
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 -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.
sourcepub fn tumbling_window_in_seconds(&self) -> Option<i32>
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.
sourcepub fn function_response_types(&self) -> &[FunctionResponseType]
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()
.
sourcepub fn amazon_managed_kafka_event_source_config(
&self
) -> Option<&AmazonManagedKafkaEventSourceConfig>
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.
sourcepub fn self_managed_kafka_event_source_config(
&self
) -> Option<&SelfManagedKafkaEventSourceConfig>
pub fn self_managed_kafka_event_source_config( &self ) -> Option<&SelfManagedKafkaEventSourceConfig>
Specific configuration settings for a self-managed Apache Kafka event source.
sourcepub fn scaling_config(&self) -> Option<&ScalingConfig>
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.
sourcepub fn document_db_event_source_config(
&self
) -> Option<&DocumentDbEventSourceConfig>
pub fn document_db_event_source_config( &self ) -> Option<&DocumentDbEventSourceConfig>
Specific configuration settings for a DocumentDB event source.
source§impl UpdateEventSourceMappingOutput
impl UpdateEventSourceMappingOutput
sourcepub fn builder() -> UpdateEventSourceMappingOutputBuilder
pub fn builder() -> UpdateEventSourceMappingOutputBuilder
Creates a new builder-style object to manufacture UpdateEventSourceMappingOutput
.
Trait Implementations§
source§impl Clone for UpdateEventSourceMappingOutput
impl Clone for UpdateEventSourceMappingOutput
source§fn clone(&self) -> UpdateEventSourceMappingOutput
fn clone(&self) -> UpdateEventSourceMappingOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for UpdateEventSourceMappingOutput
impl PartialEq for UpdateEventSourceMappingOutput
source§fn eq(&self, other: &UpdateEventSourceMappingOutput) -> bool
fn eq(&self, other: &UpdateEventSourceMappingOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for UpdateEventSourceMappingOutput
impl RequestId for UpdateEventSourceMappingOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.