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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-lambda/types.rb

Overview

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #batch_size ⇒ Integer

  The maximum number of items to retrieve in a single batch.

• #bisect_batch_on_function_error ⇒ Boolean

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

• #destination_config ⇒ Types::DestinationConfig

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

• #event_source_arn ⇒ String

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

• #function_arn ⇒ String

  The ARN of the Lambda function.

• #function_response_types ⇒ Array<String>

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

• #last_modified ⇒ Time

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

• #last_processing_result ⇒ String

  The result of the last AWS Lambda invocation of your Lambda function.

• #maximum_batching_window_in_seconds ⇒ Integer

  (Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds.

• #maximum_record_age_in_seconds ⇒ Integer

  (Streams) Discard records older than the specified age.

• #maximum_retry_attempts ⇒ Integer

  (Streams) Discard records after the specified number of retries.

• #parallelization_factor ⇒ Integer

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

• #queues ⇒ Array<String>

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

• #self_managed_event_source ⇒ Types::SelfManagedEventSource

  The Self-Managed Apache Kafka cluster for your event source.

• #source_access_configurations ⇒ Array<Types::SourceAccessConfiguration>

  An array of the authentication protocol, or the VPC components to secure 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 the last change to the event source mapping was made by a user, or by the Lambda service.

• #topics ⇒ Array<String>

  The name of the Kafka topic.

• #tumbling_window_in_seconds ⇒ Integer

  (Streams) The duration in seconds of a processing window.

• #uuid ⇒ String

  The identifier of the event source mapping.

Instance Attribute Details

#batch_size ⇒ Integer

The maximum number of items to retrieve in a single batch.

Returns:

• (Integer)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#bisect_batch_on_function_error ⇒ Boolean

(Streams) 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 1687

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#destination_config ⇒ Types::DestinationConfig

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

Returns:

• (Types::DestinationConfig)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  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 1687

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#function_arn ⇒ String

The ARN of the Lambda function.

Returns:

• (String)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#function_response_types ⇒ Array<String>

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

Returns:

• (Array<String>)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

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

Returns:

• (Time)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#last_processing_result ⇒ String

The result of the last AWS Lambda invocation of your Lambda function.

Returns:

• (String)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_batching_window_in_seconds ⇒ Integer

(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.

Returns:

• (Integer)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_record_age_in_seconds ⇒ Integer

(Streams) Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

Returns:

• (Integer)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_retry_attempts ⇒ Integer

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

Returns:

• (Integer)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factor ⇒ Integer

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

Returns:

• (Integer)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#queues ⇒ Array<String>

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

Returns:

• (Array<String>)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  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 1687

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#source_access_configurations ⇒ Array<Types::SourceAccessConfiguration>

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

Returns:

• (Array<Types::SourceAccessConfiguration>)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position ⇒ String

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.

Returns:

• (String)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position_timestamp ⇒ Time

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

Returns:

• (Time)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  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 1687

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#state_transition_reason ⇒ String

Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.

Returns:

• (String)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  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 1687

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#tumbling_window_in_seconds ⇒ Integer

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

Returns:

• (Integer)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#uuid ⇒ String

The identifier of the event source mapping.

Returns:

• (String)

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

class EventSourceMappingConfiguration < Struct.new(
  :uuid,
  :starting_position,
  :starting_position_timestamp,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :event_source_arn,
  :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)
  SENSITIVE = []
  include Aws::Structure
end