Skip to content

nhammond101/tf-apigateway

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Terraform API Gateway Module

About:

Supports basic setup of API Gateway with an OpenAPI 3 YML document:

These parameters configure the use of the OpenAPI 3 document:

  • api_template: API Gateway OpenAPI 3 template file
  • api_template_vars: Variables required in the OpenAPI template file

Added support for CloudWatch Alarms in v1.2, use the var.resources parameter to specify which endpoints you want to monitor.

How to use:

Call the module with the specific version you want using the ref query parameter:

# -----------------------------------------------------------------------------
# API Gateway
# -----------------------------------------------------------------------------
module "apigateway" {
  source            = "github.com/nhammond101/tf-apigateway?ref=v1.5.3"
  resource_tag_name = var.resource_tag_name
  namespace         = var.namespace
  region            = var.region

  api_name                   = local.api_name
  api_throttling_rate_limit  = var.api_throttling_rate_limit
  api_throttling_burst_limit = var.api_throttling_burst_limit
  api_metrics_enabled        = var.api_metrics_enabled
  api_logging_level          = var.api_logging_level
  api_template               = file("../../services/api/${local.api_name}.yml")
  api_template_vars = {
    region = var.region
  }

  resources = {
    "/identity/authenticate" = "POST",
    "/identity/register"     = "POST",
    "/identity/reset"        = "POST",
    "/identity/verify"       = "POST",
    "/user"                  = "GET"
  }
}

Changelog

v1.3

  • removed Lambda source code check, use this if you deploy your source code with CodePipeline

v1.2

Use the resources parameter var.resources to specify which API endpoints you want the following Alarms to be enabled:

  • latency P95
  • latency P99
  • 400 Errors
  • 500 Errors

v1.1

  • added data trace variable
  • added X-Ray tracing variable

v1.0

Initial release

About

Terraform API Gateway Module

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HCL 100.0%