How can I create a default deployment stage in API Gateway using Terraform?

Question

I have an API Gateway setup using Terraform. I need to be able to visit the API Gateway on the base path, i.e, without the stage name appended to the base URL.

https://{api_id}.execute-api.{region}.amazonaws.com/ <- acceptable

https://{api_id}.execute-api.{region}.amazonaws.com/{StageName} <- not acceptable

I would do this from the console by creating a default deployment stage like here.

I looked but could not find anything in the terraform documentation here for stages

I want to be able to do this by creating the default stage, not using a aws_api_gateway_domain_name resource

Danny Guo · Accepted Answer · 2021-08-27 14:13:09Z

16

From the AWS documentation:

You can create a $default stage that is served from the base of your API's URL—for example, https://{api_id}.execute-api.{region}.amazonaws.com/. You use this URL to invoke an API stage.

The Terraform documentation doesn't mention this, but you can create a stage with $default as the stage name. Calling the base path should then use that stage.

resource "aws_apigatewayv2_stage" "example" {
  api_id = aws_apigatewayv2_api.example.id
  name   = "$default"
}

answered Aug 27, 2021 at 14:13

Danny Guo

1,0221 gold badge16 silver badges30 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Jay Prall Over a year ago

Note that this is only available for the HTTP version of the API Gateway. It's not supported by the REST version.

Marcin · Accepted Answer · 2021-04-06 22:20:09Z

7

aws_api_gateway_domain_name is for REST API which does not have a default stage. To create such a stage you have to use HTTP API which in terraform is provided by the family of apigatewayv2 methods.

answered Apr 6, 2021 at 22:20

Marcin

241k16 gold badges315 silver badges368 bronze badges

Collectives™ on Stack Overflow

How can I create a default deployment stage in API Gateway using Terraform?

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related