Class: Aws::Lambda::Types::EventSourceMappingConfiguration

Inherits:

Struct

Object
Struct
Aws::Lambda::Types::EventSourceMappingConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lambda/types.rb

Overview

A mapping between an Amazon Web Services resource and a Lambda function. For details, see CreateEventSourceMapping.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#amazon_managed_kafka_event_source_config ⇒ Types::AmazonManagedKafkaEventSourceConfig

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

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function.
#bisect_batch_on_function_error ⇒ Boolean

(Kinesis and DynamoDB Streams only) If the function returns an error, split the batch in two and retry.
#destination_config ⇒ Types::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.
#document_db_event_source_config ⇒ Types::DocumentDBEventSourceConfig

Specific configuration settings for a DocumentDB event source.
#event_source_arn ⇒ String

The Amazon Resource Name (ARN) of the event source.
#event_source_mapping_arn ⇒ String

The Amazon Resource Name (ARN) of the event source mapping.
#filter_criteria ⇒ Types::FilterCriteria

An object that defines the filter criteria that determine whether Lambda should process an event.
#filter_criteria_error ⇒ Types::FilterCriteriaError

An object that contains details about an error related to filter criteria encryption.
#function_arn ⇒ String

The ARN of the Lambda function.
#function_response_types ⇒ Array<String>

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

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function’s [filter criteria].
#last_modified ⇒ Time

The date that the event source mapping was last updated or that its state changed.
#last_processing_result ⇒ String

The result of the last Lambda invocation of your function.
#maximum_batching_window_in_seconds ⇒ Integer

The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.
#maximum_record_age_in_seconds ⇒ Integer

(Kinesis and DynamoDB Streams only) Discard records older than the specified age.
#maximum_retry_attempts ⇒ Integer

(Kinesis and DynamoDB Streams only) Discard records after the specified number of retries.
#parallelization_factor ⇒ Integer

(Kinesis and DynamoDB Streams only) The number of batches to process concurrently from each shard.
#queues ⇒ Array<String>

(Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
#scaling_config ⇒ Types::ScalingConfig

(Amazon SQS only) The scaling configuration for the event source.
#self_managed_event_source ⇒ Types::SelfManagedEventSource

The self-managed Apache Kafka cluster for your event source.
#self_managed_kafka_event_source_config ⇒ Types::SelfManagedKafkaEventSourceConfig

Specific configuration settings for a self-managed Apache Kafka event source.
#source_access_configurations ⇒ Array<Types::SourceAccessConfiguration>

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
#starting_position ⇒ String

The position in a stream from which to start reading.
#starting_position_timestamp ⇒ Time

With ‘StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading.
#state ⇒ String

The state of the event source mapping.
#state_transition_reason ⇒ String

Indicates whether a user or Lambda made the last change to the event source mapping.
#topics ⇒ Array<String>

The name of the Kafka topic.
#tumbling_window_in_seconds ⇒ Integer

(Kinesis and DynamoDB Streams only) The duration in seconds of a processing window for DynamoDB and Kinesis Streams event sources.
#uuid ⇒ String

The identifier of the event source mapping.

Instance Attribute Details

#amazon_managed_kafka_event_source_config ⇒ `Types::AmazonManagedKafkaEventSourceConfig`

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

Returns:

(Types::AmazonManagedKafkaEventSourceConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#batch_size ⇒ `Integer`

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.

Returns:

(Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#bisect_batch_on_function_error ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destination_config ⇒ `Types::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.

Returns:

(Types::DestinationConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#document_db_event_source_config ⇒ `Types::DocumentDBEventSourceConfig`

Specific configuration settings for a DocumentDB event source.

Returns:

(Types::DocumentDBEventSourceConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_arn ⇒ `String`

The Amazon Resource Name (ARN) of the event source.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_mapping_arn ⇒ `String`

The Amazon Resource Name (ARN) of the event source mapping.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#filter_criteria ⇒ `Types::FilterCriteria`

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

If filter criteria is encrypted, this field shows up as ‘null` in the response of ListEventSourceMapping API calls. You can view this field in plaintext in the response of GetEventSourceMapping and DeleteEventSourceMapping calls if you have `kms:Decrypt` permissions for the correct KMS key.

[1]: docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html

Returns:

(Types::FilterCriteria)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#filter_criteria_error ⇒ `Types::FilterCriteriaError`

An object that contains details about an error related to filter criteria encryption.

Returns:

(Types::FilterCriteriaError)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#function_arn ⇒ `String`

The ARN of the Lambda function.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#function_response_types ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ `String`

The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function’s [filter criteria].

[1]: docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-basics

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ `Time`

The date that the event source mapping was last updated or that its state changed.

Returns:

(Time)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_processing_result ⇒ `String`

The result of the last Lambda invocation of your function.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_batching_window_in_seconds ⇒ `Integer`

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.

Returns:

(Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_record_age_in_seconds ⇒ `Integer`

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

<note markdown=“1”> 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

</note>

Returns:

(Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_retry_attempts ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factor ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#queues ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_config ⇒ `Types::ScalingConfig`

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

[1]: docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency

Returns:

(Types::ScalingConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_event_source ⇒ `Types::SelfManagedEventSource`

The self-managed Apache Kafka cluster for your event source.

Returns:

(Types::SelfManagedEventSource)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_kafka_event_source_config ⇒ `Types::SelfManagedKafkaEventSourceConfig`

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

Returns:

(Types::SelfManagedKafkaEventSourceConfig)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source_access_configurations ⇒ `Array<Types::SourceAccessConfiguration>`

An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

Returns:

(Array<Types::SourceAccessConfiguration>)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position_timestamp ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `String`

The state of the event source mapping. It can be one of the following: ‘Creating`, `Enabling`, `Enabled`, `Disabling`, `Disabled`, `Updating`, or `Deleting`.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state_transition_reason ⇒ `String`

Indicates whether a user or Lambda made the last change to the event source mapping.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#topics ⇒ `Array<String>`

The name of the Kafka topic.

Returns:

(Array<String>)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tumbling_window_in_seconds ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

#uuid ⇒ `String`

The identifier of the event source mapping.

Returns:

(String)

# File 'lib/aws-sdk-lambda/types.rb', line 2036

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :filter_criteria,
  :function_arn,
  :last_modified,
  :last_processing_result,
  :state,
  :state_transition_reason,
  :destination_config,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tumbling_window_in_seconds,
  :function_response_types,
  :amazon_managed_kafka_event_source_config,
  :self_managed_kafka_event_source_config,
  :scaling_config,
  :document_db_event_source_config,
  :kms_key_arn,
  :filter_criteria_error,
  :event_source_mapping_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Lambda::Types::EventSourceMappingConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#amazon_managed_kafka_event_source_config ⇒ Types::AmazonManagedKafkaEventSourceConfig

#batch_size ⇒ Integer

#bisect_batch_on_function_error ⇒ Boolean

#destination_config ⇒ Types::DestinationConfig

#document_db_event_source_config ⇒ Types::DocumentDBEventSourceConfig

#event_source_arn ⇒ String

#event_source_mapping_arn ⇒ String

#filter_criteria ⇒ Types::FilterCriteria

#filter_criteria_error ⇒ Types::FilterCriteriaError

#function_arn ⇒ String

#function_response_types ⇒ Array<String>

#kms_key_arn ⇒ String

#last_modified ⇒ Time

#last_processing_result ⇒ String

#maximum_batching_window_in_seconds ⇒ Integer

#maximum_record_age_in_seconds ⇒ Integer

#maximum_retry_attempts ⇒ Integer

#parallelization_factor ⇒ Integer

#queues ⇒ Array<String>

#scaling_config ⇒ Types::ScalingConfig

#self_managed_event_source ⇒ Types::SelfManagedEventSource

#self_managed_kafka_event_source_config ⇒ Types::SelfManagedKafkaEventSourceConfig

#source_access_configurations ⇒ Array<Types::SourceAccessConfiguration>

#starting_position ⇒ String

#starting_position_timestamp ⇒ Time

#state ⇒ String

#state_transition_reason ⇒ String

#topics ⇒ Array<String>

#tumbling_window_in_seconds ⇒ Integer

#uuid ⇒ String

#amazon_managed_kafka_event_source_config ⇒ `Types::AmazonManagedKafkaEventSourceConfig`

#batch_size ⇒ `Integer`

#bisect_batch_on_function_error ⇒ `Boolean`

#destination_config ⇒ `Types::DestinationConfig`

#document_db_event_source_config ⇒ `Types::DocumentDBEventSourceConfig`

#event_source_arn ⇒ `String`

#event_source_mapping_arn ⇒ `String`

#filter_criteria ⇒ `Types::FilterCriteria`

#filter_criteria_error ⇒ `Types::FilterCriteriaError`

#function_arn ⇒ `String`

#function_response_types ⇒ `Array<String>`

#kms_key_arn ⇒ `String`

#last_modified ⇒ `Time`

#last_processing_result ⇒ `String`

#maximum_batching_window_in_seconds ⇒ `Integer`

#maximum_record_age_in_seconds ⇒ `Integer`

#maximum_retry_attempts ⇒ `Integer`

#parallelization_factor ⇒ `Integer`

#queues ⇒ `Array<String>`

#scaling_config ⇒ `Types::ScalingConfig`

#self_managed_event_source ⇒ `Types::SelfManagedEventSource`

#self_managed_kafka_event_source_config ⇒ `Types::SelfManagedKafkaEventSourceConfig`

#source_access_configurations ⇒ `Array<Types::SourceAccessConfiguration>`

#starting_position ⇒ `String`

#starting_position_timestamp ⇒ `Time`

#state ⇒ `String`

#state_transition_reason ⇒ `String`

#topics ⇒ `Array<String>`

#tumbling_window_in_seconds ⇒ `Integer`

#uuid ⇒ `String`