Skip to content
v2.275.0

CfnRepositoryProps Struct ​

Properties for defining a CfnRepository.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codeartifact as codeartifact } from 'aws-cdk-lib';

declare const permissionsPolicyDocument: any;
const cfnRepositoryProps: codeartifact.CfnRepositoryProps = {
  domainName: 'domainName',
  repositoryName: 'repositoryName',

  // the properties below are optional
  description: 'description',
  domainOwner: 'domainOwner',
  externalConnections: ['externalConnections'],
  permissionsPolicyDocument: permissionsPolicyDocument,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  upstreams: ['upstreams'],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A text description of the repository.
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*stringrequired#
The name of the domain that contains the repository.
domainOwneroptionalstringdomain_owneroptionalstrdomainOwneroptionalStringDomainOwneroptionalstringDomainOwneroptional*string#
The 12-digit account number of the AWS account that owns the domain that contains the repository.

It does not include dashes or spaces.

externalConnectionsoptionalstring[]external_connectionsoptionaltyping.List[str]externalConnectionsoptionalList<String>ExternalConnectionsoptionalstring[]ExternalConnectionsoptional*[]*string#
An array of external connections associated with the repository.

For more information, see Supported external connection repositories in the CodeArtifact user guide .

permissionsPolicyDocumentoptionalanypermissions_policy_documentoptionalAnypermissionsPolicyDocumentoptionalObjectPermissionsPolicyDocumentoptionalobjectPermissionsPolicyDocumentoptionalinterface{}#
The document that defines the resource policy that is set on a repository.
repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*stringrequired#
The name of an upstream repository.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to be applied to the repository.
upstreamsoptionalstring[]upstreamsoptionaltyping.List[str]upstreamsoptionalList<String>Upstreamsoptionalstring[]Upstreamsoptional*[]*string#
A list of upstream repositories to associate with the repository.
notes

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 .