Feature Request: Data source to get API Gateway REST API by name

[timborrowdale]

Use case:

We would like to be able to independently deploy resource integrations to a single API Gateway. e.g.

1. Main pipeline creates API Gateway
2. Resource 1 pipeline creates lambda function and sets up integration on API Gateway for resource /1
3. Resource 2 pipeline creates lambda function and sets up integration on API Gateway for resource /2

In order to do this the following terraform resources need knowledge of the existing API Gateway:

• aws_api_gateway_resource
• aws_api_gateway_method
• aws_api_gateway_integration

Suggested data source

data "aws_api_gateway_rest_api" "by_name" {
  name = "my-gateway"
}

which would return id and root_resource_id as computed attributes

I can have a go at implementing this if it is considered useful, but I have a concern that currently it is possible to create two API Gateways with the same name. What would be the expected output of a query where there is more than one match?

[catsby]

Seems possible, unfortunately there is no "filter" for the GetRestAPIs endpoint. You send the query and get a paginated result, we'd have to loop through and pattern match on the name 😦

Still, a reasonable request. I don't believe anyone on the Terraform team will be able to get to this, but if someone is reading this and wants to give it a try, I would recommend copying the AutoScaling Group Data Source and test file, and modifying to do as I mentioned:

• grab name from config
• call GetRestApis
• loop until we find a match

The SDK includes GetRestApisPages which will handle the paginated requests:

• https://github.com/terraform-providers/terraform-provider-aws/blob/6097dd5c25599fe0ca9c2064be48dcdbce5f3256/vendor/github.com/aws/aws-sdk-go/service/apigateway/api.go#L6760-L6779

[bflad]

The aws_api_gateway_rest_api data source has been released in version 1.15.0 of the AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!