NAME

Paws::Lambda::CreateEventSourceMapping - Arguments for method CreateEventSourceMapping on Paws::Lambda

DESCRIPTION

This class represents the parameters used for calling the method CreateEventSourceMapping on the AWS Lambda service. Use the attributes of this class as arguments to method CreateEventSourceMapping.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEventSourceMapping.

SYNOPSIS

    my $lambda = Paws->service('Lambda');
    # To create a mapping between an event source and an AWS Lambda function
    # The following example creates a mapping between an SQS queue and the
    # my-function Lambda function.
    my $EventSourceMappingConfiguration = $lambda->CreateEventSourceMapping(
      'BatchSize'      => 5,
      'EventSourceArn' => 'arn:aws:sqs:us-west-2:123456789012:my-queue',
      'FunctionName'   => 'my-function'
    );
    # Results:
    my $BatchSize      = $EventSourceMappingConfiguration->BatchSize;
    my $EventSourceArn = $EventSourceMappingConfiguration->EventSourceArn;
    my $FunctionArn    = $EventSourceMappingConfiguration->FunctionArn;
    my $LastModified   = $EventSourceMappingConfiguration->LastModified;
    my $State          = $EventSourceMappingConfiguration->State;
    my $StateTransitionReason =
      $EventSourceMappingConfiguration->StateTransitionReason;
    my $UUID = $EventSourceMappingConfiguration->UUID;
    # Returns a L<Paws::Lambda::EventSourceMappingConfiguration> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/lambda/CreateEventSourceMapping>

ATTRIBUTES

BatchSize => Int

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.

BisectBatchOnFunctionError => Bool

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

DestinationConfig => Paws::Lambda::DestinationConfig

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

Enabled => Bool

If true, the event source mapping is active. Set to false to pause polling and invocation.

EventSourceArn => Str

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.

REQUIRED FunctionName => Str

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.

FunctionResponseTypes => ArrayRef[Str|Undef]

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

MaximumBatchingWindowInSeconds => Int

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

MaximumRecordAgeInSeconds => Int

(Streams only) Discard records older than the specified age. The default value is infinite (-1).

MaximumRetryAttempts => Int

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

ParallelizationFactor => Int

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

Queues => ArrayRef[Str|Undef]

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

SelfManagedEventSource => Paws::Lambda::SelfManagedEventSource

The Self-Managed Apache Kafka cluster to send records.

SourceAccessConfigurations => ArrayRef[Paws::Lambda::SourceAccessConfiguration]

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

StartingPosition => Str

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.

Valid values are: "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP"

StartingPositionTimestamp => Str

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

Topics => ArrayRef[Str|Undef]

The name of the Kafka topic.

TumblingWindowInSeconds => Int

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>