{"id":19129450,"url":"https://github.com/launchbynttdata/tf-aws-module_primitive-api_gateway_v2_stage","last_synced_at":"2026-05-17T02:15:28.335Z","repository":{"id":234078324,"uuid":"787609201","full_name":"launchbynttdata/tf-aws-module_primitive-api_gateway_v2_stage","owner":"launchbynttdata","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-07T19:52:00.000Z","size":91,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-07T21:41:17.554Z","etag":null,"topics":["aws","infrastructure-as-code","platform-automation","primitive","terraform"],"latest_commit_sha":null,"homepage":"https://launch.nttdata.com","language":"Makefile","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,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-16T21:08:18.000Z","updated_at":"2026-05-07T19:51:22.000Z","dependencies_parsed_at":"2024-05-08T13:26:31.296Z","dependency_job_id":"3c1dae61-ec6d-4d71-af59-45ea1dd48b7f","html_url":"https://github.com/launchbynttdata/tf-aws-module_primitive-api_gateway_v2_stage","commit_stats":null,"previous_names":["launchbynttdata/tf-aws-module_primitive-api_gateway_v2_stage"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/launchbynttdata/tf-aws-module_primitive-api_gateway_v2_stage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/launchbynttdata","download_url":"https://codeload.github.com/launchbynttdata/tf-aws-module_primitive-api_gateway_v2_stage/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/launchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33125184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"online","status_checked_at":"2026-05-17T02:00:05.366Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["aws","infrastructure-as-code","platform-automation","primitive","terraform"],"created_at":"2024-11-09T06:07:32.384Z","updated_at":"2026-05-17T02:15:28.304Z","avatar_url":"https://github.com/launchbynttdata.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tf-aws-module_primitive-api_gateway_v2_stage\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 an API Gateway Stage resource.\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.0 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | \u003e= 5.14 |\n| \u003ca name=\"requirement_random\"\u003e\u003c/a\u003e [random](#requirement\\_random) | \u003e= 3.6 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | 6.44.0 |\n\n## Modules\n\nNo modules.\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_apigatewayv2_stage.stage](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/apigatewayv2_stage) | resource |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_api_id\"\u003e\u003c/a\u003e [api\\_id](#input\\_api\\_id) | ID of the API Gateway to which this stage will attach | `string` | n/a | yes |\n| \u003ca name=\"input_name\"\u003e\u003c/a\u003e [name](#input\\_name) | Name of the stage. Must be between 1 and 128 characters in length. | `string` | `\"$default\"` | no |\n| \u003ca name=\"input_description\"\u003e\u003c/a\u003e [description](#input\\_description) | Description for the stage. Must be less than or equal to 1024 characters in length. | `string` | `null` | no |\n| \u003ca name=\"input_deployment_id\"\u003e\u003c/a\u003e [deployment\\_id](#input\\_deployment\\_id) | Optional deployment identifier of the stage. Use the aws\\_apigatewayv2\\_deployment resource to configure a deployment. | `string` | `null` | no |\n| \u003ca name=\"input_auto_deploy\"\u003e\u003c/a\u003e [auto\\_deploy](#input\\_auto\\_deploy) | Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs. | `bool` | `false` | no |\n| \u003ca name=\"input_log_group_arn\"\u003e\u003c/a\u003e [log\\_group\\_arn](#input\\_log\\_group\\_arn) | ARN of the CloudWatch Logs log group to receive access logs. Any trailing :* is trimmed from the ARN. If not supplied (default), the stage will not produce any logs. | `string` | `null` | no |\n| \u003ca name=\"input_access_log_format\"\u003e\u003c/a\u003e [access\\_log\\_format](#input\\_access\\_log\\_format) | Single line format of the access logs of data. Refer to log settings for HTTP (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging-variables.html) or Websocket (https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html). | `string` | `\"{ \\\"requestId\\\":\\\"$context.requestId\\\", \\\"ip\\\": \\\"$context.identity.sourceIp\\\", \\\"requestTime\\\":\\\"$context.requestTime\\\", \\\"httpMethod\\\":\\\"$context.httpMethod\\\",\\\"routeKey\\\":\\\"$context.routeKey\\\", \\\"status\\\":\\\"$context.status\\\",\\\"protocol\\\":\\\"$context.protocol\\\", \\\"responseLength\\\":\\\"$context.responseLength\\\" }\"` | no |\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_stage_id\"\u003e\u003c/a\u003e [api\\_gateway\\_stage\\_id](#output\\_api\\_gateway\\_stage\\_id) | Identifier of the Stage |\n| \u003ca name=\"output_api_gateway_stage_arn\"\u003e\u003c/a\u003e [api\\_gateway\\_stage\\_arn](#output\\_api\\_gateway\\_stage\\_arn) | ARN of the Stage |\n| \u003ca name=\"output_execution_arn\"\u003e\u003c/a\u003e [execution\\_arn](#output\\_execution\\_arn) | ARN prefix to be used in an `aws_lambda_permission`'s `source_arn` attribute or in an `aws_iam_policy` to authorize access to the @connections API. See https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.html for details. |\n| \u003ca name=\"output_invoke_url\"\u003e\u003c/a\u003e [invoke\\_url](#output\\_invoke\\_url) | URL to invoke the API pointing to the Stage |\n| \u003ca name=\"output_log_group_arn\"\u003e\u003c/a\u003e [log\\_group\\_arn](#output\\_log\\_group\\_arn) | ARN of the Log Group to receive Stage logs. |\n\u003c!-- END_TF_DOCS --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaunchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaunchbynttdata%2Ftf-aws-module_primitive-api_gateway_v2_stage/lists"}