Existing cache_key_parameters become uncached when new parameters are added

[joecritch]

Terraform CLI and Terraform AWS Provider Version

Terraform v1.2.3
on darwin_arm64
+ provider registry.terraform.io/hashicorp/aws v4.21.0

(also broken on aws provider v3.x)

Affected Resource(s)

• aws_api_gateway_*

Terraform Configuration Files

terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
}

provider "aws" {
  profile = "default"
  region = "us-east-1"
}

locals {
    api_name = "about_example"
    api_host = "http://api.example.com"
    api_stage_name = "dev"

    api_method_request_parameters = {
      "method.request.path.proxy" = true
      "method.request.header.Accept-Language" = false
      "method.request.querystring.test1" = false
      # "method.request.querystring.test2" = false
    }

    api_integration_cache_key_parameters = [
      "method.request.path.proxy",
      "method.request.header.Accept-Language",
      "method.request.querystring.test1"#,
      #"method.request.querystring.test2",
    ]
    
    api_integration_request_parameters = {
      "integration.request.path.proxy" = "method.request.path.proxy"
      "integration.request.header.Accept-Language" = "method.request.header.Accept-Language"
    }
}

resource "aws_api_gateway_rest_api" "about_example" {
  name = local.api_name
}

resource "aws_api_gateway_resource" "about_example" {
  parent_id   = aws_api_gateway_rest_api.about_example.root_resource_id
  rest_api_id = aws_api_gateway_rest_api.about_example.id
  path_part   = "{proxy+}"
}

resource "aws_api_gateway_method" "about_example" {
  authorization = "NONE"
  http_method   = "ANY"
  resource_id   = aws_api_gateway_resource.about_example.id
  rest_api_id   = aws_api_gateway_rest_api.about_example.id
  request_parameters = local.api_method_request_parameters
}

resource "aws_api_gateway_integration" "about_example" {
  http_method = aws_api_gateway_method.about_example.http_method
  integration_http_method = aws_api_gateway_method.about_example.http_method
  resource_id = aws_api_gateway_resource.about_example.id
  rest_api_id = aws_api_gateway_rest_api.about_example.id
  type        = "HTTP_PROXY"
  uri = "${format("%s/{proxy}", "${local.api_host}")}"
  passthrough_behavior     = "WHEN_NO_MATCH"
  timeout_milliseconds = 29000
  cache_key_parameters = local.api_integration_cache_key_parameters
  cache_namespace = "${local.api_stage_name}"
  request_parameters = local.api_integration_request_parameters
}

resource "aws_api_gateway_deployment" "about_example" {
  rest_api_id = aws_api_gateway_rest_api.about_example.id

  lifecycle {
    create_before_destroy = true
  }
}

resource "aws_api_gateway_stage" "about_example" {
  deployment_id = aws_api_gateway_deployment.about_example.id
  rest_api_id   = aws_api_gateway_rest_api.about_example.id
  stage_name    = local.api_stage_name
  cache_cluster_enabled = true
  cache_cluster_size = 0.5
}

resource "aws_api_gateway_method_settings" "all" {
  rest_api_id = aws_api_gateway_rest_api.about_example.id
  stage_name  = aws_api_gateway_stage.about_example.stage_name
  method_path = "*/*"

  settings {
    caching_enabled = true
    cache_ttl_in_seconds = 30
  }
}

Expected Behavior

When you add a new cache key parameter and a corresponding method request parameter (of the same name) to main.tf, it should be added to the `URL Query String Parameters' list, checked as 'Cached'. All other parameters should remain in-tact.

Actual Behavior

When you add the cache key parameter and method request parameter, it adds it, but it also unchecks the 'Cached' checkbox on all previous parameters.

Steps to Reproduce

1. Run the example code, and terraform apply
2. In the example main.tf, add a new test parameter to api_method_request_parameters and api_integration_request_parameters
3. Run terraform apply
4. Check AWS console (it will be broken at this point)
5. Run terraform apply again
6. Check AWS console again (it will be fixed at this point)

Output

First apply (when it breaks):

Second apply (when it fixes):

References

Here's a video of the issue...

Kapture.2022-07-07.at.21.10.03.mp4

[felsteadd]

We've raised a similar issue today #29910

[github-actions]

This functionality has been released in v4.59.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.