goci-io / aws-api-gateway-settings

Configures API Gateway settings to write Logs to CloudWatch and corresponding IAM role

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

aws-api-gateway-settings

Maintained by @goci-io/prp-terraform

terraform

This module creates a new IAM service role to be used by API Gateway to write logs to CloudWatch and to setup the API Gateway Account.

module "apigw_settings" {
  source     = "git::https://github.com/goci-io/aws-api-gateway-settings.git?ref=tags/<latest-version>"
  namespace  = "goci"
  stage      = "staging"
  region     = "eu1"
  aws_region = "eu-central-1"
}

Results in an IAM role named goci-staging-api-logs-eu1 with region based access to write Logs to CloudWatch. The role ARN will also be set for API Gateway Settings.

Configuration

Name Description Default
namespace The company or organization prefix (eg: goci) -
stage The stage this configuration is for (eg: staging or prod) -
name Optional name (subdomain) for this hosted zone api
attributes Additional attributes (e.g. ["eu1"]) ["logs"]
tags Additional tags (e.g. map("BusinessUnit", "XYZ") {}
delimiter  Delimiter between namespace, stage, name and attributes  -
region Custom region name to use for labels and tags var.aws_region
aws_region AWS Region to apply the account settings to -

About

Configures API Gateway settings to write Logs to CloudWatch and corresponding IAM role

License:Apache License 2.0


Languages

Language:HCL 100.0%