Add ability to query ECR repository for most recently pushed image

[yvrhdn]

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

Use case: in my setup I often wish to deploy the most recently pushed ECR image to a test environment. But I found it isn't possible to query for this image directly using aws_ecr_image.

You can do fairly easy with the AWS cli:

$ aws ecr describe-images --repository-name <REPO> --query 'sort_by(imageDetails, &imagePushedAt)[-1]'

I would propose adding query functionality to aws_ecr_image, similar to aws_ami

data "aws_ecr_image" "most_recent" {
  repository_name = "my-repository"
  most_recent     = true
}

New or Affected Resource(s)

• aws_ecr_image

Potential Terraform Configuration

Desired configuration:

data "aws_ecr_image" "most_recent" {
  repository_name = "my-repository"
  most_recent     = true
}

References

• N/A

[yvrhdn]

FWIW, I've been able to put a workaround together:

variable "repository_name" {
  description = "The ECR repository to query"
  type        = string
}

# Terraform's AWS provider does not provide a mechanism to query the ecr repository.
#
# We use an external data source, which can run any program that returns valid JSON, to run the AWS
# cli manually, which will produce a JSON in the following format:
#
#   {
#     "tags": "[\"1.0.0.1166\"]"
#   }
#
data "external" "tags_of_most_recently_pushed_image" {
  program = [
    "aws", "ecr", "describe-images",
    "--repository-name", var.repository_name,
    "--query", "{\"tags\": to_string(sort_by(imageDetails,& imagePushedAt)[-1].imageTags)}",
  ]
}

output "tags" {
  description = ""
  value       = jsondecode(data.external.tags_of_most_recently_pushed_image.result.tags)
}

[github-actions]

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