GitHub - cloudposse/terraform-aws-codeartifact: Terraform module to provision AWS CodeArtifact domains, repositories, upstreams, cross-account access policies and package groups

Terraform module to provision an AWS CodeArtifact domain and its repositories:

A CodeArtifact domain, optionally encrypted with a customer managed KMS key, or an existing domain to add repositories to
Repositories with external connections to public registries (PyPI, npm, Maven Central and others) and ordered upstream repositories
Domain and repository permissions policies for read-only and publish access, by IAM principal or by AWS Organization
Repository endpoint URLs for any package format
Package groups with origin controls, in the modules/package-groups submodule

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

Introduction

Repositories and upstreams

repositories is a map keyed by repository name. A repository lists other entries of the same map in upstreams, in the order CodeArtifact searches them. The common layout is one "store" repository per public registry, holding only the external connection, and internal repositories that list the stores as upstreams. Consumers point their package manager at one internal repository and resolve both private and public packages through it.

AWS rejects an upstream that does not exist yet, and a Terraform resource cannot depend on another instance of itself, so the module creates repositories in tiers by the depth of their upstream chain. Chains are capped at a depth of 3: a repository with no upstreams, one whose upstreams have none, and one whose upstreams are at most one level deep. Cycles, unknown upstream names and deeper chains fail at plan time with an error that names the offending repositories.

Cross-account access

The principals_* and organizations_* inputs generate both halves of the resource policy grant:

a domain permissions policy allowing codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken, which every caller needs before it can reach a repository, and
a permissions policy on every repository, allowing read actions, plus PublishPackageVersion and PutPackageMetadata for the *_publish_access inputs.

A cross-account caller also needs an identity policy that allows the same actions. Callers in the domain owner's account need only the identity policy. Additional statements can be merged in with domain_policy_document and the per-repository policy_document.

Package groups and the `awscc` provider

Package groups set origin controls for every package whose name matches a pattern, including packages that do not exist yet. That is the defense against dependency confusion: with publishing allowed and both upstream restrictions set to BLOCK, a matching package can only come from a direct publish into the domain, never from a public registry, even if someone registers the same name there.

The hashicorp/aws provider has no package group resource, so the modules/package-groups submodule uses awscc_codeartifact_package_group from the hashicorp/awscc provider. It is a separate module because Terraform configures every provider a module declares, even one with no resources to plan. Keeping awscc out of the root module means that consumers who do not need package groups do not need to configure it.

A package group pattern is validated by the API at apply time, not at plan time. A prefix match ends in ~ (/pypi//mycompany~), and * matches a whole segment only (/npm/@mycompany/*).

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "codeartifact" {
  source = "cloudposse/codeartifact/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  namespace = "eg"
  name      = "packages"

  # Defaults to the null-label ID. Consumers type this name, so keep it short.
  domain_name = "eg"

  repositories = {
    pypi-store = {
      description         = "Cache of public PyPI"
      external_connection = "public:pypi"
    }
    python = {
      description = "First-party Python packages, with public PyPI as an upstream"
      upstreams   = ["pypi-store"]
    }
  }

  repository_endpoint_formats = ["pypi"]

  # Read access from another account, for example CI build roles.
  principals_readonly_access = ["arn:aws:iam::111111111111:role/ci-build"]
}

# Optional. Requires the hashicorp/awscc provider.
module "codeartifact_package_groups" {
  source = "cloudposse/codeartifact/aws//modules/package-groups"
  # version = "x.x.x"

  domain_name  = module.codeartifact.domain_name
  domain_owner = module.codeartifact.domain_owner

  package_groups = {
    # Names starting with `eg` can only be published to the domain, never
    # ingested from public PyPI.
    first-party = {
      pattern           = "/pypi//eg~"
      publish           = { restriction_mode = "ALLOW" }
      external_upstream = { restriction_mode = "BLOCK" }
      internal_upstream = { restriction_mode = "BLOCK" }
    }
  }

  namespace = "eg"
  name      = "packages"
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Examples

Here is an example of using this module:

examples/complete - three tiers of repositories, endpoint lookups, a read-only grant and two package groups

Requirements

Name	Version
terraform	>= 1.4.0
aws	>= 6.0.0
time	>= 0.7.0

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_codeartifact_domain.default	resource
aws_codeartifact_domain_permissions_policy.default	resource
aws_codeartifact_repository.level_0	resource
aws_codeartifact_repository.level_1	resource
aws_codeartifact_repository.level_2	resource
aws_codeartifact_repository_permissions_policy.default	resource
terraform_data.repository_graph	resource
time_sleep.after_level_0	resource
time_sleep.after_level_1	resource
aws_caller_identity.current	data source
aws_codeartifact_repository_endpoint.default	data source
aws_iam_policy_document.domain	data source
aws_iam_policy_document.repository	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	`map(string)`	`{}`	no
attributes	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.	`list(string)`	`[]`	no
context	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.	`any`	{ "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 }	no
create_domain	Whether to create the CodeArtifact domain. Set to `false` to manage repositories and package groups inside a domain that already exists, for example one owned by another instance of this module. When `false`, `domain_name` is required, and no domain permissions policy is managed	`bool`	`true`	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	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).	`any`	`{}`	no
domain_name	Name of the CodeArtifact domain. Defaults to the null-label `id` when `null`. Every consumer types this name into its package manager configuration (`aws codeartifact login --domain ...`), so prefer something short and stable. Changing it replaces the domain, and deleting a domain deletes every package stored in it	`string`	`null`	no
domain_owner	AWS account ID that owns the domain. Only consulted when `create_domain` is `false`; defaults to the account of the current provider credentials	`string`	`null`	no
domain_policy_document	JSON IAM policy document whose statements are merged into the domain permissions policy, alongside the statements generated from the `principals_` and `organizations_` inputs. Only used when `create_domain` is `true`	`string`	`null`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
encryption_key_arn	ARN of a customer managed KMS key used to encrypt the domain's assets. When `null`, CodeArtifact uses the AWS managed key `aws/codeartifact`. A customer managed key must grant every principal that reads or publishes packages, including principals in other accounts, permission to use it. Changing this value replaces the domain	`string`	`null`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
id_length_limit	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`.	`number`	`null`	no
label_key_case	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`.	`string`	`null`	no
label_order	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.	`list(string)`	`null`	no
label_value_case	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`.	`string`	`null`	no
labels_as_tags	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.	`set(string)`	[ "default" ]	no
name	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.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
organizations_publish_access	AWS Organizations IDs (`o-xxxxxxxxxx`) whose principals are allowed to read and publish to every repository. Grants the same actions as `principals_publish_access`, conditioned on `aws:PrincipalOrgID`	`list(string)`	`[]`	no
organizations_readonly_access	AWS Organizations IDs (`o-xxxxxxxxxx`) whose principals are allowed to read every repository. Grants the same actions as `principals_readonly_access`, conditioned on `aws:PrincipalOrgID`	`list(string)`	`[]`	no
principals_publish_access	IAM principal ARNs allowed to read every repository and publish package versions to it. Includes everything granted by `principals_readonly_access`	`list(string)`	`[]`	no
principals_readonly_access	IAM principal ARNs allowed to read every repository: obtain an authorization token, look up repository endpoints, and list and download packages. Cross-account access needs both this resource policy grant and an identity policy on the caller. Principals in the domain owner's account need only the identity policy	`list(string)`	`[]`	no
regex_replace_chars	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.	`string`	`null`	no
repositories	Repositories to create in the domain, keyed by repository name. - `description`: Description of the repository. - `external_connection`: Name of a public package registry to connect to, for example `public:pypi`, `public:npmjs` or `public:maven-central`. A repository can have at most one external connection. - `upstreams`: Keys of other entries in this map, in the order CodeArtifact searches them when a package is not found in the repository itself. At most 10. - `policy_document`: JSON IAM policy document whose statements are merged into this repository's permissions policy, alongside the statements generated from the `principals_` and `organizations_` inputs. Upstreams must be repositories created by this module, and chains are capped at a depth of 3: a repository with no upstreams, a repository whose upstreams have none, and a repository whose upstreams are at most one level deep. That is a Terraform limit, not an AWS one. A repository cannot depend on another instance of its own resource, so the module creates one resource per tier. The usual shape is a "store" repository holding only the external connection, and one or more internal repositories that list it as an upstream: hcl repositories = { pypi-store = { external_connection = "public:pypi" } python = { upstreams = ["pypi-store"] } }	map(object({ description = optional(string) external_connection = optional(string) upstreams = optional(list(string), []) policy_document = optional(string) }))	`{}`	no
repository_destroy_delay	How long to wait, on destroy, between deleting a tier of repositories and deleting the upstream repositories it used. CodeArtifact releases upstream links asynchronously, so an immediate delete of the upstream fails with a `ConflictException`. Only applies when `repositories` has upstream chains, and never delays create or update	`string`	`"30s"`	no
repository_endpoint_formats	Package formats to look up repository endpoint URLs for, for example `pypi`, `npm` or `maven`. Each format is looked up for every repository and returned in the `repository_endpoints` output. Leave empty to skip the lookups	`list(string)`	`[]`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no

Outputs

Name	Description
domain_arn	ARN of the domain. Only set when this module creates the domain
domain_encryption_key_arn	ARN of the KMS key that encrypts the domain's assets. Only set when this module creates the domain
domain_name	Name of the CodeArtifact domain, the `--domain` argument of `aws codeartifact login`
domain_owner	AWS account ID that owns the domain, the `--domain-owner` argument required for every cross-account call
domain_s3_bucket_arn	ARN of the S3 bucket CodeArtifact uses to store the domain's package assets. Only set when this module creates the domain
repositories	Map of repository name to its `arn`, `name`, `administrator_account`, `external_connection` and `upstreams`
repository_arns	Map of repository name to ARN
repository_endpoints	Map of repository name to a map of package format to endpoint URL, for each format in `repository_endpoint_formats`

Related Projects

Check out these related projects.

terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.
terraform-aws-ecr - Terraform module to provision an ECR repository. The container image counterpart of this module, with the same principals_* access model.
terraform-aws-kms-key - Terraform module to provision a KMS key, for use as the domain's encryption_key_arn.

References

For additional context, refer to some of these links.

What is AWS CodeArtifact? - CodeArtifact concepts: domains, repositories, upstream repositories and external connections.
Working with package groups - Package group definition syntax and how origin controls are inherited.
Editing package origin controls - How origin controls prevent dependency substitution attacks.
Domain policies - Cross-account access to a CodeArtifact domain.
Repository policies - Cross-account access to a CodeArtifact repository.
CodeArtifact quotas - Service quotas, including the number of upstream repositories per repository.
aws_codeartifact_domain resource documentation - Terraform AWS provider documentation for the CodeArtifact resources.
awscc_codeartifact_package_group resource documentation - Terraform AWS Cloud Control provider documentation for package groups.
Cloud Posse Documentation - The Cloud Posse Developer Hub (documentation)
Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Running Terraform Tests

We use Atmos to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.

All tests are located in the test/ folder.

Under the hood, tests are powered by Terratest together with our internal Test Helpers library, providing robust infrastructure validation.

Setup dependencies:

Install Atmos (installation guide)
Install Go 1.24+ or newer
Install Terraform or OpenTofu

To run tests:

Run all tests:
```
atmos test run
```
Clean up test artifacts:
```
atmos test clean
```
Explore additional test options:
```
atmos test --help
```

The configuration for test commands is centrally managed. To review what's being imported, see the atmos.yaml file.

Learn more about our automated testing in our documentation or implementing custom commands with atmos.

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Name		Name	Last commit message	Last commit date
.github		.github
examples/complete		examples/complete
modules/package-groups		modules/package-groups
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
README.yaml		README.yaml
atmos.yaml		atmos.yaml
context.tf		context.tf
main.tf		main.tf
outputs.tf		outputs.tf
policies.tf		policies.tf
variables.tf		variables.tf
versions.tf		versions.tf

Navigation Menu

Repository navigation

About

Repository files navigation

👽 Use Atmos with Terraform

Introduction

Repositories and upstreams

Cross-account access

Package groups and the `awscc` provider

Use Terraform Reference Architectures for AWS

Day-0: Your Foundation for Success

Day-2: Your Operational Mastery

Usage

Examples

Requirements

Modules

Resources

Inputs

Outputs

Related Projects

References

✨ Contributing

Running Terraform Tests

🌎 Slack Community

📰 Newsletter

📆 Office Hours

License

Trademarks

Copyrights

About

Releases

Packages

Used by

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

👽 Use Atmos with Terraform

Introduction

Repositories and upstreams

Cross-account access

Package groups and the awscc provider

Use Terraform Reference Architectures for AWS

Day-0: Your Foundation for Success

Day-2: Your Operational Mastery

Usage

Examples

Requirements

Modules

Resources

Inputs

Outputs

Related Projects

References

✨ Contributing

Running Terraform Tests

🌎 Slack Community

📰 Newsletter

📆 Office Hours

License

Trademarks

Copyrights

About

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages

Package groups and the `awscc` provider