Micronaut 4.0.3 Documentation

• User Guide
• API Reference
• Configuration Reference
• Micronaut Guides

---

Document

Source

Handler

Handler: io.micronaut.function.aws.proxy.payload1.ApiGatewayProxyRequestEventFunction

AWS Lambda Handler

Deployment with GraalVM

If you want to deploy to AWS Lambda as a GraalVM native image, run:

./gradlew buildNativeLambda -Pmicronaut.runtime=lambda

This will build the GraalVM native image inside a docker container and generate the function.zip ready for the deployment.

• Jib Gradle Plugin

Push GraalVM Native Image To Docker Registry Workflow

Workflow file: .github/workflows/graalvm.yml

Workflow description

For pushes to the master branch, the workflow will:

1. Setup the build environment with respect to the selected java/graalvm version.
2. Login to docker registry based on provided configuration.
3. Build, tag and push Docker image with Micronaut application to the Docker container image.

Dependencies on other GitHub Actions

• Docker login(docker/login)
• Setup GraalVM(DeLaGuardo/setup-graalvm)

Setup

Add the following GitHub secrets:

Name	Description
DOCKER_USERNAME	Username for Docker registry authentication.
DOCKER_PASSWORD	Docker registry password.
DOCKER_REPOSITORY_PATH	Path to the docker image repository inside the registry, e.g. for the image foo/bar/micronaut:0.1 it is foo/bar.
DOCKER_REGISTRY_URL	Docker registry url.

Configuration examples

Specifics on how to configure public cloud docker registries like DockerHub, Google Container Registry (GCR), AWS Container Registry (ECR), Oracle Cloud Infrastructure Registry (OCIR) and many more can be found in docker/login-action documentation.

DockerHub

• DOCKER_USERNAME - DockerHub username
• DOCKER_PASSWORD - DockerHub password or personal access token
• DOCKER_REPOSITORY_PATH - DockerHub organization or the username in case of personal registry
• DOCKER_REGISTRY_URL - No need to configure for DockerHub

See docker/login-action for DockerHub

Google Container Registry (GCR)

Create service account with permission to edit GCR or use predefined Storage Admin role.

• DOCKER_USERNAME - set exactly to _json_key
• DOCKER_PASSWORD - content of the service account json key file
• DOCKER_REPOSITORY_PATH - <project-id>/foo
• DOCKER_REGISTRY_URL - gcr.io

See docker/login-action for GCR

AWS Elastic Container Registry (ECR)

Create IAM user with permission to push to ECR (or use AmazonEC2ContainerRegistryFullAccess role).

• DOCKER_USERNAME - access key ID
• DOCKER_PASSWORD - secret access key
• DOCKER_REPOSITORY_PATH - no need to set
• DOCKER_REGISTRY_URL - set to <aws-account-number>.dkr.ecr.<region>.amazonaws.com

See docker/login-action for ECR

Oracle Infrastructure Cloud Registry (OCIR)

Create auth token for authentication.

• DOCKER_USERNAME - username in format <tenancy>/<username>
• DOCKER_PASSWORD - account auth token
• DOCKER_REPOSITORY_PATH - <tenancy>/<registry>/foo
• DOCKER_REGISTRY_URL - set to <region>.ocir.io

See docker/login-action for OCIR

Requisites

• AWS Account
• CDK CLI
• AWS CLI

How to deploy

Generate the deployable artifact

./gradlew :app:buildNativeLambda
./gradlew test

Deploy

The infra/cdk.json file tells the CDK Toolkit how to execute your app.

cd infra cdk synth - emits the synthesized CloudFormation template cdk deploy - deploy this stack to your default AWS account/region cd ..

Other useful commands:

cdk diff - compare deployed stack with current state cdk docs- open CDK documentation

Cleanup

cd infra
cdk destroy
cd ..

• Shadow Gradle Plugin
• Micronaut Gradle Plugin documentation
• GraalVM Gradle Plugin documentation

Feature aws-lambda documentation

• Micronaut AWS Lambda Function documentation

Feature jmx documentation

• Micronaut JMX endpoints documentation

Feature tracing-opentelemetry-annotations documentation

• Micronaut OpenTelemetry Annotations documentation

• https://opentelemetry.io

Feature kafka documentation

• Micronaut Kafka Messaging documentation

Feature kubernetes documentation

• Micronaut Kubernetes Support documentation

• https://kubernetes.io/docs/home/

Feature aws-v2-sdk documentation

• Micronaut AWS SDK 2.x documentation

• https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html

Feature dynamodb documentation

• Micronaut Amazon DynamoDB documentation

• https://aws.amazon.com/dynamodb/

Feature awaitility documentation

• https://github.com/awaitility/awaitility

Feature aws-lambda-custom-runtime documentation

• Micronaut Custom AWS Lambda runtime documentation

• https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html

Feature github-workflow-ci documentation

• https://docs.github.com/en/actions

Feature tracing-opentelemetry-http documentation

• Micronaut OpenTelemetry HTTP documentation

Feature ksp documentation

• Micronaut Kotlin Symbol Processing (KSP) documentation

• https://kotlinlang.org/docs/ksp-overview.html

Feature security-jwt documentation

• Micronaut Security JWT documentation

Feature validation documentation

• Micronaut Validation documentation

Feature management documentation

• Micronaut Management documentation

Feature aws-parameter-store documentation

• Micronaut AWS Parameter Store Distributed Configuration documentation

• https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html

Feature aws-codebuild-workflow-ci documentation

• https://docs.aws.amazon.com/codebuild/latest/userguide

Feature email-javamail documentation

• Micronaut Javamail Email documentation

• https://jakartaee.github.io/mail-api/

Feature control-panel documentation

• Micronaut Control Panel documentation

Feature security-oauth2 documentation

• Micronaut Security OAuth 2.0 documentation

Feature email-amazon-ses documentation

• Micronaut SES Email documentation

• https://aws.amazon.com/ses/

Feature object-storage-aws documentation

• Micronaut Object Storage - AWS documentation

• https://aws.amazon.com/s3/

Feature openapi documentation

• Micronaut OpenAPI Support documentation

• https://www.openapis.org

Feature testcontainers documentation

• https://www.testcontainers.org/

Feature flyway documentation

• Micronaut Flyway Database Migration documentation

• https://flywaydb.org/

Feature aws-lambda-events-serde documentation

• Micronaut AWS Lambda Events Serde documentation

• https://github.com/aws/aws-lambda-java-libs/tree/main/aws-lambda-java-events

Feature object-storage-local documentation

• Micronaut Object Storage - Local documentation

Feature tracing-opentelemetry-exporter-otlp documentation

• Micronaut OpenTelemetry Exporter OTLP documentation

• https://opentelemetry.io

Feature http-client documentation

• Micronaut HTTP Client documentation

Feature cache-caffeine documentation

• Micronaut Caffeine Cache documentation

• https://github.com/ben-manes/caffeine

Feature micronaut-aot documentation

• Micronaut AOT documentation

Feature tracing-opentelemetry-xray documentation

• Micronaut OpenTelemetry XRay Tracing documentation

• https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html

Feature serialization-jackson documentation

• Micronaut Serialization Jackson Core documentation

Feature aws-cdk documentation

• https://docs.aws.amazon.com/cdk/v2/guide/home.html

Feature amazon-api-gateway-http documentation

• Micronaut Amazon API Gateway HTTP documentation

• https://docs.aws.amazon.com/apigateway/

Feature graphql documentation

• Micronaut GraphQL documentation

Feature localstack documentation

• https://www.testcontainers.org/modules/localstack/

Feature github-workflow-graal-docker-registry documentation

• https://docs.github.com/en/free-pro-team@latest/actions