software.amazon.awscdk.services.codeartifact

Class CfnRepository

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codeartifact.CfnRepository

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:28.706Z")
 @Stability(value=Stable)
public class CfnRepository
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeArtifact::Repository`.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codeartifact.*;
 Object permissionsPolicyDocument;
 CfnRepository cfnRepository = CfnRepository.Builder.create(this, "MyCfnRepository")
         .domainName("domainName")
         .repositoryName("repositoryName")
         // the properties below are optional
         .description("description")
         .domainOwner("domainOwner")
         .externalConnections(List.of("externalConnections"))
         .permissionsPolicyDocument(permissionsPolicyDocument)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .upstreams(List.of("upstreams"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRepository.Builder A fluent builder for CfnRepository.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRepository(Construct scope, String id, CfnRepositoryProps props) Create a new `AWS::CodeArtifact::Repository`.
protected	CfnRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRepository(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.
String	getAttrDomainName() When you pass the logical ID of this resource, the function returns the domain name that contains the repository.
String	getAttrDomainOwner() 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.
String	getAttrName() When you pass the logical ID of this resource, the function returns the name of the repository.
protected Map<String,Object>	getCfnProperties()
String	getDescription() A text description of the repository.
String	getDomainName() The name of the domain that contains the repository.
String	getDomainOwner() The 12-digit account number of the AWS account that owns the domain that contains the repository.
List<String>	getExternalConnections() An array of external connections associated with the repository.
Object	getPermissionsPolicyDocument() The document that defines the resource policy that is set on a repository.
String	getRepositoryName() The name of an upstream repository.
TagManager	getTags() A list of tags to be applied to the repository.
List<String>	getUpstreams() A list of upstream repositories to associate with the repository.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A text description of the repository.
void	setDomainName(String value) The name of the domain that contains the repository.
void	setDomainOwner(String value) The 12-digit account number of the AWS account that owns the domain that contains the repository.
void	setExternalConnections(List<String> value) An array of external connections associated with the repository.
void	setPermissionsPolicyDocument(Object value) The document that defines the resource policy that is set on a repository.
void	setRepositoryName(String value) The name of an upstream repository.
void	setUpstreams(List<String> value) A list of upstream repositories to associate with the repository.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRepository

protected CfnRepository(software.amazon.jsii.JsiiObjectRef objRef)

CfnRepository

protected CfnRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRepository

@Stability(value=Stable)
public CfnRepository(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnRepositoryProps props)

Create a new `AWS::CodeArtifact::Repository`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.

getAttrDomainName

@Stability(value=Stable)
 @NotNull
public String getAttrDomainName()

When you pass the logical ID of this resource, the function returns the domain name that contains the repository.

getAttrDomainOwner

@Stability(value=Stable)
 @NotNull
public String getAttrDomainOwner()

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.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

When you pass the logical ID of this resource, the function returns the name of the repository.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A list of tags to be applied to the repository.

getDomainName

@Stability(value=Stable)
 @NotNull
public String getDomainName()

The name of the domain that contains the repository.

setDomainName

@Stability(value=Stable)
public void setDomainName(@NotNull
                                                   String value)

The name of the domain that contains the repository.

getPermissionsPolicyDocument

@Stability(value=Stable)
 @NotNull
public Object getPermissionsPolicyDocument()

The document that defines the resource policy that is set on a repository.

setPermissionsPolicyDocument

@Stability(value=Stable)
public void setPermissionsPolicyDocument(@NotNull
                                                                  Object value)

The document that defines the resource policy that is set on a repository.

getRepositoryName

@Stability(value=Stable)
 @NotNull
public String getRepositoryName()

The name of an upstream repository.

setRepositoryName

@Stability(value=Stable)
public void setRepositoryName(@NotNull
                                                       String value)

The name of an upstream repository.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A text description of the repository.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A text description of the repository.

getDomainOwner

@Stability(value=Stable)
 @Nullable
public String getDomainOwner()

The 12-digit account number of the AWS account that owns the domain that contains the repository.

It does not include dashes or spaces.

setDomainOwner

@Stability(value=Stable)
public void setDomainOwner(@Nullable
                                                    String value)

The 12-digit account number of the AWS account that owns the domain that contains the repository.

It does not include dashes or spaces.

getExternalConnections

@Stability(value=Stable)
 @Nullable
public List<String> getExternalConnections()

An array of external connections associated with the repository.

setExternalConnections

@Stability(value=Stable)
public void setExternalConnections(@Nullable
                                                            List<String> value)

An array of external connections associated with the repository.

getUpstreams

@Stability(value=Stable)
 @Nullable
public List<String> getUpstreams()

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 .

setUpstreams

@Stability(value=Stable)
public void setUpstreams(@Nullable
                                                  List<String> value)

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 .