Package software.amazon.awscdk.services.lambda.python.alpha

@Stability(Experimental) package software.amazon.awscdk.services.lambda.python.alpha

Amazon Lambda Python Library

---

cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

This library provides constructs for Python Lambda functions.

To use this module, you will need to have Docker installed.

Python Function

Define a PythonFunction: 

 PythonFunction.Builder.create(this, "MyFunction")
         .entry("/path/to/my/function") // required
         .runtime(Runtime.PYTHON_3_8) // required
         .index("my_index.py") // optional, defaults to 'index.py'
         .handler("my_exported_func")
         .build();

All other properties of lambda.Function are supported, see also the AWS Lambda construct library.

Python Layer

You may create a python-based lambda layer with PythonLayerVersion. If PythonLayerVersion detects a requirements.txt or Pipfile or poetry.lock with the associated pyproject.toml at the entry path, then PythonLayerVersion will include the dependencies inline with your code in the layer.

Define a PythonLayerVersion: 

 PythonLayerVersion.Builder.create(this, "MyLayer")
         .entry("/path/to/my/layer")
         .build();

A layer can also be used as a part of a PythonFunction: 

 PythonFunction.Builder.create(this, "MyFunction")
         .entry("/path/to/my/function")
         .runtime(Runtime.PYTHON_3_8)
         .layers(List.of(
             PythonLayerVersion.Builder.create(this, "MyLayer")
                     .entry("/path/to/my/layer")
                     .build()))
         .build();

Packaging

If requirements.txt, Pipfile or poetry.lock exists at the entry path, the construct will handle installing all required modules in a Lambda compatible Docker container according to the runtime and with the Docker platform based on the target architecture of the Lambda function.

Python bundles are only recreated and published when a file in a source directory has changed. Therefore (and as a general best-practice), it is highly recommended to commit a lockfile with a list of all transitive dependencies and their exact versions. This will ensure that when any dependency version is updated, the bundle asset is recreated and uploaded.

To that end, we recommend using [pipenv] or [poetry] which have lockfile support.

Packaging is executed using the Packaging class, which:

  1. Infers the packaging type based on the files present.
  2. If it sees a Pipfile or a poetry.lock file, it exports it to a compatible requirements.txt file with credentials (if they're available in the source files or in the bundling container).
  3. Installs dependencies using pip.
  4. Copies the dependencies into an asset that is bundled for the Lambda package.

Lambda with a requirements.txt 

 .
 ├── lambda_function.py # exports a function named 'handler'
 ├── requirements.txt # has to be present at the entry path

Lambda with a Pipfile 

 .
 ├── lambda_function.py # exports a function named 'handler'
 ├── Pipfile # has to be present at the entry path
 ├── Pipfile.lock # your lock file

Lambda with a poetry.lock 

 .
 ├── lambda_function.py # exports a function named 'handler'
 ├── pyproject.toml # your poetry project definition
 ├── poetry.lock # your poetry lock file has to be present at the entry path

Excluding source files

You can exclude files from being copied using the optional bundling string array parameter assetExcludes: 

 PythonFunction.Builder.create(this, "function")
         .entry("/path/to/poetry-function")
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 // translates to `rsync --exclude='.venv'`
                 .assetExcludes(List.of(".venv"))
                 .build())
         .build();

Including hashes

You can include hashes in poetry using the optional boolean parameter poetryIncludeHashes: 

 PythonFunction.Builder.create(this, "function")
         .entry("/path/to/poetry-function")
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .poetryIncludeHashes(true)
                 .build())
         .build();

Excluding URLs

You can exclude URLs in poetry using the optional boolean parameter poetryWithoutUrls: 

 PythonFunction.Builder.create(this, "function")
         .entry("/path/to/poetry-function")
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .poetryWithoutUrls(true)
                 .build())
         .build();

Custom Bundling

Custom bundling can be performed by passing in additional build arguments that point to index URLs to private repos, or by using an entirely custom Docker images for bundling dependencies. The build args currently supported are:

  • PIP_INDEX_URL
  • PIP_EXTRA_INDEX_URL
  • HTTPS_PROXY

Additional build args for bundling that refer to PyPI indexes can be specified as: 

 String entry = "/path/to/function";
 DockerImage image = DockerImage.fromBuild(entry);
 
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .buildArgs(Map.of("PIP_INDEX_URL", "https://your.index.url/simple/", "PIP_EXTRA_INDEX_URL", "https://your.extra-index.url/simple/"))
                 .build())
         .build();

If using a custom Docker image for bundling, the dependencies are installed with pip, pipenv or poetry by using the Packaging class. A different bundling Docker image that is in the same directory as the function can be specified as: 

 String entry = "/path/to/function";
 DockerImage image = DockerImage.fromBuild(entry);
 
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder().image(image).build())
         .build();

You can set additional Docker options to configure the build environment: 

 String entry = "/path/to/function";
 
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .network("host")
                 .securityOpt("no-new-privileges")
                 .user("user:group")
                 .volumesFrom(List.of("777f7dc92da7"))
                 .volumes(List.of(DockerVolume.builder().hostPath("/host-path").containerPath("/container-path").build()))
                 .build())
         .build();

Custom Bundling with Code Artifact

To use a Code Artifact PyPI repo, the PIP_INDEX_URL for bundling the function can be customized (requires AWS CLI in the build environment): 

 import child.process.execSync.*;
 
 
 String entry = "/path/to/function";
 DockerImage image = DockerImage.fromBuild(entry);
 
 String domain = "my-domain";
 String domainOwner = "111122223333";
 String repoName = "my_repo";
 String region = "us-east-1";
 String codeArtifactAuthToken = execSync(String.format("aws codeartifact get-authorization-token --domain %s --domain-owner %s --query authorizationToken --output text", domain, domainOwner)).toString().trim();
 
 String indexUrl = String.format("https://aws:%s@%s-%s.d.codeartifact.%s.amazonaws.com/pypi/%s/simple/", codeArtifactAuthToken, domain, domainOwner, region, repoName);
 
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .environment(Map.of("PIP_INDEX_URL", indexUrl))
                 .build())
         .build();

The index URL or the token are only used during bundling and thus not included in the final asset. Setting only environment variable for PIP_INDEX_URL or PIP_EXTRA_INDEX_URL should work for accesing private Python repositories with pip, pipenv and poetry based dependencies.

If you also want to use the Code Artifact repo for building the base Docker image for bundling, use buildArgs. However, note that setting custom build args for bundling will force the base bundling image to be rebuilt every time (i.e. skip the Docker cache). Build args can be customized as: 

 import child.process.execSync.*;
 
 
 String entry = "/path/to/function";
 DockerImage image = DockerImage.fromBuild(entry);
 
 String domain = "my-domain";
 String domainOwner = "111122223333";
 String repoName = "my_repo";
 String region = "us-east-1";
 String codeArtifactAuthToken = execSync(String.format("aws codeartifact get-authorization-token --domain %s --domain-owner %s --query authorizationToken --output text", domain, domainOwner)).toString().trim();
 
 String indexUrl = String.format("https://aws:%s@%s-%s.d.codeartifact.%s.amazonaws.com/pypi/%s/simple/", codeArtifactAuthToken, domain, domainOwner, region, repoName);
 
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .buildArgs(Map.of("PIP_INDEX_URL", indexUrl))
                 .build())
         .build();

Command hooks

It is possible to run additional commands by specifying the commandHooks prop: 

 String entry = "/path/to/function";
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .commandHooks(Map.of(
                         // run tests
                         public String[] beforeBundling(String inputDir) {
                             return List.of("pytest");
                         },
                         public String[] afterBundling(String inputDir) {
                             return List.of("pylint");
                         }))
                 .build())
         .build();

The following hooks are available:

  • beforeBundling: runs before all bundling commands
  • afterBundling: runs after all bundling commands

They all receive the directory containing the dependencies file (inputDir) and the directory where the bundled asset will be output (outputDir). They must return an array of commands to run. Commands are chained with &&.

The commands will run in the environment in which bundling occurs: inside the container for Docker bundling or on the host OS for local bundling.

Docker based bundling in complex Docker configurations

By default the input and output of Docker based bundling is handled via bind mounts. In situtations where this does not work, like Docker-in-Docker setups or when using a remote Docker socket, you can configure an alternative, but slower, variant that also works in these situations. 

 String entry = "/path/to/function";
 
 PythonFunction.Builder.create(this, "function")
         .entry(entry)
         .runtime(Runtime.PYTHON_3_8)
         .bundling(BundlingOptions.builder()
                 .bundlingFileAccess(BundlingFileAccess.VOLUME_COPY)
                 .build())
         .build();

Troubleshooting

Containerfile: no such file or directory

If you are on a Mac, using Finch instead of Docker, and see an error like this: 

 lstat /private/var/folders/zx/d5wln9n10sn0tcj1v9798f1c0000gr/T/jsii-kernel-9VYgrO/node_modules/@aws-cdk/aws-lambda-python-alpha/lib/Containerfile: no such file or directory

That is a sign that your temporary directory has not been mapped into the Finch VM. Add the following to ~/.finch/finch.yaml: 

 additional_directories:
   - path: /private/var/folders/
   - path: /var/folders/

Then restart the Finch VM by running finch vm stop && finch vm start.