Class: Aws::Lambda::Types::CreateEventSourceMappingRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lambda/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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).

  • **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.

  • DocumentDB – Default 100. Max 10,000.

Returns:

  • (Integer) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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.

Returns:

  • (Boolean) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#destination_config ⇒ Types::DestinationConfig

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Kafka only) A configuration object that specifies the destination of an event after Lambda processes it.

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#document_db_event_source_config ⇒ Types::DocumentDBEventSourceConfig

Specific configuration settings for a DocumentDB event source.

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

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

Default: True

Returns:

  • (Boolean) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#event_source_arn ⇒ String

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

  • **Amazon Kinesis** – The ARN of the data stream or a stream consumer.

  • **Amazon DynamoDB Streams** – The ARN of the stream.

  • **Amazon Simple Queue Service** – The ARN of the queue.

  • **Amazon Managed Streaming for Apache Kafka** – The ARN of the cluster or the ARN of the VPC connection (for [cross-account event source mappings]).

  • **Amazon MQ** – The ARN of the broker.

  • **Amazon DocumentDB** – The ARN of the DocumentDB change stream.

[1]: docs.aws.amazon.com/lambda/latest/dg/with-msk.html#msk-multi-vpc

Returns:

  • (String) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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].

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

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#function_name ⇒ String

The name or ARN 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.

Returns:

  • (String) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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>) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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]. By default, Lambda does not encrypt your filter criteria object. Specify this property to encrypt data using your own customer managed key.

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

Returns:

  • (String) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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 Kinesis, DynamoDB, 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 Kinesis, DynamoDB, 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) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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 infinite (-1).

Returns:

  • (Integer) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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 infinite (-1). When set to infinite (-1), failed records are retried until the record expires.

Returns:

  • (Integer) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#metrics_config ⇒ Types::EventSourceMappingMetricsConfig

The metrics configuration for your event source. For more information, see [Event source mapping metrics].

[1]: docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics-types.html#event-source-mapping-metrics

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factor ⇒ Integer

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

Returns:

  • (Integer) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_poller_config ⇒ Types::ProvisionedPollerConfig

(Amazon MSK and self-managed Apache Kafka only) The Provisioned Mode configuration for the event source. For more information, see [Provisioned Mode].

[1]: docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html#invocation-eventsourcemapping-provisioned-mode

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#queues ⇒ Array<String>

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

Returns:

  • (Array<String>) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_event_source ⇒ Types::SelfManagedEventSource

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

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#source_access_configurations ⇒ Array<Types::SourceAccessConfiguration>

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

Returns:



887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of tags to apply to the event source mapping.

Returns:

  • (Hash<String,String>) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end

#topics ⇒ Array<String>

The name of the Kafka topic.

Returns:

  • (Array<String>) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  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) 


887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-lambda/types.rb', line 887

class CreateEventSourceMappingRequest < Struct.new(
  :event_source_arn,
  :function_name,
  :enabled,
  :batch_size,
  :filter_criteria,
  :maximum_batching_window_in_seconds,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp,
  :destination_config,
  :maximum_record_age_in_seconds,
  :bisect_batch_on_function_error,
  :maximum_retry_attempts,
  :tags,
  :tumbling_window_in_seconds,
  :topics,
  :queues,
  :source_access_configurations,
  :self_managed_event_source,
  :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,
  :metrics_config,
  :provisioned_poller_config)
  SENSITIVE = []
  include Aws::Structure
end