Skip to main content
Latest Documentation
This is the latest documentation for the Cloud Posse Reference Architecture. To determine which version you're currently using, please see Version Identification.
Version: Latest
Sponsor @cloudposse

Module: codeartifact

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

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/*).

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"
}

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

Variables​

Required Variables​

Optional Variables​

create_domain (bool) optional

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



Default value: true

domain_name (string) optional

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



Default value: null

domain_owner (string) optional

AWS account ID that owns the domain. Only consulted when create_domain is
false; defaults to the account of the current provider credentials



Default value: null

domain_policy_document (string) optional

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



Default value: null

encryption_key_arn (string) optional

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



Default value: null

organizations_publish_access (list(string)) optional

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



Default value: [ ]

organizations_readonly_access (list(string)) optional

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



Default value: [ ]

principals_publish_access (list(string)) optional

IAM principal ARNs allowed to read every repository and publish package
versions to it. Includes everything granted by principals_readonly_access



Default value: [ ]

principals_readonly_access (list(string)) optional

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



Default value: [ ]

repositories optional

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:


repositories = {<br/>
  pypi-store = { external_connection = &#34;public:pypi&#34; }<br/>
  python     = { upstreams = [&#34;pypi-store&#34;] }<br/>
}<br/>
```<br/>
<br/>
<br/>

**Type:**
```hcl
map(object({
description         = optional(string)
external_connection = optional(string)
upstreams           = optional(list(string), [])
policy_document     = optional(string)
}))

Default value: { }

repository_destroy_delay (string) optional

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



Default value: "30s"

repository_endpoint_formats (list(string)) optional

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



Default value: [ ]

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 &#34;&#34; 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 &#34;&#34; 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, &#34;/[^a-zA-Z0-9-]/&#34; 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. {&#39;BusinessUnit&#39;: &#39;XYZ&#39;}).
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​

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

Dependencies​

Requirements​

  • terraform, version: >= 1.4.0
  • aws, version: >= 6.0.0
  • time, version: >= 0.7.0

Providers​

  • aws, version: >= 6.0.0
  • terraform
  • time, version: >= 0.7.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: