Class CfnRepository
A CloudFormation AWS::CodeArtifact::Repository
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodeArtifact
Assembly: Amazon.CDK.AWS.CodeArtifact.dll
Syntax (csharp)
public class CfnRepository : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRepository
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 in the CodeArtifact User Guide . For more information about the CreateRepository
API, see CreateRepository in the CodeArtifact API Reference .
CloudformationResource: AWS::CodeArtifact::Repository
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeArtifact;
var permissionsPolicyDocument;
var cfnRepository = new CfnRepository(this, "MyCfnRepository", new CfnRepositoryProps {
DomainName = "domainName",
RepositoryName = "repositoryName",
// the properties below are optional
Description = "description",
DomainOwner = "domainOwner",
ExternalConnections = new [] { "externalConnections" },
PermissionsPolicyDocument = permissionsPolicyDocument,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Upstreams = new [] { "upstreams" }
});
Synopsis
Constructors
CfnRepository(Construct, String, ICfnRepositoryProps) | Create a new |
CfnRepository(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRepository(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository. |
AttrDomainName | When you pass the logical ID of this resource, the function returns the domain name that contains the repository. |
AttrDomainOwner | 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. |
AttrName | When you pass the logical ID of this resource, the function returns the name of the repository. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A text description of the repository. |
DomainName | The name of the domain that contains the repository. |
DomainOwner | The 12-digit account number of the AWS account that owns the domain that contains the repository. |
ExternalConnections | An array of external connections associated with the repository. |
PermissionsPolicyDocument | The document that defines the resource policy that is set on a repository. |
RepositoryName | The name of an upstream repository. |
Tags | A list of tags to be applied to the repository. |
Upstreams | A list of upstream repositories to associate with the repository. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRepository(Construct, String, ICfnRepositoryProps)
Create a new AWS::CodeArtifact::Repository
.
public CfnRepository(Construct scope, string id, ICfnRepositoryProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRepositoryProps
- resource properties.
CfnRepository(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRepository(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRepository(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRepository(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrDomainName
When you pass the logical ID of this resource, the function returns the domain name that contains the repository.
public virtual string AttrDomainName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainName
AttrDomainOwner
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.
public virtual string AttrDomainOwner { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DomainOwner
AttrName
When you pass the logical ID of this resource, the function returns the name of the repository.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A text description of the repository.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DomainName
The name of the domain that contains the repository.
public virtual string DomainName { get; set; }
Property Value
System.String
Remarks
DomainOwner
The 12-digit account number of the AWS account that owns the domain that contains the repository.
public virtual string DomainOwner { get; set; }
Property Value
System.String
Remarks
It does not include dashes or spaces.
ExternalConnections
An array of external connections associated with the repository.
public virtual string[] ExternalConnections { get; set; }
Property Value
System.String[]
Remarks
PermissionsPolicyDocument
The document that defines the resource policy that is set on a repository.
public virtual object PermissionsPolicyDocument { get; set; }
Property Value
System.Object
Remarks
RepositoryName
The name of an upstream repository.
public virtual string RepositoryName { get; set; }
Property Value
System.String
Remarks
Tags
A list of tags to be applied to the repository.
public virtual TagManager Tags { get; }
Property Value
Remarks
Upstreams
A list of upstream repositories to associate with the repository.
public virtual string[] Upstreams { get; set; }
Property Value
System.String[]
Remarks
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 .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>