Skip to main content

Component: ecr

This component is responsible for provisioning repositories, lifecycle rules, and permissions for streamlined ECR usage. This utilizes the roles-to-principals submodule to assign accounts to various roles. It is also compatible with the GitHub Actions IAM Role mixin.

Older versions of our reference architecture have aneks-iam component that needs to be updated to provide

sufficient IAM roles to allow pods to pull from ECR repos


Stack Level: Regional

Here's an example snippet for how to use this component. This component is normally only applied once as the resources it creates are globally accessible, but you may want to create ECRs in multiple regions for redundancy. This is typically provisioned via the stack for the "artifact" account (typically auto, artifact, or corp) in the primary region.

ecr_user_enabled: false
enable_lifecycle_policy: true
max_image_count: 500
scan_images_on_push: true
- prod
image_tag_mutability: MUTABLE

- infrastructure
- microservice-a
- microservice-b
- microservice-c
- admin
- cicd
- admin
corp: ["*"]
dev: ["*"]
prod: ["*"]
stage: ["*"]


terraform>= 1.0.0
aws>= 4.9.0


aws>= 4.9.0




aws_iam_policy_document.ecr_userdata source


additional_tag_mapAdditional 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.
attributesID 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.
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
ecr_user_enabledEnable/disable the provisioning of the ECR user (for CI/CD systems that don't support assuming IAM roles to access ECR, e.g. Codefresh)boolfalseno
enable_lifecycle_policyEnable/disable image lifecycle policybooln/ayes
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
image_tag_mutabilityThe tag mutability setting for the repository. Must be one of: MUTABLE or IMMUTABLEstring"MUTABLE"no
imagesList of image names (ECR repo names) to create repos forlist(string)n/ayes
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
max_image_countMax number of images to store. Old ones will be deleted to make room for new ones.numbern/ayes
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
principals_lambdaPrincipal account IDs of Lambdas allowed to consume ECRlist(string)[]no
protected_tagsTags to refrain from deletinglist(string)[]no
read_only_account_role_mapMap of account:[role, role...] for read-only access. Use * for role to grant access to entire accountmap(list(string)){}no
read_write_account_role_mapMap of account:[role, role...] for write access. Use * for role to grant access to entire accountmap(list(string))n/ayes
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
scan_images_on_pushIndicates whether images are scanned after being pushed to the repositoryboolfalseno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


ecr_repo_arn_mapMap of image names to ARNs
ecr_repo_url_mapMap of image names to URLs
ecr_user_arnECR user ARN
ecr_user_nameECR user name
ecr_user_unique_idECR user unique ID assigned by AWS
repository_hostECR repository name