Name | Version |
---|---|
aws | >= 2.42, < 4.0.0 |
Name | Description | Type | Default | Required |
---|---|---|---|---|
api_key_name | Name of API Key attached to API Gateway | any |
n/a | yes |
api_name | Name of the API to be added | any |
n/a | yes |
app_version | (Optional) Version of S3 function to use. Add this if you want to add a version number to the path of the application in S3 e.g. 0.0.1 | string |
"" |
no |
environment | Environment variables passed into function when executing | map(string) |
n/a | yes |
function_name | Name of lambda function in AWS | any |
n/a | yes |
iam_role_name | IAM Role Name that has policies attached to execute lambda functions | any |
n/a | yes |
lambda_handler_name | Name of the handler in lambda function e.g. main.handler | any |
n/a | yes |
lambda_timeout | Timeout afterwhich to kill the function | string |
"10" |
no |
quota_limit | Maximum number of api calls for the usage plan | number |
100 |
no |
quota_period | Period in which the limit is accumulated, eg DAY, WEEK, MONTH | string |
"DAY" |
no |
runtime | Lambda Runtime your function uses e.g. nodejs8.10 | any |
n/a | yes |
s3_bucket | S3 Bucket Name | any |
n/a | yes |
s3_key | Directory of the zip file inside the S3 bucket e.g. SomePath/${var.app_version}/function.zip | any |
n/a | yes |
security_group | List of security group to add to your function | list(string) |
n/a | yes |
subnet_id | List of subnets to run your function in | list(string) |
n/a | yes |
throttle_burst_limit | Burst token bucket | number |
5 |
no |
throttle_rate_limit | Rate at which burst tokens are added to bucket | number |
10 |
no |
vpc_id | VPC that your function will run in. Used when your function requires an internal IP for accessing internal services | any |
n/a | yes |
Name | Description |
---|---|
api_base_url | n/a |
api_id | n/a |
api_stage_path | n/a |
lambda_function-arn | n/a |