[Bug]: terraform apply failed to remove resource's tag from state

[44smkn]

Terraform Core Version

1.4.6

AWS Provider Version

5.0.1

Affected Resource(s)

• aws_iam_role

Expected Behavior

We removed Environment and Product of the resource's tags and moved them to default_tags.
terraform plan showed that they are removed from tags and added to tags_all.
We expected terraform apply to reflect that change to the state file.

Plan

  # aws_iam_role.sample will be updated in-place
  ~ resource "aws_iam_role" "sample" {
        id                    = "sample"
        name                  = "sample"
      ~ tags                  = {
          - "Environment" = "foo" -> null
            "ManagedBy"   = "Terraform"
          - "Product"     = "bar" -> null
        }
        # (11 unchanged attributes hidden)

        # (2 unchanged blocks hidden)
    }

Plan: 0 to add, 1 to change, 0 to destroy.

Actual Behavior

We found that terraform apply failed to remove resource's tag from the state file.
So, terraform plan always shows the deletion of the resource's tag.

Relevant Error/Panic Output Snippet

None

Terraform Configuration Files

resource "aws_iam_role" "sample" {
  name               = "sample"
  tags = {
    ManagedBy = "Terraform"
  }
}

locals {
  region         = "ap-northeast-1"
  environment    = "foo"
  product        = "bar"
}

provider "aws" {
  default_tags {
    tags = {
      Environment    = local.environment
      Product        = local.product
    }
  }
  region      = local.region
}

Steps to Reproduce

I wonder if this can be reproduced when some keys are removed from tags when tags and default_tags declared.

Debug Output

No response

Panic Output

No response

Important Factoids

No response

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[ewbankkit]

Because IAM has per-resource tagging functions rather than per-service, we cannot use the generic code in the tagging interceptor and these resources aren't getting the benefit of the default_tags work done in v5.0.0.

[nathanpreen]

Hey, I'm seeing this behaviour on several other resources also. Will list them below.

aws_kms_key
aws_security_group
aws_acm_certificate
aws_launch_template

[github-actions]

This functionality has been released in v5.2.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.