IAM
Some things people ask the terraform-aws-modules/iam/aws module for
cannot be implemented by any module, in any registry: they are limits of
Terraform and OpenTofu themselves. This page is for engineers who hit one of
them. For each it says what causes it, gives the native workaround in full, and,
where one exists, shows the Operational Rule that removes the need for a fork.
Read the native option first; several are the right answer on their own.
Terraform keeps reverting tags on IAM roles
An organization tag policy, an automated ownership-tagging job, or a scanner writes tags onto the roles and policies this module creates. Terraform removes them on the next apply, and the plan is never clean.
Why Terraform cannot fix this. Terraform's model is that it owns every attribute it can see. When a controller, an autoscaler, a scanner, or a deployment pipeline writes to one of those attributes, Terraform reads the new value as drift and plans to put its own value back. Both systems are behaving correctly; they simply disagree about who owns the field.
The only mechanism Terraform offers for splitting ownership is ignore_changes, and that is a lifecycle argument, which brings the literal-value restriction above with it. A module cannot accept the list of attributes to ignore as an input, so a module consumer has no way to declare the split.
| Repository | Issue | Title |
|---|---|---|
| hashicorp/terraform | #27360 | A method to override configuration and meta arguments within a module |
| hashicorp/terraform | #24188 | Support for dynamic blocks and meta-arguments |
| hashicorp/terraform-provider-aws | #19583 | Provider produced inconsistent final plan / an invalid new value for .tags_all |
The native workaround. Take the tag back into Terraform first, if you can. default_tags on the AWS provider applies a tag set to every resource the provider manages, and it removes the disagreement outright when the external writer can be turned off.
When the external writer cannot be turned off - a Kubernetes or load balancer controller writing its own tags is the usual case - the only native option left is ignore_changes = [tags, tags_all] inside the resource block, and that means forking the module. Fork this module and add the lifecycle block to the resource yourself. That works, and module maintainers do it when they need it. The cost is ongoing rather than one-off: the fork has to be re-synced with every upstream release, and each sync needs a review to confirm the block still lands on the resource it was meant for. A wrapper module does not avoid this, because the lifecycle block still has to sit inside the resource block, which is inside the module you did not write.
The rule that answers it. lifecycle_ignore_tags adds the
block for you, server-side, while the module is being downloaded. What arrives
in .terraform/modules/ is ordinary HCL with this change already in it, and
nothing else about the module changes: same inputs, same outputs, same version.
resource "aws_iam_role" "this" {
# ... the module's own configuration, unchanged ...
+
+ lifecycle {
+ ignore_changes = [tags, tags_all]
+ }
}Use the rule
This source line applies the rules above during terraform init. The inputs
and outputs stay the upstream module's.
module "iam" {
source = "https://registry.compliance.tf/terraform-aws-modules/iam/aws//modules/iam-role?version=x.y.z&add_rules=lifecycle_ignore_tags"
# ... the same inputs you pass today; the version is in the URL above ...
}- Pin the version in the URL.
?version=takes an exact release; without it the registry serves the latest. Delete theversionargument, which Terraform accepts only on registry-protocol sources. Several rules go in?add_rules=, separated by commas. - Keep the token out of the source line. Register a free compliance.tf
account and configure an access token; it never
goes in the
sourceline or in git. - Preview in the Playground, within its limits. The
Rules Playground shows the diff with no account, at
the version it pins for IAM, which need not be yours. It reads the
module root only: a rule whose resource lives in a submodule shows no diff
there even though the download applies it, and a module that publishes
nothing but submodules cannot be previewed. It takes the list as
?rules=because it previews rules on their own rather than against your Baseline.
On registry.compliance.tf, or on a framework host, ?add_rules= adds to
whatever Baseline your organization has Enforced; on an organization host that
organization's configuration decides. A module compliance.tf builds for you
carries a compliancetf-manifest.json naming every rule the build received,
each with an outcome recording what it did.
Related
- Rules overview - what rules are, and how they differ from compliance controls
- Rule definitions - the HCL of every selectable rule
- lifecycle_ignore_tags - the rule page, with limits and failure modes
- Stop paying the Terraform fork tax - why forking a module to add a
lifecycleblock costs more than it looks