Skip to main content
Sponsor @cloudposse

Module: ecr

Terraform module to provision an AWS ECR Docker Container registry.

Usage​

The module creates one or more Elastic Container Registry (ECR) repositories. All repositories created will share the same configuration. Use this module multiple times to create repositories with different configurations.

If you provide 1 or more names in image_names then one repository will be created for each of the names you provide. Those names can include "namespaces", which are just prefixes ending with a slash (/).

If you do not provide any names in image_names, the module will create a single ECR repo named namespace-stage-name or just name depending on the value of use_fullname.

Access to the repositories is granted to via the principals_full_access and principals_readonly_access lists, which are lists of strings that can designate any valid AWS Principal. This module only creates the Repository Policy allowing those Principals access. The Principals will still separately need IAM policies allowing them permission to execute ECR actions against the repository. For more details, see How Amazon Elastic Container Registry Works with IAM.

Include this repository as a module in your existing terraform code:

# IAM Role to be granted ECR permissions
data "aws_iam_role" "ecr" {
  name = "ecr"
}

module "ecr" {
  source = "cloudposse/ecr/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace              = "eg"
  stage                  = "test"
  name                   = "ecr"
  principals_full_access = [data.aws_iam_role.ecr.arn]
}

Advanced Usage with Image Tag Mutability Exclusion Filters​

The module supports image_tag_mutability_exclusion_filter to exclude specific tags from the repository's image tag mutability setting. This is useful when you want most tags to be immutable but allow certain tag patterns (like latest, dev-*) to be mutable.

Note: This feature requires AWS provider version >= 6.8.0.

module "ecr_with_exclusions" {
  source = "cloudposse/ecr/aws"
  # version = "x.x.x"
  
  namespace              = "eg"
  stage                  = "prod"
  name                   = "api"
  image_tag_mutability   = "IMMUTABLE_WITH_EXCLUSION"
  principals_full_access = [data.aws_iam_role.ecr.arn]

  # Allow 'latest' and 'dev-*' tags to be mutable while keeping others immutable
  image_tag_mutability_exclusion_filter = [
    {
      filter      = "latest"
      filter_type = "WILDCARD"
    },
    {
      filter      = "dev-"
      filter_type = "WILDCARD"
    },
    {
      filter      = "feature-"
      filter_type = "WILDCARD"
    }
  ]
}

Variables​

Required Variables​

Optional Variables​

custom_lifecycle_rules optional

Custom lifecycle rules to override or complement the default ones


Type:

list(object({
description = optional(string)
selection = object({
  tagStatus      = string
  countType      = string
  countNumber    = number
  countUnit      = optional(string)
  tagPrefixList  = optional(list(string))
  tagPatternList = optional(list(string))
})
action = object({
  type = string
})
}))

Default value: [ ]

default_lifecycle_rules_settings optional

Default lifecycle rules settings


Type:

object({
untagged_image_rule = optional(object({
  enabled = optional(bool, true)
  }), {
  enabled = true
})
remove_old_image_rule = optional(object({
  enabled = optional(bool, true)
  }), {
  enabled = true
})
})

Default value:

{
  "remove_old_image_rule": {
    "enabled": true
  },
  "untagged_image_rule": {
    "enabled": true
  }
}
enable_lifecycle_policy (bool) optional

Set to false to prevent the module from adding any lifecycle policies to any repositories


Default value: true

encryption_configuration optional

ECR encryption configuration


Type:

object({
encryption_type = string
kms_key         = any
})

Default value: null

force_delete (bool) optional

Whether to delete the repository even if it contains images


Default value: false

image_names (list(string)) optional

List of Docker local image names, used as repository names for AWS ECR


Default value: [ ]

image_tag_mutability (string) optional

The tag mutability setting for the repository. Must be one of: MUTABLE, IMMUTABLE, IMMUTABLE_WITH_EXCLUSION, or MUTABLE_WITH_EXCLUSION. Defaults to IMMUTABLE


Default value: "IMMUTABLE"

image_tag_mutability_exclusion_filter optional

List of exclusion filters for image tag mutability. Each filter object must contain 'filter' and 'filter_type' attributes. Requires AWS provider >= 6.8.0


Type:

list(object({
filter      = string
filter_type = optional(string, "WILDCARD")
}))

Default value: [ ]

max_image_count (number) optional

How many Docker Image versions AWS ECR will store


Default value: 500

organizations_full_access (list(string)) optional

Organization IDs to provide with full access to the ECR.


Default value: [ ]

organizations_push_access (list(string)) optional

Organization IDs to provide with push access to the ECR


Default value: [ ]

organizations_readonly_access (list(string)) optional

Organization IDs to provide with readonly access to the ECR.


Default value: [ ]

prefixes_pull_through_repositories (list(string)) optional

Organization IDs to provide with push access to the ECR


Default value: [ ]

principals_full_access (list(string)) optional

Principal ARNs to provide with full access to the ECR


Default value: [ ]

principals_lambda (list(string)) optional

Principal account IDs of Lambdas allowed to consume ECR


Default value: [ ]

principals_pull_though_access (list(string)) optional

Principal ARNs to provide with pull though access to the ECR


Default value: [ ]

principals_push_access (list(string)) optional

Principal ARNs to provide with push access to the ECR


Default value: [ ]

principals_readonly_access (list(string)) optional

Principal ARNs to provide with readonly access to the ECR


Default value: [ ]

protected_tags (set(string)) optional

List of image tags prefixes and wildcards that should not be destroyed. Useful if you tag images with prefixes like dev, staging, prod or wildcards like *dev, *prod,*.*.*


Default value: [ ]

protected_tags_keep_count (number) optional

Number of Image versions to keep for protected tags


Default value: 999999

replication_configurations optional

Replication configuration for a registry. See Replication Configuration.


Type:

list(object({
rules = list(object({
  # Maximum 10
  destinations = list(object({
    # Maximum 25
    region      = string
    registry_id = string
  }))
  repository_filters = list(object({
    filter      = string
    filter_type = string
  }))
}))
}))

Default value: [ ]

scan_images_on_push (bool) optional

Indicates whether images are scanned after being pushed to the repository (true) or not (false)


Default value: true

time_based_rotation (bool) optional

Set to true to filter image based on the sinceImagePushed count type.


Default value: false

use_fullname (bool) optional

Set 'true' to use namespace-stage-name for ecr repository name, else name


Default value: true

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

registry_id

Registry ID

repository_arn

ARN of first repository created

repository_arn_map

Map of repository names to repository ARNs

repository_name

Name of first repository created

repository_url

URL of first repository created

repository_url_map

Map of repository names to repository URLs

Dependencies​

Requirements​

  • terraform, version: >= 0.13.0
  • aws, version: >= 6.8.0

Providers​

  • aws, version: >= 6.8.0

Modules​

NameVersionSourceDescription
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: