@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:21.179Z") public class CfnRepository extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnRepository.Builder
A fluent builder for
CfnRepository . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnRepository(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
When you pass the logical ID of this resource, the function returns the Amazon Resource Name (ARN) of the repository.
|
java.lang.String |
getAttrDomainName()
When you pass the logical ID of this resource, the function returns the domain name that contains the repository.
|
java.lang.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.
|
java.lang.String |
getAttrName()
When you pass the logical ID of this resource, the function returns the name of the repository.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A text description of the repository.
|
java.lang.String |
getDomainName()
The name of the domain that contains the repository.
|
java.lang.String |
getDomainOwner()
The 12-digit account number of the AWS account that owns the domain that contains the repository.
|
java.util.List<java.lang.String> |
getExternalConnections()
An array of external connections associated with the repository.
|
java.lang.Object |
getPermissionsPolicyDocument()
The document that defines the resource policy that is set on a repository.
|
java.lang.String |
getRepositoryName()
The name of an upstream repository.
|
TagManager |
getTags()
A list of tags to be applied to the repository.
|
java.util.List<java.lang.String> |
getUpstreams()
A list of upstream repositories to associate with the repository.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDescription(java.lang.String value)
A text description of the repository.
|
void |
setDomainName(java.lang.String value)
The name of the domain that contains the repository.
|
void |
setDomainOwner(java.lang.String value)
The 12-digit account number of the AWS account that owns the domain that contains the repository.
|
void |
setExternalConnections(java.util.List<java.lang.String> value)
An array of external connections associated with the repository.
|
void |
setPermissionsPolicyDocument(java.lang.Object value)
The document that defines the resource policy that is set on a repository.
|
void |
setRepositoryName(java.lang.String value)
The name of an upstream repository.
|
void |
setUpstreams(java.util.List<java.lang.String> value)
A list of upstream repositories to associate with the repository.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnRepository(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnRepository(Construct scope, java.lang.String id, CfnRepositoryProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrDomainName()
public java.lang.String getAttrDomainOwner()
public java.lang.String getAttrName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getDomainName()
public void setDomainName(java.lang.String value)
public java.lang.Object getPermissionsPolicyDocument()
public void setPermissionsPolicyDocument(java.lang.Object value)
public java.lang.String getRepositoryName()
public void setRepositoryName(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getDomainOwner()
It does not include dashes or spaces.
public void setDomainOwner(java.lang.String value)
It does not include dashes or spaces.
public java.util.List<java.lang.String> getExternalConnections()
public void setExternalConnections(java.util.List<java.lang.String> value)
public java.util.List<java.lang.String> getUpstreams()
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 .
public void setUpstreams(java.util.List<java.lang.String> value)
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 .