provider/aws: Add import support for API Gateway resources

[hashibot]

This issue was originally opened by @Vinnl as hashicorp/terraform#12250. It was migrated here as part of the provider split. The original body of the issue is below.

---

(I wasn't sure if I had to create separate issues for all of these - most of them are only useful together with some of the others. If you prefer separate issues, do let me know.)

Terraform Version

At least up to v0.8.7

Affected Resource(s)

The following resources are required to set up a proxy integration with an AWS Lambda function for API Gateway, and do not support importability yet:

• aws_api_gateway_resource
• aws_api_gateway_method
• aws_api_gateway_integration
• aws_lambda_permission
• aws_api_gateway_method_response
• aws_api_gateway_integration_response
• aws_api_gateway_deployment

Expected Behavior

Running the import command for these resources should update the state.

Actual Behavior

Message resource <resource> doesn't support import.

[tdmalone]

A few more for the API Gateway import list - would love to see these! =]

• aws_api_gateway_rest_api
• aws_api_gateway_stage
• aws_api_gateway_gateway_response
• aws_api_gateway_domain_name

[bflad]

Pull requests submitted:

• resource/aws_api_gateway_base_path_mapping: Support resource import resource/aws_api_gateway_base_path_mapping: Support resource import #5566
• resource/aws_api_gateway_gateway_response: Support resource import resource/aws_api_gateway_gateway_response: Support resource import #5567
• resource/aws_api_gateway_integration: Support resource import resource/aws_api_gateway_integration: Support resource import #5568
• resource/aws_api_gateway_integration_response: Support resource import resource/aws_api_gateway_integration_response: Support resource import #5569
• resource/aws_api_gateway_method_response: Support resource import resource/aws_api_gateway_method_response: Support resource import #5570
• resource/aws_api_gateway_method: Support resource import resource/aws_api_gateway_method: Support resource import #5571
• resource/aws_api_gateway_model: Support resource import resource/aws_api_gateway_model: Support resource import #5572
• resource/aws_api_gateway_request_validator: Support resource import resource/aws_api_gateway_request_validator: Support resource import #5573
• resource/aws_api_gateway_resource: Support resource import resource/aws_api_gateway_resource: Support resource import #5574
• resource/aws_api_gateway_rest_api: Support resource import resource/aws_api_gateway_rest_api: Support resource import #5564
• resource/aws_api_gateway_stage: Support resource import resource/aws_api_gateway_stage: Support resource import #5575

aws_api_gateway_deployment looks like it will require some major refactoring to support import.

[bflad]

The above mentioned PRs have been merged and released in version 1.33.0 of the AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

[erikpaasonen]

@bflad Could you please also add import support for aws_lambda_permission? @Vinnl mentioned it in the original list of resources, but it seems to have slipped through the cracks. Saves me from opening a brand-new issue. :)

[kladiv]

+1 for "aws_api_gateway_deployment" import

[github-actions]

Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you!

[vinischeidegger]

Please don't forget the aws_api_gateway_deployment import functionality.

[natblundell]

+1 for "aws_api_gateway_deployment" import

[qingvincentyin]

Re:

• aws_api_gateway_deployment

Before that is implemented (eagerly waiting), I am hacking the terraform.tfstate file to copy-paste in a block like the following (in conjunction with terraform state pull/push). It seems to work.

• Note: In the following JSON, the dependencies array will be particular to how your terraform source code is written.

    {
      "mode": "managed",
      "type": "aws_api_gateway_deployment",
      "name": "notification_time",
      "provider": "provider[\"registry.terraform.io/hashicorp/aws\"]",
      "instances": [
        {
          "schema_version": 0,
          "attributes": {
            "created_date": "2018-05-29T17:10:43Z",
            "description": "",
            "execution_arn": "arn:aws:execute-api:us-west-2:111122223333:******/******",
            "id": "******",
            "invoke_url": "https://******.execute-api.us-west-2.amazonaws.com/******",
            "rest_api_id": "******",
            "stage_description": null,
            "stage_name": "******",
            "triggers": null,
            "variables": null
          },
          "sensitive_attributes": [],
          "dependencies": [
            "aws_api_gateway_integration.notification_time",
            "aws_api_gateway_method.notification_time",
            "aws_api_gateway_resource.notification_time",
            "data.aws_api_gateway_resource.v1",
            "data.aws_api_gateway_rest_api.api_gateway"
          ]
        }
      ]
    },

$ terraform version
Terraform v1.1.4
on linux_amd64
+ provider registry.terraform.io/hashicorp/aws v3.75.1

[CSimpiFoN]

These would be very useful. +1 for the feature

[bluenick2k17]

I've got a pull request open for the last ask left in this issue, the ability to import aws_api_gateway_deployment. If you are keeping an eye on this and are eagerly awaiting the enhancement, please consider giving the PR a 👍 to support prioritizing it. Thanks!

#28030 (comment)

[github-actions]

This functionality has been released in v4.44.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

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 have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.