{"id":19129491,"url":"https://github.com/launchbynttdata/tf-aws-module_collection-api_gateway_v2","last_synced_at":"2026-04-15T20:03:30.560Z","repository":{"id":234573369,"uuid":"789064823","full_name":"launchbynttdata/tf-aws-module_collection-api_gateway_v2","owner":"launchbynttdata","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-01T17:15:52.000Z","size":155,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-03T10:46:08.995Z","etag":null,"topics":["aws","collection","terraform"],"latest_commit_sha":null,"homepage":null,"language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/launchbynttdata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-19T16:31:50.000Z","updated_at":"2024-10-04T01:27:57.000Z","dependencies_parsed_at":"2024-04-19T21:49:59.120Z","dependency_job_id":"38d46918-1524-48c8-a909-e4b231e2f23b","html_url":"https://github.com/launchbynttdata/tf-aws-module_collection-api_gateway_v2","commit_stats":null,"previous_names":["launchbynttdata/tf-aws-module_collection-api_gateway_v2"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_collection-api_gateway_v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_collection-api_gateway_v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_collection-api_gateway_v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_collection-api_gateway_v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/launchbynttdata","download_url":"https://codeload.github.com/launchbynttdata/tf-aws-module_collection-api_gateway_v2/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240199258,"owners_count":19763827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["aws","collection","terraform"],"created_at":"2024-11-09T06:07:38.718Z","updated_at":"2026-04-15T20:03:30.551Z","avatar_url":"https://github.com/launchbynttdata.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-aws-module_collection-api_gateway_v2\n\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)\n\n## Overview\n\nProvides a full API Gateway collection, comprised of:\n\n- An API Gateway\n- One or more Stages\n- One or more Routes\n- One or more Integrations\n\nRoutes and Integrations use a common identifier (referred to internally as an `alias`) to allow for routes to be tied to an integration dynamically.\n\nPassing a Route without a `target` attribute will pull the `api_gateway_integration_id` out of the Integration with a matching `alias` and apply it to the route. Consider the following inputs:\n\n```hcl\nroutes = {\n  one = {\n    route_key = \"GET /route_one\"\n  },\n  two = {\n    route_key = \"GET /route_two\"\n  }\n  ...\n}\n\nintegrations = {\n  one = {\n    integration_type = \"HTTP_PROXY\"\n    integration_uri = \"https://some-other-service.example.com/v1/proxied_route_one\"\n  },\n  two = {\n    integration_type = \"AWS_PROXY\"\n    integration_uri = \"\u003cAWS Lambda Function ARN\u003e\n  }\n  ...\n}\n```\n\nThis module will create `route[one].target` and `route[two].target` values that will be fed into the Route after the matching Integration is created. The expected outcome is that accessing /route_one on the API Gateway results in your traffic being proxied to some-other-service.example.com, and accessing /route_two will call a Lambda function.\n\n## Pre-Commit hooks\n\n[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.\n\n`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:\n\n- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).\n- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).\n- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.\nfooters other than BREAKING CHANGE: \u003cdescription\u003e may be provided and follow a convention similar to git trailer format.\n- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)\n- **chore**: a commit of the type `chore` adds changes that don't modify src or test files\n- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)\n- **docs**: a commit of the type `docs` adds documentation only changes\n- **perf**: a commit of the type `perf` adds code change that improves performance\n- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature\n- **revert**: a commit of the type `revert` reverts a previous commit\n- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)\n- **test**: a commit of the type `test` adds missing tests or correcting existing tests\n\nBase configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)\n\nIf you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.\n\n`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS\n\nIn order for `pre-commit` hooks to work properly\n\n- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.\n- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below\n\n```\npre-commit install --hook-type commit-msg\n```\n\n## To test the resource group module locally\n\n1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.\n\n```\nmake configure\n```\n\nThis adds in several files and directories that are ignored by `git`. They expose many new Make targets.\n\n2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.\n\n`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.\n\nThese environment variables are used by `terratest` integration suit.\n\nService principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.\n\n```\n\"Microsoft.Resources/subscriptions/resourceGroups/write\"\n\"Microsoft.Resources/subscriptions/resourceGroups/read\"\n\"Microsoft.Resources/subscriptions/resourceGroups/delete\"\n```\n\nThen run this make target to set the environment variables on developer workstation.\n\n```\nmake env\n```\n\n3. The first target you care about is `check`.\n\n**Pre-requisites**\nBefore running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.\n\n- A file named `provider.tf` with contents below\n\n```\nprovider \"azurerm\" {\n  features {}\n}\n```\n\n- A file named `terraform.tfvars` which contains key value pair of variables used.\n\nNote that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.\n\nAfter creating these files, for running tests associated with the primitive/segment, run\n\n```\nmake check\n```\n\nIf `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.\n\n`make check` target\n\n- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.\n- runs `conftests`. `conftests` make sure `policy` checks are successful.\n- runs `terratest`. This is integration test suit.\n- runs `opa` tests\n\u003c!-- BEGIN_TF_DOCS --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | ~\u003e 1.5 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | ~\u003e 5.0 |\n\n## Providers\n\nNo providers.\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_api_gateway\"\u003e\u003c/a\u003e [api\\_gateway](#module\\_api\\_gateway) | terraform.registry.launch.nttdata.com/module_primitive/api_gateway_v2/aws | ~\u003e 1.0 |\n| \u003ca name=\"module_api_gateway_route\"\u003e\u003c/a\u003e [api\\_gateway\\_route](#module\\_api\\_gateway\\_route) | terraform.registry.launch.nttdata.com/module_primitive/api_gateway_v2_route/aws | ~\u003e 1.0 |\n| \u003ca name=\"module_api_gateway_integration\"\u003e\u003c/a\u003e [api\\_gateway\\_integration](#module\\_api\\_gateway\\_integration) | terraform.registry.launch.nttdata.com/module_primitive/api_gateway_v2_integration/aws | ~\u003e 1.0 |\n| \u003ca name=\"module_api_gateway_stage\"\u003e\u003c/a\u003e [api\\_gateway\\_stage](#module\\_api\\_gateway\\_stage) | terraform.registry.launch.nttdata.com/module_collection/api_gateway_v2_stage/aws | ~\u003e 1.0 |\n\n## Resources\n\nNo resources.\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_name\"\u003e\u003c/a\u003e [name](#input\\_name) | Name of the API Gateway | `string` | n/a | yes |\n| \u003ca name=\"input_routes\"\u003e\u003c/a\u003e [routes](#input\\_routes) | Map of routes to create in the API Gateway. | \u003cpre\u003emap(object({\u003cbr/\u003e    route_key = string\u003cbr/\u003e    target    = string\u003cbr/\u003e  }))\u003c/pre\u003e | n/a | yes |\n| \u003ca name=\"input_integrations\"\u003e\u003c/a\u003e [integrations](#input\\_integrations) | Map of integrations to create in the API Gateway. | \u003cpre\u003emap(object({\u003cbr/\u003e    integration_type          = string\u003cbr/\u003e    connection_id             = optional(string, null)\u003cbr/\u003e    connection_type           = optional(string, null)\u003cbr/\u003e    content_handling_strategy = optional(string, null)\u003cbr/\u003e    credentials_arn           = optional(string, null)\u003cbr/\u003e    description               = optional(string, null)\u003cbr/\u003e    integration_method        = optional(string, null)\u003cbr/\u003e    integration_subtype       = optional(string, null)\u003cbr/\u003e    integration_uri           = optional(string, null)\u003cbr/\u003e    passthrough_behavior      = optional(string, \"WHEN_NO_MATCH\")\u003cbr/\u003e    payload_format_version    = optional(string, \"2.0\")\u003cbr/\u003e    request_parameters        = optional(map(string), {})\u003cbr/\u003e    request_templates         = optional(map(string), {})\u003cbr/\u003e    response_parameters = optional(list(object({\u003cbr/\u003e      status_code = number\u003cbr/\u003e      mappings    = map(string)\u003cbr/\u003e    })), [])\u003cbr/\u003e    template_selection_expression = optional(string, null)\u003cbr/\u003e    timeout_milliseconds          = optional(number, null)\u003cbr/\u003e    server_name_to_verify         = optional(string, null)\u003cbr/\u003e  }))\u003c/pre\u003e | n/a | yes |\n| \u003ca name=\"input_stages\"\u003e\u003c/a\u003e [stages](#input\\_stages) | Map of stages to create in the API Gateway | \u003cpre\u003emap(object({\u003cbr/\u003e    name                     = optional(string, null)\u003cbr/\u003e    description              = optional(string, null)\u003cbr/\u003e    deployment_id            = optional(string, null)\u003cbr/\u003e    auto_deploy              = optional(bool, null)\u003cbr/\u003e    log_group_arn            = optional(string, null)\u003cbr/\u003e    log_group_retention_days = optional(number, 30)\u003cbr/\u003e    log_group_skip_destroy   = optional(bool, false)\u003cbr/\u003e    access_log_format        = optional(string, null)\u003cbr/\u003e  }))\u003c/pre\u003e | n/a | yes |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | Map of tags to assign to the API. | `map(string)` | `null` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_api_gateway_id\"\u003e\u003c/a\u003e [api\\_gateway\\_id](#output\\_api\\_gateway\\_id) | n/a |\n| \u003ca name=\"output_api_gateway_endpoint\"\u003e\u003c/a\u003e [api\\_gateway\\_endpoint](#output\\_api\\_gateway\\_endpoint) | n/a |\n| \u003ca name=\"output_api_gateway_routes\"\u003e\u003c/a\u003e [api\\_gateway\\_routes](#output\\_api\\_gateway\\_routes) | n/a |\n| \u003ca name=\"output_api_gateway_integrations\"\u003e\u003c/a\u003e [api\\_gateway\\_integrations](#output\\_api\\_gateway\\_integrations) | n/a |\n| \u003ca name=\"output_api_gateway_stages\"\u003e\u003c/a\u003e [api\\_gateway\\_stages](#output\\_api\\_gateway\\_stages) | n/a |\n\u003c!-- END_TF_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-aws-module_collection-api_gateway_v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchbynttdata%2Ftf-aws-module_collection-api_gateway_v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-aws-module_collection-api_gateway_v2/lists"}