class Aws::Lambda::Types::CreateEventSourceMappingRequest
@note When making an API call, you may pass CreateEventSourceMappingRequest
data as a hash: { event_source_arn: "Arn", function_name: "FunctionName", # required enabled: false, batch_size: 1, maximum_batching_window_in_seconds: 1, parallelization_factor: 1, starting_position: "TRIM_HORIZON", # accepts TRIM_HORIZON, LATEST, AT_TIMESTAMP starting_position_timestamp: Time.now, destination_config: { on_success: { destination: "DestinationArn", }, on_failure: { destination: "DestinationArn", }, }, maximum_record_age_in_seconds: 1, bisect_batch_on_function_error: false, maximum_retry_attempts: 1, tumbling_window_in_seconds: 1, topics: ["Topic"], queues: ["Queue"], source_access_configurations: [ { type: "BASIC_AUTH", # accepts BASIC_AUTH, VPC_SUBNET, VPC_SECURITY_GROUP, SASL_SCRAM_512_AUTH, SASL_SCRAM_256_AUTH, VIRTUAL_HOST uri: "URI", }, ], self_managed_event_source: { endpoints: { "KAFKA_BOOTSTRAP_SERVERS" => ["Endpoint"], }, }, function_response_types: ["ReportBatchItemFailures"], # accepts ReportBatchItemFailures }
@!attribute [rw] event_source_arn
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. @return [String]
@!attribute [rw] function_name
The name of the Lambda function. **Name formats** * **Function name** - `MyFunction`. * **Function ARN** - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction`. * **Version or Alias ARN** - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD`. * **Partial ARN** - `123456789012:function:MyFunction`. The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length. @return [String]
@!attribute [rw] enabled
If true, the event source mapping is active. Set to false to pause polling and invocation. @return [Boolean]
@!attribute [rw] batch_size
The maximum number of items to retrieve in a single batch. * **Amazon Kinesis** - Default 100. Max 10,000. * **Amazon DynamoDB Streams** - Default 100. Max 1,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. @return [Integer]
@!attribute [rw] maximum_batching_window_in_seconds
(Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. @return [Integer]
@!attribute [rw] parallelization_factor
(Streams only) The number of batches to process from each shard concurrently. @return [Integer]
@!attribute [rw] starting_position
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. @return [String]
@!attribute [rw] starting_position_timestamp
With `StartingPosition` set to `AT_TIMESTAMP`, the time from which to start reading. @return [Time]
@!attribute [rw] destination_config
(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records. @return [Types::DestinationConfig]
@!attribute [rw] maximum_record_age_in_seconds
(Streams only) Discard records older than the specified age. The default value is infinite (-1). @return [Integer]
@!attribute [rw] bisect_batch_on_function_error
(Streams only) If the function returns an error, split the batch in two and retry. @return [Boolean]
@!attribute [rw] maximum_retry_attempts
(Streams only) Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records will be retried until the record expires. @return [Integer]
@!attribute [rw] tumbling_window_in_seconds
(Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds. @return [Integer]
@!attribute [rw] topics
The name of the Kafka topic. @return [Array<String>]
@!attribute [rw] queues
(MQ) The name of the Amazon MQ broker destination queue to consume. @return [Array<String>]
@!attribute [rw] source_access_configurations
An array of authentication protocols or VPC components required to secure your event source. @return [Array<Types::SourceAccessConfiguration>]
@!attribute [rw] self_managed_event_source
The Self-Managed Apache Kafka cluster to send records. @return [Types::SelfManagedEventSource]
@!attribute [rw] function_response_types
(Streams only) A list of current response type enums applied to the event source mapping. @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31/CreateEventSourceMappingRequest AWS API Documentation
Constants
- SENSITIVE