Home

Awesome

Actions Status

NAME

AWS::Lambda - Perl support for AWS Lambda Custom Runtime.

SYNOPSIS

Save the following Perl script as handler.pl.

sub handle {
    my ($payload, $context) = @_;
    return $payload;
}
1;

and then, zip the script.

$ zip handler.zip handler.pl

Finally, create new function using awscli.

$ aws --region "$REGION" --profile "$PROFILE" lambda create-function \
    --function-name "hello-perl" \
    --zip-file "fileb://handler.zip" \
    --handler "handler.handle" \
    --runtime provided.al2023 \
    --role arn:aws:iam::xxxxxxxxxxxx:role/service-role/lambda-custom-runtime-perl-role \
    --layers "arn:aws:lambda:$REGION:445285296882:layer:perl-5-38-runtime-al2023-x86_64:1"

It also supports response streaming.

sub handle {
    my ($payload, $context) = @_;
    return sub {
        my $responder = shift;
        my $writer = $responder->('application/json');
        $writer->write('{"foo": "bar"}');
        $writer->close;
    };
}

DESCRIPTION

This package makes it easy to run AWS Lambda Functions written in Perl.

Use Pre-built Public Lambda Layers

  1. Login to your AWS Account and go to the Lambda Console.
  2. Create a new function and give it a name and an IAM Role.
  3. For the "Runtime" selection, select Provide your own bootstrap on Amazon Linux 2.
  4. In the "Designer" section of your function dashboard, select the Layers box.
  5. Scroll down to the "Layers" section and click Add a layer.
  6. Select the Provide a layer version ARN option, then copy/paste the Layer ARN for your region.
  7. Click the Add button.
  8. Click Save in the upper right.
  9. Upload your code and start using Perl in AWS Lambda!

You can get the layer ARN in your script by using get_layer_info.

use AWS::Lambda;
my $info = AWS::Lambda::get_layer_info_al2023(
    "5.38",      # Perl Version
    "us-east-1", # Region
    "x86_64",    # Architecture ("x86_64" or "arm64", optional, the default is "x86_64")
);
say $info->{runtime_arn};     # arn:aws:lambda:us-east-1:445285296882:layer:perl-5-38-runtime-al2023-x86_64:1
say $info->{runtime_version}; # 1
say $info->{paws_arn}         # arn:aws:lambda:us-east-1:445285296882:layer:perl-5-38-paws-al2023-x86_64:1
say $info->{paws_version}     # 1,

Or, you can use following one-liner.

perl -MAWS::Lambda -e 'AWS::Lambda::print_runtime_arn_al2023("5.38", "us-east-1")'
perl -MAWS::Lambda -e 'AWS::Lambda::print_paws_arn_al2023("5.38", "us-east-1")'

The list of all layer ARNs is available on AWS::Lambda::AL2023.

Use Pre-built Zip Archives

  1. Login to your AWS Account and go to the Lambda Console.
  2. Create a new layer and give it a name.
  3. For the "Code entry type" selection, select Upload a file from Amazon S3.
  4. In the "License" section, input https://github.com/shogo82148/p5-aws-lambda/blob/main/LICENSE.
  5. Click Create button.
  6. Use the layer created. For detail, see Use Prebuilt Public Lambda Layer section.

URLs for Zip archives are here.

https://shogo82148-lambda-perl-runtime-$REGION.s3.amazonaws.com/perl-$VERSION-runtime-al2023-$ARCHITECTURE.zip

Use Pre-built Docker Images

Prebuilt Docker Images based on https://gallery.ecr.aws/lambda/provided are available. You can pull from https://gallery.ecr.aws/shogo82148/p5-aws-lambda or https://hub.docker.com/r/shogo82148/p5-aws-lambda, build your custom images and deploy them to AWS Lambda.

Here is an example of Dockerfile.

FROM shogo82148/p5-aws-lambda:base-5.38.al2023
# or if you want to use ECR Public.
# FROM public.ecr.aws/shogo82148/p5-aws-lambda:base-5.38.al2023
COPY handler.pl /var/task/
CMD [ "handler.handle" ]

Build the hello-perl container image locally:

$ docker build -t hello-perl .

To check if this is working, start the container image locally using the Lambda Runtime Interface Emulator:

$ docker run -p 9000:8080 hello-perl:latest

Now, you can test a function invocation with cURL.

$ curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'

To upload the container image, you need to create a new ECR repository in your account and tag the local image to push it to ECR.

$ aws ecr create-repository --repository-name hello-perl --image-scanning-configuration scanOnPush=true
$ docker tag hello-perl:latest 123412341234.dkr.ecr.sa-east-1.amazonaws.com/hello-perl:latest
$ aws ecr get-login-password | docker login --username AWS --password-stdin 123412341234.dkr.ecr.sa-east-1.amazonaws.com
$ docker push 123412341234.dkr.ecr.sa-east-1.amazonaws.com/hello-perl:latest

Finally, create new function using awscli.

$ aws --region "$REGION" --profile "$PROFILE" lambda create-function \
    --function-name "hello-perl" \
    --code ImageUri=123412341234.dkr.ecr.sa-east-1.amazonaws.com/hello-perl:latest \
    --handler "handler.handle" \
    --runtime provided.al2023 \
    --role arn:aws:iam::xxxxxxxxxxxx:role/service-role/lambda-custom-runtime-perl-role

Run in Local using Docker

Prebuilt Docker Images based on https://hub.docker.com/r/lambci/lambda/ are available. You can pull from https://gallery.ecr.aws/shogo82148/p5-aws-lambda or https://hub.docker.com/r/shogo82148/p5-aws-lambda, and build zip archives to deploy.

# Install the dependency.
docker run --rm -v $(PWD):/var/task shogo82148/p5-aws-lambda:build-5.38.al2023 \
    cpanm --notest --local-lib extlocal --no-man-pages --installdeps .

# run an event.
docker run --rm -v $(PWD):/var/task shogo82148/p5-aws-lambda:5.38.al2023 \
    handler.handle '{"some":"event"}'

Pre-installed modules

The following modules are pre-installed for convenience.

Paws is optional. See the "Paws SUPPORT" section.

AWS X-Ray SUPPORT

AWS X-Ray is a service that collects data about requests that your application serves. You can trace AWS Lambda requests and sends segment data with pre-install module AWS::XRay.

use utf8;
use warnings;
use strict;
use AWS::XRay qw/ capture /;

sub handle {
    my ($payload, $context) = @_;
    capture "myApp" => sub {
        capture "nested" => sub {
            # do something ...
        };
    };
    capture "another" => sub {
        # do something ...
    };
    return;
}

1;

Paws SUPPORT

If you want to call AWS API from your Lambda function, you can use a pre-built Lambda Layer for Paws - A Perl SDK for AWS (Amazon Web Services) APIs.

Use Prebuilt Public Lambda Layers

Add the perl-runtime layer and the perl-paws layer into your lambda function.

aws --region "$REGION" --profile "$PROFILE" lambda create-function \
    --function-name "hello-perl" \
    --zip-file "fileb://handler.zip" \
    --handler "handler.handle" \
    --runtime provided.al2023 \
    --role arn:aws:iam::xxxxxxxxxxxx:role/service-role/lambda-custom-runtime-perl-role \
    --layers \
        "arn:aws:lambda:$REGION:445285296882:layer:perl-5-38-runtime-al2023-x86_64:5" \
        "arn:aws:lambda:$REGION:445285296882:layer:perl-5-38-paws-al2023-x86_64:4"

Now, you can use Paws to call AWS API from your Lambda function.

use Paws;
my $obj = Paws->service('...');
my $res = $obj->MethodCall(Arg1 => $val1, Arg2 => $val2);
print $res->AttributeFromResult;

The list of all layer ARNs is available on AWS::Lambda::AL2023.

URLs for Zip archive are:

https://shogo82148-lambda-perl-runtime-$REGION.s3.amazonaws.com/perl-$VERSION-paws-al2-$ARCHITECTURE.zip

Use Prebuilt Docker Images for Paws

use the base-$VERSION-paws.al2023 tag on https://gallery.ecr.aws/shogo82148/p5-aws-lambda or https://hub.docker.com/r/shogo82148/p5-aws-lambda.

FROM shogo82148/p5-aws-lambda:base-5.38-paws.al2023
# or if you want to use ECR Public.
# FROM public.ecr.aws/shogo82148/p5-aws-lambda:base-5.38-paws.al2023
COPY handler.pl /var/task/
CMD [ "handler.handle" ]

Run in Local using Docker for Paws

use the build-$VERSION-paws.al2023 and $VERSION-paws.al2023 tag on https://gallery.ecr.aws/shogo82148/p5-aws-lambda or https://hub.docker.com/r/shogo82148/p5-aws-lambda.

# Install the dependency.
docker run --rm -v $(PWD):/var/task shogo82148/p5-aws-lambda:build-5.38-paws.al2023 \
    cpanm --notest --local-lib extlocal --no-man-pages --installdeps .

# run an event.
docker run --rm -v $(PWD):/var/task shogo82148/p5-aws-lambda:5.38-paws.al2023 \
    handler.handle '{"some":"event"}'

CREATE MODULE LAYER

To create custom module layer such as the Paws Layer, install the modules into /opt/lib/perl5/site_perl in the layer.

# Create Some::Module Layer
docker run --rm \
    -v $(PWD):/var/task \
    -v $(PATH_TO_LAYER_DIR)/lib/perl5/site_perl:/opt/lib/perl5/site_perl \
    shogo82148/p5-aws-lambda:build-5.38.al2023 \
    cpanm --notest --no-man-pages Some::Module
cd $(PATH_TO_LAYER_DIR) && zip -9 -r $(PATH_TO_DIST)/some-module.zip .

MAINTENANCE AND SUPPORT

Supported Perl versions are the same as those officially supported by the Perl community (perlpolicy). It means that we support the two most recent stable release series.

LEGACY CUSTOM RUNTIME ON AMAZON LINUX

We also provide the layers for legacy custom runtime as known as "provided". These layers are only for backward compatibility. We recommend to migrate to Amazon Linux 2. These layers are NO LONGER MAINTAINED and WILL NOT RECEIVE ANY UPDATES.

The list of all layer ARNs is availeble on AWS::Lambda::AL.

Pre-built Zip Archives for Amazon Linux

URLs of zip archives are here:

https://shogo82148-lambda-perl-runtime-$REGION.s3.amazonaws.com/perl-$VERSION-runtime.zip

And Paws:

https://shogo82148-lambda-perl-runtime-$REGION.s3.amazonaws.com/perl-$VERSION-paws.zip

LEGACY CUSTOM RUNTIME ON AMAZON LINUX 2

Previously, we provided the layers that named without CPU architectures. These layers are compatible with x86_64 and only for backward compatibility. We recommend to specify the CPU architecture. These layers are NO LONGER MAINTAINED and WILL NOT RECEIVE ANY UPDATES.

Pre-built Legacy Public Lambda Layers for Amazon Linux 2

The list of all layer ARN is available on AWS::Lambda::AL2.

Pre-built Legacy Zip Archives for Amazon Linux 2 x86_64

URLs of zip archives are here:

https://shogo82148-lambda-perl-runtime-$REGION.s3.amazonaws.com/perl-$VERSION-runtime-al2.zip

And Paws:

https://shogo82148-lambda-perl-runtime-$REGION.s3.amazonaws.com/perl-$VERSION-paws-al2.zip

SEE ALSO

LICENSE

The MIT License (MIT)

Copyright (C) ICHINOSE Shogo

AUTHOR

ICHINOSE Shogo