AWS Lambda Deploy GitHub Action

Updates the code and configuration of AWS Lambda functions as part of GitHub Actions workflow steps. Supports both .zip file archives and container images stored in Amazon ECR.

Table of Contents

• Usage
  • Update Function Configuration
  • Using S3 Deployment Method
  • Dry Run Mode
  • Container Image Deployment
• Build from Source
• Inputs
• Outputs
• Credentials and Region
• Permissions
• License Summary
• Security Disclosures

Usage

name: Deploy to AWS Lambdaon:
push:
branches: [ "main" ]permissions:
id-token: write # This is required for OIDC authenticationcontents: read # This is required to checkout the repositoryjobs:
deploy:
name: Deployruns-on: ubuntu-latestenvironment: productionsteps:
- name: Checkoutuses: actions/checkout@v5
- name: Configure AWS credentialsuses: aws-actions/configure-aws-credentials@v4with:
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}aws-region: ${{ env.AWS_REGION }}# The role-to-assume should be the ARN of the IAM role you created for GitHub Actions OIDC
- name: Deploy Lambda Functionuses: aws-actions/aws-lambda-deploy@v1.1.0with:
function-name: my-function-namecode-artifacts-dir: my-code-artifacts-dirhandler: index.handlerruntime: nodejs22.x# Add any additional inputs this action supports

The required parameters depend on the deployment type:

For zip file deployments (default):

• function-name - Name of the Lambda function
• code-artifacts-dir - Path to code artifacts directory
• handler - Function handler method
• runtime - Function runtime identifier

For container image deployments:

• function-name - Name of the Lambda function
• package-type - Must be set to Image
• image-uri - URI of the container image in Amazon ECR

Note: If the function does not exist yet, the role parameter is also required for both deployment types to specify the function's IAM execution role.

If a function with the name specified by function-name does not exist, it will be created with the provided code or image and configuration parameters using the CreateFunction API.

For the full list of inputs this GitHub Action supports, see Inputs.

Update Function Configuration

Function configuration will be updated using the UpdateFunctionConfiguration API if configuration values differ from the deployed Lambda function's configuration.

As a first step, GetFunctionConfiguration is called to perform a diff between the provided configuration parameters and the configuration of the currently deployed function. If there is no change, UpdateFunctionConfiguration will not be called.

 - name: Update Lambda configurationuses: aws-actions/aws-lambda-deploy@v1.1.0with:
function-name: my-function-namecode-artifacts-dir: my-code-artifacts-dirmemory-size: 512timeout: 60environment: '{"ENV":"production","DEBUG":"true"}'

Using S3 Deployment Method

For zip file deployments, you can optionally store code artifacts in S3 instead of direct .zip file upload. Note: This method is only available for zip deployments, not container images.

 - name: Deploy Lambda function via S3uses: aws-actions/aws-lambda-deploy@v1.1.0with:
function-name: my-function-namecode-artifacts-dir: my-code-artifacts-dirs3-bucket: my-s3-bucket# s3-key is optional - a key will be auto-generated if not specified

Dry Run Mode

Validate parameters and permissions without any function code or configuration modifications.

 - name: Deploy on dry run modeuses: aws-actions/aws-lambda-deploy@v1.1.0with:
function-name: my-function-namecode-artifacts-dir: my-code-artifacts-dirdry-run: true

Note: Dry run will still call GetFunctionConfiguration to check if the function exists and perform configuration diffs against what's currently deployed.

Container Image Deployment

Deploy Lambda functions using container images from Amazon ECR. See aws-actions/amazon-ecr-login for details on logging into ECR.

 - name: Login to Amazon ECRid: login-ecruses: aws-actions/amazon-ecr-login@v1# Authenticates with ECR and returns the registry URL for building images
- name: Build, tag, and push image to Amazon ECRid: build-imageenv:
ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}ECR_REPOSITORY: my-lambda-repoIMAGE_TAG: ${{ github.sha }}run: | # Build Docker image from Dockerfile in repository root docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG . # Push the built image to ECR repository docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG # Output the full image URI for the next step echo "image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG" >> $GITHUB_OUTPUT - name: Deploy Lambda function with container imageuses: aws-actions/aws-lambda-deploy@v1.1.0with:
function-name: my-container-functionpackage-type: Image # Required: Indicates container deployment (not zip)image-uri: ${{ steps.build-image.outputs.image }} # ECR image URI from previous steprole: arn:aws:iam::123456789012:role/lambda-role # IAM execution role for Lambda# Note: handler, runtime, and layers should not be provided for container images

Build from Source

For zip file deployments, to automate building your source code, add a build step based on your runtime and build process. This build step should be performed before the AWS Lambda Deploy step, and AWS Lambda Deploy's code-artifacts-dir parameter will typically be set to the build step's code artifact output directory.

Below are two commonly used Build examples for Node.js and Python:

Node.js

 - name: Build source coderun: | # Install dependencies npm ci # Build npm run build

Python

 - name: Build source code using setup toolsrun: | # Install dependencies pip install -r requirement.txt # Build python -m build

Inputs

Name	Description	Required	Default
function-name	Name of the Lambda function	Yes
package-type	Package type of the Lambda function (Zip or Image)	No	Zip
image-uri	URI of the container image in Amazon ECR (required when package-type is Image)	No
code-artifacts-dir	Path to a directory of code artifacts to zip and deploy (required when package-type is Zip)	No
handler	Name of the function handler method (required when package-type is Zip)	No	index.handler
runtime	Function runtime identifier (required when package-type is Zip)	No	nodejs20.x
s3-bucket	S3 bucket name for Lambda deployment package. Uses S3 deployment method if provided	No
s3-key	S3 key (path) for the Lambda deployment package	No	Auto-generated
publish	Publish a new version of the function after updating	No	true
dry-run	Validate parameters and permissions without modifications	No	false
revision-id	Update only if the revision ID matches the specified ID	No
architectures	Function instruction set architecture	No	x86_64
source-kms-key-arn	ARN of the KMS key for encrypting deployment package	No
role	ARN of the function's execution role (required for new functions)	No
function-description	Description of the function	No
memory-size	Amount of memory available to the function at runtime	No
timeout	Function timeout in seconds	No	3
vpc-config	VPC configuration for network connectivity	No
environment	Environment variables as JSON string	No
dead-letter-config	Dead letter queue or topic for failed events	No
kms-key-arn	ARN of KMS customer managed key	No
tracing-config	X-Ray tracing configuration	No
layers	Function layers to add to execution environment	No
file-system-configs	Amazon EFS connection settings	No
image-config	Container image configuration	No
ephemeral-storage	Size of function's /tmp directory in MB	No	512
snap-start	Function's SnapStart setting	No
logging-config	CloudWatch Logs configuration	No
code-signing-config-arn	ARN of code-signing configuration	No
tags	Tags to apply to the function as JSON string	No
durable-config	Configuration settings for durable functions as JSON string	No

Outputs

Name	Description
function-arn	The ARN of the updated Lambda function
version	The function version if a new version was published

Credentials and Region

This action relies on the default behavior of the AWS SDK for JavaScript to determine AWS credentials and region. Use the aws-actions/configure-aws-credentials action to configure the GitHub Actions environment for AWS authentication.

OpenID Connect (OIDC)

We highly recommend using OpenID Connect (OIDC) to authenticate with AWS. OIDC allows your GitHub Actions workflows to access AWS resources without storing AWS credentials as long-lived GitHub secrets.

Here's an example of using OIDC with the aws-actions/configure-aws-credentials action:

 - name: Configure AWS credentials with OIDCuses: aws-actions/configure-aws-credentials@v4with:
role-to-assume: my-roleaws-region: my-region

To use OIDC authentication, you must configure a trust policy in AWS IAM that allows GitHub Actions to assume an IAM role. Here's an example trust policy:

{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Federated": "arn:aws:iam::123456789012:oidc-provider/token.actions.githubusercontent.com"
},
"Action": "sts:AssumeRoleWithWebIdentity",
"Condition": {
"StringEquals": {
"token.actions.githubusercontent.com:aud": "sts.amazonaws.com"
},
"StringLike": {
"token.actions.githubusercontent.com:sub": "repo:your-org/your-repo:*"
}
}
}
]
}

For more information on setting up OIDC with AWS, see Configuring OpenID Connect in Amazon Web Services.

Permissions

This action requires the following minimum set of permissions:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "LambdaDeployPermissions",
"Effect": "Allow",
"Action": [
"lambda:GetFunctionConfiguration",
"lambda:CreateFunction",
"lambda:UpdateFunctionCode",
"lambda:UpdateFunctionConfiguration",
"lambda:PublishVersion"
],
"Resource": "arn:aws:lambda:<region>:<aws_account_id>:function:<function_name>"
},
{
"Sid":"PassRolesDefinition",
"Effect":"Allow",
"Action":[
"iam:PassRole"
],
"Resource":[
"arn:aws:iam::<aws_account_id>:role/<function_execution_role_name>"
]
}
]
}

If you're using container image deployments, two sets of permissions are required:

1. IAM permissions for the GitHub Actions role to create/update the Lambda function with the container image:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "ECRAuthToken",
"Effect": "Allow",
"Action": "ecr:GetAuthorizationToken",
"Resource": "*"
},
{
"Sid": "AllowPushPull",
"Effect": "Allow",
"Action": [
"ecr:BatchGetImage",
"ecr:BatchCheckLayerAvailability",
"ecr:CompleteLayerUpload",
"ecr:GetDownloadUrlForLayer",
"ecr:InitiateLayerUpload",
"ecr:PutImage",
"ecr:UploadLayerPart"
],
"Resource": "arn:aws:ecr:<region>:<aws_account_id>:repository/<repository_name>"
}
]
}

Note: The above permissions include both push and pull operations for ECR. If you're only pulling pre-built images (not pushing), you can remove the write permissions and keep only:

• ecr:BatchGetImage
• ecr:GetDownloadUrlForLayer

2. ECR repository policy to allow the Lambda service to pull images:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "LambdaECRImageRetrievalPolicy",
"Effect": "Allow",
"Principal": {
"Service": "lambda.amazonaws.com"
},
"Action": [
"ecr:BatchGetImage",
"ecr:GetDownloadUrlForLayer"
]
}
]
}

For cross-account deployments or more details, see AWS Lambda container image deployment documentation.

If you're using the S3 deployment method (for zip file deployments), ensure your IAM role also has the following permissions:

{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "S3Permissions",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:CreateBucket",
"s3:GetObject",
"s3:PutObject",
"s3:PutBucketPublicAccessBlock",
"s3:PutEncryptionConfiguration",
"s3:PutBucketVersioning"
],
"Resource": [
"arn:aws:s3:::<bucket_name>",
"arn:aws:s3:::<bucket_name>/*"
]
}
]
}

We recommend reading AWS Lambda Security Best Practices for more information on securing your Lambda functions.

License Summary

This code is made available under the MIT license.

Security Disclosures

If you would like to report a potential security issue in this project, please do not create a GitHub issue. Instead, please follow the instructions here or email AWS security directly.