Unexpected provider exception when creating "aws_api_gateway_method_settings"

[ghost]

This issue was originally opened by @FlokiOo as hashicorp/terraform#25404. It was migrated here as a result of the provider split. The original body of the issue is below.

---

Hey,

we try to enable Logging and Metrics for our API-Gateway and added the following resource:

resource "aws_api_gateway_method_settings" "settings" {
  rest_api_id = aws_api_gateway_rest_api.rest_api.id
  stage_name = var.api_gateway_stage
  method_path = "${aws_api_gateway_resource.resource.path_part}/${aws_api_gateway_method.method.http_method}"
  settings {
    metrics_enabled = true
    logging_level = "ERROR"
    data_trace_enabled = true
  }
}

Unfortunately this throws the following exception when it gets executed:

module.datalake_zendesk.module.apigateway_instances.aws_api_gateway_method_settings.settings,
provider "aws" produced an unexpected new value for was present, but now
absent.

Any idea what could cause this issue and how we can fix it?

Greetings Dave

[bflad]

Hi @FlokiOo 👋 Thank you for raising this and sorry you ran into trouble here.

There are likely two things going on here. For the confusing error message, its related to #16796 which we will plan on fixing more broadly across Terraform AWS Provider resources in the near future. As for the cause of the confusing error message, my best guess is that in another part of your configuration you have something like the following:

resource "aws_api_gateway_deployment" "example" {
  # ... other configuration ...
  stage_name = var.api_gateway_stage
}

If that is the case, this is likely the cause. We are now recommending (and documenting) to not use the aws_api_gateway_deployment resource stage_name argument and instead using the aws_api_gateway_stage resource by itself. There's a long writeup over in #11344 (comment) with more explanation and recommended configurations if you need them.

I'm going to relabel this issue though to fix the d.IsNewResource() issue. It won't mitigate the actual problem, but it will at least give operators a slightly better error message.

[ghost]

This has been released in version 3.27.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 for triage. Thanks!

[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!