{"id":21202437,"url":"https://github.com/infrablocks/terraform-aws-api-gateway-lambda-integration","last_synced_at":"2026-03-05T00:37:55.468Z","repository":{"id":38296645,"uuid":"196392197","full_name":"infrablocks/terraform-aws-api-gateway-lambda-integration","owner":"infrablocks","description":"Terraform module for integrating a lambda to an existing API gateway","archived":false,"fork":false,"pushed_at":"2025-12-18T19:26:29.000Z","size":586,"stargazers_count":2,"open_issues_count":6,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-01-30T13:19:29.374Z","etag":null,"topics":["api-gateway","api-gateway-lambda","aws","infrastructure","terraform","terraform-modules"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infrablocks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-11T12:41:23.000Z","updated_at":"2025-06-04T20:32:16.000Z","dependencies_parsed_at":"2023-02-14T11:01:45.035Z","dependency_job_id":"da345f2d-91d4-4e2c-a197-2d9d75824c2a","html_url":"https://github.com/infrablocks/terraform-aws-api-gateway-lambda-integration","commit_stats":null,"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/infrablocks/terraform-aws-api-gateway-lambda-integration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-api-gateway-lambda-integration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-api-gateway-lambda-integration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-api-gateway-lambda-integration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-api-gateway-lambda-integration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infrablocks","download_url":"https://codeload.github.com/infrablocks/terraform-aws-api-gateway-lambda-integration/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infrablocks%2Fterraform-aws-api-gateway-lambda-integration/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30102507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T23:59:36.199Z","status":"ssl_error","status_checked_at":"2026-03-04T23:56:48.556Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-gateway","api-gateway-lambda","aws","infrastructure","terraform","terraform-modules"],"created_at":"2024-11-20T20:15:57.273Z","updated_at":"2026-03-05T00:37:55.450Z","avatar_url":"https://github.com/infrablocks.png","language":"Ruby","readme":"Terraform AWS API Gateway Lambda Integration\n============================================\n\n[![Version](https://img.shields.io/github/v/tag/infrablocks/terraform-aws-api-gateway-lambda-integration?label=version\u0026sort=semver)](https://github.com/infrablocks/terraform-aws-api-gateway-lambda-integration/tags)\n[![Build Pipeline](https://img.shields.io/circleci/build/github/infrablocks/terraform-aws-api-gateway-lambda-integration/main?label=build-pipeline)](https://app.circleci.com/pipelines/github/infrablocks/terraform-aws-api-gateway-lambda-integration?filter=all)\n[![Maintainer](https://img.shields.io/badge/maintainer-go--atomic.io-red)](https://go-atomic.io)\n\nA Terraform module for integrating a lambda to an existing API Gateway REST API\nin AWS.\n\nThe API Gateway Lambda integration requires:\n\n* An existing API Gateway REST API\n* An existing Lambda function\n\nThe API Gateway Lambda integration consists of:\n\n* resources\n* methods\n* integrations\n* permissions\n\nUsage\n-----\n\nTo use the module, include something like the following in your Terraform\nconfiguration:\n\n```terraform\nmodule \"api_gateway_lambda_integration\" {\n  source  = \"infrablocks/api-gateway-lambda-integration/aws\"\n  version = \"2.0.0\"\n\n  region = \"eu-west-2\"\n\n  component             = \"lambda-resource\"\n  deployment_identifier = \"production\"\n\n  api_gateway_rest_api_id               = \"x3H41ka22w\"\n  api_gateway_rest_api_root_resource_id = \"321pyrfif2\"\n\n  lambda_function_name = \"lambda-function\"\n}\n```\n\nBy default, the resource will allow any method at any path. However, stricter\npath definitions can be provided using the `api_gateway_resource_definitions`\nvariable.\n\nSee the\n[Terraform registry entry](https://registry.terraform.io/modules/infrablocks/api-gateway-lambda-resource/aws/latest)\nfor more details.\n\n### Inputs\n\n| Name                                    | Description                                                                                            |                  Default                  | Required |\n|-----------------------------------------|--------------------------------------------------------------------------------------------------------|:-----------------------------------------:|:--------:|\n| `region`                                | The region into which to deploy the API Gateway Lambda integration.                                    |                     -                     |   Yes    |\n| `component`                             | The component for which the API Gateway Lambda integration is being managed.                           |                     -                     |   Yes    |\n| `deployment_identifier`                 | An identifier for this instantiation.                                                                  |                     -                     |   Yes    |\n| `lambda_function_name`                  | The name of the Lambda function to integrate from the API Gateway REST API.                            |                     -                     |   Yes    |\n| `api_gateway_rest_api_id`               | The ID of the API Gateway REST API for which this Lambda integration is being managed.                 |                     -                     |   Yes    |\n| `api_gateway_rest_api_root_resource_id` | The ID of the API Gateway REST API's root resource.                                                    |                     -                     |   Yes    |\n| `api_gateway_resource_definitions`      | Definitions of the resources to manage on the API Gateway REST API for the Lambda.                     | `[ { path: \"{proxy+}\", method: \"ANY\" } ]` |    No    |\n| `use_proxy_integration`                 | Whether to use a proxy integration (`true`, `\"AWS_PROXY\"`) or a custom integration (`false`, `\"AWS\"`). |                  `true`                   |    No    |\n| `tags`                                  | A map of tags to add to created infrastructure components.                                             |                   `{}`                    |    No    |\n| `timeout_milliseconds`                  | Custom timeout. The default value is 29,000 milliseconds.                                              |                     -                     |    No    |\n\n### Outputs\n\n| Name                                | Description                                                                 |\n|-------------------------------------|-----------------------------------------------------------------------------|\n| `api_gateway_redeployment_triggers` | A map of data which upon change should trigger a redeployment of the stage. |\n\n### Compatibility\n\nThis module is compatible with Terraform versions greater than or equal to\nTerraform 1.3 and the Terraform AWS provider 4.0.\n\nDevelopment\n-----------\n\n### Machine Requirements\n\nIn order for the build to run correctly, a few tools will need to be installed\non your development machine:\n\n* Ruby (3.1)\n* Bundler\n* git\n* git-crypt\n* gnupg\n* direnv\n* aws-vault\n\n#### Mac OS X Setup\n\nInstalling the required tools is best managed by [homebrew](http://brew.sh).\n\nTo install homebrew:\n\n```shell\nruby -e \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)\"\n```\n\nThen, to install the required tools:\n\n```shell\n# ruby\nbrew install rbenv\nbrew install ruby-build\necho 'eval \"$(rbenv init - bash)\"' \u003e\u003e ~/.bash_profile\necho 'eval \"$(rbenv init - zsh)\"' \u003e\u003e ~/.zshrc\neval \"$(rbenv init -)\"\nrbenv install 3.1.1\nrbenv rehash\nrbenv local 3.1.1\ngem install bundler\n\n# git, git-crypt, gnupg\nbrew install git\nbrew install git-crypt\nbrew install gnupg\n\n# aws-vault\nbrew cask install\n\n# direnv\nbrew install direnv\necho \"$(direnv hook bash)\" \u003e\u003e ~/.bash_profile\necho \"$(direnv hook zsh)\" \u003e\u003e ~/.zshrc\neval \"$(direnv hook $SHELL)\"\n\ndirenv allow \u003crepository-directory\u003e\n```\n\n### Running the build\n\nRunning the build requires an AWS account and AWS credentials. You are free to\nconfigure credentials however you like as long as an access key ID and secret\naccess key are available. These instructions utilise\n[aws-vault](https://github.com/99designs/aws-vault) which makes credential\nmanagement easy and secure.\n\nTo run the full build, including unit and integration tests, execute:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go\n```\n\nTo run the unit tests, execute:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go test:unit\n```\n\nTo run the integration tests, execute:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go test:integration\n```\n\nTo provision the module prerequisites:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:prerequisites:provision[\u003cdeployment_identifier\u003e]\n```\n\nTo provision the module contents:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:root:provision[\u003cdeployment_identifier\u003e]\n```\n\nTo destroy the module contents:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:root:destroy[\u003cdeployment_identifier\u003e]\n```\n\nTo destroy the module prerequisites:\n\n```shell\naws-vault exec \u003cprofile\u003e -- ./go deployment:prerequisites:destroy[\u003cdeployment_identifier\u003e]\n```\n\nConfiguration parameters can be overridden via environment variables. For\nexample, to run the unit tests with a seed of `\"testing\"`, execute:\n\n```shell\nSEED=testing aws-vault exec \u003cprofile\u003e -- ./go test:unit\n```\n\nWhen a seed is provided via an environment variable, infrastructure will not be\ndestroyed at the end of test execution. This can be useful during development\nto avoid lengthy provision and destroy cycles.\n\nTo subsequently destroy unit test infrastructure for a given seed:\n\n```shell\nFORCE_DESTROY=yes SEED=testing aws-vault exec \u003cprofile\u003e -- ./go test:unit\n```\n\n### Common Tasks\n\n#### Generating an SSH key pair\n\nTo generate an SSH key pair:\n\n```shell\nssh-keygen -m PEM -t rsa -b 4096 -C integration-test@example.com -N '' -f config/secrets/keys/bastion/ssh\n```\n\n#### Generating a self-signed certificate\n\nTo generate a self signed certificate:\n\n```shell\nopenssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365\n```\n\nTo decrypt the resulting key:\n\n```shell\nopenssl rsa -in key.pem -out ssl.key\n```\n\n#### Managing CircleCI keys\n\nTo encrypt a GPG key for use by CircleCI:\n\n```shell\nopenssl aes-256-cbc \\\n  -e \\\n  -md sha1 \\\n  -in ./config/secrets/ci/gpg.private \\\n  -out ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nTo check decryption is working correctly:\n\n```shell\nopenssl aes-256-cbc \\\n  -d \\\n  -md sha1 \\\n  -in ./.circleci/gpg.private.enc \\\n  -k \"\u003cpassphrase\u003e\"\n```\n\nContributing\n------------\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/infrablocks/terraform-aws-api-gateway-lambda-resource.\nThis project is intended to be a safe, welcoming space for collaboration, and\ncontributors are expected to adhere to the\n[Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\nLicense\n-------\n\nThe library is available as open source under the terms of the\n[MIT License](http://opensource.org/licenses/MIT).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fterraform-aws-api-gateway-lambda-integration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfrablocks%2Fterraform-aws-api-gateway-lambda-integration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfrablocks%2Fterraform-aws-api-gateway-lambda-integration/lists"}