CodeArtifact CodeArtifact User Guide CodeArtifact: CodeArtifact User Guide Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved. CodeArtifact CodeArtifact User Guide Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. CodeArtifact CodeArtifact User Guide Table of Contents What is AWS CodeArtifact? ................................................................................................................. 1 How does CodeArtifact work? ..................................................................................................... 1 Concepts ................................................................................................................................... 1 Domain ............................................................................................................................. 2 Repository ......................................................................................................................... 2 Package ............................................................................................................................ 2 Package version ................................................................................................................. 2 Package version revision ..................................................................................................... 2 Upstream repository ........................................................................................................... 2 Asset ................................................................................................................................ 3 Package namespace ............................................................................................................ 3 How do I get started with CodeArtifact? ....................................................................................... 3 Setting up ......................................................................................................................................... 4 Sign up for AWS ........................................................................................................................ 4 Install or upgrade and then configure the AWS CLI ......................................................................... 4 Provision an IAM User ................................................................................................................. 5 Install your package manager or build tool ................................................................................... 6 Getting started .................................................................................................................................. 7 Prerequisites .............................................................................................................................. 7 Getting started using the console ................................................................................................ 7 Getting started using the AWS CLI ............................................................................................... 9 Working with repositories .................................................................................................................. 14 Create a repository ................................................................................................................... 14 Create a repository (console) ............................................................................................. 14 Create a repository (AWS CLI) ............................................................................................ 15 Create a repository with an upstream repository .................................................................. 16 Connect to a repository ............................................................................................................ 16 Use a package manager client ........................................................................................... 16 Delete a repository ................................................................................................................... 17 Delete a repository (console) ............................................................................................. 17 Delete a repository (AWS CLI) ............................................................................................ 17 List repositories ........................................................................................................................ 17 List repositories in an AWS account .................................................................................... 18 List repositories in the domain ........................................................................................... 18 View or modify a repository configuration ................................................................................... 20 View or modify a repository configuration (console) ............................................................. 20 View or modify a repository configuration (AWS CLI) ............................................................ 21 Repository policies .................................................................................................................. 22 Create a resource policy to grant read access ....................................................................... 22 Set a policy ..................................................................................................................... 23 Read a policy ................................................................................................................... 24 Delete a policy ................................................................................................................. 24 Grant read access to principals ........................................................................................... 24 Grant write access to packages .......................................................................................... 25 Grant write access to a repository ...................................................................................... 26 Add an external connection ....................................................................................................... 26 Add an external connection to a repository ......................................................................... 26 Supported external connection repositories ......................................................................... 27 Remove an external connection ......................................................................................... 27 Fetch npm packages from an external connection ................................................................ 28 Fetch Maven packages from an external connection .............................................................. 29 npm ingestion behavior .................................................................................................... 30 Maven ingestion behavior .................................................................................................. 31 CodeArtifact behavior when an external repository is not available ......................................... 31 iii CodeArtifact CodeArtifact User Guide Availability of new package versions ................................................................................... 32 Tag a repository ....................................................................................................................... 32 Tag repositories (CLI) ........................................................................................................ 32 Tag repositories (console) .................................................................................................. 34 Working with upstream repositories ................................................................................................... 38 Add, update, or remove upstream repositories (console) ................................................................ 38 Add, update, or remove upstream repositories (AWS CLI) ............................................................... 39 Requesting a package version with upstream repositories .............................................................. 40 Package retention from upstream repositories ..................................................................... 40 Fetch packages through an upstream relationship ................................................................ 40 Package retention in intermediate repositories ..................................................................... 42 Upstream repository priority order ............................................................................................. 42 Simple priority order example ............................................................................................ 43 Complex priority order example ......................................................................................... 43 API behavior with upstream repositories ....................................................................................