This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::CodeArtifact::Repository
<a name="aws-resource-codeartifact-repository"></a>

The `AWS::CodeArtifact::Repository` resource creates an AWS CodeArtifact repository. CodeArtifact*repositories* contain a set of package versions. For more information about repositories, see the [Repository concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-repository) in the *CodeArtifact User Guide*. For more information about the `CreateRepository` API, see [CreateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html) in the *CodeArtifact API Reference*.

## Syntax
<a name="aws-resource-codeartifact-repository-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-codeartifact-repository-syntax.json"></a>

```
{
  "Type" : "AWS::CodeArtifact::Repository",
  "Properties" : {
      "[Description](#cfn-codeartifact-repository-description)" : String,
      "[DomainName](#cfn-codeartifact-repository-domainname)" : String,
      "[DomainOwner](#cfn-codeartifact-repository-domainowner)" : String,
      "[ExternalConnections](#cfn-codeartifact-repository-externalconnections)" : [ String, ... ],
      "[PermissionsPolicyDocument](#cfn-codeartifact-repository-permissionspolicydocument)" : Json,
      "[RepositoryName](#cfn-codeartifact-repository-repositoryname)" : String,
      "[Tags](#cfn-codeartifact-repository-tags)" : [ Tag, ... ],
      "[Upstreams](#cfn-codeartifact-repository-upstreams)" : [ String, ... ]
    }
}
```

### YAML
<a name="aws-resource-codeartifact-repository-syntax.yaml"></a>

```
Type: AWS::CodeArtifact::Repository
Properties:
  [Description](#cfn-codeartifact-repository-description): String
  [DomainName](#cfn-codeartifact-repository-domainname): String
  [DomainOwner](#cfn-codeartifact-repository-domainowner): String
  [ExternalConnections](#cfn-codeartifact-repository-externalconnections): 
    - String
  [PermissionsPolicyDocument](#cfn-codeartifact-repository-permissionspolicydocument): Json
  [RepositoryName](#cfn-codeartifact-repository-repositoryname): String
  [Tags](#cfn-codeartifact-repository-tags): 
    - Tag
  [Upstreams](#cfn-codeartifact-repository-upstreams): 
    - String
```

## Properties
<a name="aws-resource-codeartifact-repository-properties"></a>

`Description`  <a name="cfn-codeartifact-repository-description"></a>
 A text description of the repository.   
*Required*: No  
*Type*: String  
*Maximum*: `1000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainName`  <a name="cfn-codeartifact-repository-domainname"></a>
 The name of the domain that contains the repository.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^([a-z][a-z0-9\-]{0,48}[a-z0-9])$`  
*Minimum*: `2`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DomainOwner`  <a name="cfn-codeartifact-repository-domainowner"></a>
 The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.   
*Required*: No  
*Type*: String  
*Pattern*: `[0-9]{12}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ExternalConnections`  <a name="cfn-codeartifact-repository-externalconnections"></a>
 An array of external connections associated with the repository. For more information, see [Supported external connection repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html#supported-public-repositories) in the *CodeArtifact user guide*.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PermissionsPolicyDocument`  <a name="cfn-codeartifact-repository-permissionspolicydocument"></a>
The document that defines the resource policy that is set on a repository.  
*Required*: No  
*Type*: Json  
*Minimum*: `2`  
*Maximum*: `5120`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RepositoryName`  <a name="cfn-codeartifact-repository-repositoryname"></a>
 The name of an upstream repository.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^([A-Za-z0-9][A-Za-z0-9._\-]{1,99})$`  
*Minimum*: `2`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-codeartifact-repository-tags"></a>
A list of tags to be applied to the repository.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-codeartifact-repository-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Upstreams`  <a name="cfn-codeartifact-repository-upstreams"></a>
 A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html).   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-codeartifact-repository-return-values"></a>

### Ref
<a name="aws-resource-codeartifact-repository-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource arn.

### Fn::GetAtt
<a name="aws-resource-codeartifact-repository-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-codeartifact-repository-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository. 

`DomainName`  <a name="DomainName-fn::getatt"></a>
When you pass the logical ID of this resource, the function returns the domain name that contains the repository.

`DomainOwner`  <a name="DomainOwner-fn::getatt"></a>
When you pass the logical ID of this resource, the function returns the 12-digit account number of the AWS account that owns the domain that contains the repository.

`Name`  <a name="Name-fn::getatt"></a>
When you pass the logical ID of this resource, the function returns the name of the repository.

## Examples
<a name="aws-resource-codeartifact-repository--examples"></a>

The following examples can help you create CodeArtifact repositories using CloudFormation.

**Topics**
+ [Create a domain and repository](#aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository)
+ [Create a repository with an upstream repository and external connection](#aws-resource-codeartifact-repository--examples--Create_a_repository_with_an_upstream_repository_and_external_connection)
+ [Create a domain and repository with tags](#aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository_with_tags)

### Create a domain and repository
<a name="aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository"></a>

The following example creates a CodeArtifact domain named *my-domain* and a CodeArtifact repository named *my-repo* inside it.

#### YAML
<a name="aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository--yaml"></a>

```
Resources:
  MyCodeArtifactDomain:
    Type: 'AWS::CodeArtifact::Domain'
    Properties:
      DomainName: "my-domain"
  MyCodeArtifactRepository:
    Type: 'AWS::CodeArtifact::Repository'
    Properties:
      RepositoryName: "my-repo"
      DomainName: !GetAtt MyCodeArtifactDomain.Name
```

#### JSON
<a name="aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository--json"></a>

```
{
  "Resources": {
    "MyCodeArtifactDomain": {
      "Type": "AWS::CodeArtifact::Domain",
      "Properties": {
        "DomainName": "my-domain"
      }
    },
    "MyCodeArtifactRepository": {
      "Type": "AWS::CodeArtifact::Repository",
      "Properties": {
        "RepositoryName": "my-repo",
        "DomainName": {
          "Fn::GetAtt": [
            "MyCodeArtifactDomain",
            "Name"
          ]
        }
      }
    }
  }
}
```

### Create a repository with an upstream repository and external connection
<a name="aws-resource-codeartifact-repository--examples--Create_a_repository_with_an_upstream_repository_and_external_connection"></a>

The following example creates a CodeArtifact domain named *my-domain* to store repositories. It also creates two CodeArtifact repositories: *my-repo* and *my-upstream-repo* within the domain. *my-repo* has *my-upstream-repo* configured as an upstream repository, and *my-upstream-repo* has an external connection to the public repository, **npmjs**.

#### YAML
<a name="aws-resource-codeartifact-repository--examples--Create_a_repository_with_an_upstream_repository_and_external_connection--yaml"></a>

```
Resources:
  MyCodeArtifactDomain:
    Type: 'AWS::CodeArtifact::Domain'
    Properties:
      DomainName: "my-domain"
  MyCodeArtifactUpstreamRepository:
    Type: 'AWS::CodeArtifact::Repository'
    Properties:
      RepositoryName: "my-upstream-repo"
      DomainName: !GetAtt MyCodeArtifactDomain.Name
      ExternalConnections:
        - public:npmjs
  MyCodeArtifactRepository:
    Type: 'AWS::CodeArtifact::Repository'
    Properties:
      RepositoryName: "my-repo"
      DomainName: !GetAtt MyCodeArtifactDomain.Name
      Upstreams:
        - !GetAtt MyCodeArtifactUpstreamRepository.Name
```

#### JSON
<a name="aws-resource-codeartifact-repository--examples--Create_a_repository_with_an_upstream_repository_and_external_connection--json"></a>

```
{
  "Resources": {
    "MyCodeArtifactDomain": {
      "Type": "AWS::CodeArtifact::Domain",
      "Properties": {
        "DomainName": "my-domain"
      }
    },
    "MyCodeArtifactUpstreamRepository": {
      "Type": "AWS::CodeArtifact::Repository",
      "Properties": {
        "RepositoryName": "my-upstream-repo",
        "DomainName": {
          "Fn::GetAtt": [
            "MyCodeArtifactDomain",
            "Name"
          ]
        },
        "ExternalConnections": [
          "public:npmjs"
        ]
      }
    },
    "MyCodeArtifactRepository": {
      "Type": "AWS::CodeArtifact::Repository",
      "Properties": {
        "RepositoryName": "my-repo",
        "DomainName": {
          "Fn::GetAtt": [
            "MyCodeArtifactDomain",
            "Name"
          ]
        },
        "Upstreams": [
          {
            "Fn::GetAtt": [
              "MyCodeArtifactUpstreamRepository",
              "Name"
            ]
          }
        ]
      }
    }
  }
}
```

### Create a domain and repository with tags
<a name="aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository_with_tags"></a>

The following example creates a CodeArtifact domain named *my-domain* and a CodeArtifact repository named *my-repo* inside it with two tags. One tag consists of a key named `keyname1` and a value of `value1`. The other consists of a key named `keyname2` and a value of `value2`.

#### YAML
<a name="aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository_with_tags--yaml"></a>

```
Resources:
  MyCodeArtifactDomain:
    Type: 'AWS::CodeArtifact::Domain'
    Properties:
      DomainName: "my-domain"
  MyCodeArtifactRepository:
    Type: 'AWS::CodeArtifact::Repository'
    Properties:
      RepositoryName: "my-repo"
      DomainName: !GetAtt MyCodeArtifactDomain.Name
      Tags:
        - Key: "keyname1"
          Value: "value1"
        - Key: "keyname2"
          Value: "value2"
```

#### JSON
<a name="aws-resource-codeartifact-repository--examples--Create_a_domain_and_repository_with_tags--json"></a>

```
{
  "Resources": {
    "MyCodeArtifactDomain": {
      "Type": "AWS::CodeArtifact::Domain",
      "Properties": {
        "DomainName": "my-domain"
      }
    },
    "MyCodeArtifactRepository": {
      "Type": "AWS::CodeArtifact::Repository",
      "Properties": {
        "RepositoryName": "my-repo",
        "DomainName": {
          "Fn::GetAtt": [
            "MyCodeArtifactDomain",
            "Name"
          ]
        },
        "Tags" : [
          {
            "Key" : "keyname1",
            "Value" : "value1"
          },
          {
            "Key" : "keyname2",
            "Value" : "value2"
          }
        ]
      }
    }
  }
}
```

# AWS::CodeArtifact::Repository Tag
<a name="aws-properties-codeartifact-repository-tag"></a>

A tag is a key-value pair that can be used to manage, search for, or filter resources in AWS CodeArtifact.

## Syntax
<a name="aws-properties-codeartifact-repository-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codeartifact-repository-tag-syntax.json"></a>

```
{
  "[Key](#cfn-codeartifact-repository-tag-key)" : String,
  "[Value](#cfn-codeartifact-repository-tag-value)" : String
}
```

### YAML
<a name="aws-properties-codeartifact-repository-tag-syntax.yaml"></a>

```
  [Key](#cfn-codeartifact-repository-tag-key): String
  [Value](#cfn-codeartifact-repository-tag-value): String
```

## Properties
<a name="aws-properties-codeartifact-repository-tag-properties"></a>

`Key`  <a name="cfn-codeartifact-repository-tag-key"></a>
The tag key.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-codeartifact-repository-tag-value"></a>
The tag value.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)