squidfunk/terraform-aws-api-gateway-enable-cors

Easily add an OPTIONS method to an API Gateway resource to enable CORS

Terraform AWS API Gateway Enable CORS

A Terraform module to add an OPTIONS method to allow Cross-Origin Resource Sharing (CORS) preflight requests.

Usage

module "cors" {
  source = "squidfunk/api-gateway-enable-cors/aws"
  version = "0.3.3"

  api_id          = "<api_id>"
  api_resource_id = "<api_resource_id>"
}

By default, this will create a new MOCK endpoint on the provided API Gateway resource allowing CORS preflight requests for all methods and all origins by default. Of course this can be customized using variables as stated in the next section.

Configuration

The following variables can be configured:

Required

api_id

• Description: API identifier
• Default: none

api_resource_id

• Description: API resource identifier
• Default: none

Optional

allow_headers

• Description: Allow headers (Access-Control-Allow-Headers)

• Default:

  [
    "Authorization",
    "Content-Type",
    "X-Amz-Date",
    "X-Amz-Security-Token",
    "X-Api-Key"
  ]

allow_methods

• Description: Allow methods (Access-Control-Allow-Methods)

• Default:

  [
    "OPTIONS",
    "HEAD",
    "GET",
    "POST",
    "PUT",
    "PATCH",
    "DELETE"
  ]

allow_origin

• Description: Allow origin (Access-Control-Allow-Origin)
• Default: "*"

allow_max_age

• Description: Allow caching time (Access-Control-Allow-Max-Age)
• Default: "7200"

allow_credentials

• Description: Allow credentials (Access-Control-Allow-Credentials)
• Default: none

Outputs

None.

License

MIT License

Copyright (c) 2018-2020 Martin Donath

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

terraform-aws-api-gateway-enable-cors's Issues

Failing on Terraform 0.15

Terraform 0.15 removed the deprecated map() function, hence this module is not working. Error log below:

╷
│ Error: Error in function call
│
│   on .terraform/modules/cors_policy_item/headers.tf line 27, in locals:
│   27:   headers = map(
│   28:     "Access-Control-Allow-Headers", "'${join(",", var.allow_headers)}'",
│   29:     "Access-Control-Allow-Methods", "'${join(",", var.allow_methods)}'",
│   30:     "Access-Control-Allow-Origin", "'${var.allow_origin}'",
│   31:     "Access-Control-Max-Age", "'${var.allow_max_age}'",
│   32:     "Access-Control-Allow-Credentials", var.allow_credentials ? "'true'" : ""
│   33:   )
│     ├────────────────
│     │ var.allow_credentials will be known only after apply
│     │ var.allow_headers is a list of string, known only after apply
│     │ var.allow_max_age is a string, known only after apply
│     │ var.allow_methods is a list of string, known only after apply
│     │ var.allow_origin is a string, known only after apply
│
│ Call to function "map" failed: the "map" function was deprecated in Terraform v0.12 and is no longer available; use tomap({ ... }) syntax to write a literal map.

Deprecation warnings after upgrading to Terraform 0.12

After upgrading Terraform to 0.12 there appears to be multiple deprecation warnings coming from this library:

Warning: Interpolation-only expressions are deprecated
Warning: Quoted references are deprecated
Warning: Quoted type constraints are deprecated

Are there any plans to address these?

Update: I see there is an open PR for this already:

https://github.com/squidfunk/terraform-aws-api-gateway-enable-cors/pull/6/files

Thanks

Error: Error creating API Gateway Method: NotFoundException: Invalid Resource identifier specified

Hello,

I had this error after the apply
Error: Error creating API Gateway Method: NotFoundException: Invalid Resource identifier specified
do you have any idea ?
Thanks

Error in versions > v0.12 Terraform

On using the terraform-aws-api-gateway-enable-cors module and running terraform plan
Error
│ on .terraform/modules/cors/headers.tf line 27, in locals:
│ 27: headers = map(
│ 28: "Access-Control-Allow-Headers", "'${join(",", var.allow_headers)}'",
│ 29: "Access-Control-Allow-Methods", "'${join(",", var.allow_methods)}'",
│ 30: "Access-Control-Allow-Origin", "'${var.allow_origin}'",
│ 31: "Access-Control-Max-Age", "'${var.allow_max_age}'",
│ 32: "Access-Control-Allow-Credentials", var.allow_credentials ? "'true'" : ""
│ 33: )
│ ├────────────────
│ │ var.allow_credentials will be known only after apply
│ │ var.allow_headers is a list of string, known only after apply
│ │ var.allow_max_age is a string, known only after apply
│ │ var.allow_methods is a list of string, known only after apply
│ │ var.allow_origin is a string, known only after apply
│
│ Call to function "map" failed: the "map" function was deprecated in Terraform v0.12 and is no longer available; use tomap({ ... }) syntax to write a
│ literal map.

Using Binary Media Types in API Gateway causes OPTIONS requests failing with 500 errors

By using Binary Media Types set to */* in API Gateway cause OPTIONS requests failing with 500 errors. As a solution, the content_handling should be set to CONVERT_TO_TEXT in the aws_api_gateway_integration resource, see:
https://forums.aws.amazon.com/thread.jspa?threadID=256140

just wanted to say thank you!

hey man,

you solved me a problem with a 10' internet search and 6 lines of code. It works like a charm and just wanted to say thank you for releasing this module. keep up with the good work!

❤️

Enabled CORS for nested resources

When I use the module to enable CORS on both a resource and its parent, I get the following error:

Error creating API Gateway Deployment: BadRequestException: No integration defined for method