Cognito Identity Pool PrincipalTag Attribute Mapping

[artificial-aidan]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• 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
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Ability to set/manage the Principal Tag mapping for Cognito Identity Pool providers. These attributes are available for all most providers I believe, so it may make sense to use something like the aws_cognito_identity_pool_roles_attachment that could be attached to any provider.

New or Affected Resource(s)

• aws_cognito_identity_pool_provider_principal_tag_mapping

Potential Terraform Configuration

resource "aws_cognito_identity_pool_provider_principal_tag_mapping" "main" {
  identity_pool_id = aws_cognito_identity_pool.main.id
  principal_tag_mapping {
    identity_provider = "cognito-idp.us-east-1.amazonaws.com/us-east-1_Tv0493apJ"
    principal_tags { 
       client = "aud"
       username = "sub"
       email = "email" 
    }
    use_default = false
  }
}

References

• GetPrincipalTagAttributeMap
• SetPrincipalTagAttributeMap

[artificial-aidan]

Using this as a current workaround

resource "null_resource" "principal_tag_attribute_map" {
 provisioner "local-exec" {
    command = <<EOT
aws cognito-identity set-principal-tag-attribute-map \
--identity-pool-id ${aws_cognito_identity_pool.main.id} \
--identity-provider-name ${aws_cognito_user_pool.user_pool.endpoint} \
--no-use-defaults \
--principal-tags '{ "client": "aud", "email": "email", "username": "sub"}'
EOT
 }
}

[github-actions]

This functionality has been released in v3.72.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.