Files
Sébastien Stormacq 9f566bf4f1 [plugin] Display a warning when compiling on Amazon Linux 2 and optin documentation and examples for Amazon Linux 2023 (#668)
This PR has been reworked. Instead of silently switching the default
base image based on Swift version, we now:

1. **Keep Amazon Linux 2 as the default** base Docker image for the
packager plugin
2. **Add a prominent deprecation warning** when AL2 is used (either via
Docker or natively), informing developers that AL2 reaches End of Life
on June 30, 2026
3. **Migrate all examples** (READMEs, SAM templates, scripts) to build
and deploy on Amazon Linux 2023 (`provided.al2023` runtime +
`--base-docker-image swift:amazonlinux2023`)
4. **Update documentation** (readme, quick-setup) with migration notes

The warning includes the `--base-docker-image swift:6.3-amazonlinux2023`
flag and reminds developers to use the `provided.al2023` runtime when
deploying.

After June 30, 2026, the default will switch to AL2023.

---

<details>
<summary>Original PR description (superseded)</summary>

~~Now that Docker Hub has official Swift images based on Amazon Linux
2023 (starting with 6.3), the packager plugin picks the right base image
automatically depending on the Swift version:~~
~~- Swift 6.3 and later: `swift:<version>-amazonlinux2023`~~
~~- Earlier versions: `swift:<version>-amazonlinux2` (unchanged
behavior)~~
~~- No version specified (latest): defaults to `amazonlinux2023`~~

~~When only a major version is provided (e.g. `--swift-version 6`
without a minor), we conservatively treat it as 6.0 and use Amazon Linux
2, since we can't be sure it's 6.3+.~~
~~Also added a verbose log line showing the resolved Swift version,
Amazon Linux version, and final base image to help with debugging.~~
~~The `--base-docker-image` flag still overrides everything as before.~~

</details>

---------

Co-authored-by: Sébastien Stormacq <stormacq@amazon.lu>
2026-05-28 10:26:44 +02:00
..

Resources Packaging

This is an example of an AWS Lambda function that reads a bundled resource file and returns its content as a response.

This example demonstrates how to include static resources (such as text files, configuration files, or templates) in your Lambda function package using Swift Package Manager's resource bundling feature.

Code

The code creates a LambdaRuntime with a handler that reads a bundled text file and returns its content.

The handler is (event: String, context: LambdaContext). The function takes two arguments:

  • the event argument is a String. It is the parameter passed when invoking the function.
  • the context argument is a Lambda Context. It is a description of the runtime context.

The handler uses Bundle.module.url(forResource:withExtension:) to locate the hello.txt file that was bundled with the executable at build time. It then reads the file content and returns it as the function response.

The Package.swift file declares the resource using the .process("hello.txt") directive, which tells Swift Package Manager to include the file in the module's resource bundle.

Test locally

You can test your function locally before deploying it to AWS Lambda.

To start the local function, type the following commands:

swift run

It will compile your code and start the local server. You know the local server is ready to accept connections when you see this message.

Building for debugging...
Build of product 'MyLambda' complete! (0.31s)
2025-01-29T12:44:48+0100 info LocalServer : host="127.0.0.1" port=7000 [AWSLambdaRuntime] Server started and listening

Then, from another Terminal, send your payload with curl.

curl -d '"hello"' http://127.0.0.1:7000/invoke    
"Hello World\n"

Important

The local server is only available in DEBUG mode. It will not start with swift run -c release.

Build & Package

To build & archive the package, type the following commands.

swift package archive --allow-network-connections docker --base-docker-image swift:amazonlinux2023

If there is no error, there is a ZIP file ready to deploy. The ZIP file is located at .build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager/MyLambda/MyLambda.zip

Deploy

Here is how to deploy using the aws command line.

aws lambda create-function \
--function-name MyLambda \
--zip-file fileb://.build/plugins/AWSLambdaPackager/outputs/AWSLambdaPackager/MyLambda/MyLambda.zip \
--runtime provided.al2023 \
--handler provided  \
--architectures arm64 \
--role arn:aws:iam::<YOUR_ACCOUNT_ID>:role/lambda_basic_execution

The --architectures flag is only required when you build the binary on an Apple Silicon machine (Apple M1 or more recent). It defaults to x86_64.

Be sure to replace <YOUR_ACCOUNT_ID> with your actual AWS account ID (for example: 012345678901).

Invoke your Lambda function

To invoke the Lambda function, use this aws command line.

aws lambda invoke \
--function-name MyLambda \
--payload $(echo \"hello\" | base64)  \
out.txt && cat out.txt && rm out.txt

This should output the following result.

{
    "StatusCode": 200,
    "ExecutedVersion": "$LATEST"
}
"Hello World\n"

Undeploy

When done testing, you can delete the Lambda function with this command.

aws lambda delete-function --function-name MyLambda

⚠️ Security and Reliability Notice

These are example applications for demonstration purposes. When deploying such infrastructure in production environments, we strongly encourage you to follow these best practices for improved security and resiliency: