Version: Latest

codeartifact

This component is responsible for provisioning an AWS CodeArtifact domain, its repositories, cross-account read and publish access, and package groups with origin controls. It wraps the cloudposse/codeartifact/aws module and its package-groups submodule.

Repositories can connect to public registries (PyPI, npm, Maven Central and others) and list other repositories in the same domain as upstreams, so consumers point their package manager at a single repository and resolve both private and public packages through it.

Access is granted by IAM principal ARN or by AWS Organization ID. The principals receive both the domain policy (to obtain an authorization token) and a permissions policy on every repository. Wire role ARNs from other components in the stack configuration with !terraform.state.

Package groups protect first-party package names from 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. Package groups are managed with the hashicorp/awscc provider, because the hashicorp/aws provider has no resource for them.

Authentication

This component ships the next-gen providers.tf: the aws and awscc providers set only region, and Atmos Auth supplies the target account credentials before Terraform runs. There is no dependency on account-map. When account_map.full_account_map is populated, the account verification check fails the plan if the credentials belong to a different account than the stack's tenant-stage.

On infrastructure that still uses account-map and team roles, vendor the providers-account-map-bypass.depth-1.tf mixin from cloudposse-terraform-components/mixins in place of providers.tf, and give the awscc provider in provider-awscc.tf the same assume_role as the aws provider. awscc takes assume_role as an attribute, not a block:

provider "awscc" {
  region = var.region

  assume_role = var.account_map_enabled && length(compact([module.iam_roles.terraform_role_arn])) > 0 ? {
    role_arn = module.iam_roles.terraform_role_arn
  } : null
}

Usage

Stack Level: Regional

This component is normally applied once, in the account that holds build artifacts (typically artifacts, auto or corp), in the primary Region. The domain name is what every consumer types into its package manager configuration, so keep it short and never change it: replacing a domain deletes every package stored in it.

components:
  terraform:
    codeartifact:
      vars:
        enabled: true
        name: codeartifact
        domain_name: acme
        repositories:
          # Holds only the public connection. Nothing installs from it directly.
          pypi-store:
            description: "Cache of public PyPI"
            external_connection: "public:pypi"
          # First-party packages, with public PyPI resolved through pypi-store.
          python:
            description: "First-party Python packages"
            upstreams:
              - pypi-store
        repository_endpoint_formats:
          - pypi
        package_groups:
          # Packages named acme* can only be published here, never pulled from PyPI.
          first-party-python:
            pattern: "/pypi//acme~"
            publish:
              restriction_mode: ALLOW
            external_upstream:
              restriction_mode: BLOCK
            internal_upstream:
              restriction_mode: BLOCK
        # Role ARNs from other components, resolved by Atmos.
        principals_readonly_access:
          - !terraform.state iam-role/ci-build plat-dev-use1 arn
          - !terraform.state iam-role/ci-build plat-prod-use1 arn
        principals_publish_access:
          - !terraform.state iam-role/ci-publish core-auto-use1 arn

Consumers in other accounts also need an identity policy allowing codeartifact:GetAuthorizationToken, codeartifact:GetRepositoryEndpoint, codeartifact:ReadFromRepository and sts:GetServiceBearerToken.

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

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

account_map optional

Map of account names (tenant-stage format) to account IDs. Used to verify we're targeting the correct AWS account. Optional attributes support component-specific functionality (e.g., audit_account_account_name for cloudtrail, root_account_account_name for aws-sso).

Type:

object({
full_account_map              = map(string)
audit_account_account_name    = optional(string, "")
root_account_account_name     = optional(string, "")
identity_account_account_name = optional(string, "")
aws_partition                 = optional(string, "aws")
iam_role_arn_templates        = optional(map(string), {})
})

Default value:

{
  "audit_account_account_name": "",
  "aws_partition": "aws",
  "full_account_map": {},
  "iam_role_arn_templates": {},
  "identity_account_account_name": "",
  "root_account_account_name": ""
}

account_map_enabled (bool) optional

Enable the account map component

Default value: false

create_domain (bool) optional

Whether to create the CodeArtifact domain. Set to false to add repositories
and package groups to a domain that already exists, in which case
domain_name is required

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, 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 an existing domain. Only used when create_domain is false

Default value: null

domain_policy_document (string) optional

JSON IAM policy document merged into the domain permissions policy. Only used when create_domain is true

Default value: null

encryption_key_arn (string) optional

ARN of a customer managed KMS key that encrypts the domain's assets. When
null, the AWS managed key aws/codeartifact is used. Changing it replaces
the domain

Default value: null

organizations_publish_access (list(string)) optional

AWS Organizations IDs whose principals are allowed to read and publish to every repository

Default value: [ ]

organizations_readonly_access (list(string)) optional

AWS Organizations IDs whose principals are allowed to read every repository

Default value: [ ]

package_groups optional

Package groups with origin controls, keyed by a name of your choosing.

pattern: Package group definition, /<format>/<namespace>/<package>, for
example /pypi//mycompany~ (a prefix match) or /npm/@mycompany/*. The API
validates the pattern at apply time, not at plan time.
publish, external_upstream, internal_upstream: restriction_mode is one
of ALLOW, BLOCK, ALLOW_SPECIFIC_REPOSITORIES or INHERIT, and
repositories is only valid with ALLOW_SPECIFIC_REPOSITORIES. An omitted
restriction is set to INHERIT.

Set publish to ALLOW and both upstreams to BLOCK to guarantee that a
matching package can only come from a direct publish, never from a public
registry

Type:

map(object({
pattern      = string
description  = optional(string)
contact_info = optional(string)
publish = optional(object({
  restriction_mode = string
  repositories     = optional(list(string), [])
}))
external_upstream = optional(object({
  restriction_mode = string
  repositories     = optional(list(string), [])
}))
internal_upstream = optional(object({
  restriction_mode = string
  repositories     = optional(list(string), [])
}))
}))

Default value: { }

principals_publish_access (list(string)) optional

IAM principal ARNs allowed to read and publish to every repository

Default value: [ ]

principals_readonly_access (list(string)) optional

IAM principal ARNs allowed to read every repository. Wire role ARNs from other
components with !terraform.state, for example
!terraform.state iam-role/ci-build arn

Default value: [ ]

repositories optional

Repositories to create, keyed by repository name.

description: Description of the repository.
external_connection: Public registry to connect to, for example
public:pypi, public:npmjs or public:maven-central. At most one.
upstreams: Keys of other repositories in this map, in search order. At most
10, and chains are capped at a depth of 3.
policy_document: JSON IAM policy document merged into the repository's
permissions policy.

Type:

map(object({
description         = optional(string)
external_connection = optional(string)
upstreams           = optional(list(string), [])
policy_document     = optional(string)
}))

Default value: { }

repository_endpoint_formats (list(string)) optional

Package formats to look up repository endpoint URLs for, for example pypi, npm or maven

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

domain_arn: ARN of the domain. Only set when this component creates the domain
domain_encryption_key_arn: ARN of the KMS key that encrypts the domain's assets. Only set when this component 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
package_group_arns: Map of package group key to ARN
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, < 7.0.0
awscc, version: >= 1.0.0, < 2.0.0

Providers

aws, version: >= 6.0.0, < 7.0.0
terraform

Modules

Name	Version	Source	Description
`codeartifact`	0.1.0	`cloudposse/codeartifact/aws`	n/a
`iam_roles`	0.25.0	`cloudposse/label/null`	dummy module to satisfy the module dependency
`package_groups`	0.1.0	`cloudposse/codeartifact/aws//modules/package-groups`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

terraform_data.account_verification (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.account_verification (data source)

Authentication​

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Authentication

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources