- Implements: IDomain
A CodeArtifact domain.
import { Domain } from '@renovosolutions/cdk-library-aws-codeartifact'
new Domain(scope: Construct, id: string, props: DomainProps)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
DomainProps |
No description. |
- Type: constructs.Construct
- Type: string
- Type: DomainProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
applyRemovalPolicy |
Apply the given removal policy to this resource. |
addRepository |
Add a repository to this domain. |
grantRead |
Grant read permissions to the given principal on this domain. |
grantReadWrite |
Grant read and write permissions to the given principal on this domain. |
grantWrite |
Grant write permissions to the given principal on this domain. |
public toString(): string
Returns a string representation of this construct.
public applyRemovalPolicy(policy: RemovalPolicy): void
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
- Type: aws-cdk-lib.RemovalPolicy
public addRepository(id: string, props: RepositoryOptions): IRepository
Add a repository to this domain.
- Type: string
- Type: RepositoryOptions
public grantRead(principal: IGrantable): Grant
Grant read permissions to the given principal on this domain.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantReadWrite(principal: IGrantable): Grant
Grant read and write permissions to the given principal on this domain.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantWrite(principal: IGrantable): Grant
Grant write permissions to the given principal on this domain.
- Type: aws-cdk-lib.aws_iam.IGrantable
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isOwnedResource |
Returns true if the construct was created by CDK, and false otherwise. |
isResource |
Check whether the given construct is a Resource. |
fromDomainArn |
Reference an existing domain by its ARN. |
fromDomainAttributes |
Import an existing domain given its attributes. |
import { Domain } from '@renovosolutions/cdk-library-aws-codeartifact'
Domain.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
import { Domain } from '@renovosolutions/cdk-library-aws-codeartifact'
Domain.isOwnedResource(construct: IConstruct)
Returns true if the construct was created by CDK, and false otherwise.
- Type: constructs.IConstruct
import { Domain } from '@renovosolutions/cdk-library-aws-codeartifact'
Domain.isResource(construct: IConstruct)
Check whether the given construct is a Resource.
- Type: constructs.IConstruct
import { Domain } from '@renovosolutions/cdk-library-aws-codeartifact'
Domain.fromDomainArn(scope: Construct, id: string, domainArn: string)
Reference an existing domain by its ARN.
- Type: constructs.Construct
- Type: string
- Type: string
import { Domain } from '@renovosolutions/cdk-library-aws-codeartifact'
Domain.fromDomainAttributes(scope: Construct, id: string, attrs: DomainAttributes)
Import an existing domain given its attributes.
Either domainArn
or domainName
is required.
- Type: constructs.Construct
- Type: string
- Type: DomainAttributes
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
env |
aws-cdk-lib.ResourceEnvironment |
The environment this resource belongs to. |
stack |
aws-cdk-lib.Stack |
The stack in which this resource is defined. |
cfnDomain |
aws-cdk-lib.aws_codeartifact.CfnDomain |
The underlying CfnDomain resource. |
domainArn |
string |
The ARN of the domain. |
domainName |
string |
The name of the domain. |
domainEncryptionKey |
string |
The key used to encrypt the domain. |
domainOwner |
string |
The account that owns the domain. |
encryptionKey |
aws-cdk-lib.aws_kms.IKey |
The key used to encrypt the domain. |
readActions |
string[] |
No description. |
writeActions |
string[] |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly env: ResourceEnvironment;
- Type: aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack: Stack;
- Type: aws-cdk-lib.Stack
The stack in which this resource is defined.
public readonly cfnDomain: CfnDomain;
- Type: aws-cdk-lib.aws_codeartifact.CfnDomain
The underlying CfnDomain resource.
public readonly domainArn: string;
- Type: string
The ARN of the domain.
public readonly domainName: string;
- Type: string
The name of the domain.
public readonly domainEncryptionKey: string;
- Type: string
The key used to encrypt the domain.
public readonly domainOwner: string;
- Type: string
The account that owns the domain.
public readonly encryptionKey: IKey;
- Type: aws-cdk-lib.aws_kms.IKey
The key used to encrypt the domain.
public readonly readActions: string[];
- Type: string[]
public readonly writeActions: string[];
- Type: string[]
- Implements: IRepository
A CodeArtifact domain.
import { Repository } from '@renovosolutions/cdk-library-aws-codeartifact'
new Repository(scope: Construct, id: string, props: RepositoryProps)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
RepositoryProps |
No description. |
- Type: constructs.Construct
- Type: string
- Type: RepositoryProps
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
applyRemovalPolicy |
Apply the given removal policy to this resource. |
grantRead |
Grant read permissions to the given principal on this repository. |
grantReadWrite |
Grant read and write permissions to the given principal on this repository. |
grantWrite |
Grant write permissions to the given principal on this respository. |
public toString(): string
Returns a string representation of this construct.
public applyRemovalPolicy(policy: RemovalPolicy): void
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
- Type: aws-cdk-lib.RemovalPolicy
public grantRead(principal: IGrantable): Grant
Grant read permissions to the given principal on this repository.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantReadWrite(principal: IGrantable): Grant
Grant read and write permissions to the given principal on this repository.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantWrite(principal: IGrantable): Grant
Grant write permissions to the given principal on this respository.
- Type: aws-cdk-lib.aws_iam.IGrantable
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isOwnedResource |
Returns true if the construct was created by CDK, and false otherwise. |
isResource |
Check whether the given construct is a Resource. |
fromRepositoryArn |
Reference an existing repository by its ARN. |
fromRepositoryAttributes |
Reference an existing repository by its attributes. |
import { Repository } from '@renovosolutions/cdk-library-aws-codeartifact'
Repository.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
import { Repository } from '@renovosolutions/cdk-library-aws-codeartifact'
Repository.isOwnedResource(construct: IConstruct)
Returns true if the construct was created by CDK, and false otherwise.
- Type: constructs.IConstruct
import { Repository } from '@renovosolutions/cdk-library-aws-codeartifact'
Repository.isResource(construct: IConstruct)
Check whether the given construct is a Resource.
- Type: constructs.IConstruct
import { Repository } from '@renovosolutions/cdk-library-aws-codeartifact'
Repository.fromRepositoryArn(scope: Construct, id: string, repositoryArn: string)
Reference an existing repository by its ARN.
- Type: constructs.Construct
- Type: string
- Type: string
import { Repository } from '@renovosolutions/cdk-library-aws-codeartifact'
Repository.fromRepositoryAttributes(scope: Construct, id: string, attrs: RepositoryAttributes)
Reference an existing repository by its attributes.
- Type: constructs.Construct
- Type: string
- Type: RepositoryAttributes
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
env |
aws-cdk-lib.ResourceEnvironment |
The environment this resource belongs to. |
stack |
aws-cdk-lib.Stack |
The stack in which this resource is defined. |
cfnRepository |
aws-cdk-lib.aws_codeartifact.CfnRepository |
The underlying CfnRepository. |
domain |
IDomain |
The name of the repository domain. |
repositoryArn |
string |
The ARN of the repository. |
repositoryName |
string |
The name of the repository. |
repositoryDomainName |
string |
The name of the domain that contains the repository. |
repositoryDomainOwner |
string |
The account that owns the domain that contains the repository. |
readActions |
string[] |
No description. |
writeActions |
string[] |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly env: ResourceEnvironment;
- Type: aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack: Stack;
- Type: aws-cdk-lib.Stack
The stack in which this resource is defined.
public readonly cfnRepository: CfnRepository;
- Type: aws-cdk-lib.aws_codeartifact.CfnRepository
The underlying CfnRepository.
public readonly domain: IDomain;
- Type: IDomain
The name of the repository domain.
public readonly repositoryArn: string;
- Type: string
The ARN of the repository.
public readonly repositoryName: string;
- Type: string
The name of the repository.
public readonly repositoryDomainName: string;
- Type: string
The name of the domain that contains the repository.
public readonly repositoryDomainOwner: string;
- Type: string
The account that owns the domain that contains the repository.
public readonly readActions: string[];
- Type: string[]
public readonly writeActions: string[];
- Type: string[]
Attributes of a domain.
import { DomainAttributes } from '@renovosolutions/cdk-library-aws-codeartifact'
const domainAttributes: DomainAttributes = { ... }
Name | Type | Description |
---|---|---|
domainArn |
string |
The ARN of the domain. |
domainEncryptionKey |
string |
The key used to encrypt the domain. |
domainName |
string |
The name of the domain. |
domainOwner |
string |
The account that owns the domain. |
encryptionKey |
aws-cdk-lib.aws_kms.IKey |
The key used to encrypt the domain. |
public readonly domainArn: string;
- Type: string
The ARN of the domain.
public readonly domainEncryptionKey: string;
- Type: string
The key used to encrypt the domain.
public readonly domainName: string;
- Type: string
The name of the domain.
public readonly domainOwner: string;
- Type: string
The account that owns the domain.
public readonly encryptionKey: IKey;
- Type: aws-cdk-lib.aws_kms.IKey
The key used to encrypt the domain.
The properties for a new domain.
import { DomainProps } from '@renovosolutions/cdk-library-aws-codeartifact'
const domainProps: DomainProps = { ... }
Name | Type | Description |
---|---|---|
name |
string |
A string that specifies the name of the requested domain. |
encryptionKey |
aws-cdk-lib.aws_kms.IKey |
The key used to encrypt the domain. |
permissionsPolicyDocument |
aws-cdk-lib.aws_iam.PolicyDocument |
The document that defines the resource policy that is set on a domain. |
public readonly name: string;
- Type: string
A string that specifies the name of the requested domain.
public readonly encryptionKey: IKey;
- Type: aws-cdk-lib.aws_kms.IKey
- Default: An AWS managed key is created automatically.
The key used to encrypt the domain.
public readonly permissionsPolicyDocument: PolicyDocument;
- Type: aws-cdk-lib.aws_iam.PolicyDocument
- Default: No policy is set. The account will have full permissions to the domain.
The document that defines the resource policy that is set on a domain.
Attributes of a repository.
import { RepositoryAttributes } from '@renovosolutions/cdk-library-aws-codeartifact'
const repositoryAttributes: RepositoryAttributes = { ... }
Name | Type | Description |
---|---|---|
domain |
IDomain |
The domain that contains the repository. |
repositoryArn |
string |
The ARN of the repository. |
repositoryDomainName |
string |
The name of the domain that contains the repository. |
repositoryDomainOwner |
string |
The account that owns the domain that contains the repository. |
repositoryName |
string |
The name of the repository. |
public readonly domain: IDomain;
- Type: IDomain
The domain that contains the repository.
public readonly repositoryArn: string;
- Type: string
The ARN of the repository.
public readonly repositoryDomainName: string;
- Type: string
The name of the domain that contains the repository.
public readonly repositoryDomainOwner: string;
- Type: string
The account that owns the domain that contains the repository.
public readonly repositoryName: string;
- Type: string
The name of the repository.
The options for creating a new repository.
import { RepositoryOptions } from '@renovosolutions/cdk-library-aws-codeartifact'
const repositoryOptions: RepositoryOptions = { ... }
Name | Type | Description |
---|---|---|
name |
string |
The name of the repository. |
description |
string |
The description of the repository. |
externalConnections |
ExternalConnection[] |
An array of external connections associated with the repository. |
permissionsPolicyDocument |
aws-cdk-lib.aws_iam.PolicyDocument |
The document that defines the permissions policy for the repository. |
upstreams |
IRepository[] |
An array of upstream repositories associated with the repository. |
public readonly name: string;
- Type: string
The name of the repository.
public readonly description: string;
- Type: string
The description of the repository.
public readonly externalConnections: ExternalConnection[];
- Type: ExternalConnection[]
An array of external connections associated with the repository.
https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html
public readonly permissionsPolicyDocument: PolicyDocument;
- Type: aws-cdk-lib.aws_iam.PolicyDocument
The document that defines the permissions policy for the repository.
public readonly upstreams: IRepository[];
- Type: IRepository[]
An array of upstream repositories associated with the repository.
https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html
The properties of a CodeArtifact Repository.
import { RepositoryProps } from '@renovosolutions/cdk-library-aws-codeartifact'
const repositoryProps: RepositoryProps = { ... }
Name | Type | Description |
---|---|---|
name |
string |
The name of the repository. |
description |
string |
The description of the repository. |
externalConnections |
ExternalConnection[] |
An array of external connections associated with the repository. |
permissionsPolicyDocument |
aws-cdk-lib.aws_iam.PolicyDocument |
The document that defines the permissions policy for the repository. |
upstreams |
IRepository[] |
An array of upstream repositories associated with the repository. |
domain |
IDomain |
The domain that the repository will be created in. |
public readonly name: string;
- Type: string
The name of the repository.
public readonly description: string;
- Type: string
The description of the repository.
public readonly externalConnections: ExternalConnection[];
- Type: ExternalConnection[]
An array of external connections associated with the repository.
https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html
public readonly permissionsPolicyDocument: PolicyDocument;
- Type: aws-cdk-lib.aws_iam.PolicyDocument
The document that defines the permissions policy for the repository.
public readonly upstreams: IRepository[];
- Type: IRepository[]
An array of upstream repositories associated with the repository.
https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html
public readonly domain: IDomain;
- Type: IDomain
The domain that the repository will be created in.
Name | Description |
---|---|
addRepository |
Add a repository to this domain. |
grantRead |
Grant read permissions to the given principal on this domain. |
grantReadWrite |
Grant read and write permissions to the given principal on this domain. |
grantWrite |
Grant write permissions to the given principal on this domain. |
public addRepository(id: string, props: RepositoryOptions): IRepository
Add a repository to this domain.
- Type: string
- Type: RepositoryOptions
public grantRead(grantee: IGrantable): Grant
Grant read permissions to the given principal on this domain.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantReadWrite(grantee: IGrantable): Grant
Grant read and write permissions to the given principal on this domain.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantWrite(grantee: IGrantable): Grant
Grant write permissions to the given principal on this domain.
- Type: aws-cdk-lib.aws_iam.IGrantable
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
env |
aws-cdk-lib.ResourceEnvironment |
The environment this resource belongs to. |
stack |
aws-cdk-lib.Stack |
The stack in which this resource is defined. |
domainArn |
string |
The ARN of the domain. |
domainName |
string |
The name of the domain. |
domainEncryptionKey |
string |
The key used to encrypt the domain. |
domainOwner |
string |
The account that owns the domain. |
encryptionKey |
aws-cdk-lib.aws_kms.IKey |
The key used to encrypt the domain. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly env: ResourceEnvironment;
- Type: aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack: Stack;
- Type: aws-cdk-lib.Stack
The stack in which this resource is defined.
public readonly domainArn: string;
- Type: string
The ARN of the domain.
public readonly domainName: string;
- Type: string
The name of the domain.
public readonly domainEncryptionKey: string;
- Type: string
The key used to encrypt the domain.
public readonly domainOwner: string;
- Type: string
The account that owns the domain.
public readonly encryptionKey: IKey;
- Type: aws-cdk-lib.aws_kms.IKey
The key used to encrypt the domain.
-
Extends: aws-cdk-lib.IResource
-
Implemented By: Repository, IRepository
This interface represents a CodeArtifact Repository resource.
Name | Description |
---|---|
grantRead |
Grant read permissions to the given principal on this repository. |
grantReadWrite |
Grant read and write permissions to the given principal on this repository. |
grantWrite |
Grant write permissions to the given principal on this respository. |
public grantRead(grantee: IGrantable): Grant
Grant read permissions to the given principal on this repository.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantReadWrite(grantee: IGrantable): Grant
Grant read and write permissions to the given principal on this repository.
- Type: aws-cdk-lib.aws_iam.IGrantable
public grantWrite(grantee: IGrantable): Grant
Grant write permissions to the given principal on this respository.
- Type: aws-cdk-lib.aws_iam.IGrantable
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
env |
aws-cdk-lib.ResourceEnvironment |
The environment this resource belongs to. |
stack |
aws-cdk-lib.Stack |
The stack in which this resource is defined. |
domain |
IDomain |
The domain that contains the repository. |
repositoryArn |
string |
The ARN of the repository. |
repositoryName |
string |
The name of the repository. |
repositoryDomainName |
string |
The name of the domain that contains the repository. |
repositoryDomainOwner |
string |
The account that owns the domain that contains the repository. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly env: ResourceEnvironment;
- Type: aws-cdk-lib.ResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack: Stack;
- Type: aws-cdk-lib.Stack
The stack in which this resource is defined.
public readonly domain: IDomain;
- Type: IDomain
The domain that contains the repository.
public readonly repositoryArn: string;
- Type: string
The ARN of the repository.
public readonly repositoryName: string;
- Type: string
The name of the repository.
public readonly repositoryDomainName: string;
- Type: string
The name of the domain that contains the repository.
public readonly repositoryDomainOwner: string;
- Type: string
The account that owns the domain that contains the repository.
CodeArtifact supports an external connection to the following public repositories.
Name | Description |
---|---|
NPM |
npm public registry. |
DOTNET_NUGETORG |
NuGet Gallery. |
PYTHON_PYPI |
Python Package Index. |
MAVEN_CENTRAL |
Maven Central. |
MAVEN_GOOGLEANDROID |
Google Android repository. |
MAVEN_GRADLEPLUGINS |
Gradle plugins repository. |
MAVEN_COMMONSWARE |
CommonsWare Android repository. |
npm public registry.
NuGet Gallery.
Python Package Index.
Maven Central.
Google Android repository.
Gradle plugins repository.
CommonsWare Android repository.