The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

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');
    my $EventSourceMappingConfiguration = $lambda->CreateEventSourceMapping(
      EventSourceArn            => 'MyArn',
      FunctionName              => 'MyFunctionName',
      BatchSize                 => 1,                        # OPTIONAL
      Enabled                   => 1,                        # OPTIONAL
      StartingPosition          => 'TRIM_HORIZON',           # OPTIONAL
      StartingPositionTimestamp => '1970-01-01T01:00:00',    # OPTIONAL
    );

    # Results:
    my $BatchSize      = $EventSourceMappingConfiguration->BatchSize;
    my $EventSourceArn = $EventSourceMappingConfiguration->EventSourceArn;
    my $FunctionArn    = $EventSourceMappingConfiguration->FunctionArn;
    my $LastModified   = $EventSourceMappingConfiguration->LastModified;
    my $LastProcessingResult =
      $EventSourceMappingConfiguration->LastProcessingResult;
    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. Max 10.

Enabled => Bool

Disables the event source mapping to pause polling and invocation.

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

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.

StartingPosition => Str

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateEventSourceMapping in Paws::Lambda

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