コンテナイメージを使用した Java Lambda 関数のデプロイ
Java Lambda 関数のコンテナイメージを構築するには 3 つの方法があります。
-
AWS ベースイメージには、言語ランタイム、Lambda と関数コード間のやり取りを管理するランタイムインターフェースクライアント、ローカルテスト用のランタイムインターフェイスエミュレーターがプリロードされています。
-
AWS OS 専用ベースイメージ
には、Amazon Linux ディストリビューションおよびランタイムインターフェイスエミュレータ が含まれています。これらのイメージは、Go や Rust などのコンパイル済み言語や、Lambda がベースイメージを提供していない言語または言語バージョン (Node.js 19 など) のコンテナイメージの作成によく使用されます。OS 専用のベースイメージを使用してカスタムランタイムを実装することもできます。イメージに Lambda との互換性を持たせるには、Java のランタイムインターフェイスクライアントをイメージに含める必要があります。 -
Alpine Linux や Debian など、別のコンテナレジストリの代替ベースイメージを使用することもできます。組織が作成したカスタムイメージを使用することもできます。イメージに Lambda との互換性を持たせるには、Java のランタイムインターフェイスクライアントをイメージに含める必要があります。
ヒント
Lambda コンテナ関数がアクティブになるまでの時間を短縮するには、「Docker ドキュメント」の「マルチステージビルドを使用する
このページでは、Lambda のコンテナイメージを構築、テスト、デプロイする方法について説明します。
Java の AWS ベースイメージ
AWS は、Java の次のベースイメージを提供します。
タグ | ランタイム | オペレーティングシステム | Dockerfile | 廃止 |
---|---|---|---|---|
21 |
Java 21 | Amazon Linux 2023 | GitHub の Java 21 用の Dockerfile |
スケジュールされていません |
17 |
Java 17 | Amazon Linux 2 | GitHub の Java 17 用の Dockerfile |
スケジュールされていません |
11 |
Java 11 | Amazon Linux 2 | GitHub の Java 11 用の Dockerfile |
スケジュールされていません |
8.al2 |
Java 8 | Amazon Linux 2 | GitHub の Java 8 用の Dockerfile |
スケジュールされていません |
Amazon ECR リポジトリ: gallery.ecr.aws/lambda/java
Java 21 以降のベースイメージは、Amazon Linux 2023 の最小コンテナイメージに基づいています。以前のベースイメージでは Amazon Linux 2 が使用されています。AL2023 ランタイムには、デプロイのフットプリントが小さいことや、glibc
などのライブラリのバージョンが更新されていることなど、Amazon Linux 2 に比べていくつかの利点があります。
AL2023 ベースのイメージでは、Amazon Linux 2 のデフォルトのパッケージマネージャである yum
の代わりに microdnf
(dnf
としてシンボリックリンク) がパッケージマネージャとして使用されています。microdnf
は dnf
のスタンドアロン実装です。AL2023 ベースのイメージに含まれるパッケージのリストについては、「Comparing packages installed on Amazon Linux 2023 Container Images」の「Minimal Container」列を参照してください。AL2023 と Amazon Linux 2 の違いの詳細については、AWS コンピューティングブログの「Introducing the Amazon Linux 2023 runtime for AWS Lambda
注記
AWS Serverless Application Model (AWS SAM) を含む AL2023 ベースのイメージをローカルで実行するには、Docker バージョン 20.10.10 以降を使用する必要があります。
Java の AWS ベースイメージを使用する
このセクションの手順を完了するには、以下が必要です。
-
Java (たとえば、「Amazon Corretto
」) -
Docker
(Java 21 以降のベースイメージの最小バージョンは 20.10.10) -
「Apache Maven
」または「Gradle 」
-
docker run コマンドを使用して、Docker イメージを起動します。この例では、
docker-image
はイメージ名、test
はタグです。docker run --platform linux/amd64 -p 9000:8080
docker-image
:test
このコマンドはイメージをコンテナとして実行し、
localhost:9000/2015-03-31/functions/function/invocations
でローカルエンドポイントを作成します。注記
ARM64 命令セットアーキテクチャ用に Docker イメージをビルドした場合は、
--platform linux/
の代わりにamd64
--platform linux/
オプションを使用してください。arm64
-
新しいターミナルウィンドウから、イベントをローカルエンドポイントにポストします。
-
コンテナ ID を取得します。
docker ps
-
「docker kill
」コマンドを使用してコンテナを停止します。このコマンドでは、 3766c4ab331c
を前のステップのコンテナ ID で置き換えます。docker kill
3766c4ab331c
Amazon ECR にイメージをアップロードして Lambda 関数を作成するには
-
「get-login-password
」コマンドを実行して Amazon ECR レジストリに Docker CLI を認証します。 -
--region
値を Amazon ECR リポジトリを作成する AWS リージョン に設定します。 -
111122223333
を AWS アカウント ID に置き換えます。
aws ecr get-login-password --region
us-east-1
| docker login --username AWS --password-stdin111122223333
.dkr.ecr.us-east-1
.amazonaws.com -
-
「create-repository
」コマンドを使用して Amazon ECR にリポジトリを作成します。 aws ecr create-repository --repository-name
hello-world
--regionus-east-1
--image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE注記
Amazon ECR リポジトリは Lambda 関数と同じ AWS リージョン に配置されている必要があります。
成功すると、次のようなレスポンスが表示されます。
{ "repository": { "repositoryArn": "arn:aws:ecr:us-east-1:111122223333:repository/hello-world", "registryId": "111122223333", "repositoryName": "hello-world", "repositoryUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world", "createdAt": "2023-03-09T10:39:01+00:00", "imageTagMutability": "MUTABLE", "imageScanningConfiguration": { "scanOnPush": true }, "encryptionConfiguration": { "encryptionType": "AES256" } } }
-
前のステップの出力から
repositoryUri
をコピーします。 -
「docker tag
」コマンドを実行して、最新バージョンとしてローカルイメージを Amazon ECR リポジトリにタグ付けします。このコマンドで: -
docker-image:test
は、Docker イメージの名前とタグです。これは、 docker build
コマンドに指定したイメージの名前とタグです。 -
<ECRrepositoryUri>
を、コピーしたrepositoryUri
に置き換えます。URI の末尾には必ず:latest
を含めてください。
docker tag docker-image:test
<ECRrepositoryUri>
:latest例:
docker tag
docker-image
:test
111122223333
.dkr.ecr.us-east-1
.amazonaws.com/hello-world
:latest -
-
「docker push
」コマンドを実行して Amazon ECR リポジトリにローカルイメージをデプロイします リポジトリ URI の末尾には必ず :latest
を含めてください。docker push
111122223333
.dkr.ecr.us-east-1
.amazonaws.com/hello-world
:latest -
まだ作成済みでない場合、関数に「実行ロールの作成」を実行してください。次のステップではロールの Amazon リソースネーム (ARN) が必要です。
-
Lambda 関数を作成します。
ImageUri
には、先ほど使用したリポジトリ URI を指定します。URI の末尾には必ず:latest
を含めてください。aws lambda create-function \ --function-name
hello-world
\ --package-type Image \ --code ImageUri=111122223333
.dkr.ecr.us-east-1
.amazonaws.com/hello-world
:latest \ --rolearn:aws:iam::111122223333:role/lambda-ex
注記
イメージが Lambda 関数と同じリージョンに配置されていれば、別の AWS アカウントのイメージを使用して関数を作成することができます。詳細については、「 Amazon ECR クロスアカウント許可」を参照してください。
-
関数を呼び出します。
aws lambda invoke --function-name
hello-world
response.json次のような結果が表示されます。
{ "ExecutedVersion": "$LATEST", "StatusCode": 200 }
-
関数の出力を確認するには、
response.json
ファイルをチェックします。
関数コードを更新するには、イメージを再構築し、新しいイメージを Amazon ECR リポジトリにアップロードしてから、update-function-code
Lambda は、イメージタグを特定のイメージダイジェストに解決します。これは、関数のデプロイに使用されたイメージタグを Amazon ECR 内の新しいイメージを指すように変更しても、Lambda は新しいイメージを使用するように自動的に関数を更新しないことを意味します。
新しいイメージを同じ Lambda 関数にデプロイするには、Amazon ECR のイメージタグが同じままであっても、update-function-code--publish
オプションが最新のコンテナイメージを使用して関数の新しいバージョンを作成しています。
aws lambda update-function-code \ --function-name
hello-world
\ --image-uri111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest
\ --publish
ランタイムインターフェイスクライアントで代替ベースイメージを使用する
OS 専用ベースイメージまたは代替のベースイメージを使用する場合、イメージにランタイムインターフェイスクライアントを含める必要があります。ランタイムインターフェイスクライアントは、Lambda と関数コード間の相互作用を管理する カスタムランタイムに Lambda ランタイム API を使用する を拡張します。
Java 用のランタイムインターフェイスクライアントを Dockerfile にインストールするか、プロジェクトの依存関係としてインストールします。たとえば、Maven パッケージマネージャーを使用してランタイムインターフェイスクライアントをインストールするには、pom.xml
ファイルに以下を追加します。
<dependency> <groupId>com.amazonaws</groupId> <artifactId>aws-lambda-java-runtime-interface-client</artifactId> <version>2.3.2</version> </dependency>
パッケージの詳細については、「Maven Central Repository」の「AWS Lambda Java ランタイムのインターフェイスクライアント
次の例は、Amazon Corretto イメージ
このセクションの手順を完了するには、以下が必要です。
-
Java (たとえば、「Amazon Corretto
」)
-
Maven プロジェクトの作成 以下のパラメータは必須です。
-
groupId — アプリケーションの完全パッケージの名前空間。
-
artifactId — ユーザーのプロジェクト名。これがプロジェクトのディレクトリの名前になります。
-
-
プロジェクトディレクトリを開きます。
cd
myapp
-
pom.xml
ファイルを開き、内容を次に置き換えます。このファイルには、aws-lambda-java-runtime-interface-clientが依存関係として含まれています。代わりに、ランタイムインターフェイスクライアントを Dockerfile にインストールすることもできます。ただし、最も簡単な方法は、ライブラリを依存関係として含めることです。 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>example</groupId> <artifactId>hello-lambda</artifactId> <packaging>jar</packaging> <version>1.0-SNAPSHOT</version> <name>hello-lambda</name> <url>http://maven.apache.org</url> <properties> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>com.amazonaws</groupId> <artifactId>
aws-lambda-java-runtime-interface-client
</artifactId> <version>2.3.2
</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>3.1.2</version> <executions> <execution> <id>copy-dependencies</id> <phase>package</phase> <goals> <goal>copy-dependencies</goal> </goals> </execution> </executions> </plugin> </plugins> </build> </project> -
ディレクトリを開いてmyapp
/src/main/java/com/example/myapp
App.java
ファイルを探します。これは Lambda 関数のコードです。このコードを、次のコードで置き換えます。例 関数ハンドラ
package example; public class App { public static String sayHello() { return "Hello world!"; } }
-
ステップ 1 の
mvn -B archetype:generate
コマンドにより、ダミーのテストケースもsrc/test
ディレクトリに生成されます。このチュートリアルでは、この生成された/test
ディレクトリ全体を削除して、実行中のテストをスキップします。 -
プロジェクトのルートディレクトリに戻り、新しい Dockerfile を作成します。次の Dockerfile の例では、Amazon Corretto
イメージを使用しています。Amazon Corretto は、マルチプラットフォーム対応で本番稼働可能な OpenJDK の無償ディストリビューションです。 -
ベースイメージの URI に
FROM
プロパティを設定します。 -
ENTRYPOINT
を、Docker コンテナの起動時に実行させるモジュールに設定します。この場合、モジュールはランタイムインターフェイスクライアントです。 -
CMD
引数を Lambda 関数ハンドラーに設定します。
この例の Dockerfile には USER 命令
が含まれていないことに注意してください。コンテナイメージを Lambda にデプロイすると、最小特権のアクセス許可を付与したデフォルトの Linux ユーザーを Lambda が自動的に定義します。これは標準の Docker 動作とは異なります。標準の動作とは、 USER
命令を指定しなかったときにroot
ユーザーのデフォルトとなる動作のことです。例 Dockerfile
FROM
public.ecr.aws/amazoncorretto/amazoncorretto:21
as base # Configure the build environment FROM base as build RUN yum install -y maven WORKDIR /src # Cache and copy dependencies ADD pom.xml . RUN mvn dependency:go-offline dependency:copy-dependencies # Compile the function ADD . . RUN mvn package # Copy the function artifact and dependencies onto a clean base FROM base WORKDIR /function COPY --from=build /src/target/dependency/*.jar ./ COPY --from=build /src/target/*.jar ./ # Set runtime interface client as default command for the container runtime ENTRYPOINT [ "/usr/bin/java", "-cp", "./*", "com.amazonaws.services.lambda.runtime.api.client.AWSLambda
" ] # Pass the name of the function handler as an argument to the runtime CMD [ "example.App::sayHello
" ] -
-
Docker イメージを「Docker の構築
」コマンドで構築します。次の例では、イメージを docker-image
と名付けてtest
タグを付けます。 docker build --platform linux/amd64 -t
docker-image
:test
.注記
このコマンドは、ビルドマシンのアーキテクチャに関係なく、コンテナが Lambda の実行環境と互換性があることを確認する
--platform linux/amd64
オプションを特定します。ARM64 命令セットアーキテクチャを使用して Lambda 関数を作成する場合は、代わりに--platform linux/arm64
オプションを使用するようにコマンドを変更してください。
ランタイムインターフェイスエミュレーター
ローカルマシンにランタイムインターフェイスエミュレーターをインストールして実行するには
-
プロジェクトディレクトリから次のコマンドを実行して、GitHub からランタイムインターフェイスエミュレーター (x86-64 アーキテクチャ) をダウンロードし、ローカルマシンにインストールします。
-
docker run コマンドを使用して、Docker イメージを起動します。次の点に注意してください。
-
docker-image
はイメージ名、test
はタグです。 -
/usr/bin/java -cp './*' com.amazonaws.services.lambda.runtime.api.client.AWSLambda example.App::sayHello
はENTRYPOINT
で、その後に Dockerfile のCMD
が続きます。
このコマンドはイメージをコンテナとして実行し、
localhost:9000/2015-03-31/functions/function/invocations
でローカルエンドポイントを作成します。注記
ARM64 命令セットアーキテクチャ用に Docker イメージをビルドした場合は、
--platform linux/
の代わりにamd64
--platform linux/
オプションを使用してください。arm64
-
-
イベントをローカルエンドポイントにポストします。
-
コンテナ ID を取得します。
docker ps
-
「docker kill
」コマンドを使用してコンテナを停止します。このコマンドでは、 3766c4ab331c
を前のステップのコンテナ ID で置き換えます。docker kill
3766c4ab331c
Amazon ECR にイメージをアップロードして Lambda 関数を作成するには
-
「get-login-password
」コマンドを実行して Amazon ECR レジストリに Docker CLI を認証します。 -
--region
値を Amazon ECR リポジトリを作成する AWS リージョン に設定します。 -
111122223333
を AWS アカウント ID に置き換えます。
aws ecr get-login-password --region
us-east-1
| docker login --username AWS --password-stdin111122223333
.dkr.ecr.us-east-1
.amazonaws.com -
-
「create-repository
」コマンドを使用して Amazon ECR にリポジトリを作成します。 aws ecr create-repository --repository-name
hello-world
--regionus-east-1
--image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE注記
Amazon ECR リポジトリは Lambda 関数と同じ AWS リージョン に配置されている必要があります。
成功すると、次のようなレスポンスが表示されます。
{ "repository": { "repositoryArn": "arn:aws:ecr:us-east-1:111122223333:repository/hello-world", "registryId": "111122223333", "repositoryName": "hello-world", "repositoryUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world", "createdAt": "2023-03-09T10:39:01+00:00", "imageTagMutability": "MUTABLE", "imageScanningConfiguration": { "scanOnPush": true }, "encryptionConfiguration": { "encryptionType": "AES256" } } }
-
前のステップの出力から
repositoryUri
をコピーします。 -
「docker tag
」コマンドを実行して、最新バージョンとしてローカルイメージを Amazon ECR リポジトリにタグ付けします。このコマンドで: -
docker-image:test
は、Docker イメージの名前とタグです。これは、 docker build
コマンドに指定したイメージの名前とタグです。 -
<ECRrepositoryUri>
を、コピーしたrepositoryUri
に置き換えます。URI の末尾には必ず:latest
を含めてください。
docker tag docker-image:test
<ECRrepositoryUri>
:latest例:
docker tag
docker-image
:test
111122223333
.dkr.ecr.us-east-1
.amazonaws.com/hello-world
:latest -
-
「docker push
」コマンドを実行して Amazon ECR リポジトリにローカルイメージをデプロイします リポジトリ URI の末尾には必ず :latest
を含めてください。docker push
111122223333
.dkr.ecr.us-east-1
.amazonaws.com/hello-world
:latest -
まだ作成済みでない場合、関数に「実行ロールの作成」を実行してください。次のステップではロールの Amazon リソースネーム (ARN) が必要です。
-
Lambda 関数を作成します。
ImageUri
には、先ほど使用したリポジトリ URI を指定します。URI の末尾には必ず:latest
を含めてください。aws lambda create-function \ --function-name
hello-world
\ --package-type Image \ --code ImageUri=111122223333
.dkr.ecr.us-east-1
.amazonaws.com/hello-world
:latest \ --rolearn:aws:iam::111122223333:role/lambda-ex
注記
イメージが Lambda 関数と同じリージョンに配置されていれば、別の AWS アカウントのイメージを使用して関数を作成することができます。詳細については、「 Amazon ECR クロスアカウント許可」を参照してください。
-
関数を呼び出します。
aws lambda invoke --function-name
hello-world
response.json次のような結果が表示されます。
{ "ExecutedVersion": "$LATEST", "StatusCode": 200 }
-
関数の出力を確認するには、
response.json
ファイルをチェックします。
関数コードを更新するには、イメージを再構築し、新しいイメージを Amazon ECR リポジトリにアップロードしてから、update-function-code
Lambda は、イメージタグを特定のイメージダイジェストに解決します。これは、関数のデプロイに使用されたイメージタグを Amazon ECR 内の新しいイメージを指すように変更しても、Lambda は新しいイメージを使用するように自動的に関数を更新しないことを意味します。
新しいイメージを同じ Lambda 関数にデプロイするには、Amazon ECR のイメージタグが同じままであっても、update-function-code--publish
オプションが最新のコンテナイメージを使用して関数の新しいバージョンを作成しています。
aws lambda update-function-code \ --function-name
hello-world
\ --image-uri111122223333.dkr.ecr.us-east-1.amazonaws.com/hello-world:latest
\ --publish