class Amazonite::Lambda::CreateEventSourceMappingRequest

Included Modules

Defined in:

lambda/create_event_source_mapping_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(function_name : String, event_source_arn : String | Nil = nil, enabled : Bool | Nil = nil, batch_size : Int32 | Nil = nil, filter_criteria : FilterCriteria | Nil = nil, kms_key_arn : String | Nil = nil, metrics_config : EventSourceMappingMetricsConfig | Nil = nil, logging_config : EventSourceMappingLoggingConfig | Nil = nil, scaling_config : ScalingConfig | Nil = nil, maximum_batching_window_in_seconds : Int32 | Nil = nil, parallelization_factor : Int32 | Nil = nil, starting_position : EventSourcePosition | Nil = nil, starting_position_timestamp : Time | Nil = nil, destination_config : DestinationConfig | Nil = nil, maximum_record_age_in_seconds : Int32 | Nil = nil, bisect_batch_on_function_error : Bool | Nil = nil, maximum_retry_attempts : Int32 | Nil = nil, tags : Hash(String, String) | Nil = nil, tumbling_window_in_seconds : Int32 | Nil = nil, topics : Array(String) | Nil = nil, queues : Array(String) | Nil = nil, source_access_configurations : Array(SourceAccessConfiguration) | Nil = nil, self_managed_event_source : SelfManagedEventSource | Nil = nil, function_response_types : Array(FunctionResponseType) | Nil = nil, amazon_managed_kafka_event_source_config : AmazonManagedKafkaEventSourceConfig | Nil = nil, self_managed_kafka_event_source_config : SelfManagedKafkaEventSourceConfig | Nil = nil, document_db_event_source_config : DocumentDBEventSourceConfig | Nil = nil, provisioned_poller_config : ProvisionedPollerConfig | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def amazon_managed_kafka_event_source_config : AmazonManagedKafkaEventSourceConfig | Nil #

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


[View source]
def amazon_managed_kafka_event_source_config=(amazon_managed_kafka_event_source_config : AmazonManagedKafkaEventSourceConfig | Nil) #

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


[View source]
def batch_size : Int32 | Nil #

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.


[View source]
def batch_size=(batch_size : Int32 | Nil) #

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.


[View source]
def bisect_batch_on_function_error : Bool | Nil #

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.


[View source]
def bisect_batch_on_function_error=(bisect_batch_on_function_error : Bool | Nil) #

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) If the function returns an error, split the batch in two and retry.


[View source]
def destination_config : DestinationConfig | Nil #

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


[View source]
def destination_config=(destination_config : DestinationConfig | Nil) #

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


[View source]
def document_db_event_source_config : DocumentDBEventSourceConfig | Nil #

Specific configuration settings for a DocumentDB event source.


[View source]
def document_db_event_source_config=(document_db_event_source_config : DocumentDBEventSourceConfig | Nil) #

Specific configuration settings for a DocumentDB event source.


[View source]
def enabled : Bool | Nil #

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

Default: True


[View source]
def enabled=(enabled : Bool | Nil) #

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

Default: True


[View source]
def event_source_arn : String | Nil #

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.


[View source]
def event_source_arn=(event_source_arn : String | Nil) #

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.


[View source]
def filter_criteria : FilterCriteria | Nil #

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


[View source]
def filter_criteria=(filter_criteria : FilterCriteria | Nil) #

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


[View source]
def 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.


[View source]
def function_name=(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.


[View source]
def function_response_types : Array(FunctionResponseType) | Nil #

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.


[View source]
def function_response_types=(function_response_types : Array(FunctionResponseType) | Nil) #

(Kinesis, DynamoDB Streams, Amazon MSK, self-managed Apache Kafka, and Amazon SQS) A list of current response type enums applied to the event source mapping.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def kms_key_arn : String | Nil #

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.


[View source]
def kms_key_arn=(kms_key_arn : String | Nil) #

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.


[View source]
def logging_config : EventSourceMappingLoggingConfig | Nil #

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.


[View source]
def logging_config=(logging_config : EventSourceMappingLoggingConfig | Nil) #

(Amazon MSK, and self-managed Apache Kafka only) The logging configuration for your event source. For more information, see Event source mapping logging.


[View source]
def maximum_batching_window_in_seconds : Int32 | Nil #

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.


[View source]
def maximum_batching_window_in_seconds=(maximum_batching_window_in_seconds : Int32 | Nil) #

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.


[View source]
def maximum_record_age_in_seconds : Int32 | Nil #

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).


[View source]
def maximum_record_age_in_seconds=(maximum_record_age_in_seconds : Int32 | Nil) #

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) Discard records older than the specified age. The default value is infinite (-1).


[View source]
def maximum_retry_attempts : Int32 | Nil #

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) 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.


[View source]
def maximum_retry_attempts=(maximum_retry_attempts : Int32 | Nil) #

(Kinesis, DynamoDB Streams, Amazon MSK, and self-managed Apache Kafka) 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.


[View source]
def metrics_config : EventSourceMappingMetricsConfig | Nil #

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


[View source]
def metrics_config=(metrics_config : EventSourceMappingMetricsConfig | Nil) #

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


[View source]
def parallelization_factor : Int32 | Nil #

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


[View source]
def parallelization_factor=(parallelization_factor : Int32 | Nil) #

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


[View source]
def provisioned_poller_config : ProvisionedPollerConfig | Nil #

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.


[View source]
def provisioned_poller_config=(provisioned_poller_config : ProvisionedPollerConfig | Nil) #

(Amazon SQS, Amazon MSK, and self-managed Apache Kafka only) The provisioned mode configuration for the event source. For more information, see provisioned mode.


[View source]
def queues : Array(String) | Nil #

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


[View source]
def queues=(queues : Array(String) | Nil) #

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


[View source]
def scaling_config : ScalingConfig | Nil #

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


[View source]
def scaling_config=(scaling_config : ScalingConfig | Nil) #

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


[View source]
def self_managed_event_source : SelfManagedEventSource | Nil #

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


[View source]
def self_managed_event_source=(self_managed_event_source : SelfManagedEventSource | Nil) #

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


[View source]
def self_managed_kafka_event_source_config : SelfManagedKafkaEventSourceConfig | Nil #

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


[View source]
def self_managed_kafka_event_source_config=(self_managed_kafka_event_source_config : SelfManagedKafkaEventSourceConfig | Nil) #

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


[View source]
def source_access_configurations : Array(SourceAccessConfiguration) | Nil #

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


[View source]
def source_access_configurations=(source_access_configurations : Array(SourceAccessConfiguration) | Nil) #

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


[View source]
def starting_position : EventSourcePosition | Nil #

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.


[View source]
def starting_position=(starting_position : EventSourcePosition | Nil) #

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.


[View source]
def starting_position_timestamp : Time | Nil #

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


[View source]
def starting_position_timestamp=(starting_position_timestamp : Time | Nil) #

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


[View source]
def tags : Hash(String, String) | Nil #

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


[View source]
def tags=(tags : Hash(String, String) | Nil) #

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


[View source]
def topics : Array(String) | Nil #

The name of the Kafka topic.


[View source]
def topics=(topics : Array(String) | Nil) #

The name of the Kafka topic.


[View source]
def tumbling_window_in_seconds : Int32 | Nil #

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


[View source]
def tumbling_window_in_seconds=(tumbling_window_in_seconds : Int32 | Nil) #

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


[View source]
def validate! : Nil #

[View source]