terraform-aws-apikey

Terraform module, which creates AWS apigateway api key resources.

Usage

module "api_key" {
  source  = "tomoki171923/apikey/aws"
  version = "0.1.2"
  api_name   = "your_api_name"
  api_id     = "your_api_id"
  client_name = "api_client_name"
  api_keys = [
    {
      name      = "your_api_key_name_dev"
      usage_plan = "free"
    },
    {
      name      = "your_api_key_name_pro"
      usage_plan = "flex"
    }
  ]
  usage_plans = [
    {
      name        = "free"
      description = "API Development Usage Plan."
      burst_limit = 100
      rate_limit  = 200
      quota_limit = 5000
      quota_period = "DAY"
      stages      = ["dev", "st"]
    },
    {
      name        = "basic"
      description = "API Production Usage Plan. (Basic)"
      burst_limit = 100
      rate_limit  = 200
      quota_limit = 5000
      quota_period = "DAY"
      stages      = ["pro"]
    },
    {
      name        = "flex"
      description = "API Production Usage Plan. (Flex)"
      burst_limit = 500
      rate_limit  = 1000
      quota_limit = 25000
      quota_period = "DAY"
      stages      = ["pro"]
    },
    {
      name        = "premium"
      description = "API Production Usage Plan. (Premium)"
      burst_limit = 1000
      rate_limit  = 2000
      quota_limit = 50000
      quota_period = "DAY"
      stages      = ["pro"]
    }
  ]
}

Examples

basic

Requirements

Name	Version
terraform	>= 1.0
aws	~> 4.11

Providers

Name	Version
aws	~> 4.11

Inputs

Name	Description	Type	Default	Required
api_name	The API's name on Amazon API Gateway	`string`	`null`	yes
api_id	The API's id on Amazon API Gateway	`string`	`null`	yes
client_name	The Client name to use this api	`string`	`null`	no
api_keys	API keys. name: api key's name, usage_plan: usage plan name to attach.	list(object({ name = string usage_plan = string}))	See api_keys on variables.tf	no
usage_plans	API Usage plans. name: usage plan's name, description: usage plan's description, burst_limit: the api request burst limit, rate_limit: the api request steady-state rate limit, quota_limit: the maximum number of requests that can be made in a given time period, quota_period: the time period in which the limit applies. valid values are DAY, WEEK or MONTH, stages: api stage names of the associated api stage in a usage plan.	list(object({ name = string description = string burst_limit = number rate_limit = number quota_limit = number quota_period = string stages = list(string)}))	See usage_plans on variables.tf	no
cloudwatch_metric_alarms	Acloudwatch metric alarm settings. stage_name: stage name on aws apigateway, label: label, description: alarm description, alarm_actions: cloudwatch metric alarm actions, ok_actions: cloudwatch metric ok actions, metric_name: cloudwatch metric name, period: alarms period (sec), statistic: cloudwatch metric statistic, threshold: cloudwatch metric threshold, treat_missing_data: how this alarm is to handle missing data points,	list(object({ stage_name = string label = string description = string alarm_actions = list(string) ok_actions = list(string) metric_name = string period = number statistic = string threshold = number treat_missing_data = string}))	See cloudwatch_metric_alarms on variables.tf	no
tags	A map of tags to assign to resources.	map(string)	{}	no

Outputs

Name	Description
api_key	Provides an API Gateway API Key. See official for details.
usage_plan	Provides an API Gateway Usage Plan. See official for details.
usage_plan_key	Provides an API Gateway Usage Plan Key. See official for details.
cloudwatch_metric_alarm	CloudWatch Metric Alarm. See official for details.